[education/kstars] doc: More revision with items reordered

Antoni Bella Pérez null at kde.org
Tue Jul 27 04:19:07 BST 2021


Git commit 6beac9288e0de9e3a03e7db6768ea98ba2d68721 by Antoni Bella Pérez.
Committed on 25/07/2021 at 12:54.
Pushed by mutlaqja into branch 'master'.

More revision with items reordered

M  +1    -1    doc/calc-apcoords.docbook
M  +1    -1    doc/calc-ecliptic.docbook
M  +1    -1    doc/calc-eqgal.docbook
M  +1    -1    doc/calc-equinox.docbook
M  +2    -2    doc/calc-geodetic.docbook
M  +1    -1    doc/calc-horizontal.docbook
M  +6    -6    doc/calc-julianday.docbook
M  +2    -2    doc/calc-planetcoords.docbook
M  +3    -2    doc/calc-sidereal.docbook
M  +20   -18   doc/calculator.docbook
M  +25   -26   doc/details.docbook

https://invent.kde.org/education/kstars/commit/6beac9288e0de9e3a03e7db6768ea98ba2d68721

diff --git a/doc/calc-apcoords.docbook b/doc/calc-apcoords.docbook
index a175e6353..e9386717a 100644
--- a/doc/calc-apcoords.docbook
+++ b/doc/calc-apcoords.docbook
@@ -36,7 +36,7 @@ catalog coordinates by selecting an object using the <guilabel>Find Object</guil
 dialog.  You can also specify the
 catalog's epoch here (usually 2000.0 for modern object
 catalogs).  Then the object's coordinates for the target date
-will be displayed in the <guilabel>Apparent Coordinates</guilabel>
+will be displayed in the <guilabel>Apparent coordinates:</guilabel>
 section.
 </para>
 </sect2>
diff --git a/doc/calc-ecliptic.docbook b/doc/calc-ecliptic.docbook
index 2307dfa49..21eb55f51 100644
--- a/doc/calc-ecliptic.docbook
+++ b/doc/calc-ecliptic.docbook
@@ -22,7 +22,7 @@ The Ecliptic Coordinates calculator module
 <para>
 This module converts between <link linkend="equatorial">Equatorial
 coordinates</link> and <link linkend="ecliptic">Ecliptic
-coordinates</link>.  First, select <guilabel>Date & time</guilabel>.
+coordinates</link>.  First, select <guilabel>Date and time:</guilabel>.
 Then, fill in the coordinate values in either the <guilabel>Ecliptic
 Coordinates</guilabel> or <guilabel>Equatorial Coordinates</guilabel>
 section.  Alternatively set the equatorial coordinates by selecting an
diff --git a/doc/calc-eqgal.docbook b/doc/calc-eqgal.docbook
index d5ae72045..116fabfec 100644
--- a/doc/calc-eqgal.docbook
+++ b/doc/calc-eqgal.docbook
@@ -24,7 +24,7 @@ This module converts from <link linkend="equatorial">Equatorial
 coordinates</link> to <link linkend="galactic">Galactic
 coordinates</link>, and vice versa.  Fill in the
 coordinate values in either the <guilabel>Galactic
-coordinates</guilabel> or <guilabel>Equatorial coordinates</guilabel>
+coordinates</guilabel> or <guilabel>Equatorial coordinates (J2000)</guilabel>
 section.  Alternatively set the equatorial coordinates by selecting an
 object using the <guilabel>Find Object</guilabel> dialog.
 Then the complementary coordinates will be filled in.
diff --git a/doc/calc-equinox.docbook b/doc/calc-equinox.docbook
index 86ec40e6d..8bdd061d5 100644
--- a/doc/calc-equinox.docbook
+++ b/doc/calc-equinox.docbook
@@ -34,6 +34,6 @@ Then specify the input and output filenames, and press the
 <guibutton>Compute</guibutton> button to generate the output
 file.  Each line in the output file contains the input year and
 the date of each event. You can also read the output directly in &kstars;
-by pressing the <guibutton>View output</guibutton> button.
+by pressing the <guibutton>View output...</guibutton> button.
 </para>
 </sect2>
diff --git a/doc/calc-geodetic.docbook b/doc/calc-geodetic.docbook
index 7dac23065..b2d85baa9 100644
--- a/doc/calc-geodetic.docbook
+++ b/doc/calc-geodetic.docbook
@@ -35,8 +35,8 @@ Geographic coordinates (Longitude, Latitude and Elevation).
 
 <para>
 To use the module, first select which coordinates you will use as
