Difference between revisions of "Wiki Conventions"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
(One intermediate revision by the same user not shown) | |||
Line 7: | Line 7: | ||
:: This sample shows the kinds of the things you might see in a GUI path: | :: This sample shows the kinds of the things you might see in a GUI path: | ||
::: '''<tt>Item | ::: '''<tt>Item > {choice} > [Button]</tt>''' | ||
:: where: | :: where: | ||
:::* '''<tt>Item</tt>''' - Typically an item in the navigation pane. Could also be a menu item. | :::* '''<tt>Item</tt>''' - Typically an item in the navigation pane. Could also be a menu item. | ||
:::* '''<tt>{choice}</tt>''' - A selection you make or a value you enter | :::* '''<tt>{choice}</tt>''' - A selection you make or a value you enter | ||
:::* '''<tt>[Button]</tt>''' - A button you click | :::* '''<tt>[Button]</tt>''' - A button you click | ||
{{Note| | {{Note|Text you enter is often indicated in ''italics''. But it may also be shown in <tt>monospaced font</tt>, if it pertains to a file, directory path, or code.}} |
Latest revision as of 23:47, 11 December 2012
- To make it easier to go from the GUI to the Wiki, the Wiki tries to have a page for each section heading in the GUI. In most cases, it should be possible to search on a section heading, to find the material you're looking for.
- From any given page, you can use "What links here" to get more information. (Links tell you where material is used, "transclusions" point to pages that provide a larger context.)
- When you follow a link to a Wiki page, it sometimes raises the question, "Where is this section in the GUI?" To help answer that question, pages that correspond to GUI sections have a GUI path at the top. Those paths tell you what actions you take to get to that section of the GUI. The general format of a path looks like this:
- Do this > Then this > And this
- This sample shows the kinds of the things you might see in a GUI path:
- Item > {choice} > [Button]
- This sample shows the kinds of the things you might see in a GUI path:
- where:
- Item - Typically an item in the navigation pane. Could also be a menu item.
- {choice} - A selection you make or a value you enter
- [Button] - A button you click
- where: