Item10334: provide documentation template for tag

git-svn-id: http://svn.foswiki.org/trunk@10676 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
foswiki · Feb 9, 2011 · 2cbf5e6 · 2cbf5e6
1 parent 3ba81d2
commit 2cbf5e6
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/EmptyPlugin/data/Sandbox/PluginTestEmptyPlugin.txt b/EmptyPlugin/data/Sandbox/PluginTestEmptyPlugin.txt
@@ -1,4 +1,7 @@
-%META:TOPICINFO{author="ProjectContributor" date="1042728360" format="1.0" version="$Rev$"}%
+%META:TOPICINFO{author="ProjectContributor" date="1297235194" format="1.0" version="$Rev$"}%
 %META:TOPICPARENT{name="EmptyPlugin"}%
+---+!! Testing !EmptyPlugin 
 
 SOME EXAMPLES OF THE PLUGIN
+
+__Related:__ %SYSTEMWEB%.EmptyPlugin
diff --git a/EmptyPlugin/data/System/EmptyPlugin.txt b/EmptyPlugin/data/System/EmptyPlugin.txt
@@ -32,7 +32,7 @@ One line description, required for extensions repository catalog.
 ---++ Plugin Info
 
 |  Author: | Foswiki:Main.PluginAuthor |
-|  Copyright: | &copy; 2009, Foswiki Contributors |
+|  Copyright: | &copy; 2011, Foswiki Contributors |
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
 |  Release: | %$RELEASE% |
 |  Version: | %$VERSION% |

diff --git a/EmptyPlugin/data/System/VarEXAMPLETAG.txt b/EmptyPlugin/data/System/VarEXAMPLETAG.txt
@@ -0,0 +1,10 @@
+%META:TOPICINFO{author="ProjectContributor" date="1297235055" format="1.1" version="$Rev$"}%
+%META:TOPICPARENT{name="EmptyPlugin"}%
+#VarEXAMPLETAG
+---+++ EXAMPLETAG -- example variable
+   * The =%<nop>EXAMPLETAG{}%= variable is handled by the ExamplePlugin
+   * Syntax: =%<nop>EXAMPLETAG{"text" format="..."}%=
+   * Parameter =text="..."= - example text.
+   * Parameter =format="..."= - format of report.
+   * Example: =%<nop>EXAMPLETAG{"hello" format="| $topic: $summary |"}%=
+   * Related: ExamplePlugin
diff --git a/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin/MANIFEST b/EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin/MANIFEST
@@ -1,3 +1,4 @@
 data/System/EmptyPlugin.txt 0644 Plugin doc page
-lib/Foswiki/Plugins/EmptyPlugin.pm 0444 Plugin Perl module
+data/System/VarEXAMPLETAG.txt 0644 Tag documentation
 data/Sandbox/PluginTestEmptyPlugin.txt 0644 Plugin examples
+lib/Foswiki/Plugins/EmptyPlugin.pm 0444 Plugin Perl module