Git commit 4695a1e220fabc711c74b73e6249d8d72f5f6a3d by Jasem Mutlaq. Committed on 07/01/2019 at 08:45. Pushed by mutlaqja into branch 'doc_refactor'.
Creating branch for documentation refactoring works A +8 -0 doc/ekos.docbook M +252 -235 doc/index.docbook M +2 -0 doc/tools.docbook A +24 -0 doc/xplanetsolarsys.docbook A +- -- doc/xplanetsolarsystem.png https://commits.kde.org/kstars/4695a1e220fabc711c74b73e6249d8d72f5f6a3d diff --git a/doc/ekos.docbook b/doc/ekos.docbook new file mode 100644 index 000000000..cfc507a0f --- /dev/null +++ b/doc/ekos.docbook @@ -0,0 +1,8 @@ +<chapter id="ekos"> +<title>Ekos Astrophotography Tool</title> + +<para> +TODO +</para> + +</chapter> diff --git a/doc/index.docbook b/doc/index.docbook index 9ffee73e0..2bcb39250 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,176 +1,173 @@ <?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ - <!ENTITY astroinfo SYSTEM "astroinfo.docbook"> - <!ENTITY blackbody SYSTEM "blackbody.docbook"> - <!ENTITY calc-angdist SYSTEM "calc-angdist.docbook"> - <!ENTITY calc-apcoords SYSTEM "calc-apcoords.docbook"> - <!ENTITY calc-ecliptic SYSTEM "calc-ecliptic.docbook"> - <!ENTITY calc-eqgal SYSTEM "calc-eqgal.docbook"> - <!ENTITY calc-equinox SYSTEM "calc-equinox.docbook"> - <!ENTITY calc-horiz SYSTEM "calc-horizontal.docbook"> - <!ENTITY calc-planetcoords SYSTEM "calc-planetcoords.docbook"> - <!ENTITY calc-geodetic SYSTEM "calc-geodetic.docbook"> - <!ENTITY calc-dayduration SYSTEM "calc-dayduration.docbook"> - <!ENTITY calc-julian SYSTEM "calc-julianday.docbook"> - <!ENTITY calc-sidereal SYSTEM "calc-sidereal.docbook"> - <!ENTITY calculator SYSTEM "calculator.docbook"> - <!ENTITY cequator SYSTEM "cequator.docbook"> - <!ENTITY colorandtemp SYSTEM "colorandtemp.docbook"> - <!ENTITY commands SYSTEM "commands.docbook"> - <!ENTITY config SYSTEM "config.docbook"> - <!ENTITY contents SYSTEM "ai-contents.docbook"> - <!ENTITY cosmicdist SYSTEM "cosmicdist.docbook"> - <!ENTITY cpoles SYSTEM "cpoles.docbook"> - <!ENTITY credits SYSTEM "credits.docbook"> - <!ENTITY csphere SYSTEM "csphere.docbook"> - <!ENTITY darkmatter SYSTEM "darkmatter.docbook"> - <!ENTITY dumpmode SYSTEM "dumpmode.docbook"> - <!ENTITY ecliptic SYSTEM "ecliptic.docbook"> - <!ENTITY ellipgal SYSTEM "ellipticalgalaxies.docbook"> - <!ENTITY epoch SYSTEM "epoch.docbook"> - <!ENTITY equinox SYSTEM "equinox.docbook"> - <!ENTITY faq SYSTEM "faq.docbook"> - <!ENTITY flux SYSTEM "flux.docbook"> - <!ENTITY geocoords SYSTEM "geocoords.docbook"> - <!ENTITY greatcircle SYSTEM "greatcircle.docbook"> - <!ENTITY horizon SYSTEM "horizon.docbook"> - <!ENTITY hourangle SYSTEM "hourangle.docbook"> - <!ENTITY indi SYSTEM "indi.docbook"> - <!ENTITY julianday SYSTEM "julianday.docbook"> - <!ENTITY leapyear SYSTEM "leapyear.docbook"> - <!ENTITY lightcurves SYSTEM "lightcurves.docbook"> - <!ENTITY luminosity SYSTEM "luminosity.docbook"> - <!ENTITY magnitude SYSTEM "magnitude.docbook"> - <!ENTITY meridian SYSTEM "meridian.docbook"> - <!ENTITY parallax SYSTEM "parallax.docbook"> - <!ENTITY precession SYSTEM "precession.docbook"> - <!ENTITY quicktour SYSTEM "quicktour.docbook"> - <!ENTITY retrograde SYSTEM "retrograde.docbook"> - <!ENTITY sidereal SYSTEM "sidereal.docbook"> - <!ENTITY skycoords SYSTEM "skycoords.docbook"> - <!ENTITY spiralgal SYSTEM "spiralgalaxies.docbook"> - <!ENTITY stars SYSTEM "stars.docbook"> - <!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"> - <!ENTITY tool-scriptbuilder SYSTEM "scriptbuilder.docbook"> - <!ENTITY tool-solarsys SYSTEM "solarsys.docbook"> - <!ENTITY tool-jmoons SYSTEM "jmoons.docbook"> - <!ENTITY tool-obsplanner SYSTEM "obsplanner.docbook"> - <!ENTITY tool-fitsviewer SYSTEM "fitsviewer.docbook"> - <!ENTITY tools SYSTEM "tools.docbook"> - <!ENTITY utime SYSTEM "utime.docbook"> - <!ENTITY zenith SYSTEM "zenith.docbook"> - <!ENTITY hips SYSTEM "hips.docbook"> - <!ENTITY % addindex "INCLUDE"> - <!ENTITY % English "INCLUDE"><!-- change language only here --> + +<!ENTITY astroinfo SYSTEM "astroinfo.docbook"> +<!ENTITY blackbody SYSTEM "blackbody.docbook"> +<!ENTITY calc-angdist SYSTEM "calc-angdist.docbook"> +<!ENTITY calc-apcoords SYSTEM "calc-apcoords.docbook"> +<!ENTITY calc-ecliptic SYSTEM "calc-ecliptic.docbook"> +<!ENTITY calc-eqgal SYSTEM "calc-eqgal.docbook"> +<!ENTITY calc-equinox SYSTEM "calc-equinox.docbook"> +<!ENTITY calc-horiz SYSTEM "calc-horizontal.docbook"> +<!ENTITY calc-planetcoords SYSTEM "calc-planetcoords.docbook"> +<!ENTITY calc-geodetic SYSTEM "calc-geodetic.docbook"> +<!ENTITY calc-dayduration SYSTEM "calc-dayduration.docbook"> +<!ENTITY calc-julian SYSTEM "calc-julianday.docbook"> +<!ENTITY calc-sidereal SYSTEM "calc-sidereal.docbook"> +<!ENTITY calculator SYSTEM "calculator.docbook"> +<!ENTITY cequator SYSTEM "cequator.docbook"> +<!ENTITY colorandtemp SYSTEM "colorandtemp.docbook"> +<!ENTITY commands SYSTEM "commands.docbook"> +<!ENTITY config SYSTEM "config.docbook"> +<!ENTITY contents SYSTEM "ai-contents.docbook"> +<!ENTITY cosmicdist SYSTEM "cosmicdist.docbook"> +<!ENTITY cpoles SYSTEM "cpoles.docbook"> +<!ENTITY credits SYSTEM "credits.docbook"> +<!ENTITY csphere SYSTEM "csphere.docbook"> +<!ENTITY darkmatter SYSTEM "darkmatter.docbook"> +<!ENTITY dumpmode SYSTEM "dumpmode.docbook"> +<!ENTITY ecliptic SYSTEM "ecliptic.docbook"> +<!ENTITY ekos SYSTEM "ekos.docbook"> +<!ENTITY ellipgal SYSTEM "ellipticalgalaxies.docbook"> +<!ENTITY epoch SYSTEM "epoch.docbook"> +<!ENTITY equinox SYSTEM "equinox.docbook"> +<!ENTITY faq SYSTEM "faq.docbook"> +<!ENTITY flux SYSTEM "flux.docbook"> +<!ENTITY geocoords SYSTEM "geocoords.docbook"> +<!ENTITY greatcircle SYSTEM "greatcircle.docbook"> +<!ENTITY horizon SYSTEM "horizon.docbook"> +<!ENTITY hourangle SYSTEM "hourangle.docbook"> +<!ENTITY indi SYSTEM "indi.docbook"> +<!ENTITY julianday SYSTEM "julianday.docbook"> +<!ENTITY leapyear SYSTEM "leapyear.docbook"> +<!ENTITY lightcurves SYSTEM "lightcurves.docbook"> +<!ENTITY luminosity SYSTEM "luminosity.docbook"> +<!ENTITY magnitude SYSTEM "magnitude.docbook"> +<!ENTITY meridian SYSTEM "meridian.docbook"> +<!ENTITY parallax SYSTEM "parallax.docbook"> +<!ENTITY precession SYSTEM "precession.docbook"> +<!ENTITY quicktour SYSTEM "quicktour.docbook"> +<!ENTITY retrograde SYSTEM "retrograde.docbook"> +<!ENTITY sidereal SYSTEM "sidereal.docbook"> +<!ENTITY skycoords SYSTEM "skycoords.docbook"> +<!ENTITY spiralgal SYSTEM "spiralgalaxies.docbook"> +<!ENTITY stars SYSTEM "stars.docbook"> +<!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"> +<!ENTITY tool-scriptbuilder SYSTEM "scriptbuilder.docbook"> +<!ENTITY tool-solarsys SYSTEM "solarsys.docbook"> +<!ENTITY tool-xplanetsolarsys SYSTEM "xplanetsolarsys.docbook"> +<!ENTITY tool-jmoons SYSTEM "jmoons.docbook"> +<!ENTITY tool-obsplanner SYSTEM "obsplanner.docbook"> +<!ENTITY tool-fitsviewer SYSTEM "fitsviewer.docbook"> +<!ENTITY tools SYSTEM "tools.docbook"> +<!ENTITY ekos SYSTEM "ekos.docbook"> +<!ENTITY utime SYSTEM "utime.docbook"> +<!ENTITY zenith SYSTEM "zenith.docbook"> +<!ENTITY hips SYSTEM "hips.docbook"> +<!ENTITY % addindex "INCLUDE"> +<!ENTITY % English "INCLUDE"> +<!-- change language only here --> ]> - <book id="kstars" lang="&language;"> -<title>The &kstars; Handbook</title> -<bookinfo> - -<authorgroup> -<author> -<firstname>Jason</firstname> -<surname>Harris</surname> -<affiliation> -<address>&Jason.Harris.mail;</address> -</affiliation> -</author> - -<othercredit role="developer"> -<firstname>Jasem</firstname> -<surname>Mutlaq</surname> -<affiliation> -<address><email>mutlaqja AT ikarustech DOT com</email></address> -</affiliation> -<contrib>Core Developer</contrib> -</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> -<address><email>bowlin AT mindspring DOT com</email></address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<othercredit role="developer"> -<firstname>Heiko</firstname> -<surname>Evermann</surname> -<affiliation> -<address>&Heiko.Evermann.mail;</address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<othercredit role="developer"> -<firstname>Thomas</firstname> -<surname>Kabelmann</surname> -<affiliation> -<address>&Thomas.Kabelmann.mail;</address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<othercredit role="developer"> -<firstname>Pablo</firstname> -<surname>de Vicente</surname> -<affiliation> -<address>&Pablo.de.Vicente.mail;</address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<othercredit role="developer"> -<firstname>Carsten</firstname> -<surname>Niehaus</surname> -<affiliation> -<address><email>&Carsten.Niehaus.mail;</email></address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<othercredit role="developer"> -<firstname>Mark</firstname> -<surname>Holloman</surname> -<affiliation> -<address>&Mark.Holloman.mail;</address> -</affiliation> -<contrib>Core Developer</contrib> -</othercredit> - -<!-- TRANS:ROLES_OF_TRANSLATORS --> - -</authorgroup> - -<copyright> -<year>2001-2018</year> -<holder>&Jason.Harris; and the &kstars; Team</holder> -</copyright> - -<legalnotice>&FDLNotice;</legalnotice> - -<date>2018-05-25</date> -<releaseinfo>2.9.6</releaseinfo> - -<abstract> -<para> + <title>The &kstars; Handbook</title> + <bookinfo> + <authorgroup> + <author> + <firstname>Jason</firstname> + <surname>Harris</surname> + <affiliation> + <address>&Jason.Harris.mail;</address> + </affiliation> + </author> + <othercredit role="developer"> + <firstname>Jasem</firstname> + <surname>Mutlaq</surname> + <affiliation> + <address> + <email>mutlaqja AT ikarustech DOT com</email> + </address> + </affiliation> + <contrib>Core Developer</contrib> + </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> + <address> + <email>bowlin AT mindspring DOT com</email> + </address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <othercredit role="developer"> + <firstname>Heiko</firstname> + <surname>Evermann</surname> + <affiliation> + <address>&Heiko.Evermann.mail;</address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <othercredit role="developer"> + <firstname>Thomas</firstname> + <surname>Kabelmann</surname> + <affiliation> + <address>&Thomas.Kabelmann.mail;</address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <othercredit role="developer"> + <firstname>Pablo</firstname> + <surname>de Vicente</surname> + <affiliation> + <address>&Pablo.de.Vicente.mail;</address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <othercredit role="developer"> + <firstname>Carsten</firstname> + <surname>Niehaus</surname> + <affiliation> + <address> + <email>&Carsten.Niehaus.mail;</email> + </address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <othercredit role="developer"> + <firstname>Mark</firstname> + <surname>Holloman</surname> + <affiliation> + <address>&Mark.Holloman.mail;</address> + </affiliation> + <contrib>Core Developer</contrib> + </othercredit> + <!-- TRANS:ROLES_OF_TRANSLATORS --> + </authorgroup> + <copyright> + <year>2001-2019</year> + <holder>&Jason.Harris; and the &kstars; Team</holder> + </copyright> + <legalnotice>&FDLNotice;</legalnotice> + <date>2019-01-10</date> + <releaseinfo>3.1.0</releaseinfo> + <abstract> + <para> &kstars; is free, open source, cross-platform Astronomy Software. It provides an accurate graphical simulation of the night sky, from any location on Earth, at any date and time. The display includes up to 100 million stars, 13,000 deep-sky objects,all 8 planets, the Sun and Moon, and thousands of comets, asteroids, supernovae, and satellites. @@ -181,83 +178,103 @@ HiPS all-sky progressive overlay provide stunning views from numerous surveys sp Included with &kstars; is Ekos astrophotography suite, a complete astrophotography solution that can control all INDI devices including numerous telescopes, CCDs, DSLRs, focusers, filters, and a lot more. Ekos supports highly accurate tracking using online and offline astrometry solver, autofocus and autoguiding capabilities, and capture of single or multiple images using the powerful built in sequence manager. </para> -</abstract> + </abstract> + <keywordset> + <keyword>KDE</keyword> + <keyword>KStars</keyword> + <keyword>Astronomy</keyword> + <keyword>Astrophotography</keyword> + </keywordset> + </bookinfo> + <chapter id="introduction"> + <title>Introduction</title> + <para> +&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>. + </para> + <para> +However, &kstars; is more than a simple night-sky simulator. The display provides a compelling interface to a number of tools with which you can learn more about astronomy and the night sky. There is a context-sensitive + <link linkend="popup-menu">popup menu</link> attached to each displayed object, which displays object-specific information and actions. Hundreds of objects provide links in their popup menus to informative web pages and beautiful images taken by the Hubble Space Telescope and other observatories. + </para> + <para> +From an object's popup menu, you can open its + <link linkend="tool-details">Detailed Information Window</link>, where you can examine positional data about the object, and query a huge treasury of online databases for professional-grade astronomical data and literature references about the object. You can even attach your own Internet links, images and text notes, making &kstars; a graphical front-end to your observing logs and your personal astronomical notebook. -<keywordset> -<keyword>KDE</keyword> -<keyword>kdeedu</keyword> -<keyword>Astronomy</keyword> -<keyword>KStars</keyword> -</keywordset> + </para> + <para> +Our + <link linkend="tool-calculator">Astrocalculator</link> tool provides direct access to many of the algorithms the program uses behind the scenes, including coordinate converters and time calculators. -</bookinfo> + </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. 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. -<chapter id="introduction"> -<title>Introduction</title> - -<para> -&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>. -</para> -<para> -However, &kstars; is more than a simple night-sky simulator. The display provides a compelling interface to a number of tools with which you can learn more about astronomy and the night sky. There is -a context-sensitive <link linkend="popup-menu">popup menu</link> attached to each displayed object, which displays object-specific information and actions. Hundreds of objects provide links in their -popup menus to informative web pages and beautiful images taken by the Hubble Space Telescope and other observatories. -</para><para> -From an object's popup menu, you can open its <link linkend="tool-details">Detailed Information Window</link>, where you can examine positional data about the object, and query a huge treasury of online databases for professional-grade astronomical data and literature references about the object. You can even attach your own Internet links, images and text notes, making &kstars; a graphical front-end to your observing logs and your personal astronomical notebook. -</para> -<para> -Our <link linkend="tool-calculator">Astrocalculator</link> tool provides direct access to many of the algorithms the program uses behind the scenes, including coordinate converters and time calculators. -</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. 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 -linkend="tool-jmoons">Jupiter Moons Tool</link> which shows the positions of Jupiter's four largest moons as a function of time. -</para> -<para> -Our primary goal is to make &kstars; an interactive educational tool for learning about astronomy and the night sky. To this end, the &kstars; Handbook includes the <link linkend="astroinfo">AstroInfo -Project</link>, a series of short, hyperlinked articles on astronomical topics that can be explored with &kstars;. In addition, &kstars; -includes &DBus; functions that allow you to <link linkend="tool-scriptbuilder">write complex scripts</link>, making &kstars; a powerful "demo engine" for classroom use or general illustration of -astronomical topics. Furthermore, any 3rd party tool or language with support of &DBus; can be used to write powerful scripts using <ulink url="http://api.kde.org/4.x-api/kdeedu-apidocs/kstars/html/classkstars.html";>&kstars; &DBus; API</ulink> -</para> -<para> -Enable <link linkend="hips">HiPS all-sky progressive overlay</link> to fetch high-resolution images and display them directly in the sky map. You can select from numerous catalogs compiled from different earth and space based missions. + </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. For advanced solar system simulation, use the <link linkend="tool-xplanetsolarsys">XPlanet-based Solar System Simulator</link>. It provides a graphical interactive simulation for all the planets and major moons of the solar system where you can observe how they appear from different vantage points and at different time scales. + </para> + <para> +Our primary goal is to make &kstars; an interactive educational tool for learning about astronomy and the night sky. To this end, the &kstars; Handbook includes the + <link linkend="astroinfo">AstroInfo +Project</link>, a series of short, hyperlinked articles on astronomical topics that can be explored with &kstars;. In addition, &kstars; +includes &DBus; functions that allow you to + <link linkend="tool-scriptbuilder">write complex scripts</link>, making &kstars; a powerful "demo engine" for classroom use or general illustration of +astronomical topics. Furthermore, any 3rd party tool or language with support of &DBus; can be used to write powerful scripts using + <ulink url="https://api.kde.org/extragear-api/edu-apidocs/kstars/html/index.html";>&kstars; &DBus; API</ulink> + </para> + <para> +Enable + <link linkend="hips">HiPS all-sky progressive overlay</link> to fetch high-resolution images and display them directly in the sky map. You can select from numerous catalogs compiled from different earth and space based missions. This features requires a fast internet connection in order to download the images. The images are cached locally to reduce bandwidth. You can optimize the caching options to best balance between disk space versus bandwidth. -</para> -<para> -However, &kstars; is not just for students. You can control telescopes and cameras with &kstars;, using the elegant and powerful <link linkend="indi">INDI</link> protocol. &kstars; supports several popular -telescopes including Meade's LX200 family and Celestron GPS. Several popular CCD cameras, webcams, and computerized focusers are also supported. Simple slew/track commands are integrated directly into the main window's -popup menu, and the INDI Control Panel provides full access to all of your telescope's functions. INDI's Client/Server -architecture allows for seamless control of any number of <link linkend="indi-kstars-setup">local</link> or <link linkend="indi-remote-control">remote</link> telescopes using a single -&kstars; session.For advanced users, &kstars; provides Ekos, a complete astrophotography suite for Linux. <ulink url="http://www.indilib.org/about/ekos.html";>Ekos</ulink> is based on a modular extensible framework to perform common astrophotography tasks. This includes highly accurate GOTOs using astrometry solver, ability to measure and correct polar alignment errors , auto-focus and auto-guide capabilities, -and capture of single or stack of images with filter wheel support. -</para> -<para> -We are very interested in your feedback; please report bugs or feature requests to the &kstars; development mailing list: <email>kstars-de...@kde.org</email>. You can also use the automated bug reporting tool, accessible from the Help menu. -</para> -<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + + </para> + <para> + However, &kstars; is not just for students. You can control telescopes and cameras with &kstars;, using the elegant and powerful + <link linkend="indi">INDI</link> protocol. &kstars; supports numerous mounts and cameras in addition to other + <ulink url="https://indilib.org/devices.html";>astronomical devices</ulink>. Simple slew/track commands are integrated directly into the main window's popup menu, and the INDI Control Panel provides full access to all of your telescope's functions. INDI's Client/Server architecture allows for seamless control of any number of + <link linkend="indi-kstars-setup">local</link> or + <link linkend="indi-remote-control">remote</link> telescopes using a single &kstars; session.For advanced users, &kstars; provides Ekos, a complete astrophotography suite for Linux. + <link linkend="ekos">Ekos</link> is based on a modular extensible framework to perform common astrophotography tasks. This includes highly accurate GOTOs using astrometry solver, ability to measure and correct polar alignment errors , auto-focus and auto-guide capabilities, and capture of single or stack of images with filter wheel support. + + </para> + <para> +We are very interested in your feedback; please report bugs or feature requests to the &kstars; development mailing list: + <email>kstars-de...@kde.org</email>. You can also use the automated bug reporting tool, accessible from the Help menu. + + </para> + <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; -</chapter> -&quicktour; <!--A Quick Tour of &kstars;--> -&config; <!--Configuring &kstars;--> -&commands; <!--Command Reference--> -&tools; <!--&kstars; Tools--> -&dumpmode; <!--Command-line image-dump mode--> -&indi; <!-- INDI--> -&faq; <!--Questions and Answers--> -&astroinfo; <!--AstroInfo Articles--> -&credits; <!--Credits and License--> + </chapter> + +&quicktour; + <!--A Quick Tour of &kstars;--> +&config; + <!--Configuring &kstars;--> +&commands; + <!--Command Reference--> +&tools; + <!--&kstars; Tools--> +&dumpmode; + <!--Command-line image-dump mode--> +&indi; + <!-- INDI--> +&faq; + <!--Questions and Answers--> +&astroinfo; + <!--AstroInfo Articles--> +&credits; + <!--Credits and License--> &documentation.index; + </book> <!-- Local Variables: diff --git a/doc/tools.docbook b/doc/tools.docbook index 26a0c947d..fe24bff32 100644 --- a/doc/tools.docbook +++ b/doc/tools.docbook @@ -14,6 +14,7 @@ some more advanced aspects of astronomy and the night sky. <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-xplanetsolarsys">XPlanet Solar System Simulator</link></para></listitem> <listitem><para><link linkend="tool-jmoons">Jupiter Moons Tool</link></para></listitem> <listitem><para><link linkend="tool-obsplanner">Observation Planner</link></para></listitem> <listitem><para><link linkend="tool-fitsviewer">FITS Viewer</link></para></listitem> @@ -26,6 +27,7 @@ some more advanced aspects of astronomy and the night sky. &tool-whatsup; &tool-scriptbuilder; &tool-solarsys; +&tool-xplanetsolarsys; &tool-jmoons; &tool-obsplanner; &tool-fitsviewer; diff --git a/doc/xplanetsolarsys.docbook b/doc/xplanetsolarsys.docbook new file mode 100644 index 000000000..657d1f6b0 --- /dev/null +++ b/doc/xplanetsolarsys.docbook @@ -0,0 +1,24 @@ +<sect1 id="tool-xplanetsolarsys"> +<title>XPlanet Solar System Simulator</title> +<indexterm><primary>Tools</primary> +<secondary>Solar System Simulator</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The Solar System Simulator +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="xplanetsolarsystem.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Solar System Simulator</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> + TODO +</para> +</sect1> diff --git a/doc/xplanetsolarsystem.png b/doc/xplanetsolarsystem.png new file mode 100644 index 000000000..744a2ecbe Binary files /dev/null and b/doc/xplanetsolarsystem.png differ
