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