"Fossies" - the Fresh Open Source Software Archive

Member "serendipity/bundled-libs/docs/TokenRuleKeys.wiki.txt" (20 Nov 2022, 3169 Bytes) of package /linux/www/serendipity-2.4.0.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 + Token Rule Keys
    2 
    3 || '''Rule Name'''       || '''Description'''                                 || '''Options''' ||
    4 || {{blockquote}}        || Block-quoted text.                                || {{type:[start|end] }} ||
    5 || {{bold}}              || Bold text.                                        || {{type:[start|end]}} ||
    6 || {{code}}              || A block of generic computer code.                 || {{text}} ||
    7 || {{deflist}}           || Definition list element.                          || {{type:[list|term|narr]_[start|end]}} ||
    8 || {{delimiter}}         || An existing delimiter.                            || - ||
    9 || {{emphasis}}          || Emphasized (usually italic) text.                 || {{type:[start|end]}} ||
   10 || {{freelink}}          || A local !WikiPage reference in free link format.  || {{page}}, {{text}}, {{anchor}} ||
   11 || {{heading}}           || A heading.                                        || {{type:[start|end], level, text}} ||
   12 || {{horiz}}             || A horizontal rule.                                || - ||
   13 || {{html}}              || A block of HTML text to be displayed as-is.       || {{text}}  ||
   14 || {{interwiki}}         || An !InterWiki reference.                          || {{site}}, {{page}} ||
   15 || {{italic}}            || Italic text.                                      || {{type:[start|end]}} ||
   16 || {{list}}              || Bullet or number list elements.                   || {{type:[bullet|number|item]_[start|end], level, count}} ||
   17 || {{newline}}           || A new line or line break.                         || - ||
   18 || {{phpcode}}           || A block of PHP code to be colorized.              || {{text}} ||
   19 || {{phplookup}}         || A function name to link to at php.net             || {{text}} ||
   20 || {{raw}}               || Raw or plain text to be displayed as-is.          || {{text}} ||
   21 || {{strong}}            || Strong (usually bold) text.                       || {{type:[start|end]}} ||
   22 || {{superscript}}       || Superscript text.                                 || {{type:[start|end]}} ||
   23 || {{table}}             || Table elements.                                   || {{type:[table|row|cell]_[start|end], colspan}} ||
   24 || {{tt}}                || Teletype (monospaced) text.                       || {{type:[start|end]}} ||
   25 || {{url}}               || A page URL.                                       || {{type:[inline|footnote|descr]}}, {{href}}, {{text}} ||
   26 || {{wikilink}}          || A local !WikiPage reference.                      || {{page}}, {{anchor}} ||
   27 || {{toc}}               || Table of contents.                                || {{type:[list_start|list_end|item_start|item_end|target], level, count}} ||
   28 
   29 ++ Tokens Entry Format
   30 
   31 Simple format (no options).
   32 
   33 <code>
   34 $_tokens[] = Array
   35     (
   36         [0] => 'rule_name'
   37         [1] => array
   38             (
   39             )
   40     )
   41 </code>
   42 
   43 Complex format (with options).
   44 
   45 <code>
   46 $_tokens[] = Array
   47     (
   48         [0] => 'rule_name'
   49         [1] => Array
   50             (
   51                 ['opt0'] => 'value 0'
   52                 ['opt1'] => 'value 1'
   53                 ...
   54                 ['optN'] => 'value N'
   55             )
   56     )
   57 </code>