Edgewall Software
Home
Trac
Trac Hacks
Genshi
Babel
Bitten
Home
Download
Documentation
Mailing Lists
License
FAQ
Search:
Login
Preferences
Help/Guide
About Trac
Wiki
Timeline
Roadmap
Browse Source
View Tickets
New Ticket
Search
Context Navigation
+0
Start Page
Index
History
Editing PageOutline
Adjust edit area height:
8
12
16
20
24
28
32
36
40
Edit side-by-side
= ![[PageOutline]] One of the bundled macros, which displays a table of contents for the Wiki page in which the macro is inserted. == Usage [[MacroList(PageOutline)]] For [trachacks:HackIndex trac-hack / plugin] descriptions, the standard format is as follows: {{{ [[PageOutline(2-5,Contents,pullout)]] }}} == Examples === Range of Headings Displayed ![[PageOutline]]'s first parameter only accepts integers, and doesn't have a coded value for displaying the default of all headings. It displays an error message when a non-integer value is passed. || ![[PageOutline(1)]] || Only level 1 heading: [[PageOutline(1)]] || || ![[PageOutline(1-2)]] || Only first 2 levels of headings: [[PageOutline(1-2)]] || === Outline Title To specify the title, you must also give the range of headings. You can't just pass an empty first parameter, such as ![[PageOutline(,Title)]]. || ![[PageOutline(1-6,Page Contents)]] || A title over 'all' headings -- actually the first 100 levels of headings: [[PageOutline(1-6,Page Contents)]] || === Inline / Pullout 'Inline' means 'part of the content' and not a floating box; it doesn't mean the text is a list without linebreaks, as one's HTML background might suggest. || ![[PageOutline(1-6,Page Contents,inline)]] || Ditto, but '''inline''': [[PageOutline(1-6,Page Contents,inline)]] || === Numbered / Unnumbered Only useful for inline content. || ![[PageOutline(1-6,Page Contents,inline,unnumbered)]] || Ditto, but '''without numbering''': [[PageOutline(1-6,Page Contents,inline,unnumbered)]] || See also: trachacks:TocMacro
Note:
See
WikiFormatting
and
TracWiki
for help on editing wiki content.
Change information
Your email or username:
E-mail address and name can be saved in the
Preferences
Comment about this change (optional):
Note:
See
TracWiki
for help on using the wiki.