Welcome » Extensions » Extension list

== Extension list ==

== Actions ==
Extensions that most of the time act as ((../Actions)) are listed here; see also ((#other)) extensions.

= ((Image)) Inserts an image. Parameters: **file, title, width, height, size, no link, align, clear**.
  = ((Include)) Embeds a document. Parameters: **page, tree, format, isolate**.
  = RunDoc A version of ((action:Include)) that only formats the document without putting it into the main document's tree; since included doc is ran as soon as a call to ((action:RunDoc)) was met it can be used to change the way main document is processed (e.g. alter some parser settings or ((action:Term define)) ((/Terms))).
  = Meta Each document has a set of user-data fields called //meta//. This action adds an arbitrary record there: %%{{Meta author=Proger_XP, date=16 Sep 2011}}%%.
  = ((NewStyle)) Creates a style/markup alias so you can invoke an extension using a different name or use a custom name for one of ((/Basic ~!! marker)), ((/Paragraph/Styles Paragraph)) or ((/Container+s)) styles.
  = ((FormatAs)) Sets default markup used for one of ((.. extension callers)) - ((formatter:)) or ((action:)).
  = Title Sets or outputs ({{Title}}) document title. Normally you set it using ((/Headings 1st level heading)) but this action-((#formatter+s)) lets you set it in any markup: %%~%%(Title; PHP)'This is the title'~%%%%; only works if there is no 1st level heading or parser is configured to use **shifted heading mode**.
  = TOC Creates Table Of Contents based on document ((/Headings)). Optional parameter **up to** sets max heading level to include into the TOC. **Has only block form.**
  = AnchorizeAssocLists Once called each item in document's ((/Lists#associative)) lists automatically obtain an anchor that can be linked to normally. The page you're reading uses this action. //See also ((action:SortAssocLists)).//
  = ((SortAssocLists)) Once called all document's ((/Lists#associative)) lists become sorted by their term name (%%<dt>%%). The page you're reading uses this action - check its source code on the left and compare the order of items you see on the right. Parameters: **collation, by, on render, type, desc**.
  = DownloadCount Accompanies ((formatter:Attach)) - outputs download count of a specific attachment; see ((formatter:Attach)) for details.
  = LoadMod Dynamically loads markup modules: %%{{LoadMod term.php, domhint.php}}%%; ".php" extension can be omitted.
  = LoadMarkup Dynamically loads a markup from a given directory: %%{{LoadMarkup PHP}}%%.
  = Priority Changes the order in which following **chained** ((.. extensions)) are executed; expects a number (1.0 = max, 0.1 = min priority), **lowest, low, normal** or **high** as a first argument. Example: %%{{Priority low; TOC}}%%. //See also ((action:Dynamic)).//
  = Dynamic Makes all following **chained** ((.. extensions)) run on render rather then on parse phase. For example, %%{{Dynamic; Include updates; HTML}}%% will cause ((action:Include)) to embed "updates" page and highlight it as HTML on each page render, not when the main document is parser.
  = Setting Changes parser settings. Note that not all of them can be changed when document is already being processed. Is often used along with **isolate=1** argument of ((action:Include)). For example: %%{{Setting fetchRemoteTitles=no}}%%.
  = Term Adds a term that has all following occurrences replaced similar to the way ((/Terms (?terms Term description?))) work except that actual term's name isn't output until it's mentioned: {{Term ABC=A Big Computer}} "ABC".
  = TopDoc Replaces all following **chained** ((.. extensions))' context so that they run not in their caller's document space but several levels above, as specified. Expects a number as a first parameter, if omitted it's set to 1. Example: %%{{TopDoc; Term New term=Description}}%%; useful applications are for ((action:Setting)), ((action:Term)), ((action:TOC)) and others.
  = ((Class~==Class)), Func, Prop, FieldAlias == These actions were created for documenting PHP code/API. They all output a link to the page of a class, its function or its property (both can be static or instance).
  = ((Description)) == Creates an associated list with formatted key/value pairs; ((/ wiki markup)) can be used. The list can be customized using CSS.
  = FormatDescription == //A helper action for ((action:Description)).//
  = ((LinkProxy)) == Changes all (or only external) links so they will go through a specified URL. Useful when anonymizing external links or just for some gateway/statistic script. //See also ((formatter:LinkStat)).//
  = ((LinkStat)) == Collects statistics about links used in rendered documents. //See also ((formatter:LinkProxy)).//
  = Charset Converts document from a specified charset into **((WP:UTF-8))** (any document processed by **UverseWiki** must be **UTF-8**-encoded). Due to internal limitations this action must occur at a very first byte of the source. Example: %%{{Charset cp1251}}%%.

== Formatters ==
Extensions that are mostly ((../Formatters)) are listed here; see also ((#other)) extensions.

= Pre This is the default formatter for ((/Basic ~%% token)) - it turns off any formatting and outputs its contents as a plain text. Useful for outputting code: %%[B]BB-codes[/B] - <HTML> for beginners%%.
  = Color Outputs colored text. If color starts with **#** it must be either full (#FF0000) or short (#F00) RGB value; if with **$** then a Pascal-style color with reversed octets is expected ($0000FF); otherwise it must be a ((http://www.w3schools.com/css/css_colors.asp valid)) color name.
    # Examples: %%(color red)Reddish%%, %%(color #07F) short RGB%%, %%(color $FF7700)Pascal%%, **chaining**: %%(color green; pre) **preformatted**%%.
    * usually ((/Paragraphs/Styles styles)) are better than using a fixed color - they are not affected by theme changes and allow more flexible design other than a simple color change.
  = Mirror Mirrors an input markup creating a table showing original source on the left and formatted output on the right. Only block; supports chaining. //See also ((formatter:WikiSample)).//
  = ((Attach)) Creates a downloadable attachment like %%(attach attachment.wiki) this one%%; optionally tracks download count. Parameters: **hide, no stats, mime, compress**.
  = DomHint Shows hints when you move your mouse over a document node. You can see it in action by checking "Hint nodes on mouse hover" flag ((#footer below)) the edit area. Accepts one parameter **nested** that prevents it from creating hints in nested documents. **Supports block and inline bforms and chaining.** Example: %%(DomHint) //this// is ~%%(php)highlighted~%%%%.
  = LiteComment A ((WP:Markdown))-like markup for quick typing: *bold*, `code`, automatic link/e-mail convertion, typographics and so on. Needs the ((http://proger.i-forge.net/LiteComment/czD LiteComment class)) to work.
  = RawHTML Outputs raw HTML - but be aware that it exposes your site to XSS and other HTML-based attacks. Example: %%~%%(RawHTML) <iframe src="http://www.youtube.com/embed/..."></iframe>~%%%%.
  = ((WikiSample)) Creates an area where visitors can edit markup and see the result instantly in a window nearby; can work both **block and inline**, also supporting **chained** formatters (**Wacko** by default). //See also ((formatter:Mirror)).//

=== Highlighters ===
**Highlighters** are technically ((#formatters)) that take plain-text input and beautify or reformat it without modification. Source codes are usually highlighted using them.

= WackoWiki highlighters == Original ((http://wackowiki.org WackoWiki)) highlighters are supported. Default distribution contains 28 highlighters that can be used in any **UverseWiki** document as normal (but only **block**) formatters((*)). Among others they include: //css, email, html, icq, ini, java, pascal, sql, xml//.
  = PHP == ((WP:PHP)) code highlighter: %%(php) printf('A %s string.', 'PHP');%%
  = Pascal (and its alias "Delphi") == ((WP:Object Pascal==)) code highlighter: %%(pascal) WriteLn('Hello!');%%
  = XML (and its alias "HTML") == ((WP:Extensible Markup Language==XML)) code highlighter: %%(xml) <node attr="value" />%%
  = CSS == ((WP:Cascading Style Sheets==CSS)) code highlighter: %%(css) .button:hover { color: #FF0000; }%%
  = Conf == A generic highlighter for ((WP:INI file==INI))-style configuration files supporting sections (%%(conf)[Section]%%), comments (%%(conf);comment%% and %%(conf)#comment%%) and key/value pairs (%%(conf)key=value%%).
  = Log == A generic highlighter for log files colorizing curly, round and square brackets and single- and double-quote strings, as well as outputiing numbers in bold: %%(log) 127.0.0.1 {5 times} - [Sun Jul 8] action "register" (repeated) 'http://localhost' = logged%%
  = Sh == A generic *nix shell script highlighter: %%(sh) echo -n "because nobody sees..." >&1/dev/null%%
  = Shell == A simple terminal-window highlighter - colorizes prompt line: %%(shell) % ipfw%%; by default lines starting with "%", "#", "$" and ">" are highlighted but you can override this: %%(shell ucla.edu#) ucla.edu# exit%%

((*
%%(email)
Check this out: http://google.com
%%

Using a ((#wackowiki WackoWiki highlighter)) in inline form results in the following error message: %%(email) text%%.
))

== Other ==
Here extensions that can behave both as ((../Formatters)) ([[#formatters list]]) and as ((../Actions)) ([[#actions list]]) are listed.

= RGBox Adds a popup color sample to all RGB colors appearing in your texts, for example, #FF0000.
  = Strip Copyright == It was a sample code demonstrating the use of **UverseWiki** hooks; removes all lines starting and ending with **dual asterisks (~**)** from the post's source.
  = Mask E-mails == This was another sample ((.. extension)); operates on **Wacko** or **other** documents being formatted and replaces e-mail strings (like "e.mail@example.com") with a JavaScript (for **Wacko**) or obfuscated text (for **other**) like "e.mail at example.com".

This is Wackobin where you can store formatted documents and link to them using a short URL.

You can refer to earlier saved docs with user: interwiki in links or user- prefix elsewhere. Examples (replace «123» with text after «?» symbol in saved doc’s URL): ((user:123)), {{Include user-123}}.

Advanced

Hint nodes on mouse hover.

Upload document:

Extension list

1. Actions
2. Formatters
1. 2.1. Highlighters
3. Other

Actions

Extensions that most of the time act as Actions are listed here; see also other extensions.

AnchorizeAssocLists: Once called each item in document’s associative lists automatically obtain an anchor that can be linked to normally. The page you’re reading uses this action. See also SortAssocLists.
Charset: Converts document from a specified charset into UTF-8 (any document processed by UverseWiki must be UTF-8-encoded). Due to internal limitations this action must occur at a very first byte of the source. Example: {{Charset cp1251}}.
Class, Func, Prop, FieldAlias: These actions were created for documenting PHP code/API. They all output a link to the page of a class, its function or its property (both can be static or instance).
Description: Creates an associated list with formatted key/value pairs; wiki markup can be used. The list can be customized using CSS.
DownloadCount: Accompanies Attach – outputs download count of a specific attachment; see Attach for details.
Dynamic: Makes all following chained extensions run on render rather then on parse phase. For example, {{Dynamic; Include updates; HTML}} will cause Include to embed «updates» page and highlight it as HTML on each page render, not when the main document is parser.
FormatAs: Sets default markup used for one of extension callers – formatter or action.
FormatDescription: A helper action for Description.
Image: Inserts an image. Parameters: file, title, width, height, size, no link, align, clear.
Include: Embeds a document. Parameters: page, tree, format, isolate.
LinkProxy: Changes all (or only external) links so they will go through a specified URL. Useful when anonymizing external links or just for some gateway/statistic script. See also LinkStat.
LinkStat: Collects statistics about links used in rendered documents. See also LinkProxy.
LoadMarkup: Dynamically loads a markup from a given directory: {{LoadMarkup PHP}}.
LoadMod: Dynamically loads markup modules: {{LoadMod term.php, domhint.php}}; «.php» extension can be omitted.
Meta: Each document has a set of user-data fields called meta. This action adds an arbitrary record there: {{Meta author=Proger_XP, date=16 Sep 2011}}.
NewStyle: Creates a style/markup alias so you can invoke an extension using a different name or use a custom name for one of !! marker, Paragraph or /Container styles.
Priority: Changes the order in which following chained extensions are executed; expects a number (1.0 = max, 0.1 = min priority), lowest, low, normal or high as a first argument. Example: {{Priority low; TOC}}. See also Dynamic.
RunDoc: A version of Include that only formats the document without putting it into the main document’s tree; since included doc is ran as soon as a call to RunDoc was met it can be used to change the way main document is processed (e.g. alter some parser settings or define Terms).
Setting: Changes parser settings. Note that not all of them can be changed when document is already being processed. Is often used along with isolate=1 argument of Include. For example: {{Setting fetchRemoteTitles=no}}.
SortAssocLists: Once called all document’s associative lists become sorted by their term name (<dt>). The page you’re reading uses this action – check its source code on the left and compare the order of items you see on the right. Parameters: collation, by, on render, type, desc.
Term: Adds a term that has all following occurrences replaced similar to the way terms work except that actual term’s name isn’t output until it’s mentioned: «ABC».
Title: Sets or outputs (Extension list) document title. Normally you set it using 1^st level heading but this action-formatter lets you set it in any markup: %%(Title; PHP)'This is the title'%%; only works if there is no 1^st level heading or parser is configured to use shifted heading mode.
TOC: Creates Table Of Contents based on document Headings. Optional parameter up to sets max heading level to include into the TOC. Has only block form.
TopDoc: Replaces all following chained extensions’ context so that they run not in their caller’s document space but several levels above, as specified. Expects a number as a first parameter, if omitted it’s set to 1. Example: {{TopDoc; Term New term=Description}}; useful applications are for Setting, Term, TOC and others.

Formatters

Extensions that are mostly Formatters are listed here; see also other extensions.

Attach

Creates a downloadable attachment like attachment.wiki this one; optionally tracks download count. Parameters: hide, no stats, mime, compress.

Color

Outputs colored text. If color starts with # it must be either full (#FF0000) or short (#F00) RGB value; if with $ then a Pascal-style color with reversed octets is expected ($0000FF); otherwise it must be a valid color name.

Examples: Reddish, short RGB, Pascal, chaining: **preformatted**.
usually styles are better than using a fixed color – they are not affected by theme changes and allow more flexible design other than a simple color change.

DomHint

Shows hints when you move your mouse over a document node. You can see it in action by checking «Hint nodes on mouse hover» flag below the edit area. Accepts one parameter nested that prevents it from creating hints in nested documents. Supports block and inline bforms and chaining. Example: this is PHPhighlighted.

LiteComment

A Markdown-like markup for quick typing: *bold*, `code`, automatic link/e-mail convertion, typographics and so on. Needs the LiteComment class to work.

Mirror

Mirrors an input markup creating a table showing original source on the left and formatted output on the right. Only block; supports chaining. See also WikiSample.

Pre

This is the default formatter for %% token – it turns off any formatting and outputs its contents as a plain text. Useful for outputting code: [B]BB-codes[/B] - <HTML> for beginners.

RawHTML

Outputs raw HTML – but be aware that it exposes your site to XSS and other HTML-based attacks. Example: %%(RawHTML) <iframe src="http://www.youtube.com/embed/..."></iframe>%%.

WikiSample

Creates an area where visitors can edit markup and see the result instantly in a window nearby; can work both block and inline, also supporting chained formatters (Wacko by default). See also Mirror.

Highlighters

Highlighters are technically formatters that take plain-text input and beautify or reformat it without modification. Source codes are usually highlighted using them.

Conf: A generic highlighter for INI-style configuration files supporting sections (conf[Section]), comments (conf;comment and conf#comment) and key/value pairs (confkey=value).
CSS: CSS code highlighter: css.button:hover { color: #FF0000; }
Log: A generic highlighter for log files colorizing curly, round and square brackets and single- and double-quote strings, as well as outputiing numbers in bold: log127.0.0.1 {5 times} - [Sun Jul 8] action "register" (repeated) 'http://localhost' = logged
Pascal (and its alias «Delphi»): Object Pascal code highlighter: pascalWriteLn('Hello!');
PHP: PHP code highlighter: PHPprintf('A %s string.', 'PHP');
Sh: A generic *nix shell script highlighter: shecho -n "because nobody sees..." >&1/dev/null
Shell: A simple terminal-window highlighter – colorizes prompt line: shell% ipfw; by default lines starting with «%», «#», «$» and «>» are highlighted but you can override this: shellucla.edu# exit
WackoWiki highlighters: Original WackoWiki highlighters are supported. Default distribution contains 28 highlighters that can be used in any UverseWiki document as normal (but only block) formatters*. Among others they include: css, email, html, icq, ini, java, pascal, sql, xml.
XML (and its alias «HTML»): XML code highlighter: xml<node attr="value" />

Check this out: http://google.com

Using a WackoWiki highlighter in inline form results in the following error message: text.

Other

Here extensions that can behave both as Formatters (list) and as Actions (list) are listed.

Mask E-mails: This was another sample extension; operates on Wacko or other documents being formatted and replaces e-mail strings (like «e.mail@example.com») with a JavaScript (for Wacko) or obfuscated text (for other) like «e.mail at example.com».
RGBox: Adds a popup color sample to all RGB colors appearing in your texts, for example, #FF0000.
Strip Copyright: It was a sample code demonstrating the use of UverseWiki hooks; removes all lines starting and ending with dual asterisks (**) from the post’s source.

Input document