Changeset 2864

Timestamp:

03/01/05 10:36:01 (8 years ago)

Author:

hauma

Message:

• Updated inline documentation of TracNav.

File:

• trac/trunk/wiki-macros/TracNav.py (modified) (1 diff)

trac/trunk/wiki-macros/TracNav.py

@@ -9 +9 @@
 topics. The design of TracNav mimics the design of the TracGuideToc
 that was originally supplied with Trac. The drawback of TracGuideToc
-is that is is not customizable without editing its source code and
+is that it is not customizable without editing its source code and
 that it does not support hierarchical ordering.
+
+
+== Installation ==
+
+To install TracNav, you must place the file {{{TracNav.py}}} somewhere
+in your {{{wiki-macros/}}} directory of your Trac
+installation. Additionally, you have to append the following lines to
+the file {{{htdocs/css/wiki.css}}} that can also be found in your Trac
+directoryhierarchy.
+
+{{{
+/* Styles for TracNav */
+.wiki-toc.trac-nav li { margin: 0; padding: 0; }
+.wiki-toc.trac-nav li li { margin: 0; padding: 0 1em; }
+.wiki-toc.trac-nav .edit { border:0; position:absolute; top:0; right:5px; }
+.wiki-toc.trac-nav .edit a { color:blue; border-color:blue; }
+}}}
+
+The lines above define the styles for displaying the navigation
+bar. These styles build upon the styles for !TracGuideToc that come
+with your Trac distribution. If you just install the macro but miss to
+extend the style file, TracNav will work but look somewhat strange.
+
+
+== Usage ==
+
+To 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. The index page is a regular wiki page. The page with the
+table of contents must include an unordered list of links that should
+be displayed in the navigation bar.
+
+To 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.
+
+
+== Additional information and a life example ==
+
+Please visit: http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav
 """