Changes between Version 45 and Version 46 of TocMacro


Ignore:
Timestamp:
Jan 21, 2014, 6:53:34 AM (10 years ago)
Author:
Ryan J Ollos
Comment:

Updated documentation (copied from source code). Refs #11513.

Legend:

Unmodified
Added
Removed
Modified

  • TocMacro

    v45 v46  
    1313}}}
    1414
    15 To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro. This is the macro call for the table of contents visible on the right side of this page:
     15To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro, e.g. as in
    1616
    1717{{{
    18 [[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup, TracLogging,
    19 TracPermissions, TracWiki, WikiFormatting, TracBrowser, TracRoadmap, TracChangeset,
    20 TracTickets, TracReports, TracQuery, TracTimeline, TracRss, TracNotification)]]
     18[[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup,
     19      TracLogging, TracPermissions, TracWiki, WikiFormatting, TracBrowser,
     20      TracRoadmap, TracChangeset, TracTickets, TracReports, TracQuery,
     21      TracTimeline, TracRss, TracNotification)]]
    2122}}}
    2223
    23 
    24 A wildcard '*' can be used to fetch a sorted list of all pages starting with the preceding pagename stub (Since [2801]):
     24A wildcard `*` can be used to fetch a sorted list of all pages starting with the preceding pagename stub:
    2525
    2626{{{
    … …  
    2828}}}
    2929
    30 For 'titleindex' argument, an empty pagelist will evaluate to all pages (Since [2801]):
     30The following ''control'' arguments change the default behaviour of the TOC macro:
     31||= Argument     =||= Description =||
     32|| `heading=<x>`  || Override the default heading of "Table of Contents" ||
     33|| `noheading`    || Suppress display of the heading. ||
     34|| `depth=<n>`    || Display headings of ''subsequent'' pages to a maximum depth of '''<n>'''. ||
     35|| `inline`       || Display TOC inline rather than as a side-bar. ||
     36|| `sectionindex` || Only display the page name and title of each page in the wiki section. ||
     37|| `titleindex`   || Only display the page name and title of each page, similar to TitleIndex. ||
     38|| `notitle`      || Supress display of page title. ||
     39|| `reverse`      || Display TOC sorted in reversed order. //(Since 11.0.0.4)// ||
     40
     41For `titleindex` argument, an empty pagelist will evaluate to all pages:
    3142
    3243{{{
    … …  
    3445}}}
    3546
    36 'sectionindex' allows to generate a title index for all pages in a given section of the wiki. A section is defined by wiki page name, using '/' as a section level delimiter (like directories in a file system). Giving '/' or '*' as the page name produces the same result as 'titleindex' (title of all pages). If a page name ends with a '/', only children of this page will be processed. Else the page given in the argument is also included, if it exists. For 'sectionindex' argument, an empty pagelist will evaluate to all page below the same parent as the current page:
     47The `sectionindex` argument allows a title index to be generated for all pages in a given section of the wiki. A section is defined by wiki page name, using `/` as a section level delimiter (like directories in a file system). Giving `/` or `*` as the page name produces the same result as `titleindex` (title of all pages). If a page name ends with a `/`, only children of this page will be processed. Otherwise, the page given in the argument is also included, if it exists. For `sectionindex` argument, an empty pagelist will evaluate to all page below the same parent as the current page:
    3748
    3849{{{
    3950[[TOC(sectionindex, notitle, heading=This section pages)]]
    4051}}}
    41 
    42 The following ''control'' arguments change the default behaviour of the TOC macro (Since [22]):
    43 
    44 || '''Argument''' || '''Meaning''' ||
    45 || `heading=<x>` || Override the default heading of "Table of Contents" or "Page Index" for titleindex. ||
    46 || `noheading` || Suppress display of the heading. ||
    47 || `depth=<n>` || Display headings of ''subsequent'' pages to a maximum depth of '''<n>'''. ||
    48 || `inline` || Display TOC inline rather than as a side-bar. ||
    49 || `sectionindex`|| Only display the page name and title of each page for all pages in a given section. (Since [3417]). ||
    50 || `titleindex`|| Only display the page name and title of each page, similar to TitleIndex. (Since [37]). ||
    51 || `notitle` || Supress display of page title (Since [2801]). ||
    5252
    5353== Bugs/Feature Requests ==
    … …  
    6363#!sh
    6464easy_install http://trac-hacks.org/svn/tocmacro/0.10   # 0.10
    65 easy_install http://trac-hacks.org/svn/tocmacro/0.11   # 0.11 and 0.12
     65easy_install http://trac-hacks.org/svn/tocmacro/0.11   # 0.11, 0.12, 1.0
    6666}}}
    6767