[kstars] doc: Make compile + some updates

Yuri Chornoivan null at kde.org
Fri May 25 17:14:07 UTC 2018


Git commit 7d4975cf387966a4267c81a4325cb7e0fd727c29 by Yuri Chornoivan.
Committed on 25/05/2018 at 17:13.
Pushed by yurchor into branch 'master'.

Make compile + some updates

M  +1    -1    doc/commands.docbook
M  +42   -3    doc/config.docbook

https://commits.kde.org/kstars/7d4975cf387966a4267c81a4325cb7e0fd727c29

diff --git a/doc/commands.docbook b/doc/commands.docbook
index 5ead555bd..4b7f6c0a7 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -392,7 +392,7 @@ object.</para></listitem>
 <guimenu>View</guimenu>
 <guimenuitem>HiPS All Sky Overlay</guimenuitem>
 </menuchoice></term>
-<listitem><para>Select and configure &hips; sky overlays</para></listitem>
+<listitem><para>Select and configure <link linkend="hips">HiPS</link> sky overlays</para></listitem>
 </varlistentry>
 
 </variablelist>
diff --git a/doc/config.docbook b/doc/config.docbook
index f088e51ec..87d5bf38a 100644
--- a/doc/config.docbook
+++ b/doc/config.docbook
@@ -141,10 +141,10 @@ The window is depicted below:
 </para>
 
 <para>
-The <guilabel>Configure &kstars;</guilabel> window is divided into nine pages:
+The <guilabel>Configure &kstars;</guilabel> window is divided into eleven pages:
 <guilabel>Catalogs</guilabel>, <guilabel>Solar System</guilabel>, <guilabel>Satellites</guilabel>,
-<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Colors</guilabel>,
-<guilabel>INDI</guilabel>, <guilabel>Ekos</guilabel> and <guilabel>Advanced</guilabel>.
+<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Colors</guilabel>, <guilabel>FITS</guilabel>,
+<guilabel>INDI</guilabel>, <guilabel>Ekos</guilabel>, <guilabel>Xplanet</guilabel> and <guilabel>Advanced</guilabel>.
 </para>
 
 <para>
@@ -191,6 +191,10 @@ The <guilabel>Colors</guilabel> page allows you to set the color scheme,
 and to define new custom color schemes.
 </para>
 
+<para>For detailed explanation of the options on the <guilabel>FITS</guilabel>
+page see the <link linkend="fits-configure">Configure FITS</link> section.
+</para>
+
 <para>For detailed explanation of the options on the <guilabel>INDI</guilabel>
 page see the <link linkend="indi-configure">Configure INDI</link> section.
 </para>
@@ -199,6 +203,13 @@ page see the <link linkend="indi-configure">Configure INDI</link> section.
 see the official <ulink url="http://www.indilib.org/about/ekos.html">Ekos</ulink> page.
 </para>
 
+<para>
+<indexterm><primary>Configure &kstars; window</primary>
+<secondary>Xplanet page</secondary></indexterm>
+The <guilabel>Xplanet</guilabel> page provides fine-grained control
+over <ulink url="http://xplanet.sourceforge.net/">Solar system planet surface renderer Xplanet</ulink> (should be installed separately).
+</para>
+
 <para>
 <indexterm><primary>Configure &kstars; window</primary>
 <secondary>Advanced page</secondary></indexterm>
@@ -971,6 +982,32 @@ Scheme</guibutton> button.
 </para>
 </sect1>
 
+<sect1 id="fits-configure">
+<title>FITS</title>
+<indexterm><primary>Configure &kstars; window</primary>
+<secondary>FITS page</secondary></indexterm>
+<para><abbrev>FITS</abbrev> (Flexible Image Transport System) is a popular open  standard for storage, transmission and processing of digital data. For the details, one is referred to the <ulink url="https://en.wikipedia.org/wiki/FITS">corresponding Wikipedia article</ulink>. This page allows you to configure presentation and processing of FITS data in &kstars;.
+</para>
+<para>
+    The left panel is for configuring FITS viewer itself.
+</para>
+<para>
+Check <guilabel></guilabel> item if you want automatically display received images in the FITS Viewer.
+</para>
+<para>The <guilabel>Single Preview Tab</guilabel> item is to display all captured FITS images in a single tab instead of multiple tabs 
+per image. The <guilabel>Single Window Capture</guilabel> item is to display captured FITS images from all cameras in a single FITS Viewer window 
+instead of a dedicated window to each camera. The <guilabel>Single Window Open</guilabel> item is to display opened FITS images in a single FITS Viewer window instead of a 
+dedicated window to each file and the <guilabel>Independent Window</guilabel> item is to Make FITS Viewer window independent from &kstars;.
+</para>
+<para>
+The right panel lists processing options. The <guilabel>Auto Stretch</guilabel> item is to always apply auto stretch to images in FITS Viewer, <guilabel>Limited Resources Mode</guilabel> is to enable limited resource mode to turn off any resource-intensive, namely: <guilabel>Auto Debayer</guilabel> (bayered images will not be debayered; only grayscale images are shown), <guilabel>Auto WCS</guilabel> (World Coordinate System data 
+will not be processed; WCS maps sky coordinates to image coordinates; 
+equatorial grid lines, object identification, and telescope slew within an 
+image are disabled), and <guilabel>3D Cube</guilabel> (RGB images will not be 
+processed; only grayscale images are shown). You can switch off some of these resource-greedy operations separately as well.
+</para>
+</sect1>
+
 <sect1 id="indi_tab">
 <title>INDI</title>
 <screenshot>
@@ -1181,4 +1218,6 @@ from the <menuchoice><guimenu>Settings</guimenu><guisubmenu>FOV Symbols</guisubm
 
 </sect1>
 
+&hips;
+
 </chapter>


More information about the kde-doc-english mailing list