Changeset 3044 for trac/trunk


Ignore:
Timestamp:
11/01/05 12:56:03 (8 years ago)
Author:
moschny
Message:

Installation instructions updated.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trac/trunk/wiki-macros/TracNav.py

    r3037 r3044  
    1515== Installation == 
    1616 
    17 To install TracNav, you must place the file {{{TracNav.py}}} somewhere 
    18 in your {{{wiki-macros/}}} directory of your Trac 
    19 installation. Additionally, you have to append the following lines to 
    20 the file {{{htdocs/css/wiki.css}}} that can also be found in your Trac 
    21 directoryhierarchy. 
    22  
     17To install TracNav, place the file `TracNav.py` in the `wiki-macros` 
     18subdirectory and the accompanying `tracnav.css` file in the 
     19`templates` subdirectory of your Trac project. Add this line 
    2320{{{ 
    24 /* Styles for TracNav */ 
    25 .wiki-toc.trac-nav h4 { margin: 0; padding: 0; } 
    26 .wiki-toc.trac-nav ul > li:first-child { margin-right: 4ex; } 
    27 .wiki-toc.trac-nav .edit { 
    28  position: absolute; 
    29  top: 2px; 
    30  right: 3px; 
    31  margin-left: 3px; 
    32  border: 0; 
    33 } 
    34 .wiki-toc.trac-nav .edit a { color:blue; border-color:blue; } 
     21@import url(<?cs var:chrome.href ?>/site/tracnav.css); 
    3522}}} 
    36  
    37 The lines above define the styles for displaying the navigation 
    38 bar. These styles build upon the styles for !TracGuideToc that come 
    39 with your Trac distribution. If you just install the macro but miss to 
    40 extend the style file, TracNav will work but look somewhat strange. 
     23to the `templates/site_css.cs` file of your Trac project. 
     24 
     25The `tracnav.css` file defines the styles for displaying the 
     26navigation bar. These styles build upon the styles for !TracGuideToc 
     27that come with your Trac distribution. If you just install the macro 
     28but miss to install the style file, TracNav will work but look 
     29somewhat strange. 
    4130 
    4231 
    4332== Usage == 
    4433 
    45 To use TracNav, you have to create an index page for your site and 
    46 call the TracNav macro on each page, where the navigation bar should 
    47 be displayed. The index page is a regular wiki page. The page with the 
     34To use TracNav, create an index page for your site and call the 
     35TracNav macro on each page, where the navigation bar should be 
     36displayed. The index page is a regular wiki page. The page with the 
    4837table of contents must include an unordered list of links that should 
    4938be displayed in the navigation bar. 
Note: See TracChangeset for help on using the changeset viewer.