[kde-doc-english] [kstars] doc: Update the documentation for KStars' Astrocalculator
Raphael Cojocaru
raphael.cojocaru at yahoo.com
Tue Jul 12 12:13:17 UTC 2016
Git commit 7130dbdaaf37c9373500c1312fb77f2b7076d0b3 by Raphael Cojocaru.
Committed on 12/07/2016 at 12:12.
Pushed by raphaelc into branch 'master'.
Update the documentation for KStars' Astrocalculator
M +3 -1 doc/calc-angdist.docbook
M +3 -1 doc/calc-apcoords.docbook
M +0 -10 doc/calc-ecliptic.docbook
M +12 -2 doc/calc-eqgal.docbook
M +3 -3 doc/calc-equinox.docbook
M +17 -2 doc/calc-geodetic.docbook
M +16 -1 doc/calc-julianday.docbook
M +1 -1 doc/calc-planetcoords.docbook
M +17 -0 doc/calc-sidereal.docbook
M +7 -2 doc/details.docbook
http://commits.kde.org/kstars/7130dbdaaf37c9373500c1312fb77f2b7076d0b3
diff --git a/doc/calc-angdist.docbook b/doc/calc-angdist.docbook
index eda551a..c83a1f0 100644
--- a/doc/calc-angdist.docbook
+++ b/doc/calc-angdist.docbook
@@ -28,7 +28,9 @@ the two points.
</para>
<para>
There is also a Batch mode for this module. In batch mode, you
-specify an input filename which contains four numbers per line:
+specify an input filename which contains a number of parameters (up to four) on each line:
+the initial right ascension (RA), initial declination (Dec), final right ascension and
+final declination. By default, each line should contain four numbers signifying
the RA and Dec values for pairs of points. Alternatively, you can
specify a single value for any of these four coordinates in
the calculator panel (the corresponding values in the input file
diff --git a/doc/calc-apcoords.docbook b/doc/calc-apcoords.docbook
index 7edb3dd..cb8a77b 100644
--- a/doc/calc-apcoords.docbook
+++ b/doc/calc-apcoords.docbook
@@ -31,7 +31,9 @@ aberration. This module takes these effects into account.
To use the module, first enter the desired target date and time
in the <guilabel>Target Time & Date</guilabel> section. Then,
enter the catalog coordinates in the <guilabel>Catalog
-Coordinates</guilabel> section. You can also specify the
+Coordinates</guilabel> section. Alternatively you can set the
+catalog coordinates by selecting an object using the <guilabel>Find Object</guilabel>
+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>
diff --git a/doc/calc-ecliptic.docbook b/doc/calc-ecliptic.docbook
index e4fb18e..07a2289 100644
--- a/doc/calc-ecliptic.docbook
+++ b/doc/calc-ecliptic.docbook
@@ -29,14 +29,4 @@ 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.
</para>
-<para>
-The module contains a batch mode for converting several coordinate
-pairs at once. You must construct an input file in which each line
-contains two values: the input coordinate pairs (either Equatorial
-or Ecliptic). Then specify which coordinates you are using as input,
-and identify the input and output filenames. Finally, press the
-<guibutton>Run</guibutton> button to generate the output file,
-which will contain the converted coordinates (Equatorial or
-Ecliptic; the complement of what you chose as the input values).
-</para>
</sect2>
diff --git a/doc/calc-eqgal.docbook b/doc/calc-eqgal.docbook
index 1f8141d..d658fd4 100644
--- a/doc/calc-eqgal.docbook
+++ b/doc/calc-eqgal.docbook
@@ -27,7 +27,17 @@ coordinate values in either the <guilabel>Galactic
coordinates</guilabel> or <guilabel>Equatorial coordinates</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.
+Then the complementary coordinates will be filled in.
</para>
-</sect2>
+<para>
+The module contains a batch mode for converting several coordinate
+pairs at once. You must construct an input file in which each line
+contains two values: the input coordinate pairs (either Equatorial
+or Galactic). Then specify which coordinates you are using as input,
+and identify the input and output filenames. Finally, press the
+<guibutton>Run</guibutton> button to generate the output file,
+which will contain the converted coordinates (Equatorial or
+Galactic; the complement of what you chose as the input values).
+</para>
+</sect2>
diff --git a/doc/calc-equinox.docbook b/doc/calc-equinox.docbook
index 008b855..d7b2863 100644
--- a/doc/calc-equinox.docbook
+++ b/doc/calc-equinox.docbook
@@ -32,8 +32,8 @@ generate an input file whose lines each contain a year
for which the Equinox and Solstice data will be computed.
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,
-the date and time of each event, and the length of each
-season.
+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.
</para>
</sect2>
diff --git a/doc/calc-geodetic.docbook b/doc/calc-geodetic.docbook
index 16337d4..92f0677 100644
--- a/doc/calc-geodetic.docbook
+++ b/doc/calc-geodetic.docbook
@@ -29,11 +29,14 @@ around the equator is about 0.3% longer than a <link
linkend="ai-greatcircle">Great Circle</link> that passes through the
poles. The <firstterm>Geodetic Coordinate system</firstterm> takes
this ellipsoidal shape into account, and expresses the position
-on the Earth's surface in Cartesian coordinates (X, Y, and Z).
+on the Earth's surface in Cartesian coordinates (X, Y and Z) or in
+Geographic coordinates (Longitude, Latitude and Elevation).
</para>
+
<para>
To use the module, first select which coordinates you will use as
-input in the <guilabel>Select Input Coordinates</guilabel> section.
+input in the <guilabel>Select Input Coordinates</guilabel> section: <quote>Cartesian</quote>
+or <quote>Geographic</quote>.
Then select an ellipsoid model and fill
in the input coordinates in either the <guilabel>Cartesian
Coordinates</guilabel> section or the <guilabel>Geographic
@@ -41,4 +44,16 @@ Coordinates</guilabel> section. When you press the
<guibutton>Convert</guibutton> button, the corresponding
coordinates will be filled in.
</para>
+
+<para>
+The module contains a batch mode for converting several coordinate
+values at once. You must construct an input file in which each line
+contains up to three numbers: the input coordinate values (either Cartesian
+or Geographic). Then specify which coordinates you are using as input,
+and identify the input and output filenames. Finally, press the
+<guibutton>Run</guibutton> button to generate the output file,
+which will contain the converted coordinates (Cartesian or
+Geographic; the complement of what you chose as the input values).
+</para>
+
</sect2>
diff --git a/doc/calc-julianday.docbook b/doc/calc-julianday.docbook
index 724e6a9..de759ce 100644
--- a/doc/calc-julianday.docbook
+++ b/doc/calc-julianday.docbook
@@ -26,7 +26,22 @@ linkend="ai-julianday">Julian Day</link>, and the
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
-the other two date systems will be displayed.
+the other two date systems will be displayed. You can also set the Date and time to now, by pressing
+the <guibutton>Now</guibutton> button.
+</para>
+
+<para>
+There is a batch mode for this module. To use it, simply
+generate an input file whose lines each contain a number of values for
+the input parameter: <quote>Date and time</quote>, <quote>Julian day</quote>
+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>.
+You can read the output directly in &kstars;
+by pressing the <guibutton>View output</guibutton> button.
</para>
<tip>
diff --git a/doc/calc-planetcoords.docbook b/doc/calc-planetcoords.docbook
index 00b1c6c..01ba141 100644
--- a/doc/calc-planetcoords.docbook
+++ b/doc/calc-planetcoords.docbook
@@ -38,7 +38,7 @@ and latitude). You may choose to specify a constant value
for some of the parameters in the calculator window (these
parameters should be skipped in the input file). You may
also specify which of the output parameters (Equatorial,
-Horizontal, and Ecliptic coordinates) should be calculated.
+Horizontal, Heliocentric ecliptic and Geocentric ecliptic coordinates) should be calculated.
Finally, specify the input and output filenames, and press
the <guibutton>Run</guibutton> button to generate the output
file with the computed values.
diff --git a/doc/calc-sidereal.docbook b/doc/calc-sidereal.docbook
index 03bdf4c..39c92da 100644
--- a/doc/calc-sidereal.docbook
+++ b/doc/calc-sidereal.docbook
@@ -25,4 +25,21 @@ Time</link> and Local <link linkend="ai-sidereal">Sidereal Time</link>.
First, select a geographic location and a date for the
calculation. Then the corresponding value for the other Time will be displayed.
</para>
+
+<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>.
+You can choose to set the <guilabel>Date</guilabel> and <guilabel>Location</guilabel> in the
+current window, or you can tell &kstars; to read the <guilabel>Date</guilabel> and
+<guilabel>Location</guilabel> values from the input file.
+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 complementary parameter. For example,
+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.
+</para>
+
</sect2>
diff --git a/doc/details.docbook b/doc/details.docbook
index cdebdf3..22d75ce 100644
--- a/doc/details.docbook
+++ b/doc/details.docbook
@@ -46,7 +46,10 @@ appear in the popup menu when the object is
links to the object with the <guibutton>Add Link...</guibutton>
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). Keep in mind that the custom link can easily point
+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
to a file on your local disk, so you can use this feature to index
your personal astronomical images or observing logs.
</para>
@@ -112,7 +115,9 @@ from any of these surveys, centered on the selected object.
<para>
Finally, in the <guilabel>Log</guilabel> Tab, you can type in some text
that will remain associated with this object's Details window.
-You could use this to attach personal observing notes, for example.
+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;.
</para>
</sect1>
More information about the kde-doc-english
mailing list