6 changes: 3 additions & 3 deletions docbook/kst/additionalformats-chapter.docbook
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<appendix id="supportingadditionalfileformats">
<title>Supporting Additional File Formats</title>
<sect2>
<title>WARNING: This section was written for Kst version 1 and may be somewhat, or even totally obsolete. WARNING</title>
</sect2>
<warning>
<para>WARNING: This section was written for Kst version 1 and may be somewhat, or even totally obsolete. WARNING</para>
</warning>
<para>
This section describes
how to create additional
Expand Down
6 changes: 3 additions & 3 deletions docbook/kst/creatingplugins-chapter-new.docbook
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<appendix id="creatingplugins">
<title>Creating Additional Plugins</title>
<sect2>
<title>WARNING: This section was written for Kst version 1 and may be somewhat, or even totally obsolete. WARNING</title>
</sect2>
<warning>
<para>WARNING: This section was written for Kst version 1 and may be somewhat, or even totally obsolete. WARNING</para>
</warning>

<para>
&kst; has a simple and standardized interface that facilitates easy creation of additional plugins.
Expand Down
28 changes: 14 additions & 14 deletions docbook/kst/data-chapter.docbook
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ However, for other data sources (eg, dirfiles), there may be multiple samples pe
In the figure, imagine that time proceeds from top to bottom. &kst; assumes that the first sample in a frame is simultaneous for every field in the data source, and that the rest of the samples are sampled evenly throughout the frame, as shown.
</para>
<para>
When plotting one vector agains another, &kst; assumes that the first and last samples of each vector are simultaneous, and interpolates the shorter vector up to the resolution of the longer vector. Since only the first sample in a frame can be assumed to be simultaneous across fields, <emphasis>when &kst; reads data into a vector, it only reads up to the first sample of the last frame requested,</emphasis> so that plotting one vector against another will make sense. The rest of the last frame will not be read.
When plotting one vector against another, &kst; assumes that the first and last samples of each vector are simultaneous, and interpolates the shorter vector up to the resolution of the longer vector. Since only the first sample in a frame can be assumed to be simultaneous across fields, <emphasis>when &kst; reads data into a vector, it only reads up to the first sample of the last frame requested,</emphasis> so that plotting one vector against another will make sense. The rest of the last frame will not be read.
</para>
<para>
So if the first three frames of Field1 and Field2 are read from the data source in the figure, 3 samples will be read from Field1, and 9 samples will be read from Field2 (ending at first sample of Frame 3) - not 12 as one might expect.
Expand All @@ -76,7 +76,7 @@ As well as the explicit data fields in a data file, &kst; implicitly creates an
<sect2 id="creatingascii">
<title>ASCII Input Files</title>
<para>
&kst; is capable of reading vectors from a wide range of ASCII formats. As long as the data are in columns, and as long as each non-comment row has the same number of collumns, &kst; can probably read it.
&kst; is capable of reading vectors from a wide range of ASCII formats. As long as the data are in columns, and as long as each non-comment row has the same number of columns, &kst; can probably read it.
</para>
<para>
Consider reading this simple ASCII csv file: each comma separated column represents a field.
Expand Down Expand Up @@ -157,10 +157,10 @@ icon in the tool bar.
</para>

<para>
Items can also be deleted from this dialog by selecting them and clicking <guibutton>Delete</guibutton>. This will delete the selected item and all items which depend on it. So if you delete a vector, all curves, spectra, historgrams, or equations that depend on it will also be deleted. Be careful, because this can not be undone.
Items can also be deleted from this dialog by selecting them and clicking <guibutton>Delete</guibutton>. This will delete the selected item and all items which depend on it. So if you delete a vector, all curves, spectra, histograms, or equations that depend on it will also be deleted. Be careful, because this can not be undone.
</para>
<para>
Clicking <guibutton>Purge</guibutton> will remove all undisplayed data objects. If deleting an object (and everthing that depends on it) will not change any plots or labels, then it is deleted. Nothing that is displayed is deleted. This can not be undone.
Clicking <guibutton>Purge</guibutton> will remove all undisplayed data objects. If deleting an object (and everything that depends on it) will not change any plots or labels, then it is deleted. Nothing that is displayed is deleted. This can not be undone.
</para>

