[Kst] branches/work/kst/newdocs/doc/kst

Duncan Hanson duncan.hanson at gmail.com
Wed Apr 4 23:11:52 CEST 2007 

SVN commit 650576 by dhanson:

address the problems which barth found.

 AM            Screenshot-kst-commontasks-curvefitting-fitcontext.png  
 M             Screenshot-kst-commontasks-curvefitting-plottedcurve.png  
 D             Screenshot-kst-commontasks-curvefitting-selectplugin.png  
 AM            Screenshot-kst-commontasks-plottingsimplegraphs-configureascii.png  
 A             Screenshot-kst-commontasks-plottingsimplegraphs-finalplot.png   Screenshot-kst-commontasks-plottingsimplegraphs.png#645983
 D             Screenshot-kst-commontasks-plottingsimplegraphs.png  
 D             Screenshot-kst-intro-equationnew.png  
 AM            Screenshot-kst-intro-gs-configureascii.png  
 AM            Screenshot-kst-intro-gs-configurelayout.png  
 AM            Screenshot-kst-intro-gs-datamanager.png  
 AM            Screenshot-kst-intro-gs-equationnew.png  
 A             Screenshot-kst-intro-gs-finalplots.png   Screenshot-kst-intro-gsfinalplots.png#645972
 A             Screenshot-kst-intro-gs-initialplots.png   Screenshot-kst-intro-gsinitialplots.png#645972
 AM            Screenshot-kst-intro-gs-maximize.png  
 AM            Screenshot-kst-intro-gs-presentation.png  
 AM            Screenshot-kst-intro-gs-saveas.png  
 AM            Screenshot-kst-intro-gs-selectdata.png  
 AM            Screenshot-kst-intro-gs-tiedzoom.png  
 D             Screenshot-kst-intro-gsfinalplots.png  
 D             Screenshot-kst-intro-gsinitialplots.png  
 M  +17 -25    commontasks-chapter.docbook  
 M  +12 -12    intro-chapter.docbook  
 M  +1 -10     views-chapter.docbook  


** branches/work/kst/newdocs/doc/kst/Screenshot-kst-commontasks-curvefitting-fitcontext.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-commontasks-plottingsimplegraphs-configureascii.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-configureascii.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-configurelayout.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-datamanager.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-equationnew.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-maximize.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-presentation.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-saveas.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-selectdata.png #property svn:mime-type
   + application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-intro-gs-tiedzoom.png #property svn:mime-type
   + application/octet-stream
--- branches/work/kst/newdocs/doc/kst/commontasks-chapter.docbook #650575:650576
@@ -90,7 +90,7 @@
 <screeninfo>Plotting Simple Graphs</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-commontasks-plottingsimplegraphs.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-commontasks-plottingsimplegraphs-finalplot.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
@@ -121,30 +121,24 @@
 
 <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>Data Plugins</guilabel> list which appears will contain all of the &kst; fitting plugins, and more. Since the example data here are quadratic, we'll use the <guilabel>Fit polynomial</guilabel> plugin. Click Ok.
+Right click on the 'simple graphs' plot which you've created and select 'y' from the <guimenu>Fit</guimenu> submenu in the context menu which appears.
 </para>
 
 <screenshot>
-<screeninfo>Curve Fitting - Select Plugin</screeninfo>
+<screeninfo>Curve Fitting - Fit Context Menu</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-commontasks-curvefitting-selectplugin.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-commontasks-curvefitting-fitcontext.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
-
 </listitem>
 
 <listitem>
 <para>
-Now a 'New Plugin' dialog will appear which allows you to configure the fit. Select <guilabel>x</guilabel> for the <guilabel>X Array</guilabel> and <guilabel>y</guilabel> for the <guilabel>Y Array</guilabel>. 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 (eg. the Standard Deviation of x, <guilabel>x/Sigma</guilabel>).
+Now a 'New Plugin' dialog will appear which allows you to configure the fit. Since the example data here are quadratic, we'll use the <guilabel>Fit polynomial</guilabel> plugin. Choose this from the Plugin Selection drop-list. 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 (eg. the Standard Deviation of x, <guilabel>[x/Sigma]</guilabel>).
 </para>
 <para>
 There are several Output fields where you can enter text to be used as the unique name for the vectors and scalars generated by this fit. For more information, you can read the section on the <link linkend="plugin-kstfit_polynomial_unweighted">Fit Polynomial</link> in the <link linkend="pluginsandfilters">Plugins</link> chapter.
@@ -153,36 +147,34 @@
 
 <listitem>
 <para>
-Hit <guibutton>OK</guibutton> to generate the fit values.
+Hit <guibutton>OK</guibutton> to perform the fit. A new curve showing the best fit polynomial will be automatically added to the plot containing the original curve. A new <link linkend="view-types-labels">label</link> object is also added to the plot containing the fitted coefficients for x^2, x^1 and x^0 (the constant).
 </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>
-
 <screenshot>