-input in the <guilabel>Select Input Coordinates</guilabel> section: <quote>Cartesian</quote>
-or <quote>Geographic</quote>.
+input in the <guilabel>Select Input Coordinates</guilabel> section: <guilabel>Cartesian</guilabel>
+or <guilabel>Geographic</guilabel> radio buttons.
 Then select an ellipsoid model and fill
 in the input coordinates in either the <guilabel>Cartesian
 Coordinates</guilabel> section or the <guilabel>Geographic
diff --git a/doc/calc-horizontal.docbook b/doc/calc-horizontal.docbook
index ababb431f..f8e02226f 100644
--- a/doc/calc-horizontal.docbook
+++ b/doc/calc-horizontal.docbook
@@ -25,7 +25,7 @@ coordinates</link> to <link linkend="horizontal">Horizontal
 coordinates</link>.  First, select the date, time, and
 geographic coordinates for the calculation.  Then, fill in the
 equatorial coordinates to be converted or use the <guilabel>Find Object</guilabel> dialog
-in the <guilabel>Equatorial Coordinates</guilabel> section.
+in the <guilabel>Equatorial Coordinates (J2000)</guilabel> section.
 The corresponding Horizontal coordinates will be presented in
 the <guilabel>Horizontal Coordinates</guilabel> section.
 </para>
diff --git a/doc/calc-julianday.docbook b/doc/calc-julianday.docbook
index c5727b4a6..428554d34 100644
--- a/doc/calc-julianday.docbook
+++ b/doc/calc-julianday.docbook
@@ -20,9 +20,9 @@ The Julian Day calculator module
 </screenshot>
 
 <para>
-This module converts between the calendar <guilabel>Date and time</guilabel>, the <link
-linkend="ai-julianday">Julian Day</link>, and the
-<firstterm>Modified Julian Day</firstterm>.  The Modified Julian Day
+This module converts between the calendar <guilabel>Date and time:</guilabel>, the <link
+linkend="ai-julianday"><guilabel>Julian day:</guilabel></link>, and the
+<guilabel>Modified julian day:</guilabel>.  The Modified Julian Day
 is simply equal to the Julian Day - 2,400,000.5.
 </para><para>
 To use the module, enter one of the three dates and the corresponding values for
@@ -38,10 +38,10 @@ or <quote>Modified Julian day</quote>.
 Then specify the input and output filenames, and press the
 <guibutton>Compute</guibutton> button to generate the output
 file. The output file will contains values for the other two complementary parameters. For example,
-if your input file contains a set of <quote>Date and time</quote> values, then each line of
-the output file will contain values for <quote>Julian day</quote> and <quote>Modified Julian day</quote>.
+if your input file contains a set of <guilabel>Date and time:</guilabel> values, then each line of
+the output file will contain values for <guilabel>Julian day:</guilabel> and <guilabel>Modified julian day:</guilabel>.
 You can read the output directly in &kstars;
-by pressing the <guibutton>View output</guibutton> button.
+by pressing the <guibutton>View output...</guibutton> button.
 </para>
 
 <tip>
diff --git a/doc/calc-planetcoords.docbook b/doc/calc-planetcoords.docbook
index c57968d0c..1e6a6d512 100644
--- a/doc/calc-planetcoords.docbook
+++ b/doc/calc-planetcoords.docbook
@@ -22,8 +22,8 @@ The Planet Coordinates calculator module
 <para>
 The Planet Coordinates module computes positional data for
 any major solar system body, for any time and date and any
-geographic location.  Simply select the <guilabel>Solar
-system body</guilabel> from the drop-down list, and specify
+geographic location.  Simply select from the <guilabel>Solar
+system body:</guilabel> drop-down list, and specify
 the desired date, time, and geographic coordinates (these
 values are preset to the current &kstars; settings).  Then
 the <link linkend="equatorial">Equatorial</link>, <link
diff --git a/doc/calc-sidereal.docbook b/doc/calc-sidereal.docbook
index a68225af7..278768a73 100644
--- a/doc/calc-sidereal.docbook
+++ b/doc/calc-sidereal.docbook
@@ -29,7 +29,8 @@ calculation. Then the corresponding value for the other Time will be displayed.
 <para>
 There is a batch mode for this module.  To use it, simply
 generate an input file whose lines each contain values for
-the input parameter: <quote>sidereal time</quote> or <quote>standard time</quote>.
+the input parameter: <guimenuitem>Compute sidereal time</guimenuitem> or 
+<guimenuitem>Compute standard time</guimenuitem> from to left dropdown box.
 You can choose to set the <guilabel>Date:</guilabel> and <guilabel>Location:</guilabel> in the
 current window, or you can tell &kstars; to read these values from the <guilabel>Input file:</guilabel>.
 Then specify the input and output filenames, and press the
