Wiki Tutorial: Glue

Description

The Glue plugin helps you to write more readable Wiki markup by allowing tags and arguments to be formatted on multiple lines. This is done by removing whitespace and recombining consecutive lines that begin with tilde (~) characters.

Tere are two was of gluing (recombining) lines: either by removing all whitespace between two lines or by removing all whitespace and then separating the recombined lines with a single space.

In addition, there's a helper character sequence, %~~ that prevents the Wiki engine from interpreting tags (variables) before the GluePlugin has reformatted the text.

Syntax

Line prefix Action
%~~   avoid interpreting a variable before the pieces have been glued together
~~~   recombine lines with one whitespace between them
*~~   recombine lines by removing all whitespace between them

  • The ~~~   and *~~   sequences are recognized only at the beginning of a line.
  • The %~~   sequence can appear anywhere.

Examples

Example

%~~ TAG{
~~~ key="
*~~      hello
~~~      world
*~~ "
~~~ }%

Test Result

%TAG{ key="hello world" }%

Example

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

Result

This is a line glued to another line.

Example

Glue
*~~ Plugin

Result

GluePlugin

Example

Apples

~~~  

And

~~~

Oranges

Result

Apples And Oranges

Example

%~~ SEARCH{
~~~     "WikiTut"
~~~     scope="topic"
~~~     nosearch="on" nosummary="on" nototal="on"
~~~     format="   * $topic"
~~~ }%

Result

  • WikiTut
  • WikiTutAccess
  • WikiTutActionTracker
  • WikiTutActionTrackerData
  • WikiTutActionTrackerEntry
  • WikiTutActionTrackerQuery
  • WikiTutAnchors
  • WikiTutApp
  • WikiTutAppE1
  • WikiTutAppE1Create
  • WikiTutAppE1Form
  • WikiTutAppE1Index
  • WikiTutAppE1Search
  • WikiTutAppE1TemplateStrict
  • WikiTutAppExamples
  • WikiTutAppHowTo
  • WikiTutAppHowToSearch
  • WikiTutAppHowToTemplate
  • WikiTutAppInstancePage
  • WikiTutAppStationery
  • WikiTutAppUpdater
  • WikiTutApp_0807_0
  • WikiTutApp_1009_0
  • WikiTutBugzilla
  • WikiTutBullets
  • WikiTutCSS
  • WikiTutCalEvents
  • WikiTutCalc
  • WikiTutCalendar
  • WikiTutCalendar2Code
  • WikiTutCalendar2Demo
  • WikiTutCalendar2DemoEvents
  • WikiTutCalendarAddEventTemplate
  • WikiTutCalendarApp
  • WikiTutCalendarCode
  • WikiTutCalendarDemo
  • WikiTutCalendarDemoEvents
  • WikiTutCalendarEventsList
  • WikiTutChecklist
  • WikiTutChecklist2
  • WikiTutChecklist2ChecklistItemState
  • WikiTutChecklistChecklistItemState
  • WikiTutColorTable
  • WikiTutColorTableCols
  • WikiTutComment
  • WikiTutCommentPlugin1
  • WikiTutCommentPlugin2
  • WikiTutCommentPlugin3
  • WikiTutCommentPlugin3Code
  • WikiTutCommentPlugin4
  • WikiTutCommentPlugin5
  • WikiTutCommentPlugin6
  • WikiTutCommentResults3
  • WikiTutCommentTemplate
  • WikiTutCommentUserTemplateExamples
  • WikiTutDelete
  • WikiTutDeprExample
  • WikiTutDiscussionForum
  • WikiTutDocAppCreate
  • WikiTutDocForm
  • WikiTutETable
  • WikiTutETableJS
  • WikiTutETableSandbox
  • WikiTutEditTable
  • WikiTutEditTemplate
  • WikiTutExampleOutput_Feb_08_2007
  • WikiTutFAQ
  • WikiTutFilter
  • WikiTutFilterData
  • WikiTutFormExample1
  • WikiTutFormExample2
  • WikiTutForms
  • WikiTutGlue
  • WikiTutImageMap
  • WikiTutInclude
  • WikiTutIncludeVariables
  • WikiTutIncludedTopic1
  • WikiTutIncludedTopic2
  • WikiTutIncludedTopic3
  • WikiTutIncludedVar
  • WikiTutIncludedVar2
  • WikiTutKickoffFormTemplateStrict
  • WikiTutNewTopic
  • WikiTutNewViewTemplate
  • WikiTutNoFormView
  • WikiTutOverrideView
  • WikiTutPageCreate
  • WikiTutPageTemplateSample
  • WikiTutPageTitle
  • WikiTutParentTopic
  • WikiTutPlugins
  • WikiTutPower
  • WikiTutPowerCalendar
  • WikiTutRename
  • WikiTutRenderList
  • WikiTutReviewFormTemplateStrict
  • WikiTutRollup
  • WikiTutRollupTableData1
  • WikiTutRollupTableData2
  • WikiTutRollupTables
  • WikiTutSearch
  • WikiTutSlideShow
  • WikiTutSortLists
  • WikiTutSpreadsheet
  • WikiTutStatusUpdate
  • WikiTutStatusUpdateTmpl
  • WikiTutTOCTree
  • WikiTutTabRow
  • WikiTutTable
  • WikiTutTableCellBullets
  • WikiTutTableColors
  • WikiTutTableColumns
  • WikiTutTableTricks
  • WikiTutTemplateStop
  • WikiTutTemplateView
  • WikiTutTemplates
  • WikiTutTimeTable
  • WikiTutTips
  • WikiTutTipsThumbnails
  • WikiTutTopFormView
  • WikiTutTopicIndex
  • WikiTutTopicMove
  • WikiTutTopicSearch
  • WikiTutTopicTitle
  • WikiTutTopicTree
  • WikiTutTrainingDemo1
  • WikiTutTreeBrowser
  • WikiTutTricks
  • WikiTutTricksIncludeCell
  • WikiTutTricksIncludeRow1
  • WikiTutTricksIncludeRow2
  • WikiTutTricksRecentUpdate
  • WikiTutTricksWebLeftBar
  • WikiTutTricksWebTopBar
  • WikiTutTrouble
  • WikiTutTwisty
  • WikiTutUpdatedExample
  • WikiTutVarCachePlugin
  • WikiTutViewTemplate2
  • WikiTutViewTemplate3
  • WikiTutWebTopBar


-- VickiBrown - 24 Sep 2008

This topic: Help > WikiTut > WikiTutPower > WikiTutPlugins > WikiTutGlue
Topic revision: 09 Feb 2011, vlb
This site is powered by Foswiki Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
Foswiki version v2.1.6, Release Foswiki-2.1.6, Plugin API version 2.4
Ideas, requests, problems regarding CFCL Wiki? Send us email