</sect1>
Expand Down Expand Up @@ -217,7 +217,7 @@ icon in the tool bar.
</para>

<para>
The plot displays two curves. One curve takes two data vectors (INDEX and Column 2) as inputs. The other takes INDEX as its X vector, and the ouput vector of the Low Pass Filter as its Y vector. The low pass filter takes the Column 2 vector, and two Scalars as its inputs. The two data vectors get their data from the Data Source.
The plot displays two curves. One curve takes two data vectors (INDEX and Column 2) as inputs. The other takes INDEX as its X vector, and the output vector of the Low Pass Filter as its Y vector. The low pass filter takes the Column 2 vector, and two Scalars as its inputs. The two data vectors get their data from the Data Source.
</para>

<para>
Expand Down Expand Up @@ -251,7 +251,7 @@ Vectors are ordered lists of numbers. They are used as the inputs to Data Objec
<itemizedlist>
<listitem>
<para>
Data Vectors aquire their data from Data Sources (ie, data files). They can be created from the <guimenuitem>Vector</guimenuitem> option in the <guimenu>Create</guimenu> menu, or by selecting the
Data Vectors acquire their data from Data Sources (ie, data files). They can be created from the <guimenuitem>Vector</guimenuitem> option in the <guimenu>Create</guimenu> menu, or by selecting the

<inlinemediaobject>
<imageobject>
Expand Down Expand Up @@ -335,11 +335,11 @@ Curves are created by the data wizard, from the creation dialog from Data Object
</para>

<para>
The appearance of curves is adjusted in the <guilabel>Appearance</guilabel> box. Some of the flexability of curves in kst is shown in the next figure.
The appearance of curves is adjusted in the <guilabel>Appearance</guilabel> box. Some of the flexibility of curves in kst is shown in the next figure.
Note that the options are not exclusive - for example, <guilabel>Lines</guilabel> and <guilabel>Points</guilabel> can both be selected. The <guilabel>Size</guilabel> field specifies the dimensions of display elements such as points and error flags in points (the same way as font sizes are defined.)
The <guilabel>Weight</guilabel> field specifies the width of lines,
bar graph borders, and the strokes for points. The color selector to the right of the example line sets the color of lines, points, and bargraph borders. The color selector to the right of the <guilabel>Bargraph</guilabel> checkbox sets the fill color for bargraphs. The last (most recent) point of a
curve can be indicated by slecting <guilabel>Head</guilabel> and specifying
curve can be indicated by selecting <guilabel>Head</guilabel> and specifying
a point type and color. The color selector to the right of the <guilabel>Head</guilabel> sets the color for this point.
</para>

Expand Down Expand Up @@ -497,7 +497,7 @@ 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 column) 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>
Expand Down Expand Up @@ -616,7 +616,7 @@ In the <guilabel>New Histogram</guilabel> dialog, the bins can be set manually,


<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).
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 respectively).
</para>

<screenshot>
Expand Down Expand Up @@ -682,7 +682,7 @@ Remove a constant from the input vector to make it mean zero before calculating
<listitem>
<para>
Apodize the data with the selected function before calculating the power spectrum to reduce
bin to bin leackage. The default is a Hanning Window.
bin to bin leakage. The default is a Hanning Window.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -858,7 +858,7 @@ Auto-generating axes labels for plots will be based on these units.
</para>

<para>
For fields such as angles which have (for example) a discontinuity at 360 degrees, the Unwind Fliter can be used to make the signal continuous. So if the unfiltered signal goes from 359.5 degrees to 0.5 degrees in consecutive samples, the filtered signal will go from 359.5 degrees to 360.5 degrees.
For fields such as angles which have (for example) a discontinuity at 360 degrees, the Unwind Filter can be used to make the signal continuous. So if the unfiltered signal goes from 359.5 degrees to 0.5 degrees in consecutive samples, the filtered signal will go from 359.5 degrees to 360.5 degrees.
</para>

<para>
Expand Down Expand Up @@ -895,7 +895,7 @@ Matrices are two dimensional tables of numbers. They can be used as the inputs
<itemizedlist>
<listitem>
<para>
Data Matrices aquire their data from Data Sources (ie, data files). They can be created from the <guimenuitem>Matrix</guimenuitem> option in the <guimenu>Create</guimenu> menu, or by selecting the
Data Matrices acquire their data from Data Sources (ie, data files). They can be created from the <guimenuitem>Matrix</guimenuitem> option in the <guimenu>Create</guimenu> menu, or by selecting the

