GluePlugin
Description
This plugin will help you to write
readable TWikiML 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 was of glueing and recombining lines by
either removing all whitespaces between two lines or
by removing all whitespaces and separateing lines with a single space.
In addition, there's a helper character sequence that prevents the
TWiki engine to interprete tags before the
GluePlugin could reformat
the text.
Syntax
| Line prefix | Action |
|---|
~~~<space> | combine lines by removing all, insert one whitespaces |
%~~<space> | escape tag interpretation |
*~~<space> | recombine lines by removing any whitespaces between them |
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 Settings
- Set SHORTDESCRIPTION = Enable TWikiML to span multiple lines
Plugin Installation Instructions
- Download the ZIP file
- Unzip it in your twiki installation directory. Content:
- (Dakar) Visit
configure in your TWiki installation, and enable the plugin in the {Plugins} section.
- If the plugin is installed correctly then the following two fruits will appear joined on one line: Apples and Oranges
Plugin Info
--
TWiki:Main.MichaelDaum - 28 Jul 2006
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.