AgileApps Support Wiki Pre Release

Wiki Conventions

From AgileApps Support Wiki
Revision as of 02:52, 7 May 2011 by imported>Aeric
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
  • 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 > /Tab\ > _Link_ > {choice} > [Button]
where:
  • Item - Typically an item in the navigation pane. Could also be a menu item.
  • /Tab\ - A tab you click __TBD: Not Used__
  • _Link_ - A link on the page that you click __TBD: Not Used__
  • {choice} - A selection you make or a value you enter
  • [Button] - A button you click

Notepad.png

Note: The items marked "not used" look good when displayed in TT font, as above. They do not look as good in actual use, with a normal font.