<inlinemediaobject>
<imageobject>
Expand Down Expand Up @@ -951,7 +951,7 @@ Matrices are two dimensional tables of numbers. They can be used as the inputs
</listitem>
<listitem>
<para>
BIT Image Streams (BIS) fiiles.
BIT Image Streams (BIS) files.
</para>
</listitem>
</itemizedlist>
Expand Down
14 changes: 7 additions & 7 deletions docbook/kst/debuglog-chapter.docbook
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<appendix id="debuglog">
<title>Troubleshooting</title>
<para>
Unfortunately, things can sometimes go wrong with &kst;. This section lists somee things that can be useful to unbreak things.
Unfortunately, things can sometimes go wrong with &kst;. This section lists some things that can be useful to unbreak things.
</para>

<sect3>
<sect1>
<title>Clearing Defaults</title>

<para>
For convenience reasons, &kst; makes agressive use of sticky defaults - that is to say, &kst; will generally remember what you did last time, and make that the new default behaviour. Unfortunately, this can sometimes leave the program in an odd state where the assumptions it is making make no sense. This most often happens with files and file defaults.
For convenience reasons, &kst; makes aggressive use of sticky defaults - that is to say, &kst; will generally remember what you did last time, and make that the new default behaviour. Unfortunately, this can sometimes leave the program in an odd state where the assumptions it is making make no sense. This most often happens with files and file defaults.
</para>

<para>
If you find that &kst; has broken for you (that is, something that used to work no longer does), bad defaults is a pretty plausable explaination (though we do keep trying to track these situations down and remove them). You can completely restore &kst; to it's default, just-installed configuration by selecting <guimenuitem>Clear datasource settings</guimenuitem> and <guimenuitem>Clear settings and defaults</guimenuitem> from the <guimenu>Settings</guimenu> menu. Unfortunately, this will erase all of your settings and defaults, but it may be necessary in some cases. If the problem seems to have something to do with data files, try <guimenuitem>Clear datasource settings</guimenuitem> first because it is generally less destructive and more likely to help.
If you find that &kst; has broken for you (that is, something that used to work no longer does), bad defaults is a pretty plausible explanation (though we do keep trying to track these situations down and remove them). You can completely restore &kst; to it's default, just-installed configuration by selecting <guimenuitem>Clear datasource settings</guimenuitem> and <guimenuitem>Clear settings and defaults</guimenuitem> from the <guimenu>Settings</guimenu> menu. Unfortunately, this will erase all of your settings and defaults, but it may be necessary in some cases. If the problem seems to have something to do with data files, try <guimenuitem>Clear datasource settings</guimenuitem> first because it is generally less destructive and more likely to help.
</para>
</sect3>
</sect1>

<sect3>
<sect1>
<title>The Debug Dialog</title>

<para>
Expand All @@ -26,7 +26,7 @@ Unfortunately, things can sometimes go wrong with &kst;. This section lists som
<para>
The Log tab provides a log the loading of all data sources and data plugins, as well as logging some errors, such as out of memory errors. This log tab can be a useful place to look if things are not working out well.
</para>
</sect3>
</sect1>

</appendix>

Expand Down
7 changes: 5 additions & 2 deletions docbook/kst/plugins-chapter.docbook
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
<chapter id="pluginsandfilters">
<title>Plugins, Fits, and Filters</title>

<sect1>
<title>Using Plugins, Fits, and Filters</title>
<para>
Many of the mathematical data operators in &kst;, including fits and filters, are implemented as plugins. Plugins are loaded at run time and use a stable API, so it is possible to write your own plugins and include them in your local installation without re-compiling &kst;. Fits and Filters are simply subsets of the set of plugins, and thus behave identically to generic plugins, with the exception of additional convenience dialog functionality when selected from the plot contect menu. See <link linkend="fits">here</link> for a general description of the creation of fits and filters.
Many of the mathematical data operators in &kst;, including fits and filters, are implemented as plugins. Plugins are loaded at run time and use a stable API, so it is possible to write your own plugins and include them in your local installation without re-compiling &kst;. Fits and Filters are simply subsets of the set of plugins, and thus behave identically to generic plugins, with the exception of additional convenience dialog functionality when selected from the plot context menu. See <link linkend="fits">here</link> for a general description of the creation of fits and filters.
</para>

