[Kst] branches/work/kst/newdocs/doc/kst
Duncan Hanson
duncan.hanson at gmail.com
Sun Apr 1 20:44:12 CEST 2007
SVN commit 648951 by dhanson:
misc updates: rectangles/boxes, elog, newshortcuts, no healpix libs, install reqs
AM Screenshot-kst-data-staticvectoredit.png
AM Screenshot-kst-extensions-dialog.png
M Screenshot-kst-extensions-elog-loggingsettings.png
M Screenshot-kst-extensions-elog-serversettings.png
M Screenshot-kst-settings-shortcuts.png
M +1 -1 data-chapter.docbook
M +22 -9 extensions-chapter.docbook
M +1 -1 install-chapter.docbook
M +7 -7 views-chapter.docbook
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-data-staticvectoredit.png #property svn:mime-type
+ application/octet-stream
** branches/work/kst/newdocs/doc/kst/Screenshot-kst-extensions-dialog.png #property svn:mime-type
+ application/octet-stream
--- branches/work/kst/newdocs/doc/kst/data-chapter.docbook #648950:648951
@@ -1686,7 +1686,7 @@
<sect2 id="data-sources-healpix">
<title>HEALPix FITS files</title>
<para>
-HEALPix is a pixelisation scheme for the sphere. More information can be found at <ulink url="http://healpix.jpl.nasa.gov/">http://healpix.jpl.nasa.gov/</ulink>. HEALPix data is typically be loaded into &kst; as a matrix. For this data source to work you must have the HEALPix and CFITSIO libraries installed. An image of a sample HEALPix matrix is shown below:
+HEALPix is a pixelisation scheme for the sphere. More information can be found at <ulink url="http://healpix.jpl.nasa.gov/">http://healpix.jpl.nasa.gov/</ulink>. HEALPix data is typically be loaded into &kst; as a matrix. For this data source to work you must have the CFITSIO libraries installed. An image of a sample HEALPix matrix is shown below:
</para>
<screenshot>
--- branches/work/kst/newdocs/doc/kst/extensions-chapter.docbook #648950:648951
@@ -1,11 +1,28 @@
<chapter id="extensions">
<title>Kst Extensions</title>
+<para>
+&kst; extensions are a powerful way to add functionality to &kst;. They can, for example, add elements to the &kst; user interface. They are usually designed to accomplish specific tasks which aren't of general use to the &kst; community.
+</para>
+
+<para>
+To load or unload extensions in &kst;, select the <guimenuitem>Extensions...</guimenuitem> item from the <guimenu>Settings</guimenu> menu. A dialog will be presented which allows you to load or unload installed plugins.
+</para>
+
+<screenshot>
+<screeninfo>Extensions Dialog</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-extensions-dialog.png" format="PNG" />
+</imageobject>
+</mediaobject>
+</screenshot>
+
<sect1 id="extensions-elog">
<!-- FIXME: review ELOG documentation -->
<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 periodic data reports. 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.
+The ELOG extension allows <link linkend="data-types-eventmonitors">event monitors</link> 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 periodic data reports. 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="extensions-elog-settings">
@@ -150,7 +167,7 @@
<sect1 id="extensions-kstscript">
<title>KstScript</title>
<para>
-KstScript is a JavaScript binding for &kst;. It aims to offer full control over all aspects of &kst;.
+KstScript is a JavaScript binding for &kst;. It aims to offer full control over all aspects of &kst;. To enable KstScript, select <guimenuitem>Extensions...</guimenuitem> from the <guimenu>Settings</guimenu> menu and ensure that <quote>JavaScript Extension</quote> is checked.
</para>
<sect2 id="kstscriptrunning">
@@ -162,17 +179,13 @@
<itemizedlist>
<listitem> <para>
from the command line when starting &kst;:
-<screen><userinput><command>
-kst -E js:"loadScript('myscript.js')"
-</command></userinput></screen>
+<screen><userinput><command>kst -E js:"loadScript('myscript.js')"</command></userinput></screen>
</para> </listitem>
<listitem> <para>
using kstcmd. kstcmd is a JavaScript interpreter which connects to your &kst; session. It can be run from an external terminal, or from within &kst; itself by selecting <guimenuitem>Show JavaScript Console</guimenuitem> from the <guimenu>Tools</guimenu> menu.
-<screen><userinput><command>
-kstcmd
-</command></userinput>
-Attached to Kst session kst-17704
+<screen><userinput><command>kstcmd</command>
+</userinput>Attached to Kst session kst-17704
kst> <command>loadScript(myscript.js)</command>
</screen>
</para> </listitem>
--- branches/work/kst/newdocs/doc/kst/install-chapter.docbook #648950:648951
@@ -38,7 +38,7 @@
<sect2 id="installation-fromsource-requirements">
<title>Requirements</title>
<para>
-&kst; v1.4.0 requires the &kde; 3.3 libraries and &Qt; 3.1. Almost all major &Linux; distributions have packages
+&kst; v1.4.0 requires the &kde; 3.4 libraries and &Qt; 3.3. Almost all major &Linux; distributions have packages
for &kde; and &Qt;. Since &Qt; is a dependency of &kde;, having the required version of &kde; should
be sufficient. It is recommended that you refer to your particular distribution's documentation for
&kde; library installation. Note that the entire &kde; desktop environment
--- branches/work/kst/newdocs/doc/kst/views-chapter.docbook #648950:648951
@@ -27,7 +27,7 @@
</para>
<para>
-Annotations things like labels, arrows, etc. which can be used to display information about plots, or highlight areas of interest. The annotation objects currently implemented in &kst; are Labels, Rectangles, Ellipses, Lines, Arrows, and Pictures. They are very useful when preparing plots for presentation or publication.
+Annotations things like labels, arrows, etc. which can be used to display information about plots, or highlight areas of interest. The annotation objects currently implemented in &kst; are Labels, Boxes, Ellipses, Lines, Arrows, and Pictures. They are very useful when preparing plots for presentation or publication.
</para>
<para>
@@ -888,9 +888,9 @@
</sect2>
<sect2 id="view-types-rectanglesandellipses">
-<title>Rectangles / Ellipses</title>
+<title>Boxes / Ellipses</title>
<para>
-Rectangle and ellipse annotation objects are usually used to outline important features on a plot.
+Box and ellipse annotation objects are usually used to outline important features on a plot.
</para>
<para>
@@ -916,7 +916,7 @@
<term><guilabel>Border Color</guilabel></term>
<listitem>
<para>
-The color of the outline of the rectangle/ellipse object. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser.
+The color of the outline of the box/ellipse object. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser.
</para>
</listitem>
</varlistentry>
@@ -934,7 +934,7 @@
<term><guilabel>Fill Color / Transparent Fill</guilabel></term>
<listitem>
<para>
-The color of the contents of the rectangle/ellipse. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser. If you select "Transparent Fill" then the rectangle/ellipse will be see-through.
+The color of the contents of the box/ellipse. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser. If you select "Transparent Fill" then the box/ellipse will be see-through.
</para>
</listitem>
</varlistentry>
@@ -943,7 +943,7 @@
<term><guilabel>X/Y Roundness</guilabel></term>
<listitem>
<para>
-These options are for rectangles only. They determine the fractional rounding of the rectangle's corners in a non-intuitive way. Values of 0 result in standard corners (right angles), while values of 99 result in a maximally rounded rectangle (an ellipse). For more information on these options, see the Qt documentation on QPainter::drawRoundRect.
+These options are for boxes only. They determine the fractional rounding of the boxes's corners in a non-intuitive way. Values of 0 result in standard corners (right angles), while values of 99 result in a maximally rounded box (an ellipse). For more information on these options, see the Qt documentation on QPainter::drawRoundRect.
</para>
</listitem>
</varlistentry>
@@ -1050,7 +1050,7 @@
<term><guilabel>Border Color</guilabel></term>
<listitem>
<para>
-The color of the outline of the rectangle/ellipse object. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser.
+The color of the outline of the box/ellipse object. Clicking the <inlinemediaobject><imageobject><imagedata fileref="Widget-kst-colorchooser.png" format="PNG"/></imageobject></inlinemediaobject> button displays the standard &kde; color chooser.
</para>
</listitem>
</varlistentry>
More information about the Kst
mailing list