GluePlugin

Description

This plugin will help you to write readable markup (TopicMarkup, HMTL, ...) 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 engine to interprete tags before the GluePlugin could reformat the text. In addition there's a glue sequence #~~ to insert comments within a TopicMarkup 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 WikiApplications 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 WikiApplication
~~~
%~~ 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 
#~~ # | WikiTables | 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 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:
Glue
*~~ Plugin
You get (faked):
GluePlugin
You get if installed:
Glue *~~ Plugin

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:
%~~ SEARCH{"GluePlugin" ~~~ nosearch="on" nosummary="on" nototal="on" ~~~ separator=", " ~~~ scope="topic" ~~~ format="$topic" ~~~ }%

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

  • Set the plugins evaluation order to put the GluePlugin in first position, e.g.
    $Foswiki::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: Michael Daum
Copyright ©: 2005-2014, Michael Daum http://michaeldaumconsulting.com
License: GPL (GNU General Public License)
Release: 2.20
Version: 2.20
Change History:  
17 Apr 2009: converted to foswiki
07 Jan 2009: certified for foswiki/compat
23 Nov 2007: added way to add comments in the middle of a TopicMarkup 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
Dependency: $Foswiki::Plugins::VERSION 1.024
Plugin Home: Foswiki:Extensions/GluePlugin
Support: Foswiki:Support/GluePlugin
Topic revision: r10 - 23 Apr 2014, MichaelDaum
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License