[kde-doc-english] [kstars] doc: Update documentation for KStars tools

Tue Jul 12 17:18:41 UTC 2016

Git commit 16880caf3cfb62378cf2e7e55e1a7047804fcd41 by Raphael Cojocaru.
Committed on 12/07/2016 at 17:18.
Pushed by raphaelc into branch 'master'.

Update documentation for KStars tools

M  +2    -1    doc/jmoons.docbook
M  +16   -6    doc/obsplanner.docbook
M  +3    -3    doc/scriptbuilder.docbook
M  +2    -1    doc/solarsys.docbook
M  +12   -6    doc/wut.docbook

http://commits.kde.org/kstars/16880caf3cfb62378cf2e7e55e1a7047804fcd41

diff --git a/doc/jmoons.docbook b/doc/jmoons.docbook
index 40a7d7b..be11ea9 100644
--- a/doc/jmoons.docbook
+++ b/doc/jmoons.docbook
@@ -28,7 +28,8 @@ in arcminutes.  The offset is measured along the direction of Jupiter's
 equator.  Each moon's position as a function of time traces a sinusoidal
 path in the plot, as the moon orbits around Jupiter.  Each track is 
 assigned a different color to distinguish it from the others; the name 
-labels at the top of the window indicate the color used by each moon.
+labels at the top of the window indicate the color used by each moon 
+(&ie; red for Io, yellow for Europa, green for Callisto and blue for Ganymede).
 </para><para>
 The plot can be manipulated with the keyboard.  The time axis can be 
 expanded or compressed using the <keycap>+</keycap> and 
diff --git a/doc/obsplanner.docbook b/doc/obsplanner.docbook
index e3bc3ea..98bf2a7 100644
--- a/doc/obsplanner.docbook
+++ b/doc/obsplanner.docbook
@@ -23,7 +23,7 @@
       </para>
     </caption>
   </mediaobject>
-  <para>The <guibutton>Save all Images</guibutton> button does a search for the SDSS images and displays the DSS image if the requested RA/Dec is out of the SDSS footprint.</para>
+  <para>The <guibutton>Download all Images</guibutton> button does a search for the SDSS images and displays the DSS image if the requested RA/Dec is out of the SDSS footprint.</para>
   <mediaobject>
     <imageobject>
       <imagedata fileref="sds.png" format="PNG"/>
@@ -55,10 +55,19 @@
       </para>
     </caption>
   </mediaobject>
-  <para>You can add more objects by pressing the <guibutton>Add Object</guibutton> button. It has quite accurate method for sorting out items, depending on what options you have given to him. They are: Any, Stars, Solar System, Clusters (Globular and Open), Nebula (Gaseous and Planetary), Galaxies, Comets, Asteroids and Constellations + the name filter.</para>
-  <para>Here you can see the object visibility based on the time and date. The leader line shows the time right now.</para>
-  <para>And below this you can add notes about observing this object.</para>
-  <para>Do note that the Wish List is not the Session Plan. In the Wish List you can add objects that you wish to observer at some point. From there you can add them to the Session Plan.</para>
+  <para>You can add more objects by pressing the <guibutton>Find Object</guibutton> button. It will open
+the <guilabel>Find Object</guilabel> tool which provides two accurate methods for sorting out the items, 
+depending on what criteria you want to use. 
+You can filter the list by objects type: Any, Stars, Solar System, Clusters (Globular and Open), 
+Nebulae (Gaseous and Planetary), Galaxies, Comets, Asteroids, Constellations, Supernovae or Satellites.
+You can also filter the objects list by name. All you need to do is to enter the name of desired object 
+in <guilabel>Filter by name</guilabel> text box.
+  </para>
+
+  <para>Inside Observation Planner window you can see an Altvstime widget, which shows you how 
+the altitude of a selected object varies over time.</para>
+  <para>Below the Altvstime widget, its a text box in that you can add observing notes for current sky object.</para>
+  <para>Note that the Wish List is not the Session Plan. In the Wish List you can add objects that you wish to observe at some point. From there you can add them to the Session Plan.</para>
   <para>You can see the pop-up window that comes after right-clicking on an object.</para>
   <mediaobject>
     <imageobject>
@@ -70,7 +79,8 @@
       </para>
     </caption>
   </mediaobject>
-  <para> Here is the second way of adding objects in your Observation Plan and using you Observation Plan. To use this way you just need to press the 4-th icon on the top-left corner of the Observation Planner Wizard (which is highlighted with yellow).</para>
+  <para> Here is the second way of adding objects in your Observation Plan, using the Observing List Wizard. You 
+just need to press the fourth button on the top-left corner of the Observation Planner window.</para>
   <para>Despite looking differently this way is basically the same as the first one. Although that it could be a bit more detailed. Here you can see the same categories of objects.</para>
   <mediaobject>
     <imageobject>
