[kde-doc-english] [rkward] /: Bookkeeping
Thomas Friedrichsmeier
thomas.friedrichsmeier at ruhr-uni-bochum.de
Thu Nov 5 19:50:01 UTC 2015
Git commit 272674bd6669df1bdad15f8aa343244c4ada803e by Thomas Friedrichsmeier.
Committed on 05/11/2015 at 19:49.
Pushed by tfry into branch 'master'.
Bookkeeping
M +16 -29 doc/rkwardplugins/index.docbook
R +0 -0 techdocs/404.txt [from: doc/404.txt - 100% similarity]
http://commits.kde.org/rkward/272674bd6669df1bdad15f8aa343244c4ada803e
diff --git a/doc/rkwardplugins/index.docbook b/doc/rkwardplugins/index.docbook
index 2860559..cd27b80 100644
--- a/doc/rkwardplugins/index.docbook
+++ b/doc/rkwardplugins/index.docbook
@@ -60,8 +60,8 @@ as Authors, publish date, the abstract, and Keywords -->
and in the FDL itself on how to use it. -->
<legalnotice>&FDLNotice;</legalnotice>
-<date>2015-01-22</date>
-<releaseinfo>0.6.300</releaseinfo>
+<date>2015-11-05</date>
+<releaseinfo>0.6.400</releaseinfo>
<abstract>
<para>
@@ -83,7 +83,7 @@ This is a guide to writing plugins for &rkward;.
<note>
<para>
- Documentation as of &rkward; release 0.6.3.
+ Documentation as of &rkward; release 0.6.4.
</para>
</note>
<para>
@@ -1602,17 +1602,14 @@ This chapter contains information on some topics that are useful only to certain
[...]
<optionset id="set" min_rows="1">
<content>
- <frame>
- <optiondisplay index="true"/>
- <row>
- <input id="firstname" label="Given name(s)" size="small">
- <input id="lastname" label="Family name" size="small">
- <radio id="gender" label="Gender">
- <optioncolumn label="Male" value="m"/>
- <optioncolumn label="Female" value="f"/>
- </radio>
- </row>
- </frame>
+ <row>
+ <input id="firstname" label="Given name(s)" size="small">
+ <input id="lastname" label="Family name" size="small">
+ <radio id="gender" label="Gender">
+ <optioncolumn label="Male" value="m"/>
+ <optioncolumn label="Female" value="f"/>
+ </radio>
+ </row>
</content>
<optioncolumn id="firstnames" label="Given name(s)" connect="firstname.text">
@@ -1625,13 +1622,13 @@ This chapter contains information on some topics that are useful only to certain
<para>
Here, we created a UI for specifying a number of persons (⪚ authors). The UI requires at least one entry (<parameter>min_rows="1"</parameter>). Inside the <command><optionset></command>-element, we begin by specifying the
<command><content></command>, &ie; those elements that belong to the option set. You will be familiar with most elements
- inside the <command><content></command>. The <command><optiondisplay></command> is a special element for use in option sets. It lists the current items, allows the user to switch between items, to add or to remove entries. <parameter>index="true"</parameter> means that we want an extra column in the list, showing an index (number) of each item.
+ inside the <command><content></command>.
</para><para>
Next we specify the variables of interest that we will want to read from the option set in our JS file. As we will be dealing with
an arbitrary number of items, we cannot just read <function>getString ("firstname")</function> in JS. Rather, for each value of
interest, we specify an <command><optioncolumn></command>. For the first optioncolumn in the example, <command><connect="firstname.text"></command> means that the content of the <command><input></command>
element "firstname" is read for each item. <command><optioncolumn></command>s for which a <parameter>label</parameter> is given,
- will be shown in the <command><optiondisplay></command>, in a column by that label. In JS, we can now fetch the first names for all authors using <function>getList("set.firstname")</function>, <function>getList("set.lastnames")</function> for the family
+ will be shown in the display, in a column by that label. In JS, we can now fetch the first names for all authors using <function>getList("set.firstname")</function>, <function>getList("set.lastnames")</function> for the family
names, and <function>getList("set.gender")</function> for an array of "m"/"f" strings.
</para>
<para>
@@ -1689,7 +1686,6 @@ This chapter contains information on some topics that are useful only to certain
<varslot id="vars" label="Objects to plot"/>
<optionset id="set" keycolumn="var">
<content>
- <optiondisplay/>
[...]
<embed id="color" component="rkward::color_chooser" label="Line color"/>
</content>
@@ -1705,7 +1701,7 @@ This chapter contains information on some topics that are useful only to certain
<para>
We'll start looking at the example at the bottom. You'll note that two <command><optioncolumn></command> specifications have
<parameter>external="true"</parameter>. This tells &rkward; that these are controlled from outside the <command><optionset></command>. Here, the sole purpose of the "varnames"-optioncolumn is to provide easy-to-read labels in the
- <command><optiondisplay></command> (it is connected to the "shortname" modifier of the property holding the selected
+ optionset display (it is connected to the "shortname" modifier of the property holding the selected
objects). The purpose of the "vars"-optioncolumn is to serve as the "key" column, as specified by
<command><optionset keycolumn="vars"...></command>. This means that for each entry in this list, the set will offer
one set of options, and options are logically tied to these entries. This column is connected to the property holding the
@@ -3144,7 +3140,7 @@ Child-elements:
<varlistentry><term><parameter>external</parameter></term>
<listitem><para>Set to true, if the optioncolumn is controlled from outside the optionset (optional, boolean, defaults to false).</para></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter></term>
- <listitem><para>If given, the optioncolumn will be displayed in the <optiondisplay> in a column by that label (optional, string, defaults to not displayed).</para></listitem></varlistentry>
+ <listitem><para>If given, the optioncolumn will be displayed in a column by that label (optional, string, defaults to not displayed).</para></listitem></varlistentry>
<varlistentry><term><parameter>connect</parameter></term>
<listitem><para>The property to connect this optioncolumn to, given as id inside the <content>-area. For external <optioncolumn>s, the corresponding value will be set to the externally set value. For regular (non-external) <optioncolumn>s,
the corresponding row of the <optioncolumn>-property, will be set when the property changes inside the content-area. (optional, string, defaults to not connected).</para></listitem></varlistentry>
@@ -3154,16 +3150,7 @@ Child-elements:
</para></listitem></varlistentry>
<varlistentry>
<term><content></term>
- <listitem><para>Declare the content / UI of the set. No attributes. All usual active, passive, and layout elements are allowed as childname elements. In addition, the following special child-element is allowed:
- <variablelist>
- <varlistentry><term><optiondisplay></term>
- <listitem><para>Creates a display for showing / selecting / adding / removing items in an optionset. Allowed only inside the contents are of an optionset, and only once. Attributes:
- <variablelist>
- <varlistentry><term><parameter>index</parameter></term>
- <listitem><para>Whether to show a column with a numeric index (1...n) in the optiondisplay. (optional, boolean, defaults to "true")</para></listitem></varlistentry>
- </variablelist>
- </para></listitem></varlistentry>
- </variablelist>
+ <listitem><para>Declare the content / UI of the set. No attributes. All usual active, passive, and layout elements are allowed as childname elements. In addition, in earlier versions of RKWard (up to 0.6.3), the special child-element <command><optiondisplay></command> was allowed. This is obsolete in RKWard 0.6.4, and should simply be removed from existing plugins.
</para></listitem></varlistentry>
<varlistentry>
<term><logic></term>
diff --git a/doc/404.txt b/techdocs/404.txt
similarity index 100%
rename from doc/404.txt
rename to techdocs/404.txt
More information about the kde-doc-english
mailing list