Changeset 3044

Timestamp:

11/01/05 12:56:03 (8 years ago)

Author:

moschny

Message:

Installation instructions updated.

File:

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

trac/trunk/wiki-macros/TracNav.py

@@ -15 +15 @@
 == 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.
-
+To install TracNav, place the file `TracNav.py` in the `wiki-macros`
+subdirectory and the accompanying `tracnav.css` file in the
+`templates` subdirectory of your Trac project. Add this line
 {{{
-/* Styles for TracNav */
-.wiki-toc.trac-nav h4 { margin: 0; padding: 0; }
-.wiki-toc.trac-nav ul > li:first-child { margin-right: 4ex; }
-.wiki-toc.trac-nav .edit {
- position: absolute;
- top: 2px;
- right: 3px;
- margin-left: 3px;
- border: 0;
-}
-.wiki-toc.trac-nav .edit a { color:blue; border-color:blue; }
+@import url(<?cs var:chrome.href ?>/site/tracnav.css);
 }}}
-
-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.
+to the `templates/site_css.cs` file of your Trac project.
+
+The `tracnav.css` file defines 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 install 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
+To use TracNav, 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.