Changes between Version 2 and Version 3 of PageOutline

Timestamp:

Aug 24, 2012, 3:42:24 PM (12 years ago)

Author:

complex_trac@…

Comment:

Added examples of usage of the parameters. I needed them, experimented, and then shared.

PageOutline

@@ -9 +9 @@
 ---- 
 
+== 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