@@ -38,7 +39,7 @@ file. The output file will contains values for the complementary parameter. For
 if your input file contains a set of <quote>standard time</quote> values, then each line of
 the output file will contain values for <quote>sidereal time</quote>.
 You can read the output directly in &kstars;
-by pressing the <guibutton>View output</guibutton> button.
+by pressing the <guibutton>View output...</guibutton> button.
 </para>
 
 </sect2>
diff --git a/doc/calculator.docbook b/doc/calculator.docbook
index d88f2e1cb..e8e9ac7f6 100644
--- a/doc/calculator.docbook
+++ b/doc/calculator.docbook
@@ -9,43 +9,45 @@ The &kstars; Astrocalculator provides several modules that
 give you direct access to algorithms used by the program.
 The modules are organized by subject:
 
+<itemizedlist><title>Time Calculators</title>
+<listitem><para><link linkend="calc-julian">Julian Day</link></para></listitem>
+<listitem><para><link linkend="calc-sidereal">Sidereal Time</link></para></listitem>
+<listitem><para><link linkend="calc-dayduration">Almanac</link></para></listitem>
+<listitem><para><link linkend="calc-equinox">Equinoxes and Solstices</link></para></listitem>
+</itemizedlist>
+
 <itemizedlist><title>Coordinate Converters</title>
-<listitem><para><link linkend="calc-angdist">Angular Distance</link></para></listitem>
-<listitem><para><link linkend="calc-apcoords">Apparent Coordinates</link></para></listitem>
-<listitem><para><link linkend="calc-ecliptic">Ecliptic Coordinates</link></para></listitem>
 <listitem><para><link linkend="calc-eqgal">Equatorial/Galactic Coordinates</link></para></listitem>
+<listitem><para><link linkend="calc-apcoords">Apparent Coordinates</link></para></listitem>
 <listitem><para><link linkend="calc-horiz">Horizontal Coordinates</link></para></listitem>
+<listitem><para><link linkend="calc-ecliptic">Ecliptic Coordinates</link></para></listitem>
+<listitem><para><link linkend="calc-angdist">Angular Distance</link></para></listitem>
 <listitem><para><link linkend="calc-geodetic">Geodetic Coordinates</link></para></listitem>
 <!-- missing
-LSR Velocity
+<listitem><para><link linkend="calc-lsr-velocity">LSR Velocity</link></para></listitem>
  -->
 </itemizedlist>
 <itemizedlist><title>Solar System</title>
 <listitem><para><link linkend="calc-planetcoords">Planets Coordinates</link></para></listitem>
 <!-- missing
-Conjunctions
+<listitem><para><link linkend="calc-conjunctions">Conjunctions</link></para></listitem>
+<listitem><para><link linkend="calc-eclipses">Eclipses</link></para></listitem>
 Moon Phase Almanach
  -->
 </itemizedlist>
-<itemizedlist><title>Time Calculators</title>
-<listitem><para><link linkend="calc-dayduration">Almanac</link></para></listitem>
-<listitem><para><link linkend="calc-equinox">Equinoxes and Solstices</link></para></listitem>
-<listitem><para><link linkend="calc-julian">Julian Day</link></para></listitem>
-<listitem><para><link linkend="calc-sidereal">Sidereal Time</link></para></listitem>
-</itemizedlist>
 </para>
 
-&calc-angdist;
-&calc-apcoords;
-&calc-ecliptic;
+&calc-julian;
+&calc-sidereal;
+&calc-dayduration;
+&calc-equinox;
 &calc-eqgal;
+&calc-apcoords;
 &calc-horiz;
+&calc-ecliptic;
+&calc-angdist;
 &calc-geodetic;
 &calc-planetcoords;
-&calc-dayduration;
-&calc-equinox;
-&calc-julian;
-&calc-sidereal;
 
 </sect1>
 
diff --git a/doc/details.docbook b/doc/details.docbook
index 91f4a43c7..52e463b33 100644
--- a/doc/details.docbook
+++ b/doc/details.docbook
@@ -26,8 +26,8 @@ a specific object in the sky.  To access this tool,
 <guimenuitem>Details...</guimenuitem> item from the popup menu.
 </para>
 <para>
-The window is divided into a number of Tabs.  In the
-<guilabel>General</guilabel> Tab, we present basic data about
+The window is divided into a number of tabs.  In the
+<guilabel>General</guilabel> tab, we present basic data about
 the current object.  This includes names and catalog designations,
 object type, and <link linkend="ai-magnitude">magnitude</link>
 (brightness).  On the <guilabel>Position</guilabel> tab
