= ![[PageOutline]] =

One of the bundled macros, which displays a table of content for the Wiki page 
in which the macro is inserted.

== Usage ==
[[MacroList(PageOutline)]]

---- 

== Examples ==

=== Range of Headings Displayed ===

![[PageOutline]]'s first parameter only appears to accept integers, and doesn't appear to have a coded value for displaying the default of all headings. It displays an error message when passed a non-integer value.

|| ![[PageOutline(1)]] || Only level 1 heading: [[PageOutline(1)]] ||

|| ![[PageOutline(1-2)]] || Only first 2 levels of headings: [[PageOutline(1-2)]] ||

|| ![[PageOutline(1-100)]] || All headings -- actually first 100 levels of headings: [[PageOutline(1-100)]] ||

=== Outline Title ===

Apparently, in order to specify the title you must also give the range of headings; you can't just pass an empty first parameter (e.g. ![[PageOutline(,Title)]] ).

|| ![[PageOutline(1-100),Page Contents]] || A title over 'all' headings -- actually the first 100 levels of headings: [[PageOutline(1-100,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 mislead you into thinking.

|| ![[PageOutline(1-100),Page Contents,inline]] || Ditto, but '''inline''': [[PageOutline(1-100,Page Contents,inline)]] ||

=== Numbered / Unnumbered ===

Remember, only useful for inline contents.

|| ![[PageOutline(1-100),Page Contents,inline,unnumbered]] || Ditto, but '''inline''': [[PageOutline(1-100,Page Contents,inline,unnumbered)]] ||

See also: trachacks:TocMacro