|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GluePluginDescription
%*~~ or
by removing all whitespaces and separateing lines with a
single space using %~~~.
There's a helper character sequence %~~ that prevents the TWiki engine to
interprete tags before the GluePlugin could reformat the text.
In addition there's a glue sequence #~~ to insert comments within a TWikiMarkup
expression.
While these glue sequences might feel strange at the beginning they help you
to format and recognize your markup and make it more readable. That way you
will be able to format a TWikiApplications that looked like this
%SEARCH{"..." type="query" header="<table width="100%" border="5px"><thead><tr><th>Name</th><th>Description</th><th>Date</th></tr></thead>" format="<tr><th>$formfield(Name)</th><th>$summary</th><th>$createdate</th></tr>" footer="</table>"}%
somewhat like this
#~~ #################################
#~~ # This is my new TWikiApplication
~~~
%~~ SEARCH{
#~~ #################################
#~~ # this is the search expression
~~~ "..."
~~~
~~~ type="query"
~~~
#~~ #################################
#~~ # this is the header of the result table
~~~
~~~ header="
~~~ <table
~~~ width="100%"
~~~ border="5px"
~~~ >
~~~ <thead>
~~~ <tr>
~~~ <th>Name</th>
~~~ <th>Description</th>
~~~ <th>Date</th>
~~~ </tr>
~~~ </thead>"
#~~ #################################
#~~ # every row will be formatted like this
~~~
~~~ format="
~~~ <tr>
~~~ <th>$formfield(Name)</th>
~~~ <th>$summary</th>
~~~ <th>$createdate</th>
~~~ </tr>"
#~~ #################################
#~~ # and finally we close this html table
~~~
~~~ footer="</table>"
~~~ }%
#~~ #################################
#~~ # sure we could have used
#~~ # | TWikiTables | as well |
#~~ # but these aren't robust against newlines
#~~ # in the $summary field
#~~ #################################
Syntax
~~~<space> and
*~~<space> sequences are recognized only at the beginning of a line, whereas
the %~~<space> escape sequence might appear everywhere. The basic
anatomy of writing a TWiki tag using the GluePlugin is exemplified by
%~~ TAG{
~~~ key="
*~~ hello
~~~ world
*~~ "
~~~ }%
which will be recombined to
%<nop>TAG{ key="hello world" }%
Examples
Plugin Installation Instructions
Plugin Info
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