@@ -48,8 +48,7 @@ button.  This will open a window in which you fill in the &URL; and link
 text for the new link (you can also test the &URL; in the web browser
 from this window).  Every time you add a custom &URL; to a certain object,
 you are able to choose the resource type using the <guibutton>Resource Type</guibutton>
-radio button. It has two predefined values: <quote>Image</quote> or <quote>Information</quote>.
-Keep in mind that the custom link can easily point
+button. Keep in mind that the custom link can easily point
 to a file on your local disk, so you can use this feature to index
 your personal astronomical images or observing logs.
 </para>
@@ -63,7 +62,7 @@ an unnamed star or
 if advinterface file failed loading or
 for solar system objects -->
 <para>
-The <guilabel>Advanced</guilabel> Tab (not available for all objects) allows you to query professional
+The <guilabel>Advanced</guilabel> tab (not available for all objects) allows you to query professional
 astronomical databases on the internet for information regarding the
 current object.  To use these databases, double click on the
 desired database in the list to see the results of your query in a web browser window.  The
@@ -72,17 +71,26 @@ open the Details Dialog.  The following databases are available for
 querying:
 
 <itemizedlist>
-<listitem><para>High Energy Astrophysical Archive (HEASARC).  Here you
+<listitem><para><guimenuitem>Set of Identifications, Measurements, and Bibliography
+for Astronomical Data (SIMBAD)</guimenuitem>: SIMBAD is similar to NED, except it
+provides data about all kinds of objects, not just galaxies.
+</para></listitem>
+<listitem><para><guimenuitem>SkyView</guimenuitem>: Provides images from All-Sky surveys that have
+been performed in dozens of different parts of the spectrum, from
+Gamma Rays to the Radio.  The &kstars; interface will retrieve an image
+from any of these surveys, centered on the selected object.
+</para></listitem>
+<listitem><para><guimenuitem>High Energy Astrophysical Archive (HEASARC)</guimenuitem>: Here you
 can retrieve data about the current object from a number of
 <quote>High-energy</quote> observatories, which covers the
 Ultraviolet, X-ray and Gamma Ray portions of the electromagnetic
 spectrum.</para></listitem>
-<listitem><para>Multimission Archive at Space Telescope (MAST).
-The Space Telescope Science Institute provides access to the entire
-collection of images and spectra taken with the Hubble Space
-Telescope, as well as several other space-based observatories.
+<listitem><para><guimenuitem>NASA/IPAC Extragalactic Database (NED)</guimenuitem>: NED provides
+encapsulated data and bibliographic links about
+extragalactic objects.  You should only use NED if your target is
+extragalactic; &ie; if it is itself a galaxy.
 </para></listitem>
-<listitem><para>NASA Astrophysical Data System (ADS).  This
+<listitem><para><guimenuitem>NASA Astrophysical Data System (ADS)</guimenuitem>: This
 incredible bibliographic database encompass the entire body of
 literature published in international peer-review Journals about
 astronomy and astrophysics.  The database is divided into four
@@ -95,26 +103,17 @@ search</quote> will return articles which included the object name in
 their Title, and the <quote>Title & Keyword search</quote> uses
 both options together.
 </para></listitem>
-<listitem><para>NASA/IPAC Extragalactic Database (NED).  NED provides
-encapsulated data and bibliographic links about
-extragalactic objects.  You should only use NED if your target is
-extragalactic; &ie; if it is itself a galaxy.
-</para></listitem>
-<listitem><para>Set of Identifications, Measurements, and Bibliography
-for Astronomical Data (SIMBAD).  SIMBAD is similar to NED, except it
-provides data about all kinds of objects, not just galaxies.
-</para></listitem>
-<listitem><para>SkyView provides images from All-Sky surveys that have
-been performed in dozens of different parts of the spectrum, from
-Gamma Rays to the Radio.  The &kstars; interface will retrieve an image
-from any of these surveys, centered on the selected object.
+<listitem><para><guimenuitem>Multimission Archive at Space Telescope (MAST)</guimenuitem>:
+The <ulink url="https://www.stsci.edu/">Space Telescope Science Institute</ulink> provides access to the entire
+collection of images and spectra taken with the Hubble Space
+Telescope, as well as several other space-based observatories.
 </para></listitem>
 </itemizedlist>
 </para>
 
 <para>
-Finally, in the <guilabel>Log</guilabel> Tab, you can type in some text
-that will remain associated with this object's Details window.
+Finally, in the <guilabel>Log</guilabel> tab, you can type in some text
+that will remain associated with this object's <guilabel>Details</guilabel> window.
 You could use this to attach personal observing notes, for example. Your notes
 will be saved, such that you can easily read or use them next time when you will
 use &kstars;.



More information about the kde-doc-english mailing list