Revision history for TOCActionInfo
Additions:
=====TOC (Table of Contents) Action Documentation=====
This is the documentation page for the ##toc## action.
{{since version="1.3.6" align="left"}} Please note this action **will not work** with versions prior to 1.3.6! This is a [[http://docs.wikkawiki.org/UsingActions#hn_Post-formatter_actions | post-formatter action]] that requires slightly different syntax.
Generate a Table of Contents (""ToC"") based upon headings
##""{{{toc}}}""##
|=|levels||string||optional||"h1,h2,h3,h4,h5"||comma-delimited list of heading designators, "h1" through "h5", corresponding to indent level desired||
|=|title||string||optional||"Table of Contents"||title of ""ToC"" display||
|=|links||boolean||optional||"true"||whether or not ""ToC"" links are linked to headings||
This action generates a Table of Contents (""ToC"") based upon headings. The ""ToC"" is displayed with heading strings indented depending upon the order of the "levels" attribute. Please note that this action **requires the use of the post-formatter action markup: ##""{{{toc}}}""##**. Each linked-to heading, when clicked, will return the user to the top of the page.
##""{{{toc}}}""##
Generate a list of headings, with the title of "Table of Contents", in nested order from largest heading (h1) to smallest heading (h5).
##"">>{{{toc title="Index" levels="h5"}}}>>::c::""##
Generate a right-justified text box containing all the h5 headings on the page, with a title of "Index".
- [[http://wikkawiki.org/BrianKoontz | Brian Koontz]]
This is the documentation page for the ##toc## action.
{{since version="1.3.6" align="left"}} Please note this action **will not work** with versions prior to 1.3.6! This is a [[http://docs.wikkawiki.org/UsingActions#hn_Post-formatter_actions | post-formatter action]] that requires slightly different syntax.
Generate a Table of Contents (""ToC"") based upon headings
##""{{{toc}}}""##
|=|levels||string||optional||"h1,h2,h3,h4,h5"||comma-delimited list of heading designators, "h1" through "h5", corresponding to indent level desired||
|=|title||string||optional||"Table of Contents"||title of ""ToC"" display||
|=|links||boolean||optional||"true"||whether or not ""ToC"" links are linked to headings||
This action generates a Table of Contents (""ToC"") based upon headings. The ""ToC"" is displayed with heading strings indented depending upon the order of the "levels" attribute. Please note that this action **requires the use of the post-formatter action markup: ##""{{{toc}}}""##**. Each linked-to heading, when clicked, will return the user to the top of the page.
##""{{{toc}}}""##
Generate a list of headings, with the title of "Table of Contents", in nested order from largest heading (h1) to smallest heading (h5).
##"">>{{{toc title="Index" levels="h5"}}}>>::c::""##
Generate a right-justified text box containing all the h5 headings on the page, with a title of "Index".
- [[http://wikkawiki.org/BrianKoontz | Brian Koontz]]
Deletions:
This is the documentation page for the ##color##/##colour## action(s).
>>**See also**
[[http://wikkawiki.org/ColorAction | Development page]]
>>
{{since version="1.1.6.1" align="left"}}
Renders a string as colored text.
##""{{color [text="This is my text"] [fg="red"] [bg="black"]}}""##
|=|text||string||mandatory||-||the text you want to display colored||
|=|bg||string||optional||-||{{since version="1.1.6.2" display="inline"}} color name or hex-value for the background||
|=|fg||string||optional||-||{{since version="1.1.6.2" display="inline"}} foreground color, alias for ##c##, introduced to fit with ##bg## ||
|=|c||string||optional||-||(html) color name or hex-value for the text||
|=|hex||string||optional||-||alias for ##c##, kept for backwards-compatibility;||
|?|Color names||
|=|{width:80px}name|=|{width:50px}color||
||aqua||{background-color:aqua}||
||black||{background-color:black}||
||blue||{background-color:blue}||
||fuchsia||{background-color:fuchsia}||
||gray||{background-color:gray}||
||green||{background-color:green}||
||lime||{background-color:lime}||
||maroon||{background-color:maroon}||
||navy||{background-color:navy}||
||olive||{background-color:olive}||
||purple||{background-color:purple}||
||red||{background-color:red}||
||silver||{background-color:silver}||
||teal||{background-color:teal}||
||white||{background-color:white}||
||yellow||{background-color:yellow}||
With ##""{{color}}""## action (or its alias ##""{{colour}}""##) you can specify text color using either one of HTML defined names or a hex value (with the former one taking priority). An optional background color can also be specified. Note that you must specify a text and either use "fg", "c" or "hex" for the color.
##""{{color c="green" text="This is a test."}}""##
{{color c="green" text="This is a test."}}
If you want to use hex values:
##""{{color hex="#DD0000" text="This is another test."}}""##
{{color hex="#DD0000" text="This is another test."}}
Alternatively, you can specify a foreground and background color using the ##fg## and ##bg## parameters (they accept both named and hex values):
##""{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}""##
{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
##""{{color fg="yellow" bg="black" text="This is colored text on colored background"}}""##
{{color fg="yellow" bg="black" text="This is colored text on colored background"}}
==Release Notes==
- Versions **1.1.6.1** and below had support for parameters ##text##, ##c## and ##hex## only, and no check were performed about these values.
- {{since version="1.1.6.2" display="inline"}} two new parameters ##bg## and ##fg## have been introduced, and the colors are checked for validity. RGB syntax, Hex syntax and a wide range of color names are supported.
- {{since version="1.1.6.4" display="inline"}} support for a number of invalid colornames, such as ##antiquewhite##, ##lightgreen##, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: ##aqua##, ##black##, ##blue##, ##fuchsia##, ##gray##, ##green##, ##lime##, ##maroon##, ##navy##, ##olive##, ##purple##, ##red##, ##silver##, ##teal##, ##white## and ##yellow##.
- [[http://www.mornography.de/ | Hendrik Mans]]
- [[http://wikkawiki.org/NilsLindenberg | Nils Lindenberg]] (modifications)
- [[http://wikkawiki.org/DotMG | Mahefa Randimbisoa]] (modification - RGB syntax)
