Changes between Version 1 and Version 2 of TracNav/Usage


Ignore:
Timestamp:
Mar 1, 2005 10:12:06 AM (15 years ago)
Author:
hauma
Comment:

Initial version.

Legend:

Unmodified
Added
Removed
Modified
  • TracNav/Usage

    v1 v2  
    11= TracNav Usage =
     2[[TracNav(TracNav/TOC)]]
    23
    3 To use TracNav, create an index page for your site. The index page (TOC) must contain a linking all
     4To use TracNav, you have to create an index page for your site and call the TracNav macro on each page, where the navigation bar should be displayed.
     5
     6
     7== Table of contents ==
     8
     9The index page is a regular wiki page. This example uses the wiki page named [wiki:TracNav/TOC TracNav/TOC] to hold the table of contents for the TracNav documentation. The page with the table of contents must include an unordered list of links that should be displayed in the navigation bar.
     10
     11Here is an example of such table of contents. Note: currently, only the {{{[wiki:<Name> <Label]}}} syntax is supported for links that should be displayed in the navigation bar.
    412
    513{{{
     
    1321   * [wiki:KaRMI KaRMI]
    1422}}}
     23
     24
     25== Display the navigation bar ==
     26
     27To display the navigation bar on a page, you must call the TracNav macro on that page an pass the name of your table of contents as argument. With this approach, you can create multiple separate table of contents on your site. By following the links in the "See also" section, you can explore the usage of TracNav on the JavaParty home page.
     28
     29In this example, the following macro call is used to bring the table of contents stored in [wiki:TracNav/TOC TracNav/TOC] to this page. Place such macro invocation somewhere at the head of your wiki page.
     30
     31{{{
     32[[TracNav(TracNav/TOC)]]
     33}}}