<--
PLEASE DO NOT EDIT THIS TOPIC
It is automatically generated from the subversion repository, and any changes
you make will simply be overwritten the next time a release is generated.
Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author.
-->
GluePlugin
Description
This plugin will help you to write readable markup (TWikiMarkup, HMTL, ...)
within TWiki by allowing tags and arguments to be formatted on multiple lines.
This is done by removing whitespaces surrounding tilde characters at the
beginning of a line and recombine consecutive lines again. Basically, there
are two ways of glueing and recombining lines by either removing all whitespaces
between two lines using %*~~ 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
| Line prefix | Action |
|---|
~~~<space> | combine lines by removing all, insert one whitespaces |
*~~<space> | recombine lines by removing any whitespaces between them |
%~~<space> | escape tag interpretation |
#~~<space> | comment line, all chars on the same line are removed |
The <space> is a literal whitespace blank. The ~~~<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
| You type: |
|---|
This is a line
~~~ glued to another line.
|
| You get (faked): |
|---|
This is a line glued to another line.
|
| You get if installed: |
|---|
This is a line glued to another line.
|
| You type: |
|---|
Apples
~~~
And
~~~
Oranges
|
| You get (faked): |
|---|
| Apples And Oranges |
| You get if installed: |
|---|
|
Apples And Oranges
|
| You type: |
|---|
%~~ SEARCH{"GluePlugin"
~~~ nosearch="on" nosummary="on" nototal="on"
~~~ separator=", "
~~~ scope="topic"
~~~ format="$topic"
~~~ }%
|
| You get (faked): |
|---|
|
GluePlugin
|
| You get if installed: |
|---|
|
GluePlugin
|
Plugin Installation Instructions
- Download the ZIP file
- Unzip it in your twiki installation directory. Content:
| File: | Description: |
|---|
data/TWiki/GluePlugin.txt | | lib/TWiki/Plugins/GluePlugin.pm | | pub/TWiki/GluePlugin/wikiringlogo40x40.png | |
Plugin Info
<-- provided for compatibility only
- Set SHORTDESCRIPTION = Enable TWikiML to span multiple lines
-->
-- TWiki:Main.MichaelDaum - 23 Nov 2007
| META FILEATTACHMENT | attr="h" autoattached="0" comment="" date="1190996093" name="wikiringlogo40x40.png" path="wikiringlogo40x40.png" size="2571" user="TWikiContributor" version="1" |
|---|
| 