Difference: RecursiveRenderPlugin ( vs. 1)

Revision 12007-05-02 - Main.TWikiGuest

Line: 1 to 1
Added:
>
>

RecursiveRenderPlugin

This plugin adds the ability to tell the TWiki renderer to render a portion of a page as if it were a page all to itself.

Syntax Rules

There are two ways to use this plugin.

Syntax 1:

<render>Wiki Stuff</render>
This will render Wiki Stuff as if it were its own page, and render the rest of the page as if it were a single word. So a <render> block is valid in a table cell, or in any other context, even if you normally could not put other wiki markup in that location.

Syntax 2:

~macro
This is a macro definition.
   * This is a list inside the macro.
   * For demonstration purposes.
~~
| This is a macro usage: <br /> ~macro |
Produces:
This is a macro usage:
This is a macro definition.

  • This is a list inside the macro.
  • For demonstration purposes.

RecursiveRenderPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %RECURSIVERENDERPLUGIN_SHORTDESCRIPTION%

  • One line description, shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = This plugin adds <render> tags and ~macros.

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip RecursiveRenderPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/RecursiveRenderPlugin.txt Plugin topic
    data/TWiki/RecursiveRenderPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/RecursiveRenderPlugin.pm Plugin Perl module
  • (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the plugin is correctly installed:
    • Place the above code for syntax 2 in a Sandbox topic and see if it produces the correct results.

Plugin Info

Plugin Author: TWiki:Main.WalterMundt
Plugin Version: 01 May 2007 (V0.3)
Change History:
<-- specify latest version first -->
 
01 May 2007 0.3 Validated TWiki4.x operation
21 Jan 2003: 0.2: Bugfix release.
20 Jan 2003: 0.1: Inital release.
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.6.1 (untested on earlier versions)
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/RecursiveRenderPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RecursiveRenderPluginDev

-- TWiki:Main.WalterMundt - 20 Jan 2003

 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.RecursiveRenderPlugin