[kstars] doc: Adding preliminary documentation for eyepiece view simulation. It must be updated to fully explain the tool, I used some of Akarsh comments and added some of my own. Please update it accordingly to meet the quality standards of KStars documentation.
Jasem Mutlaq
null at kde.org
Thu Dec 15 07:11:09 UTC 2016
Git commit be958922442400b175868681d9426b824eaaa031 by Jasem Mutlaq.
Committed on 15/12/2016 at 07:09.
Pushed by mutlaqja into branch 'master'.
Adding preliminary documentation for eyepiece view simulation. It must be updated to fully explain the tool, I used some of Akarsh comments and added some of my own. Please update it accordingly to meet the quality standards of KStars documentation.
CCMAIL:kstars-devel at kde.org
CCMAIL:akarshsimha at gmail.com
A +- -- doc/Arp84_EyepieceView.png
A +- -- doc/EPView_Screenshot.png
A +64 -0 doc/eyepieceview.docbook
M +16 -7 doc/index.docbook
M +2 -2 doc/indi.docbook
M +2 -6 doc/tools.docbook
https://commits.kde.org/kstars/be958922442400b175868681d9426b824eaaa031
diff --git a/doc/Arp84_EyepieceView.png b/doc/Arp84_EyepieceView.png
new file mode 100644
index 000000000..94501408b
Binary files /dev/null and b/doc/Arp84_EyepieceView.png differ
diff --git a/doc/EPView_Screenshot.png b/doc/EPView_Screenshot.png
new file mode 100644
index 000000000..37937cce9
Binary files /dev/null and b/doc/EPView_Screenshot.png differ
diff --git a/doc/eyepieceview.docbook b/doc/eyepieceview.docbook
new file mode 100644
index 000000000..2b1e268bd
--- /dev/null
+++ b/doc/eyepieceview.docbook
@@ -0,0 +1,64 @@
+<sect1 id="tool-eyepieceview">
+<title>Simulate Eyepiece View</title>
+<indexterm><primary>Tools</primary>
+<secondary>Simulate Eyepiece View</secondary>
+</indexterm>
+
+<screenshot>
+<screeninfo>
+Simulate eyepiece view
+</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="EPView_Screenshot.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ Example View
+ </phrase>
+ </textobject>
+ <caption>
+ On the left hand side is the sky map shot from KStars. On the right hand side is the POSS (DSS) image of the same region. The orientation in the above example has been adjusted to match the view through a Dobsonian telescope at the location and time of the simulation in KStars.
+ </caption>
+</mediaobject>
+</screenshot>
+
+<para>
+This tool simulates how an object looks through your eyepeice. In addition to rendering the eyepiece field, &kstars; can also fetch and overlay the DSS imagery. Additionally, if you are using a Dobsonian telescope, you can rotate the field of view to match the eyepiece view.
+</para>
+
+<para>To use this feature, first define your eyepieces' fields of view using the <link linkend="customize">FOV Symbol editor</link>.</para>
+
+<para>Then there are two ways to invoke the feature:
+<itemizedlist>
+ <listitem><para>In Sky Map, right click on the desired object and click <guilabel>Simulate eyepiece view</guilabel> in the popup menu.</para></listitem>
+ <listitem><para>In observation planner, right click an object and click <guilabel>Simulate eyepiece view</guilabel> in the popup menu.</para></listitem>
+</itemizedlist>
+</para>
+
+<para>When the tool is first invoked, it will prompt a dialog to select the desired FOV to render the view. To compare the rendered view against a real sky image, click the <guibutton>Fetch DSS image</guibutton> button to download a DSS image. You can manually adjust the view to match your eyepiece using the rotation slider, the <guilabel>invert view</guilabel> and <guilabel>flip view</guilabel> check boxes. Alternatively, you can use a pre-calculated amount of rotation by using one of the <guilabel>Presets</guilabel> that is tailored for different optical systems.</para>
+
+<screenshot>
+<screeninfo>
+Arp84 eyepiece view
+</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="Arp84_EyepieceView.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>
+ View with Overlay
+ </phrase>
+ </textobject>
+ <caption>
+ Arp84 eyepiece view with ticks enabled indicating how the chart must be oriented to match the eyepiece view through a Dobsonian at a given time (the generated data is for location McDonald Observatory Texas, and the date is 14th Dec 2016).
+ </caption>
+</mediaobject>
+</screenshot>
+
+<para>
+To export the view to a file, Click <guibutton>Export</guibutton> button. Export enables adding ticks for printed charts as shown above and save the image.
+</para>
+
+</sect1>
diff --git a/doc/index.docbook b/doc/index.docbook
index 235306f78..41b69a3f1 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -53,6 +53,7 @@
<!ENTITY telescopes SYSTEM "telescopes.docbook">
<!ENTITY timezones SYSTEM "timezones.docbook">
<!ENTITY tool-altvstime SYSTEM "altvstime.docbook">
+ <!ENTITY tool-eyepieceview SYSTEM "eyepieceview.docbook">
<!ENTITY tool-calculator SYSTEM "calculator.docbook">
<!ENTITY tool-details SYSTEM "details.docbook">
<!ENTITY tool-whatsup SYSTEM "wut.docbook">
@@ -91,6 +92,15 @@
</othercredit>
<othercredit role="developer">
+<firstname>Akarsh</firstname>
+<surname>Simha</surname>
+<affiliation>
+<address><email>akarshsimha AT gmail dot com</email></address>
+</affiliation>
+<contrib>Core Developer</contrib>
+</othercredit>
+
+<othercredit role="developer">
<firstname>James</firstname>
<surname>Bowlin</surname>
<affiliation>
@@ -149,14 +159,14 @@
</authorgroup>
<copyright>
-<year>2001-2016</year>
+<year>2001-2017</year>
<holder>&Jason.Harris; and the &kstars; Team</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2016-08-08</date>
-<releaseinfo>2.6.0 (Applications 16.08)</releaseinfo>
+<date>2016-12-14</date>
+<releaseinfo>2.7.2 (Applications 17.04)</releaseinfo>
<abstract>
<para>
@@ -183,8 +193,7 @@ Included with &kstars; is Ekos astrophotography suite, a complete astrophotograp
<title>Introduction</title>
<para>
-&kstars; lets you explore the night sky from
-the comfort of your computer chair. It provides an accurate graphical
+&kstars; lets you explore the night sky from the comfort of your computer chair. It provides an accurate graphical
representation of the night sky for any date, from any location on
Earth. The display includes 126,000 stars to 9th magnitude (100 million with addon catalogs), 13,000 deep-sky objects (Messier, NGC, and IC catalogs), all planets, the Sun and Moon, hundreds of comets and
asteroids, the Milky Way, 88 constellations, and guide lines such as the <link linkend="ai-cequator">celestial equator</link>, the <link linkend="ai-horizon">horizon</link> and the <link linkend="ai-ecliptic">ecliptic</link>.
@@ -201,7 +210,7 @@ Our <link linkend="tool-calculator">Astrocalculator</link> tool provides direct
</para>
<para>
You can plan an observing session using our <link linkend="tool-altvstime">Altitude vs. Time</link> tool, which will plot curves representing the Altitude as a function of time for any group of objects. If that is too much detail, we also provide a <link linkend="tool-whatsup">What's Up Tonight?</link> tool that summarizes the objects that you will be able to see from your location on any given night. You can add your favorite objects to your
-observing wish-list using the <link linkend="tool-obsplanner">Observation Planner</link> tool, which allows you to plan your observation sessions professionally.
+observing wish-list using the <link linkend="tool-obsplanner">Observation Planner</link> tool, which allows you to plan your observation sessions professionally. To see how object appears in the eyepiece under different telescopes and field of views, use the <link linkend="tool-eyepieceview">Simulate Eyepiece View</link> tool to render a simulated view of what you see.
</para>
<para>
&kstars; also provides a <link linkend="tool-solarsys">Solar System Viewer</link>, which shows the current configuration of the major planets in our solar system. There is also a <link
@@ -233,11 +242,11 @@ We are very interested in your feedback; please report bugs or feature requests
&quicktour; <!--A Quick Tour of &kstars;-->
&config; <!--Configuring &kstars;-->
&commands; <!--Command Reference-->
-&astroinfo; <!--AstroInfo Articles-->
&tools; <!--&kstars; Tools-->
&dumpmode; <!--Command-line image-dump mode-->
&indi; <!-- INDI-->
&faq; <!--Questions and Answers-->
+&astroinfo; <!--AstroInfo Articles-->
&credits; <!--Credits and License-->
&documentation.index;
diff --git a/doc/indi.docbook b/doc/indi.docbook
index bfeb96d59..330332756 100644
--- a/doc/indi.docbook
+++ b/doc/indi.docbook
@@ -332,8 +332,8 @@ The window is divided into several main categories: General, Device Updates, Dis
<itemizedlist>
<listitem><para>General</para>
<itemizedlist>
- <listitem><para><option>INDI Server:</option> Specify the directory where INDI server
-is located in your system. By default, &kstars; uses <quote>/usr/bin/indiserver</quote> directory.
+ <listitem><para><option>INDI Server:</option> Specify the binary of installed INDI server
+in your system. By default, &kstars; uses <quote>/usr/bin/indiserver</quote> binary.
</para></listitem>
<listitem><para><option>INDI Drivers Directory:</option> Specify the directory where INDI
drivers are located in your system. By default, &kstars; uses <quote>/usr/share/indi</quote> directory.
diff --git a/doc/tools.docbook b/doc/tools.docbook
index 886cdbf8e..26a0c947d 100644
--- a/doc/tools.docbook
+++ b/doc/tools.docbook
@@ -9,11 +9,9 @@ some more advanced aspects of astronomy and the night sky.
<itemizedlist>
<listitem><para><link linkend="tool-details">Object Details</link></para></listitem>
<listitem><para><link linkend="tool-calculator">Astrocalculator</link></para></listitem>
-<!--
-<listitem><para><link linkend="tool-aavso">AAVSO Lightcurves</link></para></listitem>
--->
<listitem><para><link linkend="tool-altvstime">Altitude vs. Time Plotter</link></para></listitem>
<listitem><para><link linkend="tool-whatsup">What's Up Tonight?</link></para></listitem>
+<listitem><para><link linkend="tool-eyepieceview">Simulate Eyepiece View</link></para></listitem>
<listitem><para><link linkend="tool-scriptbuilder">Script Builder</link></para></listitem>
<listitem><para><link linkend="tool-solarsys">Solar System Viewer</link></para></listitem>
<listitem><para><link linkend="tool-jmoons">Jupiter Moons Tool</link></para></listitem>
@@ -23,10 +21,8 @@ some more advanced aspects of astronomy and the night sky.
&tool-details;
&tool-calculator;
-<!-- &tool-aavso;
-removed after 4.9, see http://commits.kde.org/kstars/c8dd5af7bff7f738ce2b6ab68bdb46e9125bde7d
--->
&tool-altvstime;
+&tool-eyepieceview;
&tool-whatsup;
&tool-scriptbuilder;
&tool-solarsys;
More information about the Kstars-devel
mailing list