[kst-plot] docbook/kst: Updates to the manual.
Barth Netterfield
null at kde.org
Mon Oct 30 12:34:14 UTC 2017
Git commit 31fca8c41f82052c73600e8190600b2874faa1c3 by Barth Netterfield.
Committed on 30/10/2017 at 12:32.
Pushed by netterfield into branch 'master'.
Updates to the manual.
M +- -- docbook/kst/Screenshot-kst-eq2.png
M +- -- docbook/kst/Screenshot-kst-eq2Plots.png
M +166 -337 docbook/kst/data-chapter.docbook
R +- -- docbook/kst/depricated/Diagram-kst-windowplotrelation.png [from: docbook/kst/Diagram-kst-windowplotrelation.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-datamode.png [from: docbook/kst/Screenshot-kst-datamode.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-labeleditor.png [from: docbook/kst/Screenshot-kst-labeleditor.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-mditabpage.png [from: docbook/kst/Screenshot-kst-mditabpage.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-mditoplevel.png [from: docbook/kst/Screenshot-kst-mditoplevel.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-multipleselectedplots.png [from: docbook/kst/Screenshot-kst-multipleselectedplots.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialogcontent.png [from: docbook/kst/Screenshot-kst-plotdialogcontent.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialoglabels.png [from: docbook/kst/Screenshot-kst-plotdialoglabels.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialoglegend.png [from: docbook/kst/Screenshot-kst-plotdialoglegend.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialoglimits.png [from: docbook/kst/Screenshot-kst-plotdialoglimits.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialogmarkers.png [from: docbook/kst/Screenshot-kst-plotdialogmarkers.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-plotdialogtop.png [from: docbook/kst/Screenshot-kst-plotdialogtop.png - 100% similarity]
R +- -- docbook/kst/depricated/Screenshot-kst-tiedzoom.png [from: docbook/kst/Screenshot-kst-tiedzoom.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-close.png [from: docbook/kst/Widget-kst-close.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-colourchooser.png [from: docbook/kst/Widget-kst-colourchooser.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-defaultcolours.png [from: docbook/kst/Widget-kst-defaultcolours.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-maximize.png [from: docbook/kst/Widget-kst-maximize.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-minimize.png [from: docbook/kst/Widget-kst-minimize.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-swapcolour.png [from: docbook/kst/Widget-kst-swapcolour.png - 100% similarity]
R +- -- docbook/kst/depricated/Widget-kst-undock.png [from: docbook/kst/Widget-kst-undock.png - 100% similarity]
R +0 -0 docbook/kst/depricated/plotsandwindows-chapter.docbook [from: docbook/kst/plotsandwindows-chapter.docbook - 100% similarity]
M +4 -4 docbook/kst/index.docbook
M +0 -2 docbook/kst/intro-chapter.docbook
M +1 -1 docbook/kst/tutorial.docbook
https://commits.kde.org/kst-plot/31fca8c41f82052c73600e8190600b2874faa1c3
diff --git a/docbook/kst/Screenshot-kst-eq2.png b/docbook/kst/Screenshot-kst-eq2.png
index 7f4a6117..b6015c40 100644
Binary files a/docbook/kst/Screenshot-kst-eq2.png and b/docbook/kst/Screenshot-kst-eq2.png differ
diff --git a/docbook/kst/Screenshot-kst-eq2Plots.png b/docbook/kst/Screenshot-kst-eq2Plots.png
index 102600be..f7287f65 100644
Binary files a/docbook/kst/Screenshot-kst-eq2Plots.png and b/docbook/kst/Screenshot-kst-eq2Plots.png differ
diff --git a/docbook/kst/data-chapter.docbook b/docbook/kst/data-chapter.docbook
index 36178e27..3cfe047d 100644
--- a/docbook/kst/data-chapter.docbook
+++ b/docbook/kst/data-chapter.docbook
@@ -198,7 +198,7 @@ icon in the tool bar.
<para>
As an example of how these various classes work together, consider the example session in the chapter on
- <link linkend="filters">Filters</link>. In this session, a curve from a data file was plotted, along with a low pass filtered version of the curve. The resulting data structures are as follows:
+ <link linkend="tutorial-filters">Filters</link>. In this session, a curve from a data file was plotted, along with a low pass filtered version of the curve. The resulting data structures are as follows:
</para>
@@ -240,7 +240,7 @@ Descriptions of each data type are provided below.
<sect2 id="vectors">
<title>Vectors</title>
<para>
-Vectors are ordered lists of numbers. They are used as the inputs to Data Objects. They are also used to define the X or Y axis for curves. While different types of vectors are created in different ways, they can call be used in Data Objects or curves in the same way.
+Vectors are ordered lists of numbers. They are used as the inputs to Data Objects. They are also used to define the X or Y axis for curves. While different types of vectors are created in different ways, they can all be used in Data Objects or curves in the same way.
</para>
<para>
@@ -455,7 +455,6 @@ Curves are created by the data wizard, from the creation dialog from Data Object
Functions supported by kst are:
</para>
-<literal>PLUGIN()</literal>
<itemizedlist>
<listitem>
<para>
@@ -469,11 +468,15 @@ Curves are created by the data wizard, from the creation dialog from Data Object
</listitem>
<listitem>
<para>
- Other functions: <literal>ABS()</literal>, <literal>SQRT()</literal>, <literal>CBRT()</literal>, <literal>SINH()</literal>, <literal>COSH()</literal>, <literal>TANH()</literal>, <literal>EXP()</literal>, <literal>LN()</literal>, <literal>LOG()</literal> and <literal>STEP()</literal>. <literal>STEP()</literal> returns 1 if the argument is greater than 0, and 0 otherwise.
+ Other functions: <literal>ABS()</literal> (absolute value), <literal>SQRT()</literal> (square root), <literal>CBRT()</literal> (cube root), <literal>SINH()</literal>, <literal>COSH()</literal>, <literal>TANH()</literal>, <literal>EXP()</literal>, <literal>LN()</literal> (natural logarithm), <literal>LOG()</literal> (base 10 logarithm) and <literal>STEP()</literal> (returns 1 if the argument is greater than 0, and 0 otherwise).
</para>
</listitem>
</itemizedlist>
+<para>
+ Equations also support the constants <literal>PI</literal> and <literal>e</literal>.
+</para>
+
<para>
Equations can use any vector or scalar as their input vectors, not just the X vector. In the next example, the bottom right plot shows the signal in Column 2 with the signal in Column 1 regressed out of it. This has been done by subtracting Column 1, scaled by the slope of a fit to Column 2 vs Column 1, from Column 2. The fit had been created previously using the <guimenuitem>Fit</guimenuitem> option in the right mouse button menu of the top right plot.
</para>
@@ -491,18 +494,11 @@ Curves are created by the data wizard, from the creation dialog from Data Object
</screenshot>
<para>
- The <guilabel>New Equation</guilabel> dialog which created this plot is shown below.
- Note that vectors are identified by enclosing their names in <literal>[ ]</literal>. So Column 2
- is indicated by <literal>[Column 2 (V2)]</literal>. The <guilabel>Equation</guilabel> line widget
- has a fairly powerful autocomplete mechanism with a scrollable list of all possible scalars (in
- its first colum) or vectors (in its second column) as you enter the name of the object. Similarly,
- the auto complete lists all valid functions and operators as relevant while you type. The
- <literal>Esc</literal> key hides the autocomplete widget.
+ The <guilabel>New Equation</guilabel> dialog which created this plot is shown below. Note that vectors are identified by enclosing their names in <literal>[ ]</literal>. So Column 2 is indicated by <literal>[Column 2 (V2)]</literal>. The <guilabel>Equation</guilabel> line widget has a fairly powerful autocomplete mechanism with a scrollable list of all possible scalars (in its first colum) or vectors (in its second column) as you enter the name of the object. Similarly, the auto complete lists all valid functions and operators as relevant while you type. The <literal>Esc</literal> key hides the autocomplete widget.
</para>
<para>
- If the vectors were set to <guilabel>Read to end</guilabel> mode, all elements would be updated real
- time as new data came in.
+ If the vectors were set to <guilabel>Read to end</guilabel> mode, all elements would be updated real time as new data came in.
</para>
<screenshot>
@@ -521,13 +517,40 @@ Curves are created by the data wizard, from the creation dialog from Data Object
<sect2 id="Histograms">
<title>Histograms</title>
+
+<para>
+ Histograms are data objects whose outputs are:
+</para>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector (<literal>...:num</literal>) which contains the (optionally normalized) count of samples from the input vector which lie within each interval.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector (<literal>...:bin</literal>) which contains the center of each interval for which the counts have been calculated.
+ </para>
+ </listitem>
+</itemizedlist>
+
+<para>
+ The input is:
+</para>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector for which the histogram is calculated.
+ </para>
+ </listitem>
+</itemizedlist>
+
<para>
-Histograms are data objects whose output vectors are the binned data,
-and the locations of the center of the bins. In the
-<guilabel>New Histogram</guilabel> dialog, the bins can be set manually,
-can be preset once by selecting <guilabel>Auto Bin</guilabel> or can be
-set to be automatically reset with each data update by selecting
-<guilabel>Real-time auto bin</guilabel>.
+In the <guilabel>New Histogram</guilabel> dialog, the bins can be set manually, can be preset once by selecting <guilabel>Auto Bin</guilabel> or can be set to be automatically reset with each data update by selecting <guilabel>Real-time auto bin</guilabel>.
+</para>
+
+<para>
+ By selecting <guilabel>Bargraph</guilabel> in the dialog, the histogram can be shown in the standard bar-graph form, below.
</para>
<screenshot>
@@ -558,11 +581,36 @@ set to be automatically reset with each data update by selecting
<sect2 id="power-spectra">
<title>Power Spectra</title>
+
+<para>
+ Power Spectra are data objects whose outputs are:
+</para>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector (<literal>...:psd</literal>) which contains the fft-based spectrum of the input
+ vector.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector (<literal>...:f</literal>) which contains the centers of the corresponding
+ frequency bins.
+ </para>
+ </listitem>
+</itemizedlist>
+
<para>
- Spectra are data objects whose outputs are a vector with the fft-based spectrum of the input
- vector (<literal>...:psd</literal>), and a vector containing the centers of the corresponding
- frequency bins (<literal>...:f</literal>).
+ The input is:
</para>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector for which the power spectrum is calculated. Uniform sampling is assumed.
+ </para>
+ </listitem>
+</itemizedlist>
+
<para>
The following plot shows an example spectrum. The plot has been converted to log-log mode (hit 'l' and 'g' in the plot window to toggle Y and X log axes respectvely).
@@ -671,371 +719,152 @@ Auto-generating axes labels for plots will be based on these units.
</para>
</listitem>
</varlistentry>
-
-
</variablelist>
</sect2>
-<sect2 id="plugins">
-<title>Plugins</title>
-<para>
-A plugin data object represents a &kst; plugin. All plugins have a common format, and show
-up as type <quote>Plugin</quote> in the Data Manager. For more information about plugins,
-please see <link linkend="pluginsandfilters">Plugins and Filters</link>
-</para>
-</sect2>
-
-<sect2 id="events">
-<title>Event Monitors</title>
-<para>
-An event monitor data object represents an instance of an event monitor. For more information on monitoring of events, see
-<link linkend="eventmonitoring">Event Monitoring</link>.
-</para>
-</sect2>
-
-
-<sect2 id="arrays">
-<title>Matrices</title>
-<para>
-A matrix represents a set of three-dimensional data points (x, y, z) arranged in a
-two-dimensional grid. The z values of the matrix are obtained from a vector, and the
-grid structure is manually specified using the Edit or New Matrix dialog. The descriptions
-below refer to the following diagram depicting &kst;'s matrix structure.
-</para>
-<para>
-<inlinemediaobject>
-<imageobject>
-<imagedata fileref="Diagram-kst-matrix.png" format="PNG"/>
-</imageobject>
-</inlinemediaobject>
-</para>
-<para>
-A screenshot and explanation of the matrix dialog follow.
-</para>
-<screenshot>
-<screeninfo>Matrix Window</screeninfo>
-<mediaobject>
-<imageobject>
-<imagedata fileref="Screenshot-kst-matrixwindow.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Matrix Window</phrase>
-</textobject>
-</mediaobject>
-</screenshot>
-
-<sect3 id="arrayvectorselection">
-<title>Vector Selection</title>
-
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>Z Vector</guilabel>
-</term>
-<listitem>
+<sect2 id="fits">
+<title>Fits</title>
<para>
-The data vector to obtain the z values from.
+ Fits are data objects whose outputs are:
</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="arraygridparameters">
-<title>Grid Parameters</title>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector (<literal>...:Fit</literal>) which is the fit to the data, evaluated at the X value corresponding to each input Y point.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector (<literal>...:Residuals</literal>) which is the difference between the input Y vector and the fit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ One or more named scalars which correspond to the fit parameters. For example, for linear fits, the scalars are <literal>...:Intercept</literal> and <literal>...:Gradient</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A scalar (<literal>...:chi^2/nu</literal> which holds the reduced chi squared of the fit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector (<literal>...:Covariance</literal>) which holds the Covariance matrix of the fit in an arbitrary order. Because the parameters are listed in an arbitrary order, this vector is not currently particularly useful.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector (<literal>...:Parameters</literal>) which is a list of the fit parameters in some arbitrary order. This vector is rarely useful and may be removed in the future. The named parameter scalars are a much more useful interface to the fit parameters.
+ </para>
+ </listitem>
+</itemizedlist>
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>X Minimum</guilabel> and <guilabel>Y Minimum</guilabel>
-</term>
-<listitem>
<para>
-The origin of the matrix is specified by the coordinates (X Minimum, Y Minimum).
-The location of the origin is represented by a red circle in the above diagram.
+ The inputs are:
</para>
-</listitem>
-</varlistentry>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector which is to be fit to. (The Y axis vector)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A vector which is used to generate the X values corresponding to the Y vector. Note that if the X vector is not the same length as the Y vector, then the X vector will be resampled to have the same number of points as the Y vector in order to generate a series of (X, Y) pairs.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If a weighted fit is chosen: A vector which describes the error bars for the Y vector.
+ </para>
+ </listitem>
+</itemizedlist>
-<varlistentry>
-<term>
-<guilabel>X Step Size</guilabel> and <guilabel>Y Step Size</guilabel>
-</term>
-<listitem>
<para>
-These two values specify the dimensions of each rectangular cell in the matrix grid. All cells
-in the matrix have identical dimensions.
+ A number of fits are available in kst, including weighted (in which the error bar for each Y value is specified) and unweighted fits to lines, polynomials, Gaussians, Lorentians, and exponentials.
</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<guilabel>Dimensions</guilabel> and <guilabel>Use maximum x length</guilabel>
-</term>
-<listitem>
<para>
-Enter the number of steps for the x dimension of the matrix, followed by the number of
-steps for the y dimension of the matrix. If <guilabel>Use maximum x length</guilabel> is
-checked, the x dimension of the matrix will be determined based on the length of the vector
-and the entered y dimension. If this option is checked and the length of the vector
-subsequently changes, the x dimension of the matrix will be updated accordingly.
+ The easiest way to create a fit is by selecting <guimenuitem>Create fit</guimenuitem> from the
+ plot context menu (right click in the plot, and then selecting the curve you would like to fit. The following dialog will appear.
</para>
-<para>
-Note that the minimum allowed y dimension is 1, while the minimum allowed x dimension is 0.
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-</sect2>
-<sect2 id="images">
-<title>Images</title>
-<para>
-Images are graphical representations of <link linkend="arrays">Matrices</link>. Images can be plotted
-as color maps, contour maps, or both.
-</para>
<screenshot>
-<screeninfo>Image Window</screeninfo>
+<screeninfo>New Spectrum Dialog</screeninfo>
<mediaobject>
<imageobject>
-<imagedata fileref="Screenshot-kst-imagewindow.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-fitdialog.png" format="PNG" />
</imageobject>
<textobject>
-<phrase>Image Window</phrase>
+<phrase>The Create Fit Dialog</phrase>
</textobject>
</mediaobject>
-</screenshot>
-
-<sect3 id="imagearrayselection">
-<title>Matrix Selection</title>
-
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>Matrix</guilabel>
-</term>
-<listitem>
-<para>
-Select the matrix to use for this image. New matrices can be created by clicking on the button to the right.
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="imageimagetype">
-<title>Image Type</title>
-
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>Color Map</guilabel>, <guilabel>Contour Map</guilabel>, and <guilabel>Color Map and Contour Map</guilabel>
-</term>
-<listitem>
-<para>
-Select the type of image to be plotted. Changing this selection enables or disables sections of the image dialog
-as appropriate.
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="imagecolormapparameters">
-<title>Color Map Parameters</title>
-<para>
-A color map represents the z value of each cell in the matrix using a color. This section is only available
-if <guilabel>Color Map</guilabel> or <guilabel>Color Map and Contour Map</guilabel> is selected under
-<guilabel>Image Type</guilabel>.
-</para>
-
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>Color palette</guilabel>
-</term>
-<listitem>
-<para>
-Select the color palette to use for the color map. By default, two palettes suitable for color maps are installed
-by &kst;—Kst Grayscale 256 (a 256 color grayscale palette) and Kst Spectrum 1021 (a 1021 color rainbow
-spectrum that ranges from blue to red). Additional palettes can be installed by simply copying
-<productname>GIMP</productname> compatible palette files to the <filename>colors</filename> subdirectory of
-the user configuration directory (for example, <filename>/usr/share/config/colors/</filename>). Note that
-saved images using a non-default palette may not be viewable by other users of &kst; if they do not have
-the required palette. In such cases, a default grayscale palette is used instead.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>
-<guilabel>Lower Z threshold</guilabel>, <guilabel>Upper Z threshold</guilabel> and <guibutton>Auto Threshold</guibutton>
-</term>
-<listitem>
-<para>
-Enter the lower and upper thresholds to use for the mapping of colors. Palette colors are evenly distributed
-between <guilabel>Lower Z threshold</guilabel> and <guilabel>Upper Z threshold</guilabel>. Any cells in the
-selected matrix with z values less than <guilabel>Lower Z threshold</guilabel> are mapped to the first color in the palette.
-Any cells in the selected matrix with z values greater than <guilabel>Upper Z threshold</guilabel> are mapped
-to the last color in the palette. Clicking <guibutton>Auto Threshold</guibutton> will fill in the
-lower and upper threshold values using the least and greatest z values found in the selected matrix.
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="imagecontourmapparameters">
-<title>Contour Map Parameters</title>
-<para>
-A contour map draws a set of lines, with each line representing a certain z value. This section is only available
-if <guilabel>Contour Map</guilabel> or <guilabel>Color Map and Contour Map</guilabel> is selected under
-<guilabel>Image Type</guilabel>.
-</para>
+</screenshot>
-<variablelist>
-<varlistentry>
-<term>
-<guilabel>Number of contour levels</guilabel>
-</term>
-<listitem>
<para>
-Select the number of contour levels to use. The contour levels will be distributed evenly between the lowest
-and highest z values found in the matrix.
+ A linear fit has been selected in the <guilabel>Plugin Selection</guilabel> combo box. The X and Y vectors have been automatically selected from the curve which was selected and can not be changed. The curve properties and placement of the automatically generated curve can be selected as usual.
</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<guibutton>Color</guibutton>
-</term>
-<listitem>
<para>
-Select the color to use for the contour lines. Clicking this button displays a standard &kde; color chooser
-dialog.
+ When <guibutton>Ok</guibutton> has been selected, the curve is placed in the selected plot, and a label with the fit parameters is automatically created. Click the mouse whereever you want the label to go.
</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<guilabel>Weight</guilabel> and <guilabel>Use variable line weight</guilabel>
-</term>
-<listitem>
<para>
-Select the weight, or <quote>thickness</quote> of the contour lines. If <guilabel>Use variable line weight</guilabel>
-is selected, contour lines representing higher elevations are drawn thicker than those representing lower elevations.
-Use discretion when selecting this option, as images with high contour line densities may become unreadable.
+ You can also create a fit plugin by selecting the appropriate fit from the <guimenu>Fit plugin</guimenu> submenu in the <guimenu>Create</guimenu> menu. With this dialog you can select the input vectors, but it does not automatically create a curve. You will have to create a curve by hand by selecting <guimenu>Curve</guimenu> in the <guimenu>Create</guimenu> menu.
</para>
-</listitem>
-</varlistentry>
-
-</variablelist>
-</sect3>
</sect2>
-</sect1>
-
-
-<sect1 id="thedatamenu">
-<title>The Data Menu</title>
-<para>
-The <guimenu>Data</guimenu> menu provides quick access to many features related to data objects in
-&kst;. Most of the menu functions duplicate functions found elsewhere, so only brief descriptions are
-provided below.
-</para>
-<variablelist>
-<varlistentry>
-<term><guimenuitem>Reload</guimenuitem></term>
-<listitem>
+<sect2 id="filters">
+<title>Filters</title>
<para>
-Reloads all data vectors from their source files.
+ Filters are data objects whose output is:
</para>
-</listitem>
-</varlistentry>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector (<literal>...:Filtered</literal>) which is the same size as the input vector.
+ </para>
+ </listitem>
+</itemizedlist>
-<varlistentry>
-<term><guimenuitem>Data Wizard...</guimenuitem></term>
-<listitem>
<para>
-Displays the Data Wizard.
+ The inputs are:
</para>
-</listitem>
-</varlistentry>
+<itemizedlist>
+ <listitem>
+ <para>
+ A vector which is to be filtered.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A number of scalars, unique to each filter, which are parameters for the filter.
+ </para>
+ </listitem>
+</itemizedlist>
-<varlistentry>
-<term><guimenuitem>Data Manager</guimenuitem></term>
-<listitem>
-<para>
-Displays the <link linkend="datamanager">Data Manager</link>.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><guimenuitem>New</guimenuitem> [data object]</term>
-<listitem>
-<para>
-Displays the corresponding dialog for creating the data object. Refer to
-<link linkend="datatypes">Data Types</link> for descriptions of
-each dialog.
-</para>
-</listitem>
-</varlistentry>
+</sect2>
-<varlistentry>
-<term><guimenuitem>View Scalars</guimenuitem></term>
-<listitem>
-<para>
-Displays a dialog from which the values of all the scalars in the current &kst; session
-can be viewed. The dialog is updated dynamically if the values change.
-</para>
-</listitem>
-</varlistentry>
+<sect2 id="plugins">
+<title>Other Plugins</title>
+</sect2>
-<varlistentry>
-<term><guimenuitem>View Vectors</guimenuitem></term>
-<listitem>
-<para>
-Displays a dialog from which the values in all the current vectors can be viewed. Select
-a vector to view using the drop-down list. The dialog
-is updated dynamically if the values change.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><guimenuitem>View Fit Results</guimenuitem></term>
-<listitem>
-<para>
-Displays a dialog which shows all the resulting values from performed fits. Select
-a fit result to view using the drop-down list. The dialog
-is updated dynamically if the values change.
-</para>
-</listitem>
-</varlistentry>
+<sect2 id="arrays">
+<title>Matrices</title>
+</sect2>
-<varlistentry>
-<term><guimenuitem>Change Data File</guimenuitem></term>
-<listitem>
-<para>
-Displays a dialog for quickly changing data files that vectors are associated with. Select the vectors
-to change, and then browse to a different data file. Click <guibutton>Apply</guibutton> to save the changes.
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
+<sect2 id="images">
+<title>Images</title>
+</sect2>
</sect1>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
diff --git a/docbook/kst/Diagram-kst-windowplotrelation.png b/docbook/kst/depricated/Diagram-kst-windowplotrelation.png
similarity index 100%
rename from docbook/kst/Diagram-kst-windowplotrelation.png
rename to docbook/kst/depricated/Diagram-kst-windowplotrelation.png
diff --git a/docbook/kst/Screenshot-kst-datamode.png b/docbook/kst/depricated/Screenshot-kst-datamode.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-datamode.png
rename to docbook/kst/depricated/Screenshot-kst-datamode.png
diff --git a/docbook/kst/Screenshot-kst-labeleditor.png b/docbook/kst/depricated/Screenshot-kst-labeleditor.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-labeleditor.png
rename to docbook/kst/depricated/Screenshot-kst-labeleditor.png
diff --git a/docbook/kst/Screenshot-kst-mditabpage.png b/docbook/kst/depricated/Screenshot-kst-mditabpage.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-mditabpage.png
rename to docbook/kst/depricated/Screenshot-kst-mditabpage.png
diff --git a/docbook/kst/Screenshot-kst-mditoplevel.png b/docbook/kst/depricated/Screenshot-kst-mditoplevel.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-mditoplevel.png
rename to docbook/kst/depricated/Screenshot-kst-mditoplevel.png
diff --git a/docbook/kst/Screenshot-kst-multipleselectedplots.png b/docbook/kst/depricated/Screenshot-kst-multipleselectedplots.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-multipleselectedplots.png
rename to docbook/kst/depricated/Screenshot-kst-multipleselectedplots.png
diff --git a/docbook/kst/Screenshot-kst-plotdialogcontent.png b/docbook/kst/depricated/Screenshot-kst-plotdialogcontent.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialogcontent.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialogcontent.png
diff --git a/docbook/kst/Screenshot-kst-plotdialoglabels.png b/docbook/kst/depricated/Screenshot-kst-plotdialoglabels.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialoglabels.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialoglabels.png
diff --git a/docbook/kst/Screenshot-kst-plotdialoglegend.png b/docbook/kst/depricated/Screenshot-kst-plotdialoglegend.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialoglegend.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialoglegend.png
diff --git a/docbook/kst/Screenshot-kst-plotdialoglimits.png b/docbook/kst/depricated/Screenshot-kst-plotdialoglimits.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialoglimits.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialoglimits.png
diff --git a/docbook/kst/Screenshot-kst-plotdialogmarkers.png b/docbook/kst/depricated/Screenshot-kst-plotdialogmarkers.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialogmarkers.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialogmarkers.png
diff --git a/docbook/kst/Screenshot-kst-plotdialogtop.png b/docbook/kst/depricated/Screenshot-kst-plotdialogtop.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-plotdialogtop.png
rename to docbook/kst/depricated/Screenshot-kst-plotdialogtop.png
diff --git a/docbook/kst/Screenshot-kst-tiedzoom.png b/docbook/kst/depricated/Screenshot-kst-tiedzoom.png
similarity index 100%
rename from docbook/kst/Screenshot-kst-tiedzoom.png
rename to docbook/kst/depricated/Screenshot-kst-tiedzoom.png
diff --git a/docbook/kst/Widget-kst-close.png b/docbook/kst/depricated/Widget-kst-close.png
similarity index 100%
rename from docbook/kst/Widget-kst-close.png
rename to docbook/kst/depricated/Widget-kst-close.png
diff --git a/docbook/kst/Widget-kst-colourchooser.png b/docbook/kst/depricated/Widget-kst-colourchooser.png
similarity index 100%
rename from docbook/kst/Widget-kst-colourchooser.png
rename to docbook/kst/depricated/Widget-kst-colourchooser.png
diff --git a/docbook/kst/Widget-kst-defaultcolours.png b/docbook/kst/depricated/Widget-kst-defaultcolours.png
similarity index 100%
rename from docbook/kst/Widget-kst-defaultcolours.png
rename to docbook/kst/depricated/Widget-kst-defaultcolours.png
diff --git a/docbook/kst/Widget-kst-maximize.png b/docbook/kst/depricated/Widget-kst-maximize.png
similarity index 100%
rename from docbook/kst/Widget-kst-maximize.png
rename to docbook/kst/depricated/Widget-kst-maximize.png
diff --git a/docbook/kst/Widget-kst-minimize.png b/docbook/kst/depricated/Widget-kst-minimize.png
similarity index 100%
rename from docbook/kst/Widget-kst-minimize.png
rename to docbook/kst/depricated/Widget-kst-minimize.png
diff --git a/docbook/kst/Widget-kst-swapcolour.png b/docbook/kst/depricated/Widget-kst-swapcolour.png
similarity index 100%
rename from docbook/kst/Widget-kst-swapcolour.png
rename to docbook/kst/depricated/Widget-kst-swapcolour.png
diff --git a/docbook/kst/Widget-kst-undock.png b/docbook/kst/depricated/Widget-kst-undock.png
similarity index 100%
rename from docbook/kst/Widget-kst-undock.png
rename to docbook/kst/depricated/Widget-kst-undock.png
diff --git a/docbook/kst/plotsandwindows-chapter.docbook b/docbook/kst/depricated/plotsandwindows-chapter.docbook
similarity index 100%
rename from docbook/kst/plotsandwindows-chapter.docbook
rename to docbook/kst/depricated/plotsandwindows-chapter.docbook
diff --git a/docbook/kst/index.docbook b/docbook/kst/index.docbook
index 70f1a4e2..ed09a516 100644
--- a/docbook/kst/index.docbook
+++ b/docbook/kst/index.docbook
@@ -14,14 +14,14 @@
<!ENTITY install-chapter SYSTEM "install-chapter.docbook">
<!ENTITY license-chapter SYSTEM "license-chapter.docbook">
<!ENTITY saving-chapter SYSTEM "saving-chapter.docbook">
- <!ENTITY plotsandwindows-chapter SYSTEM "plotsandwindows-chapter.docbook">
+ <!--ENTITY plotsandwindows-chapter SYSTEM "plotsandwindows-chapter.docbook"-->
<!ENTITY additionalformats-chapter SYSTEM "additionalformats-chapter.docbook">
<!ENTITY creatingplugins-chapter SYSTEM "creatingplugins-chapter-new.docbook">
<!ENTITY miscfeatures-chapter SYSTEM "miscfeatures-chapter.docbook">
<!ENTITY debuglog-chapter SYSTEM "debuglog-chapter.docbook">
<!ENTITY dcop-chapter SYSTEM "dcop-chapter.docbook">
<!ENTITY commandline-chapter SYSTEM "commandline-chapter.docbook">
- <!ENTITY eventmonitoring-chapter SYSTEM "eventmonitoring-chapter.docbook">
+ <!--ENTITY eventmonitoring-chapter SYSTEM "eventmonitoring-chapter.docbook"-->
]>
<book id="kst" lang="&language;">
@@ -116,11 +116,11 @@ the order. -->
&commontasks-chapter;
-&plotsandwindows-chapter;
+<!--&plotsandwindows-chapter; -->
&saving-chapter;
-&eventmonitoring-chapter;
+<!--&eventmonitoring-chapter;-->
&plugins-chapter;
diff --git a/docbook/kst/intro-chapter.docbook b/docbook/kst/intro-chapter.docbook
index 7949fa11..400b0811 100644
--- a/docbook/kst/intro-chapter.docbook
+++ b/docbook/kst/intro-chapter.docbook
@@ -115,8 +115,6 @@ If &kst; is started without any command-line options, an unfilled kst window is
first step is to create plots from the Data Wizard (click the <guimenuitem>Data Wizard...</guimenuitem> toolbar button
or press 'w').
The data wizard walks through the specification of a data file, selection of fields, and selection of plot options.
-For detailed descriptions of
-the data wizard options and settings, refer to the <link linkend="datawizard">Data Wizard</link> section.
</para>
<para>
diff --git a/docbook/kst/tutorial.docbook b/docbook/kst/tutorial.docbook
index 618bb587..fda5cad7 100644
--- a/docbook/kst/tutorial.docbook
+++ b/docbook/kst/tutorial.docbook
@@ -767,7 +767,7 @@ Then, from the <guimenu>Create</guimenu> menu select
</para>
</sect1>
-<sect1 id="filters">
+<sect1 id="tutorial-filters">
<title>Filters</title>
<para>
With &kst;, we can apply a variety of fits and filters to vectors in kst.
More information about the kde-doc-english
mailing list