Skyloom.Wiki's Sandbox web

Skyloom.Wiki's Sandbox web http://skyloom.com/bin/view/Sandbox The Sandbox web of TWiki. TWiki is a Web-Based Collaboration Platform for the Corporate World. en-us Copyright 2008 by contributing authors. Skyloom® is a registered trademark by Lynnwood Brown. Lynnwood Brown [twikimaster@skyloom.com] Lynnwood Brown [twikimaster@skyloom.com] Skyloom.Wiki TWiki.Sandbox Skyloom-Wiki Home.Sandbox http://skyloom.com/bin/view/Sandbox http://skyloom.com/pub/TWiki/TWikiLogos/wikiHome.gif DennisRomeroSandbox http://skyloom.com/bin/view/Sandbox/DennisRomeroSandbox?t=2008-07-11T17:47Z %HEADLINES{"http://www.google.com/calendar/embed?src=lynnwood.brown%40gmail.com&ctz=America/Denver&pvttk=aea2130ce5a0a829cee247f777419766"}% (last changed by LynnwoodBrown) 2008-07-11T17:47Z LynnwoodBrown 2 updated major http://skyloom.com/bin/rdiff/Sandbox/DennisRomeroSandbox http://skyloom.com/bin/rdiff/Sandbox/DennisRomeroSandbox WebStatistics http://skyloom.com/bin/view/Sandbox/WebStatistics?t=2006-01-31T10:30Z <<<<<<< .mine <code><b>===</b></code> ><cite>>>>>>> .r7687</cite><br /> <nop><h2><a name="Statistics_for_Sandbox_Web"></a> Statistics for <nop>Sandbox Web </h2> <p /> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><th bgcolor="#e6e6e6" class="twikiFirstCol"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=0;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">Month:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=1;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">Topic <br /> views:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=2;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">Topic <br /> saves:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=3;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">File <br /> uploads:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=4;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">Most popular <br /> topic views:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=5;table=1;up=0#sorted_table" title="Sort by this column"><font color="#000000">Top contributors for <br /> topic save and uploads:</font></a> </th></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol">  </td><td bgcolor="#ffffff">  </td><td bgcolor="#ffffff">  </td><td bgcolor="#ffffff">  </td><td bgcolor="#ffffff">  </td><td bgcolor="#ffffff">  </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> Jan 2006 </td><td bgcolor="#eaeaea" align="right"> 729 </td><td bgcolor="#eaeaea" align="right"> 2 </td><td bgcolor="#eaeaea" align="right"> 0 </td><td bgcolor="#eaeaea"> 114 <a href="http://skyloom.com/bin/view/Sandbox/WebTopicCreator" class="twikiLink">WebTopicCreator</a><br /> 48 <a href="http://skyloom.com/bin/view/Sandbox/WebHome" class="twikiLink">WebHome</a><br /> 35 <a href="http://skyloom.com/bin/view/Sandbox/TestIrcSearchInclude" class="twikiLink">TestIrcSearchInclude</a><br /> 29 <a href="http://skyloom.com/bin/view/Sandbox/WebStatistics" class="twikiLink">WebStatistics</a><br /> 27 <a href="http://skyloom.com/bin/view/Sandbox/WebChanges" class="twikiLink">WebChanges</a><br /> 25 <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink">WebPreferences</a><br /> 20 <a href="http://skyloom.com/bin/view/Sandbox/WebTopicList" class="twikiLink">WebTopicList</a><br /> 18 <a href="http://skyloom.com/bin/view/Sandbox/WebSearch" class="twikiLink">WebSearch</a><br /> 17 <a href="http://skyloom.com/bin/view/Sandbox/CodeScratchPad" class="twikiLink">CodeScratchPad</a><br /> 15 <a href="http://skyloom.com/bin/view/Sandbox/WebNotify" class="twikiLink">WebNotify</a><br /> 14 <a href="http://skyloom.com/bin/view/Sandbox/WikiFacilitation" class="twikiLink">WikiFacilitation</a> </td><td bgcolor="#eaeaea">   1 <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a><br />  1 <a href="http://skyloom.com/bin/view/Main/VivekIyyer" class="twikiLink">VivekIyyer</a> </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> Dec 2005 </td><td bgcolor="#ffffff" align="right"> 747 </td><td bgcolor="#ffffff" align="right"> 2 </td><td bgcolor="#ffffff" align="right"> 0 </td><td bgcolor="#ffffff">  47 <a href="http://skyloom.com/bin/view/Sandbox/WebTopicCreator" class="twikiLink">WebTopicCreator</a><br /> 39 <a href="http://skyloom.com/bin/view/Sandbox/WebHome" class="twikiLink">WebHome</a><br /> 35 <a href="http://skyloom.com/bin/view/Sandbox/CodeScratchPad" class="twikiLink">CodeScratchPad</a><br /> 31 <a href="http://skyloom.com/bin/view/Sandbox/WebStatistics" class="twikiLink">WebStatistics</a><br /> 29 <a href="http://skyloom.com/bin/view/Sandbox/WebChanges" class="twikiLink">WebChanges</a><br /> 24 <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink">WebPreferences</a><br /> 23 <a href="http://skyloom.com/bin/view/Sandbox/WebNotify" class="twikiLink">WebNotify</a><br /> 22 <a href="http://skyloom.com/bin/view/Sandbox/WebSearch" class="twikiLink">WebSearch</a><br /> 21 <a href="http://skyloom.com/bin/view/Sandbox/WebTopicList" class="twikiLink">WebTopicList</a><br /> 17 <a href="http://skyloom.com/bin/view/Sandbox/TestIrcSearchInclude" class="twikiLink">TestIrcSearchInclude</a><br /> 16 <a href="http://skyloom.com/bin/view/Sandbox/WebLeftBar" class="twikiLink">WebLeftBar</a> </td><td bgcolor="#ffffff">   1 <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a><br />  1 <a href="http://skyloom.com/bin/view/Main/DennisRomero" class="twikiLink">DennisRomero</a> </td></tr> </table> <<<<<<< .mine <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> Jul 2005 </td><td bgcolor="#eaeaea" align="right"> 299 </td><td bgcolor="#eaeaea" align="right"> 1 </td><td bgcolor="#eaeaea" align="right"> 0 </td><td bgcolor="#eaeaea">  43 <a href="http://skyloom.com/bin/view/Sandbox/WebHome" class="twikiLink">WebHome</a><br /> 40 <a href="http://skyloom.com/bin/view/Sandbox/WebSearch" class="twikiLink">WebSearch</a><br /> 11 <a href="http://skyloom.com/bin/view/Sandbox/WebChanges" class="twikiLink">WebChanges</a><br />  9 <a href="http://skyloom.com/bin/view/Sandbox/CodeScratchPad" class="twikiLink">CodeScratchPad</a><br />  8 <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink">WebPreferences</a><br />  7 <a href="http://skyloom.com/bin/view/Sandbox/WebNotify" class="twikiLink">WebNotify</a><br />  7 <a href="http://skyloom.com/bin/view/Sandbox/WebTopicList" class="twikiLink">WebTopicList</a><br />  7 <a href="http://skyloom.com/bin/view/Sandbox/TestFreeFindSearch" class="twikiLink">TestFreeFindSearch</a><br />  6 <a href="http://skyloom.com/bin/view/Sandbox/WebRss" class="twikiLink">WebRss</a><br />  6 <a href="http://skyloom.com/bin/view/Sandbox/WebSearchAdvanced" class="twikiLink">WebSearchAdvanced</a><br />  6 <a href="http://skyloom.com/bin/view/Sandbox/WebStatistics" class="twikiLink">WebStatistics</a> </td><td bgcolor="#eaeaea">   1 <span class="twikiNewLink">LynnwoodBrown<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/LynnwoodBrown?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> </td></tr> </table> <code><b>===</b></code> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> Aug 2005 </td><td bgcolor="#eaeaea" align="right"> 97 </td><td bgcolor="#eaeaea" align="right"> 16 </td><td bgcolor="#eaeaea" align="right"> 0 </td><td bgcolor="#eaeaea">  36 <span class="twikiNewLink">TestTopic4<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestTopic4?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br /> 22 <span class="twikiNewLink">ConformanceReport<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/ConformanceReport?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br /> 12 <span class="twikiNewLink">TestTopic3<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestTopic3?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br />  5 <a href="http://skyloom.com/bin/view/Sandbox/WebChanges" class="twikiLink">WebChanges</a><br />  3 <a href="http://skyloom.com/bin/view/Sandbox/WebHome" class="twikiLink">WebHome</a><br />  3 <a href="http://skyloom.com/bin/view/Sandbox/WebStatistics" class="twikiLink">WebStatistics</a><br />  3 <a href="http://skyloom.com/bin/view/Sandbox/WebLeftBar" class="twikiLink">WebLeftBar</a><br />  3 <span class="twikiNewLink">TestTopic1<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestTopic1?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br />  1 <span class="twikiNewLink">LevelOneAgain<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/LevelOneAgain?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br />  1 <span class="twikiNewLink">LevelOne<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/LevelOne?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span><br />  1 <span class="twikiNewLink">Shagadelic<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/Shagadelic?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> </td><td bgcolor="#eaeaea">  16 <span class="twikiNewLink">crawford<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/Crawford?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> </td></tr> </table> ><cite>>>>>>> .r7687</cite><br /> <p /> <strong><em>Notes:</em></strong><ul><li> Do not edit this topic, it is updated automatically. (You can also <span class="twikiNewLink">force<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/SCRIPTURLstatisticsSandbox?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> an update)</li><li> %TWIKIWEB%.TWikiDocumentation tells you how to enable the automatic updates of the statistics.</li><li> Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table.</li></ul> (last changed by TWikiAdminGroup) 2006-01-31T10:30Z TWikiAdminGroup 63 updated major http://skyloom.com/bin/rdiff/Sandbox/WebStatistics http://skyloom.com/bin/rdiff/Sandbox/WebStatistics WebHome http://skyloom.com/bin/view/Sandbox/WebHome?t=2006-01-27T16:16Z <nop><h1><a name="MAKETEXT_Welcome_to_the_1_web_ar"></a><a name="_MAKETEXT_Welcome_to_the_1_web_a"></a> %MAKETEXT{"Welcome to the [_1] web" args="Sandbox"}% </h1> <p /> %MAKETEXT{"The [_1] web is the sandbox you can use for testing. Everybody is welcome to add or delete some stuff. It is recommended to walk through the [_2] to get a jumpstart on the [_3] tool. A good rule of thumb is to add at the end of the page and sign and date it with your [_4]." args="<b><nop>Sandbox</b>,%TWIKIWEB%.TWikiTutorial,<nop>%WIKITOOLNAME%,%TWIKIWEB%.WikiName"}% <p /> <nop><h2><a name="MAKETEXT_Test_Topics"></a><a name="_MAKETEXT_Test_Topics_"></a> %MAKETEXT{"Test Topics"}% </h2> <p /> <blockquote> <form action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/Sandbox/"> %MAKETEXT{"Create a new document by name:"}% %MAKETEXT{"(Use a topic name in <a href="http://skyloom.com/bin/view/TWiki/WikiNotation" class="twikiLink">WikiNotation</a>)"}% <br /> <input type="text" name="topic" size="32" /> <input type="submit" class="twikiSubmit" value='%MAKETEXT{"Create by Name"}%' /> <input type="hidden" name="onlywikiname" value="on" /> </form> <p /> <form name="createNewTestTopic" action="%SCRIPTURL{"edit"}%/%BASEWEB%/TestTopicXXXXXXXXXX"> %MAKETEXT{"Create a new auto-numbered test topic:"}% <input type="submit" class="twikiSubmit" value='%MAKETEXT{"Create <nop>TestTopic###"}%' /> </form> <p /> <nop><h3><a name="MAKETEXT_Recently_changed_topics"></a><a name="_MAKETEXT_Recently_changed_topic"></a> %MAKETEXT{"Recently changed topics"}% </h3> <dl> %SEARCH{ ".*" regex="on" nosearch="on" nototal="on" order="modified" reverse="off" limit="7" format="<dt><span class="twikiNewLink">$topic<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/Topic?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span></dt><dd>$summary<br /><span class='twikiSmall twikiGrayText'><i>$date - $wikiusername</i></span></dd>"}% </dl> <em>%MAKETEXT{"A more extensive changes list is available via the ~[~[[_1]~]~[Recent Changes~]~] link in the navigation menu." args="WebChanges"}%</em> </blockquote> (last changed by LynnwoodBrown) 2006-01-27T16:16Z LynnwoodBrown 2 updated major http://skyloom.com/bin/rdiff/Sandbox/WebHome http://skyloom.com/bin/rdiff/Sandbox/WebHome WebTopicCreator http://skyloom.com/bin/view/Sandbox/WebTopicCreator?t=2005-12-01T05:21Z %INCLUDE{%TWIKIWEB%.WebTopicCreator}% (last changed by TWikiGuest) 2005-12-01T05:21Z guest 1 updated major http://skyloom.com/bin/rdiff/Sandbox/WebTopicCreator http://skyloom.com/bin/rdiff/Sandbox/WebTopicCreator BuildContrib http://skyloom.com/bin/view/Sandbox/BuildContrib?t=2005-11-19T22:29Z <strong><em>This topic is my local copy of <a href="http://twiki.org/cgi-bin/view/Plugins.BuildContrib" title="'Plugins.BuildContrib' on TWiki.org">TWiki:Plugins.BuildContrib</a> to do some refactoring. -- <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a> - 19 Nov 2005</em></strong> <hr /> <nop><h1><a name="TWiki_Developer_Environment"></a><a name="_TWiki_Developer_Environment"></a> TWiki Developer Environment </h1> <p /> Automates build process, including installer generation, for Pugins, Add-ons and Contrib modules. <p /> %TOC% <p /> <nop><h1><a name="Summary_of_Contents"></a> Summary of Contents </h1> <p /> <strong>Note</strong> Simplified access to build contrib is provided as part of the <a href="http://twiki.org/cgi-bin/view/Plugins.TWikiShellContrib" title="'Plugins.TWikiShellContrib' on TWiki.org">TWiki:Plugins.TWikiShellContrib</a>. See <a href="http://twiki.org/cgi-bin/view/Plugins.UsingBuildContribAndTWikiShell" title="'Plugins.UsingBuildContribAndTWikiShell' on TWiki.org">TWiki:Plugins.UsingBuildContribAndTWikiShell</a> <p /> <nop><h2><a name="Build_Install_Modules"></a> Build & Install Modules </h2> <p /> The Build.pm module can be used by developers to create a really simple build process for your plugin, addon or contrib module. The advantage of using this module is that it dictates a standard build procedure for plugins, so you won't get file names wrong or get the list of files in the plugin topic wrong either. <p /> The module also automatically generates an installer script that manages dependencies in the user installation. <p /> <a name="DevelopmentModel"></a> <nop><h3><a name="Development_Model"></a> Development Model </h3> <p /> The build module assumes:<ul><li> that you are <strong>not</strong> developing your plugin in a live TWiki installation (which is usually a really bad idea), but are instead doing the sensible thing and developing in a separate directory tree, usually - but not always - a CVS checkout area.</li><li> that your module follows the standards for plugins and contribs i.e. that it<ol><li> has a topic in the <code>data/TWiki</code> directory</li><li> has a perl module in the <code>lib/TWiki/Plugins</code> or <code>lib/TWiki/Contrib</code> directory</li><li> has a sub-directory alongside the perl module that contains the extra <code>.pm</code> files specific to the module</li></ol></li></ul> <p /> The idea is that your module is built using a perl script <code>build.pl</code> that is kept in the module-specific subdirectory (3). This build script is like a Makefile. It has several <em>targets</em> that can be used to perform different stages of the development cycle. By default these targets are: <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code>build</code> </td><td bgcolor="#eaeaea"> check that everything is perl </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code>test</code> </td><td bgcolor="#ffffff"> run unit tests </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code>installer</code> </td><td bgcolor="#eaeaea"> Build an install/uninstall script for use by end-users </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code>install</code> </td><td bgcolor="#ffffff"> install on local installation defined by $TWIKI_HOME </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code>uninstall</code> </td><td bgcolor="#eaeaea"> uninstall from local installation defined by $TWIKI_HOME </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code>pod</code> </td><td bgcolor="#ffffff"> build POD documentation </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code>release</code> </td><td bgcolor="#eaeaea"> build, pod and package a release zip </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code>upload</code> </td><td bgcolor="#ffffff"> build, pod, package and upload to twiki.org </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code>manifest</code> </td><td bgcolor="#eaeaea"> print a best-guess <em>draft</em> MANIFEST file </td></tr> </table> The default target is <code>test</code>. <p /> The module is designed so that most common behaviour is catered for. It is also easy to <em>override</em> any of the default targets in your <code>build.pl</code> and add extra behaviours. <p /> The result of the 'release' target is a ZIP file, that will contain the following:<ol><li> All the files listed in the MANIFEST</li><li> A generated documentation topic</li><li> An install/uninstall script, that is run after the module is unzipped</li></ol> This zip file can be generated and subsequently uploaded to twiki.org, or you can simply use the <code>upload</code> target directly. <p /> The easiest way to start using the module is to copy the <code>build.pl</code> file from <code>lib/TWiki/Contrib/BuildContrib/build.pl</code> into your own plugin or contrib, in the corresponding place i.e. copy it to <code>lib/TWiki/Plugins/MyPlugin/build.pl</code> or <code>lib/TWiki/Contrib/MyContrib/build.pl</code>. Then edit the file, and change as appropriate (it should be fairly obvious what you have to do). Then type<ul><li> <code>perl build.pl manifest</code></li></ul> This should inspect the directory structure and write a best-guess MANIFEST file. <p /> <strong><em>Notes</em></strong><ul><li> This is a <em>build</em> module for use by developers, not an <em>install</em> module for end users. When a release is built, an installer/uninstaller script is automatically generated that is packaged with the release. This simple script is the only part of the build system visible to end users</li><li> This topic and all the embedded POD documentation are generated using this build module.</li><li> The build environment does <em>not</em> assume the use of CVS, though it is highly recommended.</li><li> The <code>test</code> target assumes you are using Test::Unit. <code>Build.pm</code> has only been tested on Linux, but should work with cygwin OK.</li></ul> <p /> <nop><h3><a name="Install_support"></a> Install support </h3> <p /> The installer script shipped with the package is very simple. By default all it does is to check the dependencies you list, and if necessary download and install any missing TWiki modules. Other dependencies are simply checked. In Dakar and later releases, TWiki topics shipped with the module are automatically merged into any existing local copies, ensuring histories are preserved. <p /> If you want your installer to do anything else - for example, optionally install submodules shipped with the module - then you will need to write a POSTINSTALL script. A good example of a POSTINSTALL can be found in the CVS tree for <a href="http://twiki.org/cgi-bin/view/Plugins/WysiwygPlugin" title="'Plugins/WysiwygPlugin' on TWiki.org">TWiki:Plugins/WysiwygPlugin</a>. <p /> <nop><h2><a name="Test_Fixtures"></a> Test Fixtures </h2> <p /> The are a number of test fixtures in the repository that can be used for testing plugins with <code>Test::Unit</code>. The fixtures replace the <code>TWiki::Func</code>, <code>TWiki::Store</code> and TWiki modules, allowing a stand-alone unit test suite to be built for the plugin. The easiest way to use the fixtures is to copy the tests from an existing plugin that uses them - for example, <span class="twikiNewLink">CommentPlugin<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/CommentPlugin?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">ActionTrackerPlugin<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/ActionTrackerPlugin?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">WebDAVPlugin<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/WebDAVPlugin?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> or <span class="twikiNewLink">FormQueryPlugin<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/FormQueryPlugin?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> - and modify the tests appropriately for your plugin. <p /> The fixtures do not replace <em>all</em> of the TWiki core functionality, just those pieces used by the plugins. If you find a piece is missing, and you need it, please feel free to extend the fixtures on condition that you check your improvements back in. <p /> <nop><h2><a name="Support_scripts"></a> Support scripts </h2> <p /> <code>conformance_analyser.pl</code> is a perl script that analyses the conformance of plugins to the API and packaging standards. It is driven from the zips downloadable from twiki.org. <p /> <nop><h1><a name="Detailed_Documentation"></a> Detailed Documentation </h1> <nop><h2><a name="Package_TWiki_Contrib_Build"></a> Package TWiki::Contrib::Build </h2> <p /> Base class of build objects for TWiki packages. Creates a build environment that addresses most of the common requirements for building plugins and contrib modules. <p /> Use by writing a subclass in a script that you then run. Targets are defined as functions, so adding new targets or dependencies between targets is done by subclassing the base class. When used to generate a build script, this class will interpret the following command-line options: <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> -n </td><td bgcolor="#eaeaea"> Do nothing </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> -v </td><td bgcolor="#ffffff"> Be verbose </td></tr> </table> <p /> The list of files to be installed is determined from the MANIFEST. Only these files will get into the release zip. <p /> The environment variable TWIKI_LIBS (a colon-separated path list) may be set to point at any required dependencies. TWIKI_LIBS is used to extend @INC for the duration of the build. If all dependencies are satisfied by directories on @INC it isn't required. <p /> The following help information is cursory; for full details, look at an example or read the code. <p /> <nop><h3><a name="Targets"></a> Targets </h3> <p /> The following targets will always exist: <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> build </td><td bgcolor="#eaeaea"> check that everything is perl </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> test </td><td bgcolor="#ffffff"> run unit tests </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> install </td><td bgcolor="#eaeaea"> install on local installation defined by $TWIKI_HOME </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> uninstall </td><td bgcolor="#ffffff"> uninstall from local installation defined by $TWIKI_HOME </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> pod </td><td bgcolor="#eaeaea"> build POD documentation </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> release </td><td bgcolor="#ffffff"> build, pod and package a release zip </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> upload </td><td bgcolor="#eaeaea"> build, pod, package and upload to twiki.org </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> manifest </td><td bgcolor="#ffffff"> print to STDOUT a defaultmanifest file </td></tr> </table> <p /> Note: if you override any of these targets it is generally wise to call the SUPER version of the target! <p /> <nop><h3><a name="Standard_directory_structure"></a> Standard directory structure </h3> <p /> The standard module directory structure mirrors the TWiki installation directory structure, so each file in the development directory structure is in the place it will be in in the actual installation. From the root, these are the key files: <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> lib/TWiki/Plugins/ </td><td bgcolor="#eaeaea"> this is where your <code><i>name</i>.pm</code> file goes for plugins </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> lib/TWiki/Plugins/<i>name</i>/ </td><td bgcolor="#ffffff"> directory containing sub-modules used by your plugin, and your build.pl script. </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> lib/TWiki/Contrib/ </td><td bgcolor="#eaeaea"> this is where your <code><i>name</i>.pm</code> file goes for contribs </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> lib/TWiki/Contrib/<i>name</i>/ </td><td bgcolor="#ffffff"> directory containing sub-modules used by your contrib, and your build.pl script. </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> lib/TWiki/Plugins <em>or</em> Contrib/<i>name</i>/MANIFEST </td><td bgcolor="#eaeaea"> required - list of files and descriptions to include in release zip. Each file is given by the full path to the file relative to the build TWiki installation directory. Wildcards may NOT be used. </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> .../<i>name</i>/DEPENDENCIES </td><td bgcolor="#ffffff"> optional list of dependencies on other modules and descriptions. See below. </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> .../<i>name</i>/PREINSTALL, POSTINSTALL, PREUNINSTALL, POSTUNINSTALL </td><td bgcolor="#eaeaea"> these optional files <em>may</em> contain Perl fragments that must execute at the given stage of the process. The script fragments will be inserted into the generated installer script. Read contrib/TEMPLATE_installer.pl to see how they fit in. </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> data/ </td><td bgcolor="#ffffff"> as you expect to see in the installation </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> pub/ </td><td bgcolor="#eaeaea"> as you expect to see in the installation. You must list required directories, even if they are initially empty. </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> templates/ </td><td bgcolor="#ffffff"> as you expect to see in installation </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> templates/<skin name>/ </td><td bgcolor="#eaeaea"> this is where templates for your skin go </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> contrib/ </td><td bgcolor="#ffffff"> this is where non-TWiki, non-web-accessible files associated with a Contrib or plugin go </td></tr> </table> <p /> <nop><h3><a name="Dependencies"></a> Dependencies </h3> <p /> The DEPENDENCIES file contains a list of lines, each of which is a comma-separated tuple <pre> name, version, type, description </pre> <p /> where:<ul><li> name is the name of the module,</li><li> version is the version constraint (e.g. ">1.5"),</li><li> type is its type (CPAN, perl, C etc) and</li><li> description is a short description of the module and where to get it. Perl modules also referenced in the dependencies list in the stub topic should be listed using their perl package name (e.g. TWiki::Contrib::MyContrib) and use the type 'perl'. A dependency may optionally be preceded by a condition that limits the cases where the dependency applies. The condition is given on a line that contains</li></ul> <p /> <code>ONLYIF ( <em>condition</em> )</code>, where <em>condition</em> is a Perl conditional. This is most useful for enabling dependencies only for certain versions of TWiki. For example, <pre> TWiki::Contrib::Attrs,>=1.000,perl,Required. Download from TWiki:Plugins/AttrsContrib and install. ONLYIF ($TWiki::Plugins::VERSION < 1.025) TWiki::Plugins::CairoContrib, >=1.000, perl, Optional, only required if the plugin is to be run with versions of TWiki before Cairo. Available from the TWiki:Plugins/CairoContrib repository. </pre> Thus <nop>CairoContrib is only a dependency if the installation is being done on a TWiki version before Cairo. The ONLYIF only applies to the next dependency in the file. <p /> <nop><h3><a name="Token_expansion"></a> Token expansion </h3> <p /> The build supports limited token expansion in <code>.txt</code> files. See the documentation on the <code>filter</code> method for more detail. <p /> <nop><h3><a name="Methods"></a> Methods </h3> <p /> <nop><h4><a name="new_project"></a><a name="new_project_"></a> new($project) </h4> <p /> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> $project </td><td bgcolor="#eaeaea"> Name of plugin, addon, contrib or skin </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> $rootModule </td><td bgcolor="#ffffff"> Optional, if defined gives the name of the root .pm module that carries the VERSION and dependencies. Defaults to $project </td></tr> </table> <p /> Construct a new build object. Define the basic directory paths to places in the build/release. Read the manifest topic and build file and dependency lists. Parse command line to get target and options. <p /> <nop><h4><a name="cd_dir"></a><a name="cd_dir_"></a> cd($dir) </h4> <p /> Change to the given directory <p /> <nop><h4><a name="makepath_to"></a><a name="makepath_to_"></a> makepath($to) </h4> <p /> Make a directory and all directories leading to it. <p /> <nop><h4><a name="cp_from_to"></a><a name="cp_from_to_"></a> cp($from, $to) </h4> <p /> Copy a single file from - to. Will automatically make intervening directories in the target. Also works for target directories. <p /> <nop><h4><a name="prot_perms_file"></a><a name="prot_perms_file_"></a> prot($perms, $file) </h4> <p /> Set permissions on a file. Permissions should be expressed using POSIX chmod notation. <p /> <nop><h4><a name="sys_action_cmd"></a><a name="sys_action_cmd_"></a> sys_action($cmd) </h4> <p /> Perform a "system" command. <p /> <nop><h4><a name="target_build"></a> target_build </h4> <p /> Basic build target. By default does nothing, but subclasses may want to extend on that. <p /> <nop><h4><a name="target_test"></a> target_test </h4> <p /> Basic Test::Unit test target, runs <project>Suite. <p /> <nop><h4><a name="filter"></a> filter </h4> <p /> Expands tokens. <p /> The following tokens are supported:<ul><li> %$MANIFEST% - TWiki table of files in MANIFEST</li><li> %$DEPENDENCIES% - list of dependencies from DEPENDENCIES</li><li> %$VERSION% version from $VERSION in main .pm</li><li> %$DATE% - local date * %$POD% - expands to the POD documentation for the package, excluding test modules. * %$PREINSTALL% - inserts script from PREINSTALL (alongside MANIFEST etc) * %$POSTINSTALL% - inserts script from POSTINSTALL (alongside MANIFEST etc)</li><li> %$PREUNINSTALL% - inserts script from PREUNINSTALL (alongside MANIFEST etc)</li><li> %$POSTUNINSTALL% - inserts script from POSTINSTALL (alongside MANIFEST etc) Three spaces is automatically translated to tab.</li></ul> <p /> The filter is used in the generation of documentation topics and the installer <p /> <nop><h4><a name="target_release"></a> target_release </h4> <p /> Release target, builds release zip by creating a full release directory structure in /tmp and then zipping it in one go. Only files explicitly listed in the MANIFEST are released. Automatically runs <code>filter</code> on all <code>.txt</code> files in the MANIFEST. <p /> <nop><h4><a name="copy_fileset"></a> copy_fileset </h4> <p /> Copy all files in a file set from on directory root to another. <p /> <nop><h4><a name="target_install"></a> target_install </h4> <p /> Install target, installs to local twiki pointed at by TWIKI_HOME. Uses the installer script written by target_installer <p /> <nop><h4><a name="target_uninstall"></a> target_uninstall </h4> <p /> Uninstall target, uninstall from local twiki pointed at by TWIKI_HOME. Uses the installer script written by target_installer <p /> <nop><h4><a name="target_test_zip"></a> target_test_zip </h4> <p /> Make the tests zip file for inclusion in the release package. <p /> <nop><h4><a name="target_upload"></a> target_upload </h4> <p /> Upload to twiki.org. Prompts for username and password. Uploads the zip and the text topic to the appropriate places. Creates the topic on twiki.org if necessary. <p /> <nop><h4><a name="target_pod"></a> target_pod </h4> <p /> Build POD documentation. This target defines <code>%$POD%</code> - it does not generate any output files. The target will be invoked automatically if <code>%$POD%</code> is used in a .txt file. POD documentation is intended for use by developers only. <p /> POD test in <code>.pm</code> files should use TWiki syntax or HTML. Packages should be introduced with a level 0 header, and each method in the package by a second level header. Make sure you document any global variables used by the module. <p /> <nop><h4><a name="target_installer"></a> target_installer </h4> <p /> Write an install/uninstall script that checks dependencies, and optionally downloads and installs required zips from twiki.org. <p /> The install script is templated from <code>contrib/TEMPLATE_installer</code> and is always named <code>module_installer.pl</code> (where module is your module). It is added to the release zip and is always shipped in the root directory. It will automatically be added to the manifest if it doesn't appear in MANIFEST. <p /> The install script works using the dependency type and version fields. It will try to download from twiki.org to satisfy any missing dependencies. Downloaded modules are automatically installed. <p /> Note that the dependencies will only work if the module depended on follows the naming standards for zips i.e. it must be attached to the topic in twiki.org and have the same name as the topic, and must be a zip file. <p /> Dependencies on CPAN modules are also checked (type perl) but no attempt is made to install them. <p /> The install script also acts as an uninstaller. <p /> <strong><em>Note</em></strong> that <code>target_install</code> builds and invokes this install script. <p /> At present there is no support for a caller-provided post-install script, but this would be straightforward to do if it were required. <p /> <nop><h4><a name="build_target"></a><a name="build_target_"></a> build($target) </h4> <p /> Build the given target <p /> <nop><h4><a name="target_manifest"></a> target_manifest </h4> <p /> Generate and print to STDOUT a rough guess at the MANIFEST listing <p /> <nop><h2><a name="Package_BaseFixture_test_fixture"></a> Package Base<nop>Fixture - test fixture </h2> <p /> Basic class of all test fixtures. Sets up a very basic TWiki environment suitable for testing plugins. As well as the standard <code>set_up</code> and <code>tear_down</code>, provides functions for the generation of data (.txt) files for tests and functions for asserting the contrents of generated HTML. <p /> For full details, read the code. <p /> <nop><h2><a name="Package_TWiki_Func_test_fixture"></a> Package TWiki::Func - test fixture </h2> <p /> A test fixture module that provides an ultra-thin implementation of the functions of the TWiki::Func module that are required by plugins and add-ons. <p /> Only the methods encountered in testing to date are implemented. <p /> For full details, read the code. <p /> <nop><h2><a name="Package_TWiki_Net_test_fixture"></a> Package TWiki::Net - test fixture </h2> <p /> A test fixture module that provides an ultra-thin implementation of the functions of the TWiki::Net module that are required by plugins and add-ons. <p /> Only the methods encountered in testing to date are implemented. <p /> For full details, read the code. <p /> <nop><h2><a name="Package_TWiki_test_fixture"></a> Package TWiki - test fixture </h2> <p /> A test fixture module that provides ultra-thin implementations of some of the TWiki functions that are required by plugins and add-ons. <p /> For full details, read the code. <p /> <nop><h2><a name="Package_TWiki_Store_test_fixture"></a> Package TWiki::Store - test fixture </h2> <p /> A test fixture module that provides an ultra-thin implementation of the functions of the TWiki::Store module that are required by plugins and add-ons. <p /> Only the methods encountered in testing to date are implemented. <p /> For full details, read the code. <p /> <nop><h1><a name="Settings"></a> Settings </h1><ul><li> Name of the perl package<ul><li> Set STUB = TWiki::Contrib::Build</li></ul></li><li> One line description:<ul><li> Set SHORTDESCRIPTION = Automate build process for Pugins, Add-ons and Contrib modules</li></ul></li></ul> <p /> <nop><h1><a name="Installation_Instructions"></a> Installation Instructions </h1> You are strongly recommended to use this Contrib to help split your code development away from your live TWiki environment, as described [[#DevelopmentModel][above].<ul><li> Download the ZIP file from the Plugin web (see below)</li><li> Unzip <code><b>BuildContrib.zip</b></code> in your development ($TWIKI_DEV) directory. Content: <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"> <tr><th bgcolor="#e6e6e6" class="twikiFirstCol"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=0;table=9;up=0#sorted_table" title="Sort by this column"><font color="#000000">File:</font></a> </th><th bgcolor="#e6e6e6"> <a rel="nofollow" href="http://skyloom.com/bin/view/Sandbox/WebRss?sortcol=1;table=9;up=0#sorted_table" title="Sort by this column"><font color="#000000">Description:</font></a> </th></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>data/TWiki/BuildContrib.txt</b></code> </td><td bgcolor="#ffffff"> Description </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>lib/TWiki/Contrib/Build.pm</b></code> </td><td bgcolor="#eaeaea"> Main code module </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>lib/TWiki/Contrib/BuildContrib/build.pl</b></code> </td><td bgcolor="#ffffff"> Build script </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>contrib/TEMPLATE_installer.pl</b></code> </td><td bgcolor="#eaeaea"> Installer template </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>contrib/fixtures/BaseFixture.pm</b></code> </td><td bgcolor="#ffffff"> Test fixture </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>contrib/fixtures/TWiki/Func.pm</b></code> </td><td bgcolor="#eaeaea"> Test fixture </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>contrib/fixtures/TWiki/Plugins.pm</b></code> </td><td bgcolor="#ffffff"> Test fixture </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>contrib/fixtures/TWiki/Net.pm</b></code> </td><td bgcolor="#eaeaea"> Test fixture </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>contrib/fixtures/TWiki.pm</b></code> </td><td bgcolor="#ffffff"> Test fixture </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>contrib/fixtures/TWiki/Store.pm</b></code> </td><td bgcolor="#eaeaea"> Test fixture </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> <code><b>contrib/TestRunner.pl</b></code> </td><td bgcolor="#ffffff"> Script for running tests </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> <code><b>BuildContrib_installer.pl</b></code> </td><td bgcolor="#eaeaea"> Install script </td></tr> </table></li></ul> <p /><ul><li> Optionally, run <code><b>BuildContrib_installer</b></code> to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.</li><li> Alternatively, manually make sure the dependencies listed in the table below are resolved. <table border="1"><tr><th align="left">Name</th><th align="left">Version</th><th align="left">Description</th></tr><tr><td align="left">Test::Unit</td><td[ align="left">>=0.24</td><td align="left">Optional, required for unit testing</td></tr><tr><td align="left">Pod::Text</td><td[ align="left">>=2.21</td><td align="left">POD documentation extracter</td></tr><tr><td align="left">File::Spec</td><td[ align="left">>=0.86</td><td align="left">Used to convert relative paths to absolute</td></tr><tr><td align="left">File::Find</td><td[ align="left">>=1.05</td><td align="left">Used to find file components</td></tr><tr><td align="left">File::Copy</td><td[ align="left">>=2.06</td><td align="left">Used to copy files</td></tr></table></li></ul> <p /> <nop><h1><a name="Contrib_Info"></a> Contrib Info </h1> <p /> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <nop> <table cellspacing="1" cellpadding="1" class="twikiTable" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> Authors: </td><td bgcolor="#eaeaea"> <a href="http://twiki.org/cgi-bin/view/Main.CrawfordCurrie" title="'Main.CrawfordCurrie' on TWiki.org">TWiki:Main.CrawfordCurrie</a> </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> Copyright ©: </td><td bgcolor="#ffffff"> 2004, Crawford Currie <a target="_top" href="http://www.c-dot.co.uk">http://www.c-dot.co.uk</a> </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> License: </td><td bgcolor="#eaeaea"> <a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GPL</a> </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> Dependencies: </td><td bgcolor="#ffffff"> <table border="1"><tr><th align="left">Name</th><th align="left">Version</th><th align="left">Description</th></tr><tr><td align="left">Test::Unit</td><td[ align="left">>=0.24</td><td align="left">Optional, required for unit testing</td></tr><tr><td align="left">Pod::Text</td><td[ align="left">>=2.21</td><td align="left">POD documentation extracter</td></tr><tr><td align="left">File::Spec</td><td[ align="left">>=0.86</td><td align="left">Used to convert relative paths to absolute</td></tr><tr><td align="left">File::Find</td><td[ align="left">>=1.05</td><td align="left">Used to find file components</td></tr><tr><td align="left">File::Copy</td><td[ align="left">>=2.06</td><td align="left">Used to copy files</td></tr></table> </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> 24/05/05 </td><td bgcolor="#eaeaea"> 1.007 Crawford Currie improved POSINSTALL support and documentation </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> 24/03/05 </td><td bgcolor="#ffffff"> 1.006 Crawford Currie made it look in the same directory as build.pl for MANIFEST and DEPENDENCIES and the INSTALL files, first </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> 15/03/05 </td><td bgcolor="#eaeaea"> 1.005 Crawford Currie made the installer script check in files in Dakar installs, and fixed bugs highlighted by Thomas Weigert </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> 04/12/04 </td><td bgcolor="#ffffff"> 1.004 Martin Cleaver removed twikicli - now in <a href="http://twiki.org/cgi-bin/view/Plugins.TWikiShellContrib" title="'Plugins.TWikiShellContrib' on TWiki.org">TWiki:Plugins.TWikiShellContrib</a> </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> 12/10/04 </td><td bgcolor="#eaeaea"> 1.003 Crawford Currie added ONLYIF control to DEPENDENCIES. Added optional PREINSTALL and POSTINSTALL scripts (used to e.g. remove dead code). </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> 1/10/04 </td><td bgcolor="#ffffff"> 1.002 Crawford Currie added topic updating reminder to installer </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> 30/08/04 </td><td bgcolor="#eaeaea"> 1.001 Crawford Currie added installer scripts </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> 26/08/04 </td><td bgcolor="#ffffff"> Martin Cleaver added twikicli </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> 14/08/04 </td><td bgcolor="#eaeaea"> 1.000 Crawford Currie made the initial implementation, separated out from the old <span class="twikiNewLink">SharedCode<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/SharedCode?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> module </td></tr> <tr><td bgcolor="#ffffff" align="right" class="twikiFirstCol"> Home: </td><td bgcolor="#ffffff"> <a target="_top" href="http://TWiki.org/cgi-bin/view/Plugins/BuildContrib">http://TWiki.org/cgi-bin/view/Plugins/BuildContrib</a> </td></tr> <tr><td bgcolor="#eaeaea" align="right" class="twikiFirstCol"> Feedback: </td><td bgcolor="#eaeaea"> <a target="_top" href="http://TWiki.org/cgi-bin/view/Plugins/BuildContribDev">http://TWiki.org/cgi-bin/view/Plugins/BuildContribDev</a> </td></tr> <tr><td bgcolor="#ffffff" align="right" class="twikiFirstCol"> Appraisal: </td><td bgcolor="#ffffff"> <a target="_top" href="http://TWiki.org/cgi-bin/view/Plugins/BuildContribAppraisal">http://TWiki.org/cgi-bin/view/Plugins/BuildContribAppraisal</a> </td></tr> </table> <p /> <strong><em>Related Topics:</em></strong> %TWIKIWEB%.TWikiPreferences <p /> -- <a href="http://twiki.org/cgi-bin/view/Main/CrawfordCurrie" title="'Main/CrawfordCurrie' on TWiki.org">TWiki:Main/CrawfordCurrie</a> - 19:04:32 24 May 2005 %BR% -- <a href="http://twiki.org/cgi-bin/view/Main/MartinCleaver" title="'Main/MartinCleaver' on TWiki.org">TWiki:Main/MartinCleaver</a> - 19:04:32 24 May 2005  <p /> <p /> <p /> <p /> (last changed by LynnwoodBrown) 2005-11-19T22:29Z LynnwoodBrown 2 updated major http://skyloom.com/bin/rdiff/Sandbox/BuildContrib http://skyloom.com/bin/rdiff/Sandbox/BuildContrib WikiFacilitation http://skyloom.com/bin/view/Sandbox/WikiFacilitation?t=2005-11-05T17:25Z This page has been moved to <a href="http://skyloom.com/bin/view/Skyloom/WikiFacilitation" class="twikiLink">Skyloom.WikiFacilitation</a>. See also <a href="http://skyloom.com/bin/view/Lynnwood/WikiFacilitation" class="twikiLink">Lynnwood.WikiFacilitation</a> and <a href="http://skyloom.com/bin/view/Know/WikiFacilitation" class="twikiLink">Know.WikiFacilitation</a>. <p /> <p /> <p /> -- <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a> - 05 Nov 2005 <p /> (last changed by LynnwoodBrown) 2005-11-05T17:25Z LynnwoodBrown 1 updated major http://skyloom.com/bin/rdiff/Sandbox/WikiFacilitation http://skyloom.com/bin/rdiff/Sandbox/WikiFacilitation CalendarPluginTest http://skyloom.com/bin/view/Sandbox/CalendarPluginTest?t=2005-10-05T22:50Z %CALENDAR% <p /> <p /> <p /> <p /> <p /> -- <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a> - 05 Oct 2005 <p /> (last changed by LynnwoodBrown) 2005-10-05T22:50Z LynnwoodBrown 1 updated major http://skyloom.com/bin/rdiff/Sandbox/CalendarPluginTest http://skyloom.com/bin/rdiff/Sandbox/CalendarPluginTest WebLeftBar http://skyloom.com/bin/view/Sandbox/WebLeftBar?t=2005-09-23T14:08Z %INCLUDE{"%IF{"context can_login" then="%TWIKIWEB%.WebLeftBarLogin"}%" warn="off"}% %INCLUDE{ "%TWIKIWEB%.WebLeftBarSearch" }%<ul><li> <b>[[%INCLUDINGWEB%.%HOMETOPIC%][ %ICON{"home"}% <nop>%MAKETEXT{"[_1] Web" args="%INCLUDINGWEB%"}%]]</b></li><li> <span class="twikiNewLink"> %ICON{"newtopic"}% %MAKETEXT{"Create <nop>New <nop>Topic"}%<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/SCRIPTURLviewSCRIPTSUFFIXBASEWEBWebTopicCreatorparentBASETOPIC?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span></li><li> <a href="http://skyloom.com/bin/view/Sandbox/WebTopicList" class="twikiLink"> %ICON{"index"}% %MAKETEXT{"Index"}%</a></li><li> <span class="twikiNewLink"> %ICON{"searchtopic"}% %MAKETEXT{"Search"}%<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/INCLUDINGWEBWebSearch?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span></li><li> <a href="http://skyloom.com/bin/view/Sandbox/WebChanges" class="twikiLink"> %ICON{"changes"}% %MAKETEXT{"Changes"}%</a></li><li> <a href="http://skyloom.com/bin/view/Sandbox/WebNotify" class="twikiLink"> %ICON{"notify"}% %MAKETEXT{"Notifications"}%</a></li><li> <a href="http://skyloom.com/bin/view/Sandbox/WebStatistics" class="twikiLink"> %ICON{"statistics"}% %MAKETEXT{"Statistics"}%</a></li><li> <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink"> %ICON{"wrench"}% %MAKETEXT{"Preferences"}%</a></li></ul> %INCLUDE{ "%TWIKIWEB%.TWikiTipsOfTheDayInclude" warn="off" }% %INCLUDE{ "%TWIKIWEB%.WebLeftBarWebsList" }% (last changed by TWikiContributor) 2005-09-23T14:08Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebLeftBar http://skyloom.com/bin/rdiff/Sandbox/WebLeftBar WebPreferences http://skyloom.com/bin/view/Sandbox/WebPreferences?t=2005-09-22T15:03Z <<<<<<< .mine <p /> <code><b>===</b></code> ><cite>>>>>>> .r7687</cite><br /> <nop><h2><a name="Sandbox_Web_Preferences"></a> <nop>Sandbox Web Preferences </h2> <p /> The following settings are <strong><em>web preferences</em></strong> of the <span class="twikiNewLink">Sandbox<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/HOMETOPIC?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> web. These preferences overwrite the <strong><em>site-level preferences</em></strong> in %TWIKIWEB%.%WIKIPREFSTOPIC%, and can be overwritten by <strong><em>user preferences</em></strong> (your personal topic, eg: %MAINWEB%.TWikiGuest in the <span class="twikiNewLink">%MAINWEB%<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/MAINWEBHOMETOPIC?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> web). <p /><ul><li> Custom web preferences:<ul><li> Set TOPICTRANSLATIONS = pt-br, en</li></ul></li></ul> <p /> <strong><em>Preferences:</em></strong> <p /> These settings override the defaults for this web only. See <span class="twikiNewLink">a full list of defaults<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TWIKIWEBTWikiPreferences?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>. <p /><ul><li> Set WEBBGCOLOR = #B9DAFF</li><li> Set SITEMAPWHAT = Sandbox test area with all features enabled. </li><li> Set SITEMAPUSETO = ...experiment in an unrestricted hands-on web. </li><li> Set WEBFORMS = <span class="twikiNewLink">TestForm1<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestForm1?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> <span class="twikiNewLink">TestForm2<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestForm2?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span></li><li> Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup</li><li> Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST</li></ul> <p /> <<<<<<< .mine<ul><li> <a href="http://favicon.org" target="_top">favicon</a>: Attach a <code>favicon.ico</code> to a web's <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink">WebPreferences</a> or add a <code>FAVICON</code> setting to <a href="http://skyloom.com/bin/view/Sandbox/WebPreferences" class="twikiLink">WebPreferences</a><ul><li> Set FAVICON = %PUBURL%/%TWIKIWEB%/WebPreferences/favicon.ico</li></ul></li></ul> <p /><ul><li> List this web in the %TWIKIWEB%.SiteMap:<ul><li> If yes, Set SITEMAPLIST = <code>on</code>, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. <nop>Sandbox.Topic links.</li><li> Set SITEMAPLIST = </li><li> Set SITEMAPWHAT = Sandbox test area with all features enabled. </li><li> Set SITEMAPUSETO = ...experiment in an unrestricted hands-on web. </li></ul></li></ul> <p /><ul><li> Exclude web from a <code>web="all"</code> search: (Set to <code>on</code> for hidden webs)<ul><li> Set NOSEARCHALL = on</li></ul></li></ul> <p /><ul><li> Prevent automatic linking of <span class="twikiNewLink">WikiWords<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TWIKIWEBWikiWords?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> and acronyms (if set to <code>on</code>); link <nop>WikiWords (if empty); can be overwritten by web preferences:<ul><li> Set NOAUTOLINK = </li><li> <strong><em>Note:</em></strong> Use the <code>[<nop>[...][...]]</code> syntax to link topics in case you disabled <nop>WikiWord linking. The <code><noautolink> ... </noautolink></code> syntax can be used to prevents links within a block of text.</li></ul></li></ul> <p /><ul><li> Default template for new topics and form(s) for this web:<ul><li> <span class="twikiNewLink">WebTopicEditTemplate<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/WebTopicEditTemplate?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>: Default template for new topics in this web. (Site-level is used if topic does not exist)</li><li> <span class="twikiNewLink">%TWIKIWEB%.WebTopicEditTemplate<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TWIKIWEBWebTopicEditTemplate?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>: Site-level default template</li><li> %TWIKIWEB%.TWikiForms: How to enable form(s)</li><li> Set WEBFORMS = <span class="twikiNewLink">TestForm1<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestForm1?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span> <span class="twikiNewLink">TestForm2<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/TestForm2?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span></li></ul></li></ul> <p /><ul><li> Users or groups who <strong><em>are not</em></strong> / <strong><em>are</em></strong> allowed to <strong><em>view</em></strong> / <strong><em>change</em></strong> / <strong><em>rename</em></strong> topics in the <nop>Sandbox web: (See %TWIKIWEB%.TWikiAccessControl)<ul><li> Set DENYWEBVIEW = </li><li> Set ALLOWWEBVIEW = </li><li> Set DENYWEBCHANGE = </li><li> Set ALLOWWEBCHANGE = </li><li> Set DENYWEBRENAME = </li><li> Set ALLOWWEBRENAME = </li></ul></li></ul> <p /><ul><li> Users or groups allowed to change or rename this <nop>WebPreferences topic: (e.g., %MAINWEB%.TWikiAdminGroup)<ul><li> #Set ALLOWTOPICCHANGE = </li><li> Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup</li></ul></li></ul> <p /><ul><li> Web preferences that are <strong>not</strong> allowed to be overridden by user preferences:<ul><li> Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME</li></ul></li></ul> <p /> <code><b>===</b></code> ><cite>>>>>>> .r7687</cite><br /> <strong><em>Notes:</em></strong><ul><li> A preference is defined as: <br /> <code>6 spaces * Set NAME = value</code> <br /> Example:<ul><li> S<nop>et WEBBGCOLOR = #FFFFC0</li></ul></li><li> Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs. Example:<ul><li> When you write variable <code>%WEB<nop>BGCOLOR%</code> , it gets expanded to <code>%WEBBGCOLOR%</code> .</li></ul></li><li> The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set <code><nop>WEBCOPYRIGHT</code> before <code><nop>WIKIWEBMASTER</code> since <code>%<nop>WEBCOPYRIGHT%</code> uses the <code>%<nop>WIKIWEBMASTER%</code> variable.</li><li> You can introduce new preferences variables and use them in your topics and templates. There is no need to change the <nop>%WIKITOOLNAME% engine (Perl scripts).</li></ul> <p /> <strong><em>Related Topics:</em></strong><ul><li> %TWIKIWEB%.%WIKIPREFSTOPIC% has site-level preferences.</li><li> %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.</li><li> %TWIKIWEB%.TWikiVariables has a list of common <code>%<nop>VARIABLES%</code>.</li><li> %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.</li></ul> <p /> <strong><em>Tools:</em></strong> %INCLUDE{"TWiki.RenameWeb"}% (last changed by TWikiContributor) 2005-09-22T15:03Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebPreferences http://skyloom.com/bin/rdiff/Sandbox/WebPreferences CodeScratchPad http://skyloom.com/bin/view/Sandbox/CodeScratchPad?t=2005-08-25T17:41Z <nop><h2><a name="CodeScratchPad"></a><a name="_CodeScratchPad"></a> <a href="http://skyloom.com/bin/view/Sandbox/CodeScratchPad" class="twikiLink">CodeScratchPad</a> </h2> <p /> This topic is for quick posting of code in <code>verbatim</code> format. <p /> -- <a href="http://skyloom.com/bin/view/Main/LynnwoodBrown" class="twikiLink">LynnwoodBrown</a> - 20 Jun 2005 <p /> %TOC% <p /> <p /> <p /> %COMMENT{ type="codetalk" }% (last changed by LynnwoodBrown) 2005-08-25T17:41Z LynnwoodBrown 2 updated major http://skyloom.com/bin/rdiff/Sandbox/CodeScratchPad http://skyloom.com/bin/rdiff/Sandbox/CodeScratchPad TestIrcSearchInclude http://skyloom.com/bin/view/Sandbox/TestIrcSearchInclude?t=2005-05-31T17:15Z %INCLUDE{"http://koala.ilog.fr/twikiirc/bin/irclogger_log_search/twiki?search=Lynnwood&action=search&error=0"}% (last changed by LynnwoodBrown) 2005-05-31T17:15Z LynnwoodBrown 1 updated major http://skyloom.com/bin/rdiff/Sandbox/TestIrcSearchInclude http://skyloom.com/bin/rdiff/Sandbox/TestIrcSearchInclude WebTopicList http://skyloom.com/bin/view/Sandbox/WebTopicList?t=2005-03-27T15:43Z <p /> %TOPICLIST{" * <span class="twikiNewLink">$name<a rel="nofollow" href="http://skyloom.com/bin/edit/Sandbox/Name?topicparent=Sandbox.WebRss" title="Create this topic"><sup>?</sup></a></span>"}% <p /> %MAKETEXT{"See also the verbose [_1]." args="WebIndex"}% (last changed by TWikiContributor) 2005-03-27T15:43Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebTopicList http://skyloom.com/bin/rdiff/Sandbox/WebTopicList WebSearchAdvanced http://skyloom.com/bin/view/Sandbox/WebSearchAdvanced?t=2005-03-27T15:43Z <p /> %INCLUDE{"%TWIKIWEB%.WebSearchAdvanced"}% (last changed by TWikiContributor) 2005-03-27T15:43Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebSearchAdvanced http://skyloom.com/bin/rdiff/Sandbox/WebSearchAdvanced WebIndex http://skyloom.com/bin/view/Sandbox/WebIndex?t=2005-03-27T15:43Z <p /> %SEARCH{"\.*" scope="topic" regex="on" nosearch="on"}% <p /> %MAKETEXT{"See also the faster [_1]" args="WebTopicList"}% (last changed by TWikiContributor) 2005-03-27T15:43Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebIndex http://skyloom.com/bin/rdiff/Sandbox/WebIndex WebSearch http://skyloom.com/bin/view/Sandbox/WebSearch?t=2005-03-27T15:43Z %INCLUDE{"%TWIKIWEB%.WebSearch"}% (last changed by TWikiContributor) 2005-03-27T15:43Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebSearch http://skyloom.com/bin/rdiff/Sandbox/WebSearch WebRss http://skyloom.com/bin/view/Sandbox/WebRss?t=2005-03-27T15:43Z <channel rdf:about="%SCRIPTURL{"view"}%/Sandbox"> <title><nop>%WIKITOOLNAME%'s <nop>Sandbox web</title> <link>%SCRIPTURL{"view"}%/Sandbox</link> <description>%MAKETEXT{"The [_1] web of TWiki. TWiki is a Web-Based Collaboration Platform for the Corporate World." args="<nop>Sandbox"}%</description> %INCLUDE{"%TWIKIWEB%.WebRssBase"}% (last changed by TWikiContributor) 2005-03-27T15:43Z TWikiContributor 0 updated major http://skyloom.com/bin/rdiff/Sandbox/WebRss http://skyloom.com/bin/rdiff/Sandbox/WebRss