Changes between Version 47 and Version 48 of TocMacro
- Timestamp:
- Aug 18, 2015, 5:11:22 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TocMacro
v47 v48 13 13 }}} 14 14 15 To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro , e.g. as in15 To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro: 16 16 17 17 {{{ … … 36 36 || `sectionindex` || Only display the page name and title of each page in the wiki section. || 37 37 || `titleindex` || Only display the page name and title of each page, similar to TitleIndex. || 38 || `notitle` || Sup ress display of page title. ||39 || `reverse` || Display TOC sorted in reverse d order. //(Since 11.0.0.4)//||38 || `notitle` || Suppress display of page title. || 39 || `reverse` || Display TOC sorted in reverse order, since 0.11.0.0.4. || 40 40 41 41 For `titleindex` argument, an empty pagelist will evaluate to all pages: … … 49 49 {{{ 50 50 [[TOC(sectionindex, notitle, heading=This section pages)]] 51 }}} 52 53 '''Alternative:''' Trac 0.12 has the [wiki:WikiMacros#PageOutline-macro PageOutline] macro built-in, which can produce output identical to the simpler use cases for the TOC macro. For example, this is equivalent to the no-argument form of TOC: 54 {{{ 55 [[PageOutline(2-5, Table of Contents, floated)]] 51 56 }}} 52 57 … … 68 73 You can check out TocMacro from [http://trac-hacks.org/svn/tocmacro here] using Subversion, or [source:tocmacro browse the source] with Trac. 69 74 70 == Installation ==75 == Installation 71 76 72 77 The Trac 0.10 / 0.11 / 0.12 entries at Python Package Index (pypi) are not up-to-date with the latest versions and dependencies. To install the most recent versions, use direct installation from source: 73 78 74 {{{ 75 #!sh 76 easy_install http://trac-hacks.org/svn/tocmacro/0.10 # 0.10 77 easy_install http://trac-hacks.org/svn/tocmacro/0.11 # 0.11, 0.12, 1.0 79 {{{#!sh 80 $ easy_install http://trac-hacks.org/svn/tocmacro/0.10 # 0.10 81 $ easy_install http://trac-hacks.org/svn/tocmacro/0.11 # 0.11, 0.12, 1.0 78 82 }}} 79 83 80 Or download / check out the source from repository (see below) and install it in the usual manner.84 Or download or check out the source from repository (see above) and install it in the usual manner. 81 85 82 Do not forget to '''enable''' the plugin in `trac.ini`: 83 {{{ 84 #!ini 86 Enable the plugin in your `trac.ini` file: 87 {{{#!ini 85 88 [components] 86 89 tractoc.* = enabled … … 96 99 On the right you can see the TOC macro version of the default !TracGuideToc macro. 97 100 98 == Alternatives99 100 Trac 0.12 has the [wiki:WikiMacros#PageOutline-macro PageOutline] macro built-in, which can produce output identical to the simpler use cases for the TOC macro. For example, this is equivalent to the no-argument form of TOC:101 {{{102 [[PageOutline(2-5, Table of Contents, floated)]]103 }}}104 105 101 == Change Log 106 102