[rkward-cvs] SF.net SVN: rkward: [1900] trunk/rkward/doc/en/writing_plugins_introduction .docbook

[tfry at users.sourceforge.net]

Revision: 1900
          http://svn.sourceforge.net/rkward/?rev=1900&view=rev
Author:   tfry
Date:     2007-05-10 11:54:02 -0700 (Thu, 10 May 2007)

Log Message:
-----------
Finish reference on .rkh files

Modified Paths:
--------------
    trunk/rkward/doc/en/writing_plugins_introduction.docbook

Modified: trunk/rkward/doc/en/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-05-10 18:38:20 UTC (rev 1899)
+++ trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-05-10 18:54:02 UTC (rev 1900)
@@ -2318,75 +2318,75 @@
 </varlistentry>
 <varlistentry>
 <term><section></term>
-<listitem>
+<listitem>A general purposes section. May be used any number of times as a direct child of the <document> node. These sections are displayed in the order of their definition, but all <emphasis>after</emphasis> the <usage> section and <emphasis>before</emphasis> the <settings> section. The text contained within the <sectoin> tag will be displayed.
 	<variablelist>
 	<varlistentry>
 	<term>id</term>
-	<listitem></listitem>
+	<listitem>An identifier needed to jump to this section from the navigation bar (or a link). Needs to be unique within the file. Required, no default.</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>title</term>
-	<listitem></listitem>
+	<listitem>The title (caption) of this section. Required, no default.</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>short_title</term>
-	<listitem></listitem>
+	<listitem>A short title suitable to be displayed in the navigation bar. Optional, defaults to the full title.</listitem>
 	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
 <term><settings></term>
-<listitem></listitem>
+<listitem>Defines the section containing reference on the various GUI settings. Only meaningful and only used for plugin related help pages. Use as a direct child of the <document>. May contain only <setting> and <caption> elements as direct children. No attributes.</listitem>
 </varlistentry>
 <varlistentry>
 <term><setting></term>
-<listitem>
+<listitem>Explains a single setting in the GUI. Only allowed as a direct child of the <settings> element. The text contained within the element is displayed.
 	<variablelist>
 	<varlistentry>
 	<term>id</term>
-	<listitem></listitem>
+	<listitem>The id of the setting in the plugin .xml. Required, no default.</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>title</term>
-	<listitem></listitem>
+	<listitem>An optional title for the setting. If omitted (omission is recommended in most cases), the title will be taken from the plugin .xml.</listitem>
 	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
 <term><caption></term>
-<listitem>
+<listitem>A caption to visually group several settings. May only be used as a direct child of the <settings> element.
 	<variablelist>
 	<varlistentry>
 	<term>id</term>
-	<listitem></listitem>
+	<listitem>The id of the corresponding element (typically a <frame>, <page> or <tab>) in the plugin .xml.</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>title</term>
-	<listitem></listitem>
+	<listitem>An optional title for the caption. If omitted (omission is recommended in most cases), the title will be taken from the plugin .xml.</listitem>
 	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
 <term><related></term>
-<listitem></listitem>
+<listitem>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.</listitem>
 </varlistentry>
 <varlistentry>
 <term><technical></term>
-<listitem></listitem>
+<listitem>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.</listitem>
 </varlistentry>
 <varlistentry>
 <term><link></term>
-<listitem>
+<listitem>A link. Can be used in any of the sections described above.
 	<variablelist>
 	<varlistentry>
 	<term>href</term>
-	<listitem></listitem>
+	<listitem>The target url. Note that several rkward specific URLs are available. See <link linkend="pluginhelp">section on writing help pages</link> for details.</listitem>
 	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
 <term><various html tags></term>
-<listitem></listitem>
+<listitem>Most basic html tags are allowed within the sections. Please keep manual formatting to a minimum, however.</listitem>
 </varlistentry>
 </variablelist>
 </section>


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