Changes between Version 5 and Version 6 of PageOutline

Timestamp:

Apr 16, 2015, 7:47:52 PM (9 years ago)

Author:

figaro

Comment:

Cosmetic changes, page update

PageOutline

@@ -1 @@
-= ![[PageOutline]] =
+= ![[PageOutline]]
 
-One of the bundled macros, which displays a table of content for the Wiki page 
-in which the macro is inserted.
+One of the bundled macros, which displays a table of contents for the Wiki page in which the macro is inserted.
 
-== Usage ==
+== Usage
+
 [[MacroList(PageOutline)]]
 
----- 
+For [trachacks:HackIndex trac-hack / plugin] descriptions, the standard format is as follows:
 
-== Examples ==
+{{{
+[[PageOutline(2-5,Contents,pullout)]]
+}}}
 
-=== Range of Headings Displayed ===
+== Examples
 
-![[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.
+=== 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)]] ||
+|| ![[PageOutline(1-100)]] || First 100 levels of headings: [[PageOutline(1-100)]] ||
 
-|| ![[PageOutline(1-2)]] || Only first 2 levels of headings: [[PageOutline(1-2)]] ||
+=== Outline Title
 
-|| ![[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)]] ).
+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-100,Page Contents)]] || A title over 'all' headings -- actually the first 100 levels of headings: [[PageOutline(1-100,Page Contents)]] ||
 
-=== Inline / Pullout ===
+=== 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.
+'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-100,Page Contents,inline)]] || Ditto, but '''inline''': [[PageOutline(1-100,Page Contents,inline)]] ||
 
-=== Numbered / Unnumbered ===
+=== Numbered / Unnumbered
 
-Remember, only useful for inline contents.
+Only useful for inline content.
 
 || ![[PageOutline(1-100,Page Contents,inline,unnumbered)]] || Ditto, but '''without numbering''': [[PageOutline(1-100,Page Contents,inline,unnumbered)]] ||