[kstars] doc: Minor fixes and enhancements in docs

Yuri Chornoivan null at kde.org
Mon Jan 21 17:52:14 GMT 2019


Git commit ff4031a4b1899ba25a944d95dab4f33a5578a56c by Yuri Chornoivan.
Committed on 21/01/2019 at 17:51.
Pushed by yurchor into branch 'master'.

Minor fixes and enhancements in docs

M  +1    -1    doc/ekos-focus.docbook
M  +2    -2    doc/ekos-guide.docbook
M  +1    -1    doc/ekos-scheduler.docbook

https://commits.kde.org/kstars/ff4031a4b1899ba25a944d95dab4f33a5578a56c

diff --git a/doc/ekos-focus.docbook b/doc/ekos-focus.docbook
index 0105bbfe3..05365c90e 100644
--- a/doc/ekos-focus.docbook
+++ b/doc/ekos-focus.docbook
@@ -83,7 +83,7 @@
             </listitem>
         </itemizedlist>
         <para>
-            For absolute focusers, you can set the ticks count. To view a continuous feed of the camera, click the <guibutton>Framing</guibutton> button. An image shall be captured repeatedly according to the CCD settings in the CCD and Filter Wheel group. You can focus in and out by pressing the respective buttons, and each shall move by the step size indicated in the focus settings. For absolute and relative focusers, the step size is in units of <emphasis>ticks</emphasis> and for simple DC focusers, the step size is in <emphasis>milliseconds</emphasis>
+            For absolute focusers, you can set the ticks count. To view a continuous feed of the camera, click the <guibutton>Framing</guibutton> button. An image shall be captured repeatedly according to the CCD settings in the <guilabel>CCD and Filter Wheel</guilabel> group. You can focus in and out by pressing the respective buttons, and each shall move by the step size indicated in the focus settings. For absolute and relative focusers, the step size is in units of <emphasis>ticks</emphasis> and for simple DC focusers, the step size is in <emphasis>milliseconds</emphasis>
         </para>
         <para>
             To begin the autofocus process, simply click the <guibutton>Auto Focus</guibutton> button.
diff --git a/doc/ekos-guide.docbook b/doc/ekos-guide.docbook
index ff1e4d6f9..d92240a21 100644
--- a/doc/ekos-guide.docbook
+++ b/doc/ekos-guide.docbook
@@ -24,7 +24,7 @@
             Ekos Guide Module enables autoguiding capability using either the powerful built-in guider, or at your option, external guiding via <ulink url="http://openphdguiding.org/">PHD2</ulink> or <ulink url="https://sourceforge.net/projects/linguider/">lin_guider</ulink>. Using the internal guiding, guider CCD frames are captured and sent to Ekos for analysis. Depending on the deviations of the guide star from its lock position, guiding pulses corrections are sent to your mount <guilabel>Via</guilabel> any device that supports ST4 ports. Alternatively, you may send the corrections to your mount <emphasis>directly</emphasis>, if supported by the mount driver. Most of the GUI options in the Guide Module are well documented so just hover your mouse over an item and a tooltip will popup with helpful information.
         </para>
         <para>
-            To perform guiding, you need to select a Guider CCD in Ekos Profile Setup. The telescope aperture and focal length must be set in the telescope driver. If the Guider CCD is attached to a separate Guide Scope, you must also set the Guide Scope's Focal Length and Aperture. You can set these values under the Options tab of the telescope driver or from the Mount module. Autoguiding is a two-step process: Calibration & Guiding.
+            To perform guiding, you need to select a Guider CCD in <link linkend="ekos-profile-wizard">Ekos Profile Setup</link>. The telescope aperture and focal length must be set in the telescope driver. If the Guider CCD is attached to a separate Guide Scope, you must also set the Guide Scope's <guilabel>Focal Length</guilabel> and <guilabel>Aperture</guilabel>. You can set these values under the <guilabel>Options</guilabel> tab of the <link linkend="indi-telescope-setup">telescope driver</link> or from the Mount module. Autoguiding is a two-step process: Calibration & Guiding.
         </para>
         <mediaobject>
             <videoobject>
@@ -123,7 +123,7 @@
             </listitem>
             <listitem>
                 <para>
-                    <guilabel>Two axis</guilabel>: Check if you want the calibration process calibration in both RA & DEC. If unchecked, the calibration is only performed in RA.
+                    <guilabel>Two axis</guilabel>: Check if you want the calibration process makes calibration in both RA & DEC. If unchecked, the calibration is only performed in RA.
                 </para>
             </listitem>
             <listitem>
diff --git a/doc/ekos-scheduler.docbook b/doc/ekos-scheduler.docbook
index 2f6bd78f9..4c916aec3 100644
--- a/doc/ekos-scheduler.docbook
+++ b/doc/ekos-scheduler.docbook
@@ -332,7 +332,7 @@ exit(0)
             Before starting the <guilabel>Mosaic Job Creator</guilabel> in Ekos Scheduler, you need to select a target and a sequence file. The Sequence File contains all the information necessary to capture an image including exposure time, filters, temperature setting, &etc; Start the Mosaic Job Creator by clicking on the icon next to the <guibutton>Find</guibutton> button in Ekos Module.
         </para>
         <para>
-            On first use, you need to enter your equipment settings including your telescope focal length in addition to camera's width, height, and pixel dimensions. Finally, you need to enter the rotation of the camera with respect to north or the position angle. If you don't know this value, start Ekos and slew to your desired target then use the Align module to solve the image and obtain the position angle.
+            On first use, you need to enter your equipment settings including your telescope focal length in addition to camera's width, height, and pixel dimensions. Finally, you need to enter the rotation of the camera with respect to north or the position angle. If you don't know this value, start Ekos and slew to your desired target then use the <link linkend="ekos-align">Align module</link> to solve the image and obtain the position angle.
         </para>
         <para>
             Next, enter the desired number of horizontal and vertical panels (⪚ 2x2, 3x3, &etc;) and then click <guibutton>Update</guibutton>. The target FOV shall be calculated given the number of panels and your camera's FOV and the mosaic overlap shall be displayed. By default, the percentage of the overlap among images is 5%, but you can change this value to your desired value. You can also move the complete mosaic structure around to fine tune the position of the mosaic panels. When satisfied, click <guibutton>Create Jobs</guibutton> and Ekos shall create an observation job and a corresponding customized sequence file for each panel. All the jobs shall be saved to an Ekos Scheduler List (<filename role="extension">.esl</filename>) file that you can load on any suitable observing night and it will pick off where you left. Before starting the <guilabel>Mosaic Job Creator</guilabel>, check that all the observation job conditions, constraints, and startup/shutdown procedures are as per your requirements since these settings shall be copied to all the jobs generated by the Mosaic tool.


More information about the kde-doc-english mailing list