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.

You type:
Glue *~~ Plugin
You get (faked):
GluePlugin
You get if installed:
GluePlugin

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

• 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

Plugin Author:	TWiki:Main.MichaelDaum
Copyright ©:	2005-2007, Michael Daum http://michaeldaumconsulting.com
License:	GPL (GNU General Public License)
Plugin Version:	v2.00
Change History:
23 Nov 2007:	added way to add comments in the middle of a TWikiMarkup expression
31 Aug 2006:	added NO_PREFS_IN_TOPIC
28 Jul 2006:	fixed MANIFEST; some minor docu updates; added use strict;
28 Aug 2005:	changed glue syntax; added glue escape sequence to work arround tags been interpreted before lines are recombined
16 Aug 2005:	properly support internal tags; performance improvements; fixed use if uninitialized value
15 Aug 2005:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins/Benchmark:	GoodStyle nn%, FormattedSearch nn%, GluePlugin nn%
Plugin Home:	TWiki:Plugins/GluePlugin
Feedback:	TWiki:Plugins/GluePluginDev
Appraisal:	TWiki:Plugins/GluePluginAppraisal

-- TWiki:Main.MichaelDaum - 23 Nov 2007