<para>
Expand Down Expand Up @@ -2319,7 +2322,7 @@ The kurtosis of the data set.
</sect2>

<!-- End the long plugins section -->

</sect1>

</chapter>

Expand Down
9 changes: 5 additions & 4 deletions docbook/kst/saving-chapter.docbook
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<chapter id="savingandexporting">
<title>Saving and Printing</title>
<sect1>
<title>Saving and Exporting</title>
<para>
&kst; provides various methods of saving and exporting data and plots. These methods are described below.
</para>
Expand Down Expand Up @@ -33,7 +34,7 @@

<listitem>
<para>
Copy Tab Image: A bitmap image of the current tab contents can be saved to the clipbard for pasting into an other application by Selecting <guimenuitem>Copy Tab Image</guimenuitem> from the <guimenu>Edit</guimenu>. The image will have the dimensions (in pixels) of the tab in the kst window.
Copy Tab Image: A bitmap image of the current tab contents can be saved to the clipboard for pasting into an other application by Selecting <guimenuitem>Copy Tab Image</guimenuitem> from the <guimenu>Edit</guimenu>. The image will have the dimensions (in pixels) of the tab in the kst window.
</para>
</listitem>

Expand All @@ -47,7 +48,7 @@
<title>Saving</title>

<para>
Selecting <guimenuitem>Save</guimenuitem> or <guimenuitem>Save As</guimenuitem> from the <guimenu>File</guimenu> menu will save the state of the current kst session. By default, these session files have the extentions <literal>.kst</literal>. If this session file is opened later, the state of kst, including the loading of all data files, and the saving of all plots will be returned to the state when it was saved.
Selecting <guimenuitem>Save</guimenuitem> or <guimenuitem>Save As</guimenuitem> from the <guimenu>File</guimenu> menu will save the state of the current kst session. By default, these session files have the extensions <literal>.kst</literal>. If this session file is opened later, the state of kst, including the loading of all data files, and the saving of all plots will be returned to the state when it was saved.
</para>

</sect2>
Expand Down Expand Up @@ -164,7 +165,7 @@ To print, select <guimenuitem>Print...</guimenuitem> from the <guimenu>File</gui
If the OS supports it, the plots can be exported here to a pdf file. Otherwise, you can use the <link linkend="exportinggraphics">Exporting Tabs</link> option described in the next section to export to a pdf file.
</para>
<para>
Each page will be rescaled to fit whatever page size and orientation has been selected. The scaling and resizing rules are the same when a &kst; window is resized. If the page is the same size as has been set as the <guilabel>Reference view size</guilabel> (under <guilabel>Scaling</guilabel> in the <guilabel>Kst Settings</guilabel> dialog, selected by <guimenuitem>Configure Kst</guimenuitem> from the <guimenu>Settings</guimenu> menu), then the fonts will all have the sizes they have been set to in the various dialogs. If the selected print size is larger or smaller than this, then the fonts will be also be proportionaly larger or smaller.
Each page will be rescaled to fit whatever page size and orientation has been selected. The scaling and resizing rules are the same when a &kst; window is resized. If the page is the same size as has been set as the <guilabel>Reference view size</guilabel> (under <guilabel>Scaling</guilabel> in the <guilabel>Kst Settings</guilabel> dialog, selected by <guimenuitem>Configure Kst</guimenuitem> from the <guimenu>Settings</guimenu> menu), then the fonts will all have the sizes they have been set to in the various dialogs. If the selected print size is larger or smaller than this, then the fonts will be also be proportionally larger or smaller.
</para>
</sect1>

Expand All @@ -187,7 +188,7 @@ from the <guimenu>File</guimenu> menu. The following dialog box will appear.
</screenshot>

<para>
The root file name is specified in the <guilabel>File name:</guilabel> entry. If <guilabel>Automatic extension</guilabel> is selected, then the file name extension appropriate to the file type is automacially added to the file name.
The root file name is specified in the <guilabel>File name:</guilabel> entry. If <guilabel>Automatic extension</guilabel> is selected, then the file name extension appropriate to the file type is automatically added to the file name.
</para>

<para>
Expand Down
Loading