Using the VDF Tools Wiki Feature: Difference between revisions
Using the VDF Tools Wiki Feature (view source)
Revision as of 23:31, 16 December 2007
, 16 December 2007→Example
No edit summary |
|||
| Line 6: | Line 6: | ||
We're specifying the URL '''http://vdfwiki.com/index.php?title=''' in the project properties. | We're specifying the URL '''http://vdfwiki.com/index.php?title=''' in the project properties. | ||
We then put the cursor at the word dbView in the following code. Note that VDF Tools will by itself determine what is a word. There should be no need to select the characters forming the word you're interested in. | We then put the cursor at the word ''dbView'' in the following code. Note that VDF Tools will by itself determine what is a word. There should be no need to select the characters forming the word you're interested in. | ||
Object oMaintenance_VW is a dbView | Object oMaintenance_VW is a dbView | ||
| Line 15: | Line 15: | ||
Pressing '''Shift+F2''' or selecting '''Open Keyword in Project Wiki''' will open the URL '''http://vdfwiki.com/index.php?title=dbView'''. | Pressing '''Shift+F2''' or selecting '''Open Keyword in Project Wiki''' will open the URL '''http://vdfwiki.com/index.php?title=dbView'''. | ||
===Ad Notam=== | |||
When using a Wiki such as MediaWiki it is probably a good idea to use a separate ''namespace'' for this kind of documentation. | |||
Any word in the code can be used. So you can use this feature for quickly linking to documentation for classes, functions, data files and more. | |||