[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    branches/extragear/kde3/graphics/doc/kst
From:       Yiwen Mao <yiwenv () live ! ca>
Date:       2008-03-31 20:53:38
Message-ID: 1206996818.367421.3282.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 792343 by yiwenmao:

updated

 M  +2 -2      extensions-chapter.docbook  
 M  +9 -9      plugins-chapter.docbook  


--- branches/extragear/kde3/graphics/doc/kst/extensions-chapter.docbook \
#792342:792343 @@ -75,14 +75,14 @@
 <variablelist>
 
 <varlistentry>
-<term><guilabel>Author*:</guilabel></term>
+<term><guilabel>Author*</guilabel></term>
 <listitem><para>
 Enter the name of the author.
 </para></listitem>
 </varlistentry>
 
 <varlistentry>
-<term><guilabel>Type*:</guilabel></term>
+<term><guilabel>Type*</guilabel></term>
 <listitem><para>
 Choose the type of the log message from:
 <itemizedlist>
--- branches/extragear/kde3/graphics/doc/kst/plugins-chapter.docbook #792342:792343
@@ -1382,7 +1382,7 @@
 			<variablelist>
 					<varlistentry>
 						<term>
-						<guilabel>Y</guilabel> (Vector)
+						<guilabel>Y</guilabel> (vector)
 						</term>
 						<listitem>
 							<para>
@@ -2367,7 +2367,7 @@
 
 					<varlistentry>
 						<term>
-						<guilabel>Period</guilabel> (Scalar)
+						<guilabel>Period</guilabel> (scalar)
 						</term>
 						<listitem>
 							<para>
@@ -2377,7 +2377,7 @@
 					</varlistentry>
 					<varlistentry>
 						<term>
-						<guilabel>Zero Phase</guilabel> (Scalar)
+						<guilabel>Zero Phase</guilabel> (scalar)
 						</term>
 						<listitem>
 							<para>
@@ -2675,7 +2675,7 @@
 
 						<varlistentry>
 						<term>
-						<guilabel>Number of Bins</guilabel> (Scalar)
+						<guilabel>Number of Bins</guilabel> (scalar)
 						</term>
 						<listitem>
 							<para>
@@ -2688,7 +2688,7 @@
 
 					<varlistentry>
 						<term>
-						<guilabel>X min/X max</guilabel> (Scalar)
+						<guilabel>X min/X max</guilabel> (scalar)
 						</term>
 						<listitem>
 							<para>
@@ -3150,17 +3150,17 @@
 
 <sect2>
 <title>Overview</title>
-<para>Plugins can also be generated and edited through KstScript. See details in the \
<link linkend="class_Plugin">Plugin class</link> in the script chapter.</para> \
+<para>Plugins can also be generated and edited through KstScript. See details in the \
<link linkend="class_Plugin">Plugin class</link> in the Working With KstScript \
chapter.</para>  <para>To create a new plugin, using the following syntax:</para>
 <programlisting>plugin = new Plugin(Kst.pluginManager.modules["Plugin Name"])
-//the "Plugin Name" should be typed exactly  shown in the Create Plugin in the <link \
linkend="data-overview-datamanager">Data Manager</link>. +//the "Plugin Name" should \
be typed exactly as shown in the Create Plugin tab in the <link \
linkend="data-overview-datamanager">Data Manager</link>.  </programlisting>
 <para>To set input values of this plugin</para>
-<programlisting>plugin.setInput(<userinput>index of input</userinput>, \
<userinput>value of input</userinput>);</programlisting> \
+<programlisting>plugin.setInput(<replaceable>index of input</replaceable>, \
<replaceable>value of input</replaceable>);</programlisting>  <para>You must validate \
the plugin before you can get its outputs. To validate the plugin, use the following \
method: </para>  <programlisting>plugin.validate();</programlisting>
 <para>The output values stored in Kst as an objectcollection. To get an output of \
                this plugin, you need to specify its index: </para>
-<programlisting>v = plugin.outputs[<userinput>index of \
output</userinput>];</programlisting> +<programlisting>v = \
plugin.outputs[<replaceable>index of output</replaceable>];</programlisting>  \
<para>To know the index of inputs and outputs, refer to their appearing orders in \
dialogs of plugins UI.</para>  
 <para>See two examples below of using plugins through KstScript</para>


[prev in list] [next in list] [prev in thread] [next in thread]