Menu
▾
▴
[TWiki-Dev] [SVN] MichaelGulitz r22934 - in twiki/trunk/ConnectByRestPlugin: data/Sandbox data/TWiki lib/TWiki/Plugins/ConnectByRestPlugin
|
From: <de...@de...> - 2012-05-14 13:58:33
|
Author: MichaelGulitz Date: 2012-05-14 08:58:26 -0500 (Mon, 14 May 2012) New Revision: 22934 Trac url: http://develop.twiki.org/trac/changeset/22934 Removed: twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt,v Modified: twiki/trunk/ConnectByRestPlugin/data/Sandbox/ConnectByRestPluginTest.txt twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt twiki/trunk/ConnectByRestPlugin/lib/TWiki/Plugins/ConnectByRestPlugin/MANIFEST Log: Item6619: documentation and test topic Modified: twiki/trunk/ConnectByRestPlugin/data/Sandbox/ConnectByRestPluginTest.txt =================================================================== --- twiki/trunk/ConnectByRestPlugin/data/Sandbox/ConnectByRestPluginTest.txt 2012-05-14 12:58:55 UTC (rev 22933) +++ twiki/trunk/ConnectByRestPlugin/data/Sandbox/ConnectByRestPluginTest.txt 2012-05-14 13:58:26 UTC (rev 22934) @@ -1,10 +1,8 @@ ----++!! Tests for TWiki.ConnectByRestPlugin +---+!! Tests for TWiki.ConnectByRestPlugin -%I% _This Topic serves for Testing the REST Function of TWiki.ConnectByRestPlugin. -You can also copy the HTML forms to any Webpage for testin from outside TWiki._ +%I% __This Topic serves for Testing the REST Functions of TWiki.ConnectByRestPlugin. You can also copy the HTML forms to any Webpage for testing from outside TWiki.__ <literal> - <h1>Call REST Handler in TWiki</h1> <h2>Using REST Fuctions from ConnectByRestPlugin</h2> <p> <b>Notice:</b> @@ -71,7 +69,7 @@ <tr><td>Topic </td><td><input name="topic" size="40" type="text"></td></tr> <tr><td>Text </td><td><textarea name="text" cols="80" rows="10"></textarea></td></tr> <tr><td>Meta String</td><td><input name="metatext" size="60" type="text"></td></tr> - <tr><td colspan="2"><input name="submit3" value="Call REST: create topic" type="submit"></td></tr> + <tr><td colspan="2"><input name="submit3" value="Call REST: Savetopic" type="submit"></td></tr> </tbody> </table> </form> Modified: twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt =================================================================== --- twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt 2012-05-14 12:58:55 UTC (rev 22933) +++ twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt 2012-05-14 13:58:26 UTC (rev 22934) @@ -117,8 +117,6 @@ * Debug plugin: (See output in =data/debug.txt=) * Set DEBUG = 0 - * My own setting: - * Set HOWTO = got it! ---++ Plugin Installation Instructions @@ -128,9 +126,8 @@ * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | -| ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | -| ==data/Sandbox/PluginTest%TOPIC%.txt== | Plugin test topic | +| ==data/Sandbox/%TOPIC%Test.txt== | Plugin test topic | * Configure the Plugin: * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script to enable the Plugin Deleted: twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt,v =================================================================== --- twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt,v 2012-05-14 12:58:55 UTC (rev 22933) +++ twiki/trunk/ConnectByRestPlugin/data/TWiki/ConnectByRestPlugin.txt,v 2012-05-14 13:58:26 UTC (rev 22934) @@ -1,213 +0,0 @@ -head 1.2; -access; -symbols; -locks; strict; -comment @# @; - - -1.2 -date 2012.05.10.08.58.39; author MichaelGulitz; state Exp; -branches; -next 1.1; - -1.1 -date 2012.05.10.08.34.19; author MichaelGulitz; state Exp; -branches; -next ; - - -desc -@none -@ - - -1.2 -log -@none -@ -text -@%META:TOPICINFO{author="MichaelGulitz" date="1336640319" format="1.1" reprev="1.2" version="1.2"}% ----+!! <nop>%TOPIC% - -This plugin wraps functions from the TWiki API in REST functions. The intention is to offer external applications access to TWiki by implementing a REST interface. - -The functions of this plugin include: - * create and update topics - * read topics and meta data - * read and update form fields of a topic - -The intention is to enable other web based applications to connect to TWiki. By calling the REST functions of this plugins applications can read, change or create topics in TWiki. - -Topic content sent to the plugin for update or creation has to obey TWiki syntax - especially when providing special meta data like form fields, permissions, etc. - -Calling the REST functions always requires successful authorization. - - -%TOC% - ----++ REST Functions - ----+++ Function Readtopic - -*Description* - -This function returns the content of a topic as a string. -It reads the topic that was specified in the parameter _topic_ and returns the topic text as a string. - -*Parameters* - -| *Parameter* | *Direction* | *Type* | *Description* | -| username | in | string | | -| password | in | string | | -| topic | in | string | use full topic name: _web.topic_ | -| text | out | string | topic text | - -*Security* - - * The function checks if the given user has read access to the topic. - - - ----+++ Function Getmetastring - -*Description* - -This function returns the meta data of a topic as a string. -It reads the topic that was specified in the parameter _topic_ and uses the _stringify_ method of the Meta-Object to return the complete meta data as a string - -*Parameters* - -| *Parameter* | *Direction* | *Type* | *Description* | -| username | in | string | | -| password | in | string | | -| topic | in | string | use full topic name: _web.topic_ | -| metastring | out | string | full meta data | - -*Security* - - * The function checks if the given user has read access to the topic. - ----+++ Function Updateformfield - -*Description* - -The function updates a single form field attached to a topic. - -*Parameters* - -| *Parameter* | *Direction* | *Type* | *Description* | -| username | in | string | | -| password | in | string | | -| topic | in | string | use full topic name: _web.topic_ | -| formfield | in | string | form field name | -| newval | in | string | new form field value | - -*Security* - - * The functions checks if the given user has write access to the topic. - ----+++ Function Savetopic - -*Description* - -The function creates a new topic or updates an existing topic in the specified web. - -*Parameters* - -| *Parameter* | *Direction* | *Type* | *Description* | -| username | in | string | | -| password | in | string | | -| topic | in | string | name of the new topic; use full topic name: _web.topic_ | -| text | in | string | topic content, including meta data | - - -*Security* - - * The functions checks if the given user has write access to the web. - ----++ Syntax Rules - - * - * - ----++ Examples - - * - * - ----++ Plugin Settings - -Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>NEWPLUGIN_SHORTDESCRIPTION%== - - * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: - * Set SHORTDESCRIPTION = Call TWiki API functions via REST calls - - * Debug plugin: (See output in =data/debug.txt=) - * Set DEBUG = 0 - - * My own setting: - * Set HOWTO = got it! - ----++ 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 TWiki server. - - * Download the ZIP file from the Plugin Home (see below) - * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content: -| *File:* | *Description:* | -| ==data/TWiki/%TOPIC%.txt== | Plugin topic | -| ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | -| ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | -| ==data/Sandbox/PluginTest%TOPIC%.txt== | Plugin test topic | - - * Configure the Plugin: - * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script to enable the Plugin - * Change the Plugin settings as needed - * Test if the installation was successful: - * _enter samples here_ - ----++ Plugin Info - - * One line description - * Set SHORTDESCRIPTION = Call TWiki API functions via TWiki REST functions. - -| Plugin Author: | TWiki:Main/MichaelGulitz | -| Copyright: | 2011, TWiki:Main/MichaelGulitz | -| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | -| Plugin Version: | 2012-05-10 (V1.000) | -| Change History: | <!-- versions below in reverse order --> | -| 2010-05-05: | Initial version | -| TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 | -| CPAN Dependencies: | none | -| Other Dependencies: | none | -| Perl Version: | 5.005 | -| [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% | -| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | -| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | -| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | - -__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences -@ - - -1.1 -log -@none -@ -text -@d1 1 -a1 1 -%META:TOPICINFO{author="MichaelGulitz" date="1334959730" format="1.1" version="1.4"}% -d11 7 -d93 2 -a94 2 -| text | in | string | topic content | -| metatext | in | string | topic meta data | -d143 3 -d147 1 -a147 1 -| Copyright: | 2010, TWiki:Main/MichaelGulitz | -d149 1 -a149 1 -| Plugin Version: | 2010-05-05 (V1.000) | -@ Modified: twiki/trunk/ConnectByRestPlugin/lib/TWiki/Plugins/ConnectByRestPlugin/MANIFEST =================================================================== --- twiki/trunk/ConnectByRestPlugin/lib/TWiki/Plugins/ConnectByRestPlugin/MANIFEST 2012-05-14 12:58:55 UTC (rev 22933) +++ twiki/trunk/ConnectByRestPlugin/lib/TWiki/Plugins/ConnectByRestPlugin/MANIFEST 2012-05-14 13:58:26 UTC (rev 22934) @@ -1,5 +1,5 @@ # Release manifest for ConnectByRestPlugin data/TWiki/ConnectByRestPlugin.txt 0644 Documentation data/Sandbox/ConnectByRestPluginTest.txt 0644 Plugin Test -lib/TWiki/Plugins/ConnectByRestPlugin.pm 0644 Perl module +lib/TWiki/Plugins/ConnectByRestPlugin.pm 0444 Perl module |