Git commit 1ee95631667c0cf0a0e3afcf8c77f9b0d482465f by Barth Netterfield. Committed on 26/03/2018 at 15:19. Pushed by netterfield into branch 'master'.
Remove some obsolete files from the docs. D +- -- docbook/kst/Screenshot-kst-eventmonitor-loggingsettings.png D +- -- docbook/kst/Screenshot-kst-eventmonitor-serversettings.png D +- -- docbook/kst/Screenshot-kst-eventmonitor.png D +- -- docbook/kst/Screenshot-kst-open-file-button.png D +- -- docbook/kst/Screenshot-kst-quickstart.png D +0 -275 docbook/kst/commontasks-chapter.docbook D +0 -340 docbook/kst/eventmonitoring-chapter.docbook M +0 -12 docbook/kst/index.docbook D +- -- docbook/kst/index.tex https://commits.kde.org/kst-plot/1ee95631667c0cf0a0e3afcf8c77f9b0d482465f diff --git a/docbook/kst/Screenshot-kst-eventmonitor-loggingsettings.png b/docbook/kst/Screenshot-kst-eventmonitor-loggingsettings.png deleted file mode 100644 index c6698e60..00000000 Binary files a/docbook/kst/Screenshot-kst-eventmonitor-loggingsettings.png and /dev/null differ diff --git a/docbook/kst/Screenshot-kst-eventmonitor-serversettings.png b/docbook/kst/Screenshot-kst-eventmonitor-serversettings.png deleted file mode 100644 index f5441a8c..00000000 Binary files a/docbook/kst/Screenshot-kst-eventmonitor-serversettings.png and /dev/null differ diff --git a/docbook/kst/Screenshot-kst-eventmonitor.png b/docbook/kst/Screenshot-kst-eventmonitor.png deleted file mode 100644 index 8459548b..00000000 Binary files a/docbook/kst/Screenshot-kst-eventmonitor.png and /dev/null differ diff --git a/docbook/kst/Screenshot-kst-open-file-button.png b/docbook/kst/Screenshot-kst-open-file-button.png deleted file mode 100644 index 7addbeb9..00000000 Binary files a/docbook/kst/Screenshot-kst-open-file-button.png and /dev/null differ diff --git a/docbook/kst/Screenshot-kst-quickstart.png b/docbook/kst/Screenshot-kst-quickstart.png deleted file mode 100644 index 5895aa75..00000000 Binary files a/docbook/kst/Screenshot-kst-quickstart.png and /dev/null differ diff --git a/docbook/kst/commontasks-chapter.docbook b/docbook/kst/commontasks-chapter.docbook deleted file mode 100644 index 26f92666..00000000 --- a/docbook/kst/commontasks-chapter.docbook +++ /dev/null @@ -1,275 +0,0 @@ -<chapter id="common-tasks"> -<title>Common Tasks</title> - -<para>This chapter contains instructions for performing basic tasks -with &kst;. It runs through the method for performing each task in the -simplest way. Links to the sections of the handbook with more in-depth -information are also given.</para> - -<sect1 id="plotting-simple-graphs"> -<title>Plotting Simple Graphs</title> - -<para>How to plot a simple points-on-a-grid graph</para> - -<para>The first thing you'll want to do with &kst; is probably to plot -a simple graph. Here's the procedure:</para> - -<orderedlist> - -<listitem><para>Choose your data file. &kst; will read many types of -data file, the simplest being a plain text (<acronym>ASCII</acronym>) -file with the data in columns. For definiteness, we'll use the data -file from <xref linkend="gettingstarted"/>, with the filename <filename>simpledata.dat</filename>.</para> -</listitem> - -<listitem><para>Open &kst;. You are presented with the -<guilabel>QuickStart</guilabel> dialog: - -<screenshot> -<screeninfo>The QuickStart dialog</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-quickstart.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>The QuickStart dialog</phrase> -</textobject> -</mediaobject> -</screenshot> -</para> - -<para>Click on <guibutton>Data Wizard</guibutton>, and, in the wizard -that appears, select your data file using the <guibutton>Open -File</guibutton> button: -<inlinemediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-open-file-button.png" format="PNG" -/> -</imageobject> -</inlinemediaobject>. -</para> -</listitem> - -<listitem> -<para>The <guibutton>Next</guibutton> page is where you select which -data to use. Column 2 in the data file contains the y-axis values, so -tick the box next to 2 in the <guilabel>Field/Column</guilabel> list on the -left-hand side. The INDEX field is a special field created by &kst;, -but we won't be using it for this example.</para> -</listitem> - -<listitem> -<para>Under <guilabel>Plot Types</guilabel>, leave the default -<guilabel>XY</guilabel> as it is, but change the <guilabel>X axis -vector</guilabel> to 1.</para> -</listitem> - -<listitem> -<para>On the next page, we'll just change one thing: under -<guilabel>Curve Style</guilabel>, select <guilabel>Points -only</guilabel> to draw just the data points, and not lines joining them.</para> -</listitem> - -<listitem> -<para>Click on <guibutton>Finish</guibutton> and you're done! The new -plot appears in the main &kst; window.</para> -</listitem> - -</orderedlist> - -<!-- TODO: Link to other places in the handbook, perhaps with a little --> -<!-- more description --> - -</sect1> - -<sect1 id="curve-fitting"> -<title>Curve Fitting</title> - -<para>&kst; also provides functions for many different types of curve -fitting: linear, quadratic, sinusoidal, and more. As an example, we'll -do a simple polynomial fit to the curve we plotted previously, in <xref linkend="plotting-simple-graphs"/>.</para> - -<orderedlist> - -<listitem><para>With the plot done, open the plugins dialog from -<menuchoice><guimenu>Data</guimenu><guimenuitem>New Plugin</guimenuitem> -</menuchoice>.</para> -</listitem> - -<listitem><para>The <guilabel>Plot selection</guilabel> combo box -contains all the &kst; fitting plugins, and more. Since the example -data here are quadratic, we'll use the <guilabel>Fit -polynomial</guilabel> plugin. Select the <guilabel>X Array</guilabel> -and <guilabel>Y Array</guilabel> vectors for the fit – if you -used the default names when producing the plot, select -<guilabel>V0-1</guilabel> for the <guilabel>X Array</guilabel> and -<guilabel>V1-2</guilabel> for the <guilabel>Y Array</guilabel>. </para> -</listitem> - -<listitem><para>As it happens, the <guilabel>Order</guilabel> of the -polynomial is set -to 2 by default, which is what we want. You can set the -<guilabel>Order</guilabel> to any integer, one of the predefined -scalar quantities, or some statistical value based on one of the -available vectors (for example, <guilabel>V1-2-Mean</guilabel>).</para> -</listitem> - -<listitem><para>Hit <guibutton>OK</guibutton> to generate the -values.</para> -</listitem> - -</orderedlist> - -<para>That's all we need to do to generate the values, so now we need -to look at the output of the fitting process. Select -<menuchoice><guimenu>Data</guimenu><guimenuitem>View Fit Results</guimenuitem> -</menuchoice> from the menus, and the fit values are shown in the -dialog which appears: the coefficients for x^2, x^1 and x^0 (the -constant), along with the chi-squared value and the covariances -between the coefficients.</para> - -<para>The curve generated by the fitting is not automatically -superimposed on the data points. To do this, use the <guilabel>New -Curve</guilabel> dialog by selecting -<menuchoice><guimenu>Data</guimenu><guimenuitem>New Curve...</guimenuitem> -</menuchoice>. For the <guilabel>X axis vector</guilabel>, select -V0-1 (if you've been using the automatically generated names), and for -the <guilabel>Y axis vector</guilabel>, choose -<quote>P1-kstfit_polynomial_unweighted-Y Fitted</quote>. Click on -<guibutton>OK</guibutton> once you've set any other options that you -want. The curve is plotted in its own window: for this example, we -don't want that, so delete the new plot by right-clicking on it and -choosing <guimenuitem>Delete</guimenuitem> in the popup menu that -appears.</para> - -<para>Now, to add the curve fit to the data plot, open the Plot dialog -from <menuchoice><guimenu>Plots</guimenu><guimenuitem>Edit -Plot...</guimenuitem> -</menuchoice>. On the <guilabel>Content</guilabel> tab that -appears, the vector containing the fit data is shown under -<guilabel>Available objects</guilabel>. Select this vector, and add it -to the <guilabel>Displayed objects</guilabel> list by clicking on the -left arrow button. Click on <guibutton>Apply Edits</guibutton>, and -then <guibutton>Close</guibutton>, and you're finished.</para> - -</sect1> - -<sect1 id="plotting-a-power-spectrum"> -<title>Plotting a Power Spectrum</title> - -<para>&kst; makes plotting power spectra extremely easy. There are two -ways to do this: with the Data Wizard, or by creating a power spectrum -from an existing vector.</para> - -<sect2 id="power-spectra-data-wizard"> -<title>Power spectra with the Data Wizard</title> - -<para>This is almost the same as plotting a simple graph. Here are the -full instructions:</para> - -<para>Open the <guibutton>Data Wizard</guibutton> and select your data -file using the <guibutton>Open File</guibutton> button: - -<inlinemediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-open-file-button.png" format="PNG" -/> -</imageobject> -</inlinemediaobject>. -</para> - -<orderedlist> -<listitem> -<para>The <guibutton>Next</guibutton> page is where you select which -data to plot the power spectrum of. Column 2 in the data file contains the y-axis values, so -tick the box next to 2 in the <guilabel>Field/Column</guilabel> list on the -left-hand side.</para> -</listitem> - -<listitem> -<para>Under <guilabel>Plot Types</guilabel>, select <guilabel>Power -spectrum</guilabel>. There are also some options specifying how the -power spectrum is calculated, which we'll leave as defaults in this example.</para> -</listitem> - -<listitem> -<para>On the <guilabel>Next</guilabel> page, the options specific to a -power spectrum are found under <guilabel>Power Spectrum Axis -Mode</guilabel>. The x and y axes can both be made logarithmic here.</para> -</listitem> - -<listitem> -<para>Click on <guibutton>Finish</guibutton> and you're done! The new -plot appears in the main &kst; window.</para> -</listitem> - -</orderedlist> - - -</sect2> - -<sect2 id="power-spectra-existing-plot"> -<title>Power Spectra from an existing plot</title> -<para>Using the <filename>simpledata.dat</filename> example from <xref -linkend="plotting-simple-graphs"/>, we can do the following to produce -its power spectrum:</para> - -<orderedlist> - -<listitem><para>Open the <guilabel>Power Spectrum dialog</guilabel> -from <menuchoice><guimenu>Data</guimenu><guimenuitem>New Power -Spectrum...</guimenuitem></menuchoice>.</para> -</listitem> - -<listitem><para>From the <guilabel>Data vector</guilabel> combo box, -choose the vector representing your data. In our -<filename>simpledata.dat</filename> example, the required vector is -called V1-2.</para> -</listitem> - -<listitem><para>Click on <guibutton>OK</guibutton> and the power -spectrum is displayed in a new plot.</para> -</listitem> - -</orderedlist> - -</sect2> - -</sect1> - -<sect1 id="using-kst-from-the-command-line"> -<title>Using &kst; from the Command Line</title> - -<para>The command line switches to perform the tasks above</para> - -</sect1> - -<!-- -The interface for this is not finalized, so it's commented out for --> -<!--now, but definitely something useful to have in the future --> - -<!-- -<sect1 id="making-a-color-map"> -<title>Making a Color Map</title> -<para>How to make a color map, since the interface isn't very intuitive</para> -</sect1> ---> - -</chapter> -<!-- Keep this comment at the end of the file -Local variables: -mode: xml -sgml-omittag:nil -sgml-shorttag:nil -sgml-namecase-general:nil -sgml-general-insert-case:lower -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:0 -sgml-indent-data:true -sgml-parent-document:("index.docbook" "book" "chapter") -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> diff --git a/docbook/kst/eventmonitoring-chapter.docbook b/docbook/kst/eventmonitoring-chapter.docbook deleted file mode 100644 index 9473b1b1..00000000 --- a/docbook/kst/eventmonitoring-chapter.docbook +++ /dev/null @@ -1,340 +0,0 @@ -<chapter id="eventmonitoring"> -<title>Event Monitoring</title> -<para> -An event monitor data object essentially keeps track of one or more vectors -or scalars, and performs a specified action when a specified condition involving the vectors or scalars is true. -Event monitors are usually used in conjunction with <quote>live</quote>, or streaming data. For example, an event monitor -could be created to monitor whether or not elements of a data vector representing temperature exceed a predefined value. -</para> - -<sect1 id="eventmonitordialog"> -<title>Event Monitor Dialog</title> - -<para> -The following is a screenshot of the window displayed when creating or editing events. Explanations of the -settings are listed below. -<!-- TODO: How do you make the dialog appear? Data->New Event Monitor --> -</para> - -<screenshot> -<screeninfo>Event Monitor Window</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-eventmonitor.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Event Monitor Window</phrase> -</textobject> -</mediaobject> -</screenshot> - -<sect2 id="eventsexpression"> -<title>Expression</title> -<para> -The condition to monitor for, along with other event properties, can be modified in this section. -</para> - -<variablelist> -<varlistentry> -<term> -<guilabel>Operators</guilabel> -</term> -<listitem> -<para> -A list of available operators. Choosing an operator from the list inserts the operator at the current -insertion point in the <guilabel>Expression</guilabel> text box. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> -<guilabel>Vectors</guilabel> -</term> -<listitem> -<para> -A list of the current vector objects in &kst;. Choosing a vector from the list inserts the vector at the current -insertion point in the <guilabel>Expression</guilabel> text box. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> -<guilabel>Scalars</guilabel> -</term> -<listitem> -<para> -A list of the available scalar values. This list is composed of both the scalar values in the current &kst; -session as well as some built-in constants. Choosing a scalar from the list inserts the scalar at the current -insertion point in the <guilabel>Expression</guilabel> text box. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term> -<guilabel>Expression</guilabel> -</term> -<listitem> -<para> -The expression to monitor. You may type directly in this textbox, or select items to insert using the above drop-down -lists. Ensure that the expression entered in this textbox is a boolean expression (i.e. it evaluates to either true or -false). This usually entails using an equality or inequality in the expression. Note that vectors entered in the textbox -will be monitored according to their individual elements. -</para> -<para> -Whenever this expression is true, the event will be triggered. The action taken upon an event trigger depends on the -settings specified in the next two sections. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> -<guilabel>Description</guilabel> -</term> -<listitem> -<para> -This textbox is used to store a short description of the event. The description is primarily available as a -method for keeping track of multiple events. You can enter any text you wish in this textbox. -</para> -</listitem> -</varlistentry> -</variablelist> -</sect2> - -<sect2 id="eventskstdebuglog"> -<title>Kst Debug Log</title> -<para> -This section specifies settings for entries added to the &kst; debug log when events are triggered. -</para> -<variablelist> -<varlistentry> -<term><guilabel>Log as:</guilabel></term> -<listitem> -<para> -Enable this checkbox to have entries added to the &kst; debug log when this event is triggered. -There are three types of entries in the debug log—notices, warnings, and errors. -Select the desired type of entry using the corresponding radio button. -</para> -</listitem> -</varlistentry> -</variablelist> - - -</sect2> - -<sect2 id="eventsemailnotification"> -<title>E-Mail Notification</title> -<para> -In this section, settings for sending e-mail notifications of event triggers can be specified. -</para> - -<variablelist> -<varlistentry> -<term><guilabel>Notify</guilabel></term> -<listitem> -<para> -Enable this checkbox to have &kst; send e-mail notifications to the specified address when this -event is triggered. Also enter in the email address you would like to appear in the -<quote>From</quote> field of the email in the <guilabel>Sender</guilabel> textbox. -</para> -</listitem> -</varlistentry> -</variablelist> -</sect2> - -<sect2 id="eventselog"> -<title>ELOG</title> -<para> -&kst; supports adding entries to an ELOG logbook upon event triggers. This can be useful for remotely -monitoring live data, or for obtaining summaries of event activity. -</para> - -<variablelist> -<varlistentry> -<term><guilabel>Notify</guilabel></term> -<listitem> -<para> -Selecting this checkbox enables ELOG logging functionality for this event monitor. Click -<guibutton>Configure...</guibutton> to specify server and logging settings. -</para> -</listitem> -</varlistentry> -</variablelist> -</sect2> - -</sect1> - -<sect1 id="elogextension"> -<title>The ELOG Extension</title> -<para> -The ELOG extension allows event monitors to create logbook entries on a server running the Electronic Logbook (ELOG) -application. The created logbook entries can be used, for example, to remotely monitor &kst; events or to produce -periodical reports on data. For information on configuring and maintaining an ELOG server, please see the official -<ulink url="http://midas.psi.ch/elog/";>ELOG Homepage</ulink>. To enable the ELOG extension in &kst;, select -<guimenuitem>Extensions...</guimenuitem> from the <guimenu>Settings</guimenu> menu and ensure that -<quote>ELOG Extension</quote> is checked. -</para> - -<sect2 id="elogextensionsettings"> -<title>Server and Logging Settings</title> -<para> -Server and logging settings should be configured if ELOG functionality is enabled for an event monitor object. -To configure logging settings, click the <guibutton>Configure...</guibutton> button in the <guilabel>ELOG</guilabel> -section of the Event Monitor dialog. The ELOG Event Entry dialog should be displayed: -</para> -<screenshot> -<screeninfo>Event Monitor Logging Settings</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-eventmonitor-loggingsettings.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Event Monitor Logging Settings</phrase> -</textobject> -</mediaobject> -</screenshot> - -<para> -Use the three checkboxes at the bottom to select the type of information to be logged. -<guilabel>Include Kst capture</guilabel> specifies that a screen capture of the -currently active window should be included in the entry. <guilabel>Include Kst configuration file</guilabel> -specifies that <filename>*.kst</filename> save file should be attached to the entry. Finally, if -<guilabel>Include Kst debugging information</guilabel> is checked, a copy of the -<link linkend="debuglog">debug log</link> will be attached to the entry as well. -</para> - -<para> -Additional fields -will appear in this dialog once ELOG server settings are configured. To customize ELOG server settings, click the <guibutton>Configuration...</guibutton> button. The -following dialog should be displayed: -</para> - -<screenshot> -<screeninfo>Event Monitor Server Settings</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="Screenshot-kst-eventmonitor-serversettings.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>Event Monitor Server Settings</phrase> -</textobject> -</mediaobject> -</screenshot> - -<para> -Descriptions of the settings in this dialog follow. -</para> -<variablelist> -<varlistentry> -<term> -<guilabel>Configuration</guilabel>, <guibutton>Save</guibutton>, and <guibutton>Load</guibutton> -</term> -<listitem> -<para> -The <guilabel>Configuration</guilabel> drop down list contains a list of saved ELOG server configurations. -To load a set of configuration settings, select an item from the list and click the <guibutton>Load</guibutton> button. -To save the current configuration settings in this dialog into a slot, select the desired slot and click the -<guibutton>Save</guibutton> button. -</para> -<caution> -<para> -Saving settings into a slot overwrites any existing settings in that slot. -</para> -</caution> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>IP address</guilabel> and <guilabel>Port number</guilabel></term> -<listitem> -<para> -Enter the IP address of the machine running the ELOG server application. The port number that the ELOG server -listens on is configurable through the server, but by default it is 8080, so if you are unsure, enter 8080 as -the port number. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>Logbook</guilabel></term> -<listitem> -<para> -Each ELOG server can contain one or more logbooks, so the name of the logbook to write entries to must be -specified. Ensure that the spelling of the logbook is correct. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>User name</guilabel>, <guilabel>User password</guilabel>, and <guilabel>Write password</guilabel></term> -<listitem> -<para> -Depending on the how the ELOG server application is configured, these settings may or may not be necessary. -If they are, enter the correct login credentials in the appropriate textboxes. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>Capture size</guilabel></term> -<listitem> -<para> -Use this list box to select the size, in pixels, of the &kst; screen capture to attach (if specified). -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>Submit as HTML text</guilabel></term> -<listitem> -<para> -If this checkbox is selected, HTML tags may be used in the logbook entry. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>Suppress e-mail notification</guilabel></term> -<listitem> -<para> -If the logbook is configured to send e-mail notifications of new entries, selecting this checkbox -will disable the notifications. Note that this option is not related to &kst;'s own e-mail notification -setting for event monitors. -</para> -</listitem> -</varlistentry> - -</variablelist> - -<para> -Click the <guibutton>Apply</guibutton> button to apply the entered settings. Click <guibutton>Update</guibutton> -to update the ELOG Event Entry dialog (the previous dialog). Additional fields should appear in the -ELOG Event Entry dialog. These fields are unique to the selected logbook. Once you are satisfied with the settings, -the <guibutton>Test</guibutton> button -can be used to send a test logbook entry. Click <guibutton>Close</guibutton> to exit the dialog. -</para> -</sect2> - -</sect1> -</chapter> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: xml -sgml-omittag:nil -sgml-shorttag:nil -sgml-namecase-general:nil -sgml-general-insert-case:lower -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:0 -sgml-indent-data:true -sgml-parent-document:("index.docbook" "book" "chapter") -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> diff --git a/docbook/kst/index.docbook b/docbook/kst/index.docbook index 9741630d..a211a4ca 100644 --- a/docbook/kst/index.docbook +++ b/docbook/kst/index.docbook @@ -8,7 +8,6 @@ <!-- Chapter Information --> <!ENTITY intro-chapter SYSTEM "intro-chapter.docbook"> <!ENTITY tutorial SYSTEM "tutorial.docbook"> - <!ENTITY commontasks-chapter SYSTEM "commontasks-chapter.docbook"> <!ENTITY data-chapter SYSTEM "data-chapter.docbook"> <!ENTITY plugins-chapter SYSTEM "plugins-chapter.docbook"> <!ENTITY license-chapter SYSTEM "license-chapter.docbook"> @@ -16,7 +15,6 @@ <!ENTITY additionalformats-chapter SYSTEM "additionalformats-chapter.docbook"> <!ENTITY creatingplugins-chapter SYSTEM "creatingplugins-chapter-new.docbook"> <!ENTITY debuglog-chapter SYSTEM "debuglog-chapter.docbook"> - <!--ENTITY eventmonitoring-chapter SYSTEM "eventmonitoring-chapter.docbook"--> ]> <book id="kst" lang="&language;"> @@ -99,23 +97,13 @@ the order. --> &data-chapter; -<!--&commontasks-chapter; --> - - -<!--&plotsandwindows-chapter; --> - &saving-chapter; -<!--&eventmonitoring-chapter;--> - &plugins-chapter; -<!--&miscfeatures-chapter;--> - &license-chapter; <!--appendices start here--> -<!--&commandline-chapter;--> &creatingplugins-chapter; diff --git a/docbook/kst/index.tex b/docbook/kst/index.tex deleted file mode 100644 index 4e703c29..00000000 Binary files a/docbook/kst/index.tex and /dev/null differ