diff --git a/doc/scriptbuilder.docbook b/doc/scriptbuilder.docbook
index b121128..4611a59 100644
--- a/doc/scriptbuilder.docbook
+++ b/doc/scriptbuilder.docbook
@@ -94,7 +94,7 @@ is used to do this.  Highlight this function in the Function Browser,
 and note the documentation displayed in the panel below the Browser.
 Press the <guibutton>Add Function</guibutton> button to add this
 function to the Current Script box.  The Function Arguments panel
-will now contain a combobox labeled <quote>dir</quote>, short for
+will now contain a combobox labeled <quote>Dir</quote>, short for
 direction.  This is the direction in which the display should
 be pointed.  The combobox contains only the cardinal compass points,
 not the Moon or any other objects.  You can either enter
@@ -141,7 +141,7 @@ press the <guibutton>Browse Tree</guibutton> button, which will open
 a window containing a tree view of the available options, organized by
 topic.  In addition, each item has a short explanation of what the
 option does, and the data type of the option's value.  We find
-UseAltAz under the <guilabel>Skymap options</guilabel> category.
+UseAltAz under the <guilabel>Skymap Options</guilabel> category.
 Just highlight this item and press <guibutton>OK</guibutton>, and it
 will be selected in the combobox of the Function Arguments panel.
 Finally, make its value <quote>false</quote> or <quote>0</quote>.
@@ -168,7 +168,7 @@ Now that we have a completed script, we can run it in a couple of ways.
 From a console prompt, you can simply execute the script as long as an
 instance of &kstars; is currently running.  Alternatively, you can execute
 the script from within &kstars; using the <guimenuitem>Run
-Script</guimenuitem> item in the <guimenu>File</guimenu> menu.
+Script...</guimenuitem> item in the <guimenu>File</guimenu> menu.
 </para>
 </sect2>
 </sect1>
diff --git a/doc/solarsys.docbook b/doc/solarsys.docbook
index b3a5a07..da6e0af 100644
--- a/doc/solarsys.docbook
+++ b/doc/solarsys.docbook
@@ -39,7 +39,8 @@ clock in the main &kstars; window.  There is a timestep control
 widget here, similar to the one in the main window's toolbar.  
 However, this control defaults to a timestep of 1 day (so that 
 the motions of the planets can be seen), and it starts out with 
-the clock paused when the tool is opened.
+the clock paused when the tool is opened. You may set the date to now 
+by pressing the <guibutton>Today</guibutton> button.
 </para>
 <note>
 <para>
diff --git a/doc/wut.docbook b/doc/wut.docbook
index 6f41ccf..86d851f 100644
--- a/doc/wut.docbook
+++ b/doc/wut.docbook
@@ -38,21 +38,27 @@ in the box labeled <guilabel>Select a Category</guilabel>, and all
 objects of that type which are above the horizon on the selected
 night will be displayed in the box labeled <guilabel>Matching
 Objects</guilabel>.  For example, in the screenshot, the
-<guilabel>Planets</guilabel> category has been selected, and four
-planets which are up on the selected night are displayed (Mars,
-Neptune, Pluto, and Uranus).  When an object in the list is selected,
+<guilabel>Planets</guilabel> category has been selected, and three
+planets which are up on the selected night are displayed (Mars, 
+Jupiter and Saturn).  When an object in the list is selected,
 its rise, set and transit times are displayed in the lower-right
-panel.  In addition, you can press the <guibutton>Object
+panel (&ie; Mars rises at 17:13, transits at 21:46 and sets at 02:16).  
+In addition, you can press the <guibutton>Object
 Details...</guibutton> button to open the <link
 linkend="tool-details">Object Details window</link> for that
 object.
 </para>
 <para>
 By default, the WUT will display objects which are above the horizon
-between sunset and midnight (i.e., <quote>in the evening</quote>).
+between sunset and midnight (&ie; <quote>in the evening</quote>).
 You can choose to show objects which are up between midnight and dawn
 (<quote>in the morning</quote>), or between dusk and dawn (<quote>any
-time tonight</quote>) using the combobox near the top of the window.
+time tonight</quote>) using the combobox near the top of the window. 
+You can also choose to see only those objects that are brighter than a 
+magnitude by seting a minimum magnitude using the <guilabel>Show objects 
+brighter than magnitude</guilabel> spinbox. You may center the selected object 
+in the Sky Map or add it to Wish List by pressing the 
+<guibutton>Center Object</guibutton> or <guibutton>Add to List</guibutton> button.
 </para>
 </sect1>
 