-<screeninfo>Curve Fitting - Fit Results</screeninfo>
+<screeninfo>Curve Fitting - Plotted Curve</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-commontasks-curvefitting-fitresults.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-commontasks-curvefitting-plottedcurve.png" format="PNG" />
 </imageobject>
 </mediaobject>
-</screenshot> 
+</screenshot>
+</listitem>
+</orderedlist>
 
-<para>Now, suppose that we would like to see visually how well our fitted curve matches the data. 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 x, and for the <guilabel>Y axis vector</guilabel>, choose <quote>kstfit_polynomial_unweighted-Y Fitted</quote>. Additionally, you should select the "Place in Existing Plot" option for the Curve Placement. There should only be one existing plot available. You can also visual options for the new curve. Click on <guibutton>OK</guibutton> once you've set any other options that you want. You should now have a plot which looks similar to the following:
+<tip>
+<para>
+Not all of the fit results are shown in the new label. The covariances for the fit coefficients, as well as the Chi-Square value for the fit can be accessed from the View Fit Results dialog. Select <menuchoice><guimenu>Data</guimenu><guimenuitem>View Fit Results</guimenuitem></menuchoice> from the main menu, and choose the fit which you are interested in from the drop down list. The results are shown in a table:
 </para>
 
 <screenshot>
-<screeninfo>Curve Fitting - Plotted Curve</screeninfo>
+<screeninfo>Curve Fitting - Fit Results</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-commontasks-curvefitting-plottedcurve.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-commontasks-curvefitting-fitresults.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot> 
+</tip>
 
 </sect1>
 
--- branches/work/kst/newdocs/doc/kst/intro-chapter.docbook #650575:650576
@@ -73,7 +73,7 @@
 <screeninfo>Datasources - Configure ASCII</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-commontasks-plottingsimplegraphs-configureascii.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-configureascii.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
@@ -85,7 +85,7 @@
 <screeninfo>Data Wizard - Select Data Dialog</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-data-wizard-selectdata.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-selectdata.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
@@ -107,7 +107,7 @@
 <screeninfo>Data Wizard Data Presentation Pane</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-data-wizard-presentation.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-presentation.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
@@ -124,7 +124,7 @@
 <screeninfo>Data Wizard - Configure Plot Layout Plane</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-data-wizard-configurelayout.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-configureascii.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
@@ -137,7 +137,7 @@
 <screeninfo>Getting Started - Initial Plots</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-intro-gsinitialplots.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-initialplots.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>Getting Started - Initial Plots</phrase>
@@ -154,7 +154,7 @@
 <screeninfo>Saving a KST session</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-saving-saveas.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-saveas.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>Saving a KST session</phrase>
@@ -182,7 +182,7 @@
 <screeninfo>Maximizing a plot</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-view-zoom.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-maximize.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>Maximizing a plot</phrase>
@@ -224,7 +224,7 @@
 <screeninfo>Tied Zoom</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-view-tiedzoom.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-tiedzoom.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>Tied Zoom</phrase>
@@ -273,7 +273,7 @@
 <screeninfo>The Data Manager</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-data-datamanager.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-datamanager.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>The Data Manager</phrase>
@@ -293,14 +293,14 @@
 </para>
 
 <para>
-Begin the process of creating an Equation Object by clicking the corresponding button under the <guibutton>Create Data Object</guibutton> tab on the left side of the Data Manager. A dialog will appear to configure the new object. Configure this dialog as shown below:
+Begin the process of creating an Equation by clicking the corresponding button under the <guibutton>Create Data Object</guibutton> tab on the left side of the Data Manager. A dialog will appear to create the new object. Configure this dialog as shown below:
 </para>
 
 <screenshot>
 <screeninfo>New Equation</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-intro-equationnew.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-equationnew.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>New Equation</phrase>
@@ -320,7 +320,7 @@
 <screeninfo>Getting Started Final Plots</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="Screenshot-kst-intro-gsfinalplots.png" format="PNG" />
+<imagedata fileref="Screenshot-kst-intro-gs-finalplots.png" format="PNG" />
 </imageobject>
 </mediaobject>
 </screenshot>
--- branches/work/kst/newdocs/doc/kst/views-chapter.docbook #650575:650576
@@ -808,6 +808,7 @@
 <para>
 The text displayed by the label.  You may enter text manually in this dialog, or insert references into it using the scalar and string drop down menus. &kst; labels support many LaTeX formatting and symbol commands, prefixed with the usual '\'. A list of supported commands is given below:
 
+<!-- FFR: The symbol screenshots were taken for labels w/ font Luxi Sans size 10. Display resolution was 1280x1024.-->
 <informaltable>
 <tgroup cols="2">
 <thead>
@@ -955,16 +956,6 @@
 </varlistentry>
 
 <varlistentry>
-<term><guilabel>Justification</guilabel></term>
-<listitem>
-<para>
-The horizontal alignment of the label.  Select one of <guilabel>Left</guilabel>, <guilabel>Center</guilabel>,
-or <guilabel>Right</guilabel>.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
 <term><guilabel>Rotation</guilabel></term>
 <listitem>
 <para>

More information about the Kst mailing list