Wikka Documentation : TOCActionInfo

HomePage :: Index :: RecentChanges :: Search :: Login/Register
[2353] Latest edit on 2014-12-25 03:19:49 by BrianKoontz [New]


Additions:

TOC (Table of Contents) Action Documentation

This is the documentation page for the toc action.
NOTE
This feature is available since:
WikkaWiki 1.3.6
Please note this action will not work with versions prior to 1.3.6! This is a post-formatter action that requires slightly different syntax.
Generate a Table of Contents (ToC) based upon headings
{{{toc}}}
This action generates a Table of Contents (
levelsstringoptional"h1,h2,h3,h4,h5"comma-delimited list of heading designators, "h1" through "h5", corresponding to indent level desired
titlestringoptional"Table of Contents"title of ToC display
linksbooleanoptional"true"whether or not ToC links are linked to headings
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".

Deletions:

Color/ Colour Action Documentation

This is the documentation page for the color/colour action(s).

NOTE
This feature is available since:
WikkaWiki 1.1.6.1

Renders a string as colored text.
{{color [text="This is my text"] [fg="red"] [bg="black"]}}
With
textstringmandatory-the text you want to display colored
bgstringoptional-
since 1.1.6.2
color name or hex-value for the background
fgstringoptional-
since 1.1.6.2
foreground color, alias for c, introduced to fit with bg
cstringoptional- color name or hex-value for the text
hexstringoptional-alias for c, kept for backwards-compatibility;
Color names
namecolor
aqua
black
blue
fuchsia
gray
green
lime
maroon
navy
olive
purple
red
silver
teal
white
yellow
{{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."}}
This is a test.
If you want to use hex values:
{{color hex="#DD0000" text="This is another test."}}
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"}}
This is colored text on colored background
{{color fg="yellow" bg="black" text="This is colored text on colored background"}}
This is colored text on colored background
Release Notes




[2352] The oldest known version of this page was created on 2014-12-25 03:05:57 by BrianKoontz [Cloned from ColorActionInfo]

History of recent changes for TOCActionInfo

Color/ Colour Action Documentation

This is the documentation page for the color/colour action(s).
See also
Development page


Documentation

NOTE
This feature is available since:
WikkaWiki 1.1.6.1


Short description
Renders a string as colored text.

Usage:
{{color [text="This is my text"] [fg="red"] [bg="black"]}}

Parameters
nametyperequired?defaultdescription
textstringmandatory-the text you want to display colored
bgstringoptional-
since 1.1.6.2
color name or hex-value for the background
fgstringoptional-
since 1.1.6.2
foreground color, alias for c, introduced to fit with bg
cstringoptional- color name or hex-value for the text
hexstringoptional-alias for c, kept for backwards-compatibility;

Color names
namecolor
aqua
black
blue
fuchsia
gray
green
lime
maroon
navy
olive
purple
red
silver
teal
white
yellow

Long description
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.

Examples:
{{color c="green" text="This is a test."}}
This is a test.

If you want to use hex values:

{{color hex="#DD0000" text="This is another test."}}
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"}}
This is colored text on colored background

{{color fg="yellow" bg="black" text="This is colored text on colored background"}}
This is colored text on colored background

Release Notes


Authors

CategoryEN
Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0145 seconds