summaryrefslogtreecommitdiffstats
path: root/doc/kstars/calc-ecliptic.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'doc/kstars/calc-ecliptic.docbook')
-rw-r--r--doc/kstars/calc-ecliptic.docbook43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/kstars/calc-ecliptic.docbook b/doc/kstars/calc-ecliptic.docbook
new file mode 100644
index 00000000..9117cd25
--- /dev/null
+++ b/doc/kstars/calc-ecliptic.docbook
@@ -0,0 +1,43 @@
+<sect2 id="calc-ecliptic">
+<title>Ecliptic Coordinates module</title>
+<indexterm><primary>Tools</primary>
+<secondary>Astrocalculator</secondary>
+<tertiary>Ecliptic Coordinates module</tertiary>
+</indexterm>
+
+<screenshot>
+<screeninfo>
+The Ecliptic Coordinates calculator module
+</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="calc-ecliptic.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ecliptic Coordinates</phrase>
+ </textobject>
+</mediaobject>
+</screenshot>
+
+<para>
+This module converts between <link linkend="equatorial">Equatorial
+coordinates</link> and <link linkend="ecliptic">Ecliptic
+coordinates</link>. First, select which coordinates
+should be taken as input values in the <guilabel>Choose Input
+Coordinates</guilabel> section. Then, fill in the corresponding
+coordinate values in either the <guilabel>Ecliptic
+coordinates</guilabel> or <guilabel>Equatorial coordinates</guilabel>
+section. Finally, press the <guibutton>Compute</guibutton> button,
+and 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>