Skip to content

Commit

Permalink
Item1143: ported, ready for testing and development
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/trunk/RestPlugin@2700 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
SvenDowideit authored and SvenDowideit committed Feb 25, 2009
1 parent b38a9c4 commit bc17863
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 760 deletions.
6 changes: 3 additions & 3 deletions data/Sandbox/BugItem1.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
%META:TOPICINFO{author="BaseUserMapping_333" date="1196240328" format="1.1" reprev="1.3" version="1.3"}%
-- Main.TWikiAdminUser - 02 Nov 2007
-- Main.AdminUser - 02 Nov 2007

This Item's form comes from TWiki:Plugins.BugsContrib
This Item's form comes from Foswiki:Plugins.BugsContrib

%META:FORM{name="BugItemTemplate"}%
%META:FIELD{name="Summary" attributes="M" title="Summary" value="Test this bug very carefully - it looks sneaky"}%
%META:FIELD{name="ReportedBy" attributes="M" title="ReportedBy" value="TWikiAdminUser"}%
%META:FIELD{name="ReportedBy" attributes="M" title="ReportedBy" value="AdminUser"}%
%META:FIELD{name="AppliesTo" attributes="M" title="AppliesTo" value="Main Product"}%
%META:FIELD{name="Priority" attributes="M" title="[[Priority]]" value="Enhancement"}%
%META:FIELD{name="CurrentState" attributes="M" title="CurrentState" value="New"}%
Expand Down
2 changes: 1 addition & 1 deletion data/Sandbox/BugItemTemplate.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

---++ This is the TWiki.TWikiForms definition for the structured form based data for the TWiki:Plugins.BugsContrib
---++ This is the System.DataForms definition for the structured form based data for the Foswiki:Plugins.BugsContrib
see WebTopicEditTemplate for the TopicTemplate

| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |
Expand Down
22 changes: 11 additions & 11 deletions data/System/RestPlugin.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,19 @@ One line description, required for extensions repository catalog.
<img src="%PUBURL%/%WEB%/%TOPIC%/formfield_example.png" style="padding:6px" />

---++ Usage
This plugin begins the task of creating a real REST URI engine for TWiki. It uses a TWiki:Codev.TopicObjectModel addressing scheme based on the TWiki.IfStatements and TWiki.QuerySearch syntax,
This plugin begins the task of creating a real REST URI engine for Foswiki.
It uses a Foswiki:Development.TopicObjectModel addressing scheme based on the System.IfStatements and System.QuerySearch syntax,
and then enable both the retriving and setting / creation of topics and parts of topics.

Initially, it will be implemented using [[http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/advanced-editing-and-display/inlineeditbox][Dojotoolkit's Diji InlineEdit]] component, and apply just to formfields.
This should give us a strong basis to extend the work to all topic fragments.

---++ Examples
---+++ FORMFIELD
This allows you to change values in TWiki Forms without leaving the current topic - useful for reports and inline data-wiki applications.
This allows you to change values in Foswiki DataForms without leaving the current topic - useful for reports and inline data-wiki applications.
This syntax will be simplified in future.

This example alows you to view, and change the Summary Field in Sandbox.BugItem1 (from TWiki:Plugins.BugsContrib) - by just clicking on the text, changing it, and then hitting ENTER
This example alows you to view, and change the Summary Field in Sandbox.BugItem1 (from Foswiki:Extensions.BugsContrib) - by just clicking on the text, changing it, and then hitting ENTER

%FORMFIELD{
"Summary"
Expand All @@ -49,7 +50,7 @@ If you have installed this plugin, enabled it, and set =SKIN=dojo,pattern= then
<img src="%PUBURL%/%WEB%/%TOPIC%/restplugin-viewform.png" style="padding:6px" />

---++ Customisation
To make customisation possible, the javascript, and the formtables rendering is defined using the =restpluginscript.tmpl= and =formtables.dojo.tmpl= templates. To create your own implementations, create a new TWiki
To make customisation possible, the javascript, and the formtables rendering is defined using the =restpluginscript.tmpl= and =formtables.dojo.tmpl= templates. To create your own implementations, create a new Foswiki
Contrib that contains your javascript (in pub) and templates to activate them. Then set your SKIN to include your templates.

---++ Installation Instructions
Expand All @@ -59,18 +60,17 @@ Contrib that contains your javascript (in pub) and templates to activate them. T
---++ Plugin Info


| Plugin Author(s): | TWiki:Main.SvenDowideit - http://distributedINFORMATION.com a %PUBURL%/%WEB%/%TOPIC%/wikiringlogo20x20.png [[http://WikiRing.com][WikiRing]] founding partner |
| Copyright: | &copy; SvenDowideit@distributedINFORMATION.com |
| Plugin Author(s): | Foswiki:Main.SvenDowideit - http://fosiki.com a %PUBURL%/%WEB%/%TOPIC%/wikiringlogo20x20.png [[http://WikiRing.com][WikiRing]] founding partner |
| Copyright: | &copy; SvenDowideit@fosiki.com |
| Gear Icon | based on eXperience Crystal, by David Christian Berg |
| UniversalWikiEditButton | http://www.aboutus.org/UniversalWikiEditButton |
| License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
| Plugin Version: | %$VERSION% |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
| Dependencies: | %$DEPENDENCIES% |
| Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/RestPlugin |
| Feedback: | http://twiki.org/cgi-bin/view/Plugins/RestPluginDev |
| Appraisal: | http://twiki.org/cgi-bin/view/Plugins/RestPluginAppraisal |
| Plugin Home: | http://foswiki.org/Extensions/RestPlugin |

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

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on twiki.org instead. -->
__Related Topics:__ %SYSTEMWEB%.InstalledPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.SitePreferences

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on foswiki.org instead. -->

0 comments on commit bc17863

Please sign in to comment.