source: trac/plugins/tracnav/README @ 3090

Last change on this file since 3090 was 3090, checked in by moschny, 9 years ago

Add a hint about the plugin cache.

File size: 2.9 KB
Line 
1----------------------------------------------------------------------
2TracNav Plugin for Trac
3----------------------------------------------------------------------
4
5
6Description
7-----------
8
9The [[TracNav]] macro implements a fully customizable navigation bar
10for the Trac wiki engine. The contents of the navigation bar is a wiki
11page itself and can be edited like any other wiki page through the web
12interface. The navigation bar supports hierarchical ordering of
13topics. The design of TracNav mimics the design of the TracGuideToc
14that was originally supplied with Trac. The drawback of TracGuideToc
15is that it is not customizable without editing its source code and
16that it does not support hierarchical ordering.
17
18
19Usage
20-----
21
22To use TracNav, create an index page for your site and call the
23TracNav macro on each page, where the navigation bar should be
24displayed. The index page is a regular wiki page. The page with the
25table of contents must include an unordered list of links that should
26be displayed in the navigation bar.
27
28To display the navigation bar on a page, you must call the TracNav
29macro on that page and pass the name of your table of contents as
30argument.
31
32It is possible to have more than one index page for your toc: Simply
33list them all separated by a bar like this:
34
35[[TracNav(MyTOC|AnotherTOC)]]
36
37The TOCs are appended to each other to form one navigation bar.
38
39
40Installation
41------------
42
43See http://projects.edgewall.com/trac/wiki/TracPlugins.
44
45Short version for the impatient: run "python ./setup.py bdist_egg" and
46copy the resulting .egg file from the "dist" directory to the
47"plugins" directory of your Trac project. Using the WebAdmin plugin,
48you can even upload and deploy the .egg file to your project using a
49browser.
50
51It is very likely that you have to override the location of the
52temporary directory to which .egg files are unpacked by setting the
53PYTHON_EGG_CACHE environment variable in your webserver's
54configuration, see
55http://projects.edgewall.com/trac/wiki/TracPlugins#SettingupthePluginCache
56
57
58Homepage
59--------
60
61See http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav.
62This page contains a life demo of the plugin, too.
63
64
65Authors and License
66-------------------
67
68Copyright 2005, 2006
69- Bernhard Haumacher (haui at haumacher.de)
70- Thomas Moschny (moschny at ipd.uni-karlsruhe.de)
71
72This program is free software; you can redistribute it and/or modify
73it under the terms of the GNU General Public License as published by
74the Free Software Foundation; either version 2 of the License, or
75(at your option) any later version.
76
77This program is distributed in the hope that it will be useful,
78but WITHOUT ANY WARRANTY; without even the implied warranty of
79MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
80GNU General Public License for more details.
81
82You should have received a copy of the GNU General Public License
83along with this program; if not, write to the Free Software
84Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Note: See TracBrowser for help on using the repository browser.