Genealowiki.com > TWiki > TopicVarsPlugin

TWiki

TWiki.TopicVarsPluginr1.1 - 06 Nov 2006 - 20:16 - Main.guesttopic end

---++ TopicVarsPlugin TWiki Plugin 

This plugin will allow you to create variables in arbitrary topic pages, and not just WebPreferences. You can then refer to those variables from any topic within the same Web or Wiki. (Perhaps a future iteration will support [[TWiki.InterwikiPlugin][Interwiki]] references, but that's probably not likely, unless we use XML-RPC or something to cut down the overhead of getting those values from afar.)

---+++ Syntax Rules 

   * Set a variable:<br />
      <nop>* Set VARIABLE_NAME = "some value"<br />

   * Use a variable in the same Web:<br />
      %<nop>TopicName.VARIABLE_NAME%

   * Use a variable from a different Web:<br />
      %<nop>Webname.TopicName.VARIABLE_NAME%


(setting values is done just like in WebPreferences; with six preceeding spaces, an asterisk, and so on).

---+++ <nop>%TOPIC% Settings

   * One line description, is shown in the [[TWiki.TextFormattingRules][TextFormattingRules]] topic
      * Set SHORTDESCRIPTION = Set variables in arbitrary topics and refer to them from other topics within the same web

   * Debug %TOPIC% (see output in <code>data/debug.txt</code>)
      * Set DEBUG = 0

---+++ Plugin Installation Instructions 

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   * Check this topic here if the installation was successful
   * Test if the plugin is correctly installed:
      * Set THE_ANSWER = 42
      * You should see the answer here: [%THE_ANSWER%] (%<nop>THE_ANSWER%)
      * and here: [%TopicVarsPlugin.THE_ANSWER%] (%<nop>TopicVarsPlugin.THE_ANSWER%)
      * and here: [%TWiki.TopicVarsPlugin.THE_ANSWER%] (%<nop>TWiki.TopicVarsPlugin.THE_ANSWER%)


---+++ Plugin Info 

|  Plugin Author: | %TWIKIWEB%.TrippLilley |
|  Plugin Version: | 15 Nov 2001 |
|  Change History: | 15 Nov 2001: Initial version |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ [[TWiki.InterwikiPlugin][InterwikiPlugin]]

-- %TWIKIWEB%.TrippLilley - 15 Nov 2001 <br>

to top

End of topic
Skip to action links | Back to top

You are here: TWiki > TopicVarsPlugin

to top

			Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback


			Jump: