GuidPlugin < TWiki

---+!! GUID Plugin
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/GuidPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/GuidPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky>
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
</sticky>
%SHORTDESCRIPTION%

---++ Syntax Rules

| *You Type* | *You Get* | *Comment* |
| %<nop>GUID_ID% | %GUID_ID% | default is string type |
| %<nop>GUID_ID{type="str"}% | %GUID_ID{type="str"}% | string representation |
| %<nop>GUID_ID{type="bin"}% | %GUID_ID{type="bin"}% | binary representation |
| %<nop>GUID_ID{type="hex"}% | %GUID_ID{type="hex"}% | hex |
| %<nop>GUID_ID{type="b64"}% | %GUID_ID{type="b64"}% | base64 |

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

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>GUIDPLUGIN_SHORTDESCRIPTION%==

   * One line description, shown in the %SYSTEMWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Generate GUID unique IDs

   * 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 package from the plugin home on twiki.org (see below)
   * Put them as follows
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   * Test if the plugin is correctly installed:
      * %<nop>GUID_ID%: %GUID_ID%
      * %<nop>GUID_ID{type="str"}%: %GUID_ID{type="str"}%
      * %<nop>GUID_ID{type="bin"}%: %GUID_ID{type="bin"}%
      * %<nop>GUID_ID{type="hex"}%: %GUID_ID{type="hex"}%
      * %<nop>GUID_ID{type="b64"}%: %GUID_ID{type="b64"}%

---++ Plugin Info

|  Plugin Author: | TWiki:Main.BruceDillahunty |
|  Copyright: | &copy; 2010-2016, TWiki:Main.PeterThoeny, [[http://twiki.org/][TWiki.org]] <br /> &copy; 2010-2016 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2016-02-02 (V1.1) |
|  Change History: | <!-- specify latest version first -->&nbsp; |
|  2016-03-02: | TWikibug:Item7703: Doc fix |
|  2010-10-31: | TWikibug:Item6530: Doc fixes |
|  25 Feb 2004: | Initial version |
|  CPAN Dependencies: | CPAN:Data::UUID |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins

This topic: TWiki > TestTopic3 > GuidPlugin
Topic revision: r1 - 02 Mar 2016 - TWikiContributor

Copyright © 1999-2025 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.GuidPlugin.