[rkward-cvs] SF.net SVN: rkward:[3896] trunk/rkward/doc/rkwardplugins/index.docbook

tfry at users.sourceforge.net tfry at users.sourceforge.net
Thu Oct 6 16:07:11 UTC 2011


Revision: 3896
          http://rkward.svn.sourceforge.net/rkward/?rev=3896&view=rev
Author:   tfry
Date:     2011-10-06 16:07:10 +0000 (Thu, 06 Oct 2011)
Log Message:
-----------
Fix copy and paste bug in the reference, as pointed out by m-eik

Modified Paths:
--------------
    trunk/rkward/doc/rkwardplugins/index.docbook

Modified: trunk/rkward/doc/rkwardplugins/index.docbook
===================================================================
--- trunk/rkward/doc/rkwardplugins/index.docbook	2011-10-06 15:47:45 UTC (rev 3895)
+++ trunk/rkward/doc/rkwardplugins/index.docbook	2011-10-06 16:07:10 UTC (rev 3896)
@@ -2637,11 +2637,11 @@
 </varlistentry>
 <varlistentry>
 <term><related></term>
-<listitem><para>Defines a section containing links to further related information. Will always be displayed after the <settings> section. Use as a direct child of the <document>. May contain only <setting> and <caption> elements as direct children. No attributes.</para></listitem>
+<listitem><para>Defines a section containing links to further related information. Will always be displayed after the <settings> section. No attributes. The text contained within the <related> tag will be displayed. Typically this will contain an HTML-style list. Recommended for plugin help pages, but not required. May only be defined once, as a direct child of the <document> node.</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><technical></term>
-<listitem><para>Defines a section containing technical information of no relevance to end users (such as internal structure of the plugin). Will always be displayed last in a help page. Use as a direct child of the <document>. May contain only <setting> and <caption> elements as direct children. No attributes.</para></listitem>
+<listitem><para>Defines a section containing technical information of no relevance to end users (such as internal structure of the plugin). Will always be displayed last in a help page. No attributes. The text contained within the <related> tag will be displayed. Not required, and not recommended for most plugin help pages. May only be defined once, as a direct child of the <document> node.</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><link></term>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





More information about the rkward-tracker mailing list