GluePlugin

Description

Powered by WikiRing Consultants

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

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
*~~ "
~~~ }%

%<nop>TAG{ key="hello world" }%

Examples

This is a line
~~~ glued to another line.

This is a line glued to another line.

This is a line 
~~~ glued to another line.

Glue
*~~ Plugin

Apples

~~~  

And

~~~

Oranges

%~~ SEARCH{"GluePlugin"
~~~        nosearch="on" nosummary="on" nototal="on"
~~~        separator=", "
~~~        scope="topic"
~~~        format="$topic"
~~~ }%

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

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Set the plugins evaluation order to put the GluePlugin in first position, e.g.

  $TWiki::cfg{PluginsOrder} = 'GluePlugin,IfDefinedPlugin,SpreadSheetPlugin';

• 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 - 23 Nov 2007