[education/kstars] doc: Update docs for the new 'Terrain' config page
Yuri Chornoivan
null at kde.org
Thu Mar 11 09:22:34 GMT 2021
Git commit c3149b32eac1d3a00ac5e537c134cc127052b24d by Yuri Chornoivan.
Committed on 11/03/2021 at 09:20.
Pushed by yurchor into branch 'master'.
Update docs for the new 'Terrain' config page
M +- -- doc/advanced_tab.png
M +- -- doc/colors_tab.png
M +190 -179 doc/commands.docbook
M +146 -68 doc/config.docbook
M +- -- doc/ekos_tab.png
A +- -- doc/fits_tab.png
M +- -- doc/guides_tab.png
M +2 -2 doc/index.docbook
M +- -- doc/indi_tab.png
M +- -- doc/satellites_tab.png
M +- -- doc/solarsystem_tab.png
M +- -- doc/supernovae_tab.png
A +- -- doc/terrain_tab.png
M +- -- doc/viewops.png
A +- -- doc/xplanet_tab.png
https://invent.kde.org/education/kstars/commit/c3149b32eac1d3a00ac5e537c134cc127052b24d
diff --git a/doc/advanced_tab.png b/doc/advanced_tab.png
index 2c242eea6..17aa9a721 100644
Binary files a/doc/advanced_tab.png and b/doc/advanced_tab.png differ
diff --git a/doc/colors_tab.png b/doc/colors_tab.png
index a6ac59691..9220b0455 100644
Binary files a/doc/colors_tab.png and b/doc/colors_tab.png differ
diff --git a/doc/commands.docbook b/doc/commands.docbook
index dd04e9021..6bd5e2f8c 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -315,6 +315,17 @@ object.</para></listitem>
<link linkend="ai-skycoords">Coordinate Systems</link></para></listitem>
</varlistentry>
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+ <keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo>
+</shortcut>
+<guimenu>View</guimenu>
+<guimenuitem>Show terrain</guimenuitem>
+</menuchoice></term>
+<listitem><para>Toggle the <link linkend="terrain">terrain image</link> visibility.</para></listitem>
+</varlistentry>
+
<varlistentry>
<term><menuchoice>
<shortcut>
@@ -440,7 +451,7 @@ control it with &kstars;.
<guisubmenu>Devices</guisubmenu>
<guimenuitem>Device Manager...</guimenuitem>
</menuchoice></term>
-<listitem><para>Opens up the device manager, which allows you to start/shutdown
+<listitem><para>Opens up the device manager, which allows you to start/shutdown
device drivers and connect to remote INDI servers.
</para></listitem>
</varlistentry>
@@ -451,7 +462,7 @@ device drivers and connect to remote INDI servers.
<guisubmenu>Devices</guisubmenu>
<guimenuitem>INDI Control Panel...</guimenuitem>
</menuchoice></term>
-<listitem><para>Opens up INDI Control Panel, which allows you to control all the
+<listitem><para>Opens up INDI Control Panel, which allows you to control all the
features supported by a device.
</para></listitem>
</varlistentry>
@@ -463,7 +474,7 @@ features supported by a device.
</menuchoice></term>
<listitem>
<para>
-Opens the <guilabel>Sky Calendar</guilabel> Tool, which allows you to plan observations
+Opens the <guilabel>Sky Calendar</guilabel> Tool, which allows you to plan observations
of Solar System planets by giving graphical data on sets and rises of these objects.
</para>
</listitem>
@@ -480,7 +491,7 @@ of Solar System planets by giving graphical data on sets and rises of these obje
<listitem>
<para>
Opens the <link linkend="tool-altvstime">Altitude vs. Time</link> Tool, which
-can plot curves representing the altitude of any object as a function of time.
+can plot curves representing the altitude of any object as a function of time.
This is useful for planning observing sessions.
</para>
</listitem>
@@ -513,8 +524,8 @@ from your location on a given date.
</menuchoice></term>
<listitem>
<para>
-Opens the <guilabel>What's Interesting</guilabel> Tool, which allows you to be
-informed about the most interesting observations that can be made from your
+Opens the <guilabel>What's Interesting</guilabel> Tool, which allows you to be
+informed about the most interesting observations that can be made from your
current location using the given equipment.
</para>
</listitem>
@@ -563,9 +574,9 @@ current simulation date.
</menuchoice></term>
<listitem>
<para>
-Opens <link linkend="tool-ekos">Ekos</link>, a complete and powerful tool for astrophotography.
-With Ekos, you can align and guide your telescope, focus your CCD, and capture
-images using an easy intuitive interface.
+Opens <link linkend="tool-ekos">Ekos</link>, a complete and powerful tool for astrophotography.
+With Ekos, you can align and guide your telescope, focus your CCD, and capture
+images using an easy intuitive interface.
</para>
</listitem>
</varlistentry>
@@ -594,7 +605,7 @@ moons as a function of time.
</menuchoice></term>
<listitem>
<para>
-Opens the <guilabel>Flag manager</guilabel> Tool, which can be used to assign
+Opens the <guilabel>Flag manager</guilabel> Tool, which can be used to assign
color labels and icons to the given positions on the sky chart.
</para>
</listitem>
@@ -615,7 +626,7 @@ color labels and icons to the given positions on the sky chart.
<guimenu>Data</guimenu>
<guimenuitem>Download New Data...</guimenuitem>
</menuchoice></term>
-<listitem><para>Open the <guilabel>Get Hot New Stuff</guilabel>
+<listitem><para>Open the <guilabel>Get Hot New Stuff</guilabel>
dialog to download additional data for &kstars;.
</para></listitem>
</varlistentry>
@@ -625,14 +636,14 @@ dialog to download additional data for &kstars;.
<guimenu>Data</guimenu>
<guisubmenu>Updates</guisubmenu>
</menuchoice></term>
-<listitem><para>This submenu can be used to update various object data, namely
-asteroids, comets and satellites orbital elements as well as recent supernovae
+<listitem><para>This submenu can be used to update various object data, namely
+asteroids, comets and satellites orbital elements as well as recent supernovae
data from the Internet. The data will be downloaded for the current user account only.
-If you use &kstars; from different account you should download them for every
+If you use &kstars; from different account you should download them for every
account separately.
</para>
-<para>&kstars; tries to download recent supernovae list automatically by default.
-You can switch the download off using <guilabel>Supernovae</guilabel> page
+<para>&kstars; tries to download recent supernovae list automatically by default.
+You can switch the download off using <guilabel>Supernovae</guilabel> page
of &kstars; Settings window.</para>
</listitem>
</varlistentry>
@@ -666,7 +677,7 @@ Open the <link linkend="tool-obsplanner">Observation Planner</link> tool.
<guimenuitem>Execute the session Plan</guimenuitem>
</menuchoice></term>
<listitem><para>
-Opens <link linkend="tool-obsplanner">session plan wizard</link> or execute
+Opens <link linkend="tool-obsplanner">session plan wizard</link> or execute
the planned session.
</para></listitem>
</varlistentry>
@@ -698,10 +709,10 @@ the planned session.
<guisubmenu>Info Boxes</guisubmenu>
<guimenuitem>Show Time Box</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the Time Info Box. By default, the Time Info
-Box is located in the top left side of the screen. You can change the position
-of Time Info Box by holding the left-click mouse button and dragging it to the
-new position.
+<listitem><para>Toggle display of the Time Info Box. By default, the Time Info
+Box is located in the top left side of the screen. You can change the position
+of Time Info Box by holding the left-click mouse button and dragging it to the
+new position.
</para></listitem>
</varlistentry>
@@ -711,10 +722,10 @@ new position.
<guisubmenu>Info Boxes</guisubmenu>
<guimenuitem>Show Focus Box</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the Focus Info Box. By default, the Focus Info
-Box is located in the top right side of the screen. You can change the position
-of Focus Info Box by holding the left-click mouse button and dragging it to the
-new position.
+<listitem><para>Toggle display of the Focus Info Box. By default, the Focus Info
+Box is located in the top right side of the screen. You can change the position
+of Focus Info Box by holding the left-click mouse button and dragging it to the
+new position.
</para></listitem>
</varlistentry>
@@ -724,10 +735,10 @@ new position.
<guisubmenu>Info Boxes</guisubmenu>
<guimenuitem>Show Location Box</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the Location Info Box. By default, the
-Location Info Box is located in the bottom left side of the screen. You
-can change the position of Location Info Box by holding the left-click
-mouse button and dragging it to the new position.
+<listitem><para>Toggle display of the Location Info Box. By default, the
+Location Info Box is located in the bottom left side of the screen. You
+can change the position of Location Info Box by holding the left-click
+mouse button and dragging it to the new position.
</para></listitem>
</varlistentry>
@@ -737,16 +748,16 @@ mouse button and dragging it to the new position.
<guisubmenu>Toolbars Shown</guisubmenu>
<guimenuitem>Main Toolbar</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the Main Toolbar. By default, the Main Toolbar
-provides useful shortcuts for controlling the sky map view (&ie; Zoom in and Zoom out)
-and for controlling &kstars; clock as well. You can Start / Stop the clock, advance
-one step backward / forward in time and also you can easily set the time step used
+<listitem><para>Toggle display of the Main Toolbar. By default, the Main Toolbar
+provides useful shortcuts for controlling the sky map view (&ie; Zoom in and Zoom out)
+and for controlling &kstars; clock as well. You can Start / Stop the clock, advance
+one step backward / forward in time and also you can easily set the time step used
by &kstars;' clock. The time step is the rate at which time flows in the simulation.
-For setting the time step, you can use the spin box used for establishing the time step
+For setting the time step, you can use the spin box used for establishing the time step
units and the spin box used for increasing / decreasing the time step value.
-Using the Main Toolbar you can quickly open the <guilabel>Find Object</guilabel>,
+Using the Main Toolbar you can quickly open the <guilabel>Find Object</guilabel>,
<guilabel>Set Time</guilabel> or <guilabel>Set Geographic Location</guilabel> window.
-Main Toolbar can be configured using
+Main Toolbar can be configured using
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -757,14 +768,14 @@ Main Toolbar can be configured using
<guisubmenu>Toolbars Shown</guisubmenu>
<guimenuitem>View Toolbar</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the View Toolbar. View Toolbar controls which sky
-objects are drawn on &kstars; Sky Map (stars, deep sky objects, Solar system objects,
-supernovae or satellites) as well as what constellation information is included
-(constellation lines, constellation names, constellation art or constellation boundaries).
-It also provides icon shortcuts for: showing milky way (drawn with dark grey color),
-showing equatorial/horizontal coordinate grid and for showing the green opaque ground.
+<listitem><para>Toggle display of the View Toolbar. View Toolbar controls which sky
+objects are drawn on &kstars; Sky Map (stars, deep sky objects, Solar system objects,
+supernovae or satellites) as well as what constellation information is included
+(constellation lines, constellation names, constellation art or constellation boundaries).
+It also provides icon shortcuts for: showing milky way (drawn with dark grey color),
+showing equatorial/horizontal coordinate grid and for showing the green opaque ground.
Note that when the horizon is switched off, refraction effects are temporarily disabled.
-View Toolbar can be configured using
+View Toolbar can be configured using
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -775,14 +786,14 @@ View Toolbar can be configured using
<guisubmenu>Toolbars Shown</guisubmenu>
<guimenuitem>INDI Toolbar</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the INDI Toolbar. By default, INDI Toolbar contains
+<listitem><para>Toggle display of the INDI Toolbar. By default, INDI Toolbar contains
three shortcut icons:
<itemizedlist>
<listitem><para>Toggle Ekos</para></listitem>
<listitem><para>Toggle INDI Control Panel</para></listitem>
<listitem><para>Toggle FITS Viewer</para></listitem>
</itemizedlist>
-INDI Toolbar can be configured using
+INDI Toolbar can be configured using
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -793,7 +804,7 @@ INDI Toolbar can be configured using
<guisubmenu>Statusbar</guisubmenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice></term>
-<listitem><para>Toggle display of the Statusbar. It is located in the bottom
+<listitem><para>Toggle display of the Statusbar. It is located in the bottom
of &kstars; window.
</para></listitem>
</varlistentry>
@@ -837,8 +848,8 @@ coordinates in the statusbar.
<guisubmenu>Color Schemes</guisubmenu>
</menuchoice></term>
<listitem><para>
-This submenu contains all of the defined color schemes: Classic, Star Chart,
-Night Vision and Moonless Night. It can also include your custom color schemes.
+This submenu contains all of the defined color schemes: Classic, Star Chart,
+Night Vision and Moonless Night. It can also include your custom color schemes.
Select any item to set that color scheme.
</para></listitem>
</varlistentry>
@@ -849,11 +860,11 @@ Select any item to set that color scheme.
<guisubmenu>FOV Symbols</guisubmenu>
</menuchoice></term>
<listitem><para>
-This submenu lists the available field-of-view (FOV) Symbols. The FOV Symbol is
-drawn at the center of the display. You may choose one or more from the list of
-predefined symbols (7x35 Binoculars, Telrad, One Degree, HST WFPC2 or 30m at 1.3cm)
-by checking their specific checkbox, or you may use no symbol by unchecking all
-the items from the symbols list. You can also define your own symbols
+This submenu lists the available field-of-view (FOV) Symbols. The FOV Symbol is
+drawn at the center of the display. You may choose one or more from the list of
+predefined symbols (7x35 Binoculars, Telrad, One Degree, HST WFPC2 or 30m at 1.3cm)
+by checking their specific checkbox, or you may use no symbol by unchecking all
+the items from the symbols list. You can also define your own symbols
(or modify existing symbols) using the <guimenuitem>Edit FOV Symbols...</guimenuitem> option.
</para></listitem>
</varlistentry>
@@ -864,31 +875,31 @@ the items from the symbols list. You can also define your own symbols
<guisubmenu>Artificial Horizon</guisubmenu>
</menuchoice></term>
<listitem><para>
-If you select this submenu, then Artificial Horizon Manager will be opened.
-Artificial Horizon Manager is used to define on the skymap one or more
-regions that are blocked from view from your current location
-(&ie; tall trees or building). The window is split in two sections:
-in the left side is the Regions section while in the right side is the Points
-section. You can add a new region by pressing the <guibutton>+</guibutton>
-(Add Region) button or you can remove a region by selecting it in the regions
-list and then pressing the <guibutton>-</guibutton> (Remove Region) button.
-In order to draw a region you need to define a list of points that encompasses
-the blocked area. You can add a new point by pressing the <guibutton>+</guibutton>
-(Add Point) button from the right Points section. You can also remove a highlighted
-point from the list of points or you can clear all the points. There are two ways
-to add a new point to a selected region: manually by entering the point's coordinates
-or by selecting the point from the skymap after clicking <guibutton>Select Points</guibutton>
-button. Note that each point is described by a set of horizontal coordinates: Az (Azimuth)
-and Alt (Altitude). If you want to modify a point's coordinates, just double click on its
-Az/Alt text box value and enter the new value. First and Last points must be on the horizon.
+If you select this submenu, then Artificial Horizon Manager will be opened.
+Artificial Horizon Manager is used to define on the skymap one or more
+regions that are blocked from view from your current location
+(&ie; tall trees or building). The window is split in two sections:
+in the left side is the Regions section while in the right side is the Points
+section. You can add a new region by pressing the <guibutton>+</guibutton>
+(Add Region) button or you can remove a region by selecting it in the regions
+list and then pressing the <guibutton>-</guibutton> (Remove Region) button.
+In order to draw a region you need to define a list of points that encompasses
+the blocked area. You can add a new point by pressing the <guibutton>+</guibutton>
+(Add Point) button from the right Points section. You can also remove a highlighted
+point from the list of points or you can clear all the points. There are two ways
+to add a new point to a selected region: manually by entering the point's coordinates
+or by selecting the point from the skymap after clicking <guibutton>Select Points</guibutton>
+button. Note that each point is described by a set of horizontal coordinates: Az (Azimuth)
+and Alt (Altitude). If you want to modify a point's coordinates, just double click on its
+Az/Alt text box value and enter the new value. First and Last points must be on the horizon.
Polygons must be closed to be considered valid regions.
-Artificial Horizon Manager provides a easy way to rename your regions. By default, regions are
-named as: <quote>Region </quote> plus an index (&ie; <quote>Region 1</quote> or <quote>Region 2</quote>).
-For renaming a region, just double click on its name and then you will be invited to
-complete a new region name. You can also control which regions are enabled or disabled for
-marking on the map by a simple click on the checkbox in front of each region. After you
-defined your desired regions you can apply them by pressing the <guibutton>Apply</guibutton>
-button. If you want to use these regions again, in further astronomy sessions, you can save
+Artificial Horizon Manager provides a easy way to rename your regions. By default, regions are
+named as: <quote>Region </quote> plus an index (&ie; <quote>Region 1</quote> or <quote>Region 2</quote>).
+For renaming a region, just double click on its name and then you will be invited to
+complete a new region name. You can also control which regions are enabled or disabled for
+marking on the map by a simple click on the checkbox in front of each region. After you
+defined your desired regions you can apply them by pressing the <guibutton>Apply</guibutton>
+button. If you want to use these regions again, in further astronomy sessions, you can save
them such that next time when you will open &kstars; they will be automatically marked on the skymap.
</para></listitem>
</varlistentry>
@@ -903,7 +914,7 @@ them such that next time when you will open &kstars; they will be automatically
<guimenuitem>List your Equipment</guimenuitem>
</menuchoice></term>
<listitem><para>Allows you to define your equipment characteristics for observation logs.
-The Configure Equipment window is divided into four tabs: <guilabel>Telescope</guilabel>,
+The Configure Equipment window is divided into four tabs: <guilabel>Telescope</guilabel>,
<guilabel>Eyepiece</guilabel>, <guilabel>Lens</guilabel> and <guilabel>Filter</guilabel>.
You can add a new equipment by completing its characteristics and pressing <guibutton>Add New...</guibutton>
button. You can also save or remove an equipment from the list.
@@ -919,12 +930,12 @@ button. You can also save or remove an equipment from the list.
<guisubmenu>Configure Observation Logging</guisubmenu>
<guimenuitem>Manage Observer</guimenuitem>
</menuchoice></term>
-<listitem><para>Selecting this will open Manage Observers window that enables you to register
+<listitem><para>Selecting this will open Manage Observers window that enables you to register
a number of observers which are using &kstars; on this computer. You can add a new entry to
-observers list by completing the mandatory fields: <guilabel>Name</guilabel> and
-<guilabel>Surname</guilabel> and then pressing the <guibutton>+</guibutton> (Add observer)
-button. Note that <guilabel>Contact</guilabel> field is optional, &kstars; allowing you to
-add a new observer even though <guilabel>Contact</guilabel> text box is empty.
+observers list by completing the mandatory fields: <guilabel>Name</guilabel> and
+<guilabel>Surname</guilabel> and then pressing the <guibutton>+</guibutton> (Add observer)
+button. Note that <guilabel>Contact</guilabel> field is optional, &kstars; allowing you to
+add a new observer even though <guilabel>Contact</guilabel> text box is empty.
You can also remove an observer from the list using <guibutton>-</guibutton> (Remove observer) button.
</para></listitem>
</varlistentry>
@@ -958,30 +969,30 @@ Select a new <link linkend="setgeo">geographic location</link>.
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts</guimenuitem>
</menuchoice></term>
-<listitem><para>Open the Configure Shortcuts window which allows you to modify
-&kstars; shortcuts. You can use &kstars; default shortcuts scheme or define your
-own shortcuts scheme. In order to add a new custom shortcut to an action, you
-need to click on action's name and then press the <guibutton>Custom</guibutton>
-checkbox. Then click on the button next to <guibutton>Custom</guibutton> checkbox
-and enter the shortcut you would like to use in &kstars;. You can also remove a
+<listitem><para>Open the Configure Shortcuts window which allows you to modify
+&kstars; shortcuts. You can use &kstars; default shortcuts scheme or define your
+own shortcuts scheme. In order to add a new custom shortcut to an action, you
+need to click on action's name and then press the <guibutton>Custom</guibutton>
+checkbox. Then click on the button next to <guibutton>Custom</guibutton> checkbox
+and enter the shortcut you would like to use in &kstars;. You can also remove a
shortcut by pressing the <guibutton>Delete</guibutton> button after you select an
-action from the list. &kstars; helps you to find an action by providing its search
-method; just enter the name of the action and the list will be reduced to its best
-matches. For example, I will give you a brief example on how to use &kstars;
+action from the list. &kstars; helps you to find an action by providing its search
+method; just enter the name of the action and the list will be reduced to its best
+matches. For example, I will give you a brief example on how to use &kstars;
Configure Shortcuts feature:
<itemizedlist>
-<listitem><para>Firstly, open the Configure Shortcuts window from the
+<listitem><para>Firstly, open the Configure Shortcuts window from the
<guimenu>Settings</guimenu> menu.</para></listitem>
-<listitem><para>Then select the action you would like to add a shortcut
-(&ie; Artificial Horizon). You can use the search method provided by &kstars;. Just
-type <quote>art</quote> in the search text box and the list will be reduced to only
+<listitem><para>Then select the action you would like to add a shortcut
+(&ie; Artificial Horizon). You can use the search method provided by &kstars;. Just
+type <quote>art</quote> in the search text box and the list will be reduced to only
four actions. The Artificial Horizon is the first action in the list.</para></listitem>
-<listitem><para>Now that you find your desired action, you can add a new shortcut by clicking on
-its name. After you click on the action name, press the <guibutton>Custom</guibutton> checkbox.
+<listitem><para>Now that you find your desired action, you can add a new shortcut by clicking on
+its name. After you click on the action name, press the <guibutton>Custom</guibutton> checkbox.
There is a button next to <guibutton>Custom</guibutton> checkbox used for adding new shortcuts.
-By default, if an action has no custom shortcut, the <quote>None</quote> tag will be
-assigned to this button. Press this button and then add your custom shortcut. For example, for
-Artificial Horizon, you can use &Ctrl;+H shortcut. Hold the &Ctrl; key and press H. Your shortcut
+By default, if an action has no custom shortcut, the <quote>None</quote> tag will be
+assigned to this button. Press this button and then add your custom shortcut. For example, for
+Artificial Horizon, you can use &Ctrl;+H shortcut. Hold the &Ctrl; key and press H. Your shortcut
be automatically saved, thus you can use it next time when you open &kstars;.</para></listitem>
</itemizedlist>
</para></listitem>
@@ -1002,23 +1013,23 @@ be automatically saved, thus you can use it next time when you open &kstars;.</p
<guimenuitem>Startup Wizard</guimenuitem>
</menuchoice></term>
<listitem><para>
-By selecting the <guimenu>Startup Wizard...</guimenu> submenu, the <quote>Setup Wizard</quote> window will pop up.
-It is the same window that you saw when you ran &kstars; for the very first time. &kstars; Setup Wizard will help
-you set up some basic options, such as your location on Earth. The first page of Setup Wizard is a welcome page
-and if you press <guibutton>Next</guibutton> button, you will get the <quote>Choose Your Home Location</quote> page.
+By selecting the <guimenu>Startup Wizard...</guimenu> submenu, the <quote>Setup Wizard</quote> window will pop up.
+It is the same window that you saw when you ran &kstars; for the very first time. &kstars; Setup Wizard will help
+you set up some basic options, such as your location on Earth. The first page of Setup Wizard is a welcome page
+and if you press <guibutton>Next</guibutton> button, you will get the <quote>Choose Your Home Location</quote> page.
Here you can select your exact home location or a city near your home location if your accurate location
-is not present in &kstars; cities database. Browsing the entire list is not so efficient and thus, &kstars;
-provides you a easy-to-use method for selecting your desired city in a short time. You may filter the
+is not present in &kstars; cities database. Browsing the entire list is not so efficient and thus, &kstars;
+provides you a easy-to-use method for selecting your desired city in a short time. You may filter the
list of cities by the name of your city, province and country. By giving more details about your location, the
-list's size will reduced only to its best matches. When you highlight a city in the cities list, the
+list's size will reduced only to its best matches. When you highlight a city in the cities list, the
<guilabel>Longitude</guilabel> and <guilabel>Latitude</guilabel> boxes will be updated, containing the accurate
information of your selected location. When you hit the <guibutton>Next</guibutton> button, you will get the last
-page of &kstars; Setup Wizard: <quote>Download Extra Data Files</quote> page. Here you may download optional data
-files via the Internet, in order to enhance &kstars;, such as Messier object images, or a more complete NGC/IC catalog.
-Press the <guibutton>Download Extra Data</guibutton> button to proceed. After you pressed the
-<guibutton>Download Extra Data</guibutton> button, the <quote>Get Hot New Stuff</quote> window will appear. It is
-&kstars; Add-On Installer, which will help you to manage what extra information you added to &kstars;. Firstly, you
-can choose how the add-ons list is displayed, by pressing the <guibutton>Details view mode</guibutton> or
+page of &kstars; Setup Wizard: <quote>Download Extra Data Files</quote> page. Here you may download optional data
+files via the Internet, in order to enhance &kstars;, such as Messier object images, or a more complete NGC/IC catalog.
+Press the <guibutton>Download Extra Data</guibutton> button to proceed. After you pressed the
+<guibutton>Download Extra Data</guibutton> button, the <quote>Get Hot New Stuff</quote> window will appear. It is
+&kstars; Add-On Installer, which will help you to manage what extra information you added to &kstars;. Firstly, you
+can choose how the add-ons list is displayed, by pressing the <guibutton>Details view mode</guibutton> or
<guibutton>Icons view mode</guibutton> button. You may also order the list by various criteria like: newest,
rating, most downloads or installed. This can be easily done by selecting an option using the radio button.
You can also make searches using the <guilabel>Search:</guilabel> text box.
@@ -1027,7 +1038,7 @@ or uninstall an add-on using the <guibutton>Install</guibutton> / <guibutton>Uni
open the Details window using the <guibutton>Details</guibutton> button or you can rate an add-on by giving a number
of gold stars, up to five stars. If you want to send an email to the author of an add-on, you are able to do that
by clicking on his e-mail address. Then, your default e-mail application will guide you through the sending process.
-After you managed your &kstars; add-ons, then you can close the window by pressing the <guibutton>Close</guibutton>
+After you managed your &kstars; add-ons, then you can close the window by pressing the <guibutton>Close</guibutton>
button. You can also use the Download Extra Data Files tool later, by selecting <menuchoice><guimenu>Data</guimenu>
<guimenuitem>Download New Data...</guimenuitem></menuchoice>.
</para></listitem>
@@ -1097,17 +1108,17 @@ on this location, and engage tracking. Equivalent to double-clicking.
Here you can manage your flags and use some of &kstars; features. When <quote>Flag manager</quote>
window is open for a selected object, <guilabel>Right ascension</guilabel> and
<guilabel>Declination</guilabel> text boxes will be automatically filled with the coordinate values
-of the selected object on the Sky Map. Besides these two text boxes, you can set the
+of the selected object on the Sky Map. Besides these two text boxes, you can set the
<guilabel>Epoch</guilabel>, add a <guilabel>Label</guilabel>, set the <guilabel>Label color</guilabel>
or even add an <guilabel>Icon</guilabel>. To add custom icons, just add images in
-<filename class="directory">`qtpaths --paths GenericDataLocation`/kstars/</filename>. File names must
-begin with the <quote>flag</quote> keyword. For example,
+<filename class="directory">`qtpaths --paths GenericDataLocation`/kstars/</filename>. File names must
+begin with the <quote>flag</quote> keyword. For example,
the file <quote>flagSmall_red_cross.gif</quote> will be shown as Small red cross in the combo box. After
-you set up the information of the new flag, you can add it to the flags list using the
-<guibutton>Add</guibutton> button. You may also change flags details (&ie; RA/Dec, label or icon) and
-then save the new ones by pressing the <guibutton>Save changes</guibutton> button. Using the Flag manager,
-you can easily center an object in Map or in Telescope, by pressing <guibutton>Center in Map</guibutton>
-or <guibutton>Center in Telescope</guibutton> button. In order to delete a value from the list, just
+you set up the information of the new flag, you can add it to the flags list using the
+<guibutton>Add</guibutton> button. You may also change flags details (&ie; RA/Dec, label or icon) and
+then save the new ones by pressing the <guibutton>Save changes</guibutton> button. Using the Flag manager,
+you can easily center an object in Map or in Telescope, by pressing <guibutton>Center in Map</guibutton>
+or <guibutton>Center in Telescope</guibutton> button. In order to delete a value from the list, just
select it in the list and then press <guibutton>Delete</guibutton> button. Your flags are saved after you
close current session and thus you will be able to see them everytime you will use &kstars; again.
</para></listitem>
@@ -1129,23 +1140,23 @@ exit angular distance mode without measuring an angle.
<varlistentry>
<term>[All]</term>
<listitem><para>
-<guimenuitem>Starhop from here to</guimenuitem>: will enable you to find a path between two points in
-the sky. Star hopping is a technique that uses bright stars as a guide for finding fainter objects. So if
-you have a bright star, you can use it as a reference to find a fainter object. Starting from your reference
-star, &kstars; will find a route to the destination, traversing a sequence of stars/patterns of stars. The
-object for which you called <guilabel>Starhop from here to</guilabel> tool will be your starting point. When
-your starting point is established, a dotted line will appear, allowing you to decide which will be your
-end point. You have to move the mouse cursor to your destination object position and right click on it.
-Then, a dialog box will pop up, requiring you to set the FOV used for star hopping. For selecting a FOV,
-you need to make a choice from the FOV combo box list of values. The values you can choose include
-default FOV values (7x35 Binoculars, Telrad, One Degree, HST WFPC2 and 30m at 1.3cm) plus your customized
-FOVs. After you selected the FOV, &kstars; will find a route for you. Thus, the dialog box will contain a
-list of object used in the starhop. If &kstars; did not manage to find a route, then an error dialog box
-will be displayed, giving you a helping hand. When the Star-Hopper algorithm ends, the dialog box will
-contain a list of objects used in starhop route. For every object from the list, you can perform a set of
-actions: you can ask for details using the <guibutton>Details</guibutton> button, center selected object in
-the map using <guibutton>Center on map</guibutton> button or you can go to next star by pressing the
-<guibutton>Next</guibutton> button. Note that when go to next star, it will be automatically centered on
+<guimenuitem>Starhop from here to</guimenuitem>: will enable you to find a path between two points in
+the sky. Star hopping is a technique that uses bright stars as a guide for finding fainter objects. So if
+you have a bright star, you can use it as a reference to find a fainter object. Starting from your reference
+star, &kstars; will find a route to the destination, traversing a sequence of stars/patterns of stars. The
+object for which you called <guilabel>Starhop from here to</guilabel> tool will be your starting point. When
+your starting point is established, a dotted line will appear, allowing you to decide which will be your
+end point. You have to move the mouse cursor to your destination object position and right click on it.
+Then, a dialog box will pop up, requiring you to set the FOV used for star hopping. For selecting a FOV,
+you need to make a choice from the FOV combo box list of values. The values you can choose include
+default FOV values (7x35 Binoculars, Telrad, One Degree, HST WFPC2 and 30m at 1.3cm) plus your customized
+FOVs. After you selected the FOV, &kstars; will find a route for you. Thus, the dialog box will contain a
+list of object used in the starhop. If &kstars; did not manage to find a route, then an error dialog box
+will be displayed, giving you a helping hand. When the Star-Hopper algorithm ends, the dialog box will
+contain a list of objects used in starhop route. For every object from the list, you can perform a set of
+actions: you can ask for details using the <guibutton>Details</guibutton> button, center selected object in
+the map using <guibutton>Center on map</guibutton> button or you can go to next star by pressing the
+<guibutton>Next</guibutton> button. Note that when go to next star, it will be automatically centered on
the map. Also, Star-Hopper tool provides directions to star hop for every object of the list.
</para></listitem>
</varlistentry>
@@ -1170,10 +1181,10 @@ will read <guilabel>Remove Label</guilabel>.
<varlistentry>
<term>[All]</term>
<listitem><para>
-<guimenuitem>Add to Observing WishList</guimenuitem>: Add the selected object to
-<guimenu>Observation Planner</guimenu>'s Wish List. You can see the Wish List, by selecting
-<menuchoice><guimenu>Observation</guimenu><guimenuitem>Observation Planner</guimenuitem></menuchoice>.
-If the object is already in the Observing WishList, then this item will become
+<guimenuitem>Add to Observing WishList</guimenuitem>: Add the selected object to
+<guimenu>Observation Planner</guimenu>'s Wish List. You can see the Wish List, by selecting
+<menuchoice><guimenu>Observation</guimenu><guimenuitem>Observation Planner</guimenuitem></menuchoice>.
+If the object is already in the Observing WishList, then this item will become
<guilabel>Remove Label</guilabel>.
</para></listitem>
</varlistentry>
@@ -1181,7 +1192,7 @@ If the object is already in the Observing WishList, then this item will become
<varlistentry>
<term>[Solar system objects]</term>
<listitem><para>
-<guimenuitem>Add Trail</guimenuitem>: Add a trail to current Solar system object. A star trail is the
+<guimenuitem>Add Trail</guimenuitem>: Add a trail to current Solar system object. A star trail is the
continuous path created by the star in the night sky due to the rotation of the Earth.
If the object already has a trail, this item will become <guilabel>Remove Trail</guilabel>.
</para></listitem>
@@ -1190,15 +1201,15 @@ If the object already has a trail, this item will become <guilabel>Remove Trail<
<varlistentry>
<term>[All]</term>
<listitem><para>
-<guimenuitem>Simulate eyepiece view</guimenuitem>: Eyepiece View feature renders the
-view through the eyepiece of various telescope types. Firstly, an input dialog is shown,
-which asks you to select one of the visible FOVs to use as a FOV for the eyepiece view.
+<guimenuitem>Simulate eyepiece view</guimenuitem>: Eyepiece View feature renders the
+view through the eyepiece of various telescope types. Firstly, an input dialog is shown,
+which asks you to select one of the visible FOVs to use as a FOV for the eyepiece view.
The user also has the option of trying to determine it from the image (accurate if
-image has metadata, otherwise it will be random). After you set the FOV,
-the "Eyepiece Field View" window will pop up.
+image has metadata, otherwise it will be random). After you set the FOV,
+the "Eyepiece Field View" window will pop up.
You can easily rotate the view using the "Rotation" slider. You can
also flip and invert the view to help match the view through a telescope/camera.
-"Eyepiece view" tool can help you locate many objects with ease, instead of
+"Eyepiece view" tool can help you locate many objects with ease, instead of
trying to work with relative positions and relative orientations.
This is an important advantage, especially when you are star hopping.
Note that for getting best results, time must be synced with current
@@ -1209,8 +1220,8 @@ time in &kstars;, and &kstars; must be in horizontal coordinates mode.
<varlistentry>
<term>[Solar system objects]</term>
<listitem><para>
-<guimenuitem>Image Resources</guimenuitem>: gives a list of image links for current Solar
-system object. The images are displayed in &kstars; Image Viewer tool. Image Viewer tool
+<guimenuitem>Image Resources</guimenuitem>: gives a list of image links for current Solar
+system object. The images are displayed in &kstars; Image Viewer tool. Image Viewer tool
allows you to invert the colors and save the image in your computer.
</para></listitem>
</varlistentry>
@@ -1218,15 +1229,15 @@ allows you to invert the colors and save the image in your computer.
<varlistentry>
<term>[Solar system objects]</term>
<listitem><para>
-<guimenuitem>Information Resources</guimenuitem>: gives a list of documentation links for
-current Solar system object. The links are opened in your default browser.
+<guimenuitem>Information Resources</guimenuitem>: gives a list of documentation links for
+current Solar system object. The links are opened in your default browser.
</para></listitem>
</varlistentry>
<varlistentry>
<term>[All objects without Solar system objects]</term>
<listitem><para>
-<guimenuitem>Show SDSS Image</guimenuitem>: download a SDSS (Sloan Digital Sky Survey)
+<guimenuitem>Show SDSS Image</guimenuitem>: download a SDSS (Sloan Digital Sky Survey)
image of the object from the Internet, and display it in the Image Viewer tool.
</para></listitem>
</varlistentry>
@@ -1234,8 +1245,8 @@ image of the object from the Internet, and display it in the Image Viewer tool.
<varlistentry>
<term>[All objects without Solar system objects]</term>
<listitem><para>
-<guimenuitem>Show DSS Image</guimenuitem>: download a DSS (Digitized Sky Survey) image of
-the object from the Internet, and display it in the Image Viewer tool.
+<guimenuitem>Show DSS Image</guimenuitem>: download a DSS (Digitized Sky Survey) image of
+the object from the Internet, and display it in the Image Viewer tool.
</para></listitem>
</varlistentry>
@@ -1426,14 +1437,14 @@ Define equipment (telescope, eyepiece, lens and filter) characteristics for obse
<varlistentry>
<term><keycap>F5</keycap></term>
-<listitem><para>Switch sky chart view to the
+<listitem><para>Switch sky chart view to the
<ulink url="https://en.wikipedia.org/wiki/Lambert_azimuthal_equal-area_projection">Lambert azimuthal equal-area</ulink> projection.
</para></listitem>
</varlistentry>
<varlistentry>
<term><keycap>F6</keycap></term>
-<listitem><para>Switch sky chart view to the
+<listitem><para>Switch sky chart view to the
<ulink url="https://en.wikipedia.org/wiki/Azimuthal_equidistant_projection">azimuthal equidistant</ulink> projection.
</para></listitem>
</varlistentry>
@@ -1445,21 +1456,21 @@ Define equipment (telescope, eyepiece, lens and filter) characteristics for obse
<varlistentry>
<term><keycap>F8</keycap></term>
-<listitem><para>Switch sky chart view to the
+<listitem><para>Switch sky chart view to the
<ulink url="https://en.wikipedia.org/wiki/Equirectangular_projection">equirectangular</ulink> projection.
</para></listitem>
</varlistentry>
<varlistentry>
<term><keycap>F9</keycap></term>
-<listitem><para>Switch sky chart view to the
+<listitem><para>Switch sky chart view to the
<ulink url="https://en.wikipedia.org/wiki/Stereographic_projection">stereographic</ulink> projection.
</para></listitem>
</varlistentry>
<varlistentry>
<term><keycap>F10</keycap></term>
-<listitem><para>Switch sky chart view to the
+<listitem><para>Switch sky chart view to the
<ulink url="https://en.wikipedia.org/wiki/Gnomonic_projection">gnomonic</ulink> projection.
</para></listitem>
</varlistentry>
@@ -1472,10 +1483,10 @@ Define equipment (telescope, eyepiece, lens and filter) characteristics for obse
<indexterm><primary>Objects in the Sky</primary>
<secondary>Keyboard Actions</secondary></indexterm>
-<para>Each of the following keystrokes performs an action on the
-<firstterm>selected object</firstterm>. The selected object is the last
-object which was clicked on (identified in the status bar). Alternatively,
-if you hold down the &Shift; key, then the action is
+<para>Each of the following keystrokes performs an action on the
+<firstterm>selected object</firstterm>. The selected object is the last
+object which was clicked on (identified in the status bar). Alternatively,
+if you hold down the &Shift; key, then the action is
performed on the centered object instead.</para>
<variablelist>
@@ -1530,56 +1541,56 @@ for specifying RA/Dec or Az/Alt coordinates on which to center</para></listitem>
<varlistentry>
<term><keycap>[</keycap></term>
-<listitem><para>Start an Angular Distance measurement at the current mouse
-cursor position. The angular distance between start and end points is displayed
+<listitem><para>Start an Angular Distance measurement at the current mouse
+cursor position. The angular distance between start and end points is displayed
at the endpoint.</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="setgeo">Set Geographic Location</link>
+<listitem><para>Open the <link linkend="setgeo">Set Geographic Location</link>
window</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-calculator">AstroCalculator</link>
+<listitem><para>Open the <link linkend="tool-calculator">AstroCalculator</link>
</para></listitem>
</varlistentry>
-
+
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-altvstime">Altitude vs. Time</link>
+<listitem><para>Open the <link linkend="tool-altvstime">Altitude vs. Time</link>
tool</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-whatsup">What's Up Tonight?</link>
+<listitem><para>Open the <link linkend="tool-whatsup">What's Up Tonight?</link>
tool</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></term>
-<listitem><para>Open the <quote>What's Interesting</quote>
+<listitem><para>Open the <quote>What's Interesting</quote>
tool</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-scriptbuilder">Script Builder</link>
+<listitem><para>Open the <link linkend="tool-scriptbuilder">Script Builder</link>
tool</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-solarsys">Solar System Viewer</link>
+<listitem><para>Open the <link linkend="tool-solarsys">Solar System Viewer</link>
</para></listitem>
</varlistentry>
<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo></term>
-<listitem><para>Open the <link linkend="tool-jmoons">Jupiter Moons</link>
+<listitem><para>Open the <link linkend="tool-jmoons">Jupiter Moons</link>
tool</para></listitem>
</varlistentry>
@@ -1601,7 +1612,7 @@ The sky coordinates (Az/Alt, RA/Dec and J2000.0 RA/Dec) of the mouse cursor are
in the status bar. The status bar is located in the right bottom corner of the screen.
The status bar can be customized by selecting <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Statusbar</guimenuitem></menuchoice> submenu. Here you may choose what coordinates
-systems &kstars; will display in the status bar. Furthermore, you can hide the status bar by
+systems &kstars; will display in the status bar. Furthermore, you can hide the status bar by
unchecking the <guilabel>Show Statusbar</guilabel> checkbox.
</para></listitem>
</varlistentry>
diff --git a/doc/config.docbook b/doc/config.docbook
index 16f2e5d48..491c7d384 100644
--- a/doc/config.docbook
+++ b/doc/config.docbook
@@ -141,9 +141,9 @@ The window is depicted below:
</para>
<para>
-The <guilabel>Configure &kstars;</guilabel> window is divided into eleven pages:
+The <guilabel>Configure &kstars;</guilabel> window is divided into twelve pages:
<guilabel>Catalogs</guilabel>, <guilabel>Solar System</guilabel>, <guilabel>Satellites</guilabel>,
-<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Colors</guilabel>, <guilabel>FITS</guilabel>,
+<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Terrain</guilabel>, <guilabel>Colors</guilabel>, <guilabel>FITS</guilabel>,
<guilabel>INDI</guilabel>, <guilabel>Ekos</guilabel>, <guilabel>Xplanet</guilabel> and <guilabel>Advanced</guilabel>.
</para>
@@ -191,6 +191,16 @@ Milky Way contour).
It is possible to choose a <guilabel>Sky culture</guilabel> for the constellation lines and names on this page. The current version of &kstars; includes data for more than a dozen sky cultures.
</para>
+<!-- Terrain page: -->
+<para>
+<indexterm><primary>Configure &kstars; window</primary>
+<secondary>Terrain page</secondary></indexterm>
+<indexterm><primary>Terrain image</primary>
+<secondary>Customizing</secondary></indexterm>
+The <guilabel>Terrain</guilabel> page allows you to set the terrain or landscape image
+and configure its speedup options.
+</para>
+
<!-- Colors page: -->
<para>
<indexterm><primary>Configure &kstars; window</primary>
@@ -441,7 +451,7 @@ displayed in &kstars;. You can choose to see the stars or not by checking the
options will be enabled. Thus, you can set how many stars are drawn on the map
using the <guilabel>Star Density</guilabel> slider. You can also customize
&kstars; to toggle star name and <link linkend="ai-magnitude">magnitudes</link>.
-Star names are drawn next to bright stars. To display labels of fainter stars,
+Star names are drawn next to bright stars. To display labels of fainter stars,
increase the <guilabel>Label density</guilabel> slider.
</para>
@@ -449,15 +459,15 @@ increase the <guilabel>Label density</guilabel> slider.
<indexterm><primary>Catalogs</primary>
<secondary>Deep-Sky Catalogs</secondary></indexterm>
Below the stars section, the <guilabel>Deep-Sky Objects</guilabel> section controls
-the display of several non-stellar object catalogs. You can toggle the display of
-Deep Sky Objects and control the display of their names and magnitudes. By default,
+the display of several non-stellar object catalogs. You can toggle the display of
+Deep Sky Objects and control the display of their names and magnitudes. By default,
the list of deep-sky objects includes the Messier, NGC and IC catalogs.
-Addons catalogs are available via the
-<menuchoice><guimenu>Data</guimenu><guimenuitem>Download New Data...</guimenuitem></menuchoice>
-submenu where you can download catalogs provided by &kstars; team and the community.
-Furthermore, &kstars; supports import of custom catalogs. To import a raw ASCII catalog
-data file into &kstars;, press the <guibutton>Import Catalog</guibutton> and follow
-the instructions. To import a custom catalog already in &kstars; catalog format, press the
+Addons catalogs are available via the
+<menuchoice><guimenu>Data</guimenu><guimenuitem>Download New Data...</guimenuitem></menuchoice>
+submenu where you can download catalogs provided by &kstars; team and the community.
+Furthermore, &kstars; supports import of custom catalogs. To import a raw ASCII catalog
+data file into &kstars;, press the <guibutton>Import Catalog</guibutton> and follow
+the instructions. To import a custom catalog already in &kstars; catalog format, press the
<guilabel>Load Catalog</guilabel> button.
Each line in the custom catalog file should contain the following space-separated fields:
@@ -490,7 +500,7 @@ word, it must be enclosed in quotation marks.
<para>
Once you have constructed a custom data file, open the &kstars; configuration window
to the <guilabel>Catalogs</guilabel> tab, and press the
-<guibutton>Import Catalog...</guibutton> button. A popup window appears in which
+<guibutton>Import Catalog...</guibutton> button. A popup window appears in which
you can specify a name for the catalog, and the name of the file (including the path):
</para>
<screenshot>
@@ -604,21 +614,21 @@ magnitudes are unknown, or not available to &kstars;, are drawn irrespective of
</para>
<para>
-The following is a brief tutorial on adding new catalogues to &kstars;. To import a
+The following is a brief tutorial on adding new catalogues to &kstars;. To import a
new catalog, download a raw catalog data file where the data columns are space delimited.
-Any lines starting with # shall be ignored. For this example, we shall use the
+Any lines starting with # shall be ignored. For this example, we shall use the
<quote>Lynds Catalog of Dark Nebulae</quote>.
<itemizedlist>
<listitem>
<para>
-Download / write the raw catalog data file (the raw file is the file containing catalog's
-objects described by a set of parameters, like: ID Number, Right Ascension, Declination and so on).
+Download / write the raw catalog data file (the raw file is the file containing catalog's
+objects described by a set of parameters, like: ID Number, Right Ascension, Declination and so on).
</para>
<important>
-<para>In order to successfully load a custom catalog into &kstars;, you need to use the following syntax:
+<para>In order to successfully load a custom catalog into &kstars;, you need to use the following syntax:
(otherwise your catalog will be entirely ignored or maybe some objects from your catalog will be wrongly drawn)
</para>
<itemizedlist>
@@ -648,13 +658,13 @@ The following is a subset of the original raw data file:
5 17 13.2 -24 22 .20 +07.96 .012 4 0 9 595
</programlisting>
-The raw file contains some extra information, unusable for &kstars;. It also contains extra white spaces
-and values are not meeting &kstars; expectations (&ie; for Right Ascension: colon-delimited hh:mm:ss.s
-or floating-point value). Thus, it need to be modified in order to match &kstars; format.
-For a better understanding on what each column means, you can take a look at
-<ulink url="ftp://cdsarc.u-strasbg.fr/cats/VII/7A/">the original source</ulink> of the catalog.
-It contains the raw data file and, in addition, it contains an useful readme, which will help
-you understand what you should keep and furthermore, what you need to remove from the raw data file.
+The raw file contains some extra information, unusable for &kstars;. It also contains extra white spaces
+and values are not meeting &kstars; expectations (&ie; for Right Ascension: colon-delimited hh:mm:ss.s
+or floating-point value). Thus, it need to be modified in order to match &kstars; format.
+For a better understanding on what each column means, you can take a look at
+<ulink url="ftp://cdsarc.u-strasbg.fr/cats/VII/7A/">the original source</ulink> of the catalog.
+It contains the raw data file and, in addition, it contains an useful readme, which will help
+you understand what you should keep and furthermore, what you need to remove from the raw data file.
Minimally, the raw data file should contain the following fields:
<itemizedlist>
<listitem><para>ID Number</para></listitem>
@@ -667,59 +677,59 @@ Minimally, the raw data file should contain the following fields:
<para>
The raw <quote>Dark Nebulae by Lynds</quote> contains only three usable fields for &kstars;:
-Right Ascension, Declination and Area (square degrees). Therefore, in order to properly
-import the catalog into &kstars;, the ID and Object Type fields need to be added. You can
-insert these values manually using your favorite text editor. However, it is recommended
-to use any spreadsheet application to import the raw data file and add the necessary
-columns. This is especially convenient for large data sets. Since the original raw data
-contains an area field which is not supported by &kstars;, we need to approximate it to a
-usable value which is the Major Axis. Therefore, we use the following formula in the
+Right Ascension, Declination and Area (square degrees). Therefore, in order to properly
+import the catalog into &kstars;, the ID and Object Type fields need to be added. You can
+insert these values manually using your favorite text editor. However, it is recommended
+to use any spreadsheet application to import the raw data file and add the necessary
+columns. This is especially convenient for large data sets. Since the original raw data
+contains an area field which is not supported by &kstars;, we need to approximate it to a
+usable value which is the Major Axis. Therefore, we use the following formula in the
spreadsheet to convert area to major axis in arcminutes:
<constant>Major Axis = sqrt(Area) * 60</constant>
</para>
<para>
-After importing the raw data file into &kstars; and selecting the appropriate columns, &kstars;
-shall generate the final catalog file suitable for loading directly into &kstars;.
+After importing the raw data file into &kstars; and selecting the appropriate columns, &kstars;
+shall generate the final catalog file suitable for loading directly into &kstars;.
For example, this is a small subset of the content (header + first five objects) of the
-<quote>Dark Nebulae by Lynds</quote> catalog which was created by &kstars; after importing
+<quote>Dark Nebulae by Lynds</quote> catalog which was created by &kstars; after importing
the raw data file which only contains the data columns:
</para>
<programlisting>
-# Delimiter:
+# Delimiter:
# Name: LyndsCatalog
# Prefix: Lynds
# Color: #ff7600
# Epoch: 2000
-# ID RA Dc Mj Tp
+# ID RA Dc Mj Tp
1 16:26:0 -16:0:0.1 13.943 5
2 18:4:0 -31:30:0.1 66.813 5
3 18:0:0 -31:0:0.1 141.986 5
4 16:59:5 -22:8:0.1 3.795 5
5 17:13:2 -24:22:0.2 6.573 5
</programlisting>
-<para>As seen above, each column was assigned a &kstars; designated header such as the ID,
-Right Ascension, Declination, Major axis and Object Type fields. Note that the Catalog Prefix
-(<quote>Lynds</quote>) and the ID field are used together for identifying objects in the Sky Map
-(&ie; objects from this catalog will have names like: Lynds 1, Lynds 2, Lynds 617 up to the
+<para>As seen above, each column was assigned a &kstars; designated header such as the ID,
+Right Ascension, Declination, Major axis and Object Type fields. Note that the Catalog Prefix
+(<quote>Lynds</quote>) and the ID field are used together for identifying objects in the Sky Map
+(&ie; objects from this catalog will have names like: Lynds 1, Lynds 2, Lynds 617 up to the
last object, Lynds 1791).
</para>
</listitem>
<listitem><para>
-Open the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kstars;...</guimenuitem></menuchoice>
+Open the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kstars;...</guimenuitem></menuchoice>
menu and choose <guilabel>Catalogs</guilabel> tab.
</para></listitem>
<listitem><para>
-In the Deep-Sky objects section, press the <guibutton>Import Catalog...</guibutton> button.
-If the button is not available, check the <guibutton>Deep-Sky Catalogs</guibutton> checkbox.
+In the Deep-Sky objects section, press the <guibutton>Import Catalog...</guibutton> button.
+If the button is not available, check the <guibutton>Deep-Sky Catalogs</guibutton> checkbox.
This will enable you to configure &kstars; deep-sky objects catalogs.
</para></listitem>
<listitem><para>
-After you press the <guibutton>Import Catalog...</guibutton> button,
-<guilabel>Import Catalog</guilabel> window will pop up. At first, click on
+After you press the <guibutton>Import Catalog...</guibutton> button,
+<guilabel>Import Catalog</guilabel> window will pop up. At first, click on
<guibutton>Open file dialog</guibutton> button in order to select the raw data file.
<screenshot>
<screeninfo>Import catalog</screeninfo>
@@ -750,11 +760,11 @@ In the dialog window, find your raw file, select it and then press <guibutton>Op
</para></listitem>
<listitem><para>
-Now, you need to specify the correct order of the catalog fields within the raw
-data file. The fields must be added inside <guilabel>Catalog fields</guilabel>
-list. Note that you can drag fields in order to build the right order or you can
-use additional fields from <guilabel>Available fields</guilabel> fields. For
-example, if your raw data file contains a magnitude column, then you need to add
+Now, you need to specify the correct order of the catalog fields within the raw
+data file. The fields must be added inside <guilabel>Catalog fields</guilabel>
+list. Note that you can drag fields in order to build the right order or you can
+use additional fields from <guilabel>Available fields</guilabel> fields. For
+example, if your raw data file contains a magnitude column, then you need to add
Magnitude field to the <guilabel>Catalog fields</guilabel> list.
<screenshot>
<screeninfo>Complete info for new catalog</screeninfo>
@@ -770,27 +780,27 @@ Magnitude field to the <guilabel>Catalog fields</guilabel> list.
</para></listitem>
<listitem><para>
-After you set the fields so that they match to your catalog raw file, you can move
-to the next step: completing the remaining input fields: <guilabel>Coordinate epoch</guilabel>,
-<guilabel>Catalog name prefix</guilabel>, <guilabel>Catalog name</guilabel> and
-<guilabel>Save catalog as</guilabel>. You can also choose the <guilabel>Symbol color</guilabel>
-used for your catalog. There you can specify how the fields are split within the raw data
+After you set the fields so that they match to your catalog raw file, you can move
+to the next step: completing the remaining input fields: <guilabel>Coordinate epoch</guilabel>,
+<guilabel>Catalog name prefix</guilabel>, <guilabel>Catalog name</guilabel> and
+<guilabel>Save catalog as</guilabel>. You can also choose the <guilabel>Symbol color</guilabel>
+used for your catalog. There you can specify how the fields are split within the raw data
file: CSV (Comma-separated values) or Space Delimited.
</para></listitem>
<listitem><para>
-You can preview the output by pressing the <guibutton>Preview Output</guibutton> button.
-Pay attention to the header fields to have the same order as your catalog fields
+You can preview the output by pressing the <guibutton>Preview Output</guibutton> button.
+Pay attention to the header fields to have the same order as your catalog fields
(&ie; ID RA Dec Major Axis and Object Type).
</para></listitem>
<listitem><para>
-Press <guibutton>OK</guibutton> button to close the <guilabel>Catalog Preview</guilabel> window.
+Press <guibutton>OK</guibutton> button to close the <guilabel>Catalog Preview</guilabel> window.
Then press <guibutton>OK</guibutton> button again to create and save your catalog.
</para></listitem>
<listitem><para>
-After you successfully imported your catalog, it will be displayed in the catalogs list.
+After you successfully imported your catalog, it will be displayed in the catalogs list.
You can choose to be displayed or not, by pressing on its checkbox.
<screenshot>
<screeninfo>Added Dark Nebulae by Lynds catalog</screeninfo>
@@ -879,8 +889,8 @@ the search satellites method that &kstars; provides. You need to enter the name
satellites</guilabel> text box and the list will be reduced only to its best matches.
</para>
<para>
-You can add new satellites to &kstars; default satellites set by editing the
-<filename>kstars/data/satellites.dat</filename> file. As each line of this file is a group of
+You can add new satellites to &kstars; default satellites set by editing the
+<filename>kstars/data/satellites.dat</filename> file. As each line of this file is a group of
satellites, you need to add a new entry for your desired satellites group.
An entry should have the following format: <userinput>Group Name;local_filename;url</userinput>.
For example: <userinput>Iridium;iridium.tle;http://celestrak.com/NORAD/elements/iridium.txt</userinput>.
@@ -949,6 +959,43 @@ constellation names using your local language.
</para>
</sect1>
+<sect1 id="terrain">
+<title>Terrain</title>
+<screenshot>
+<screeninfo>Terrain Window</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="terrain_tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Terrain Window</phrase>
+ </textobject>
+</mediaobject>
+</screenshot>
+<para>
+<indexterm><primary>Configure &kstars; window</primary>
+<secondary>Terrain page</secondary></indexterm>
+The <guilabel>Terrain</guilabel> page lets you configure whether the terrain (landscape) image will be shown on the skymap.
+</para>
+<para>
+The user is responsible for creating a partially-transparent image, that is overlayed onto the sky map. This image should have transparent regions that the user creates to let the skymap show through, and opaque regions representing the trees, buildings, the landscape around the telescope. There is a particular format required, and this is a significant effort. There are many resources on the web that explain how this is done for <ulink url="http://stellarium.org/landscapes.html">Stellarium</ulink>. The details of image creation are the same.
+</para>
+<para>
+Initially, the user captures a full sphere equirectangular projection image from approximately the same point-of-view as his/her telescope. This kind of image can be captured with the Google Camera App, or the Google YouTube App on iPhone, or likely many other camera apps. The user then needs to edit the resulting image so that the sky is erased/transparent, and save it as a PNG. Finally, the user needs to determine where North is in the image, so it can eventually be aligned with the skymap. Once all that is done, the sky map can simulate the local sky view including the local terrain.
+</para>
+<para>
+Once the image is created, it is possible to upload it via the <guilabel>Terrain</guilabel> page and configure the azimuth correction value (in degrees) that allows the user to rotate the view so north in the sky map is aligned with the north in the image.
+</para>
+<para>
+Moreover, some speedup options can be configured to achieve the best user experience when rendering the terrain on the sky map.
+</para>
+<tip>
+ <para>
+ You can toggle the terrain overlay on and off using a keyboard shortcut <keycombo>&Ctrl;&Shift;<keycap>T</keycap></keycombo> and the <menuchoice><guimenu>View</guimenu><guimenuitem>Show terrain</guimenuitem></menuchoice> menu item.
+ </para>
+</tip>
+</sect1>
+
<sect1 id="colors">
<title>Colors</title>
<screenshot>
@@ -999,6 +1046,17 @@ Scheme</guibutton> button.
<sect1 id="fits-configure">
<title>FITS</title>
+<screenshot>
+<screeninfo>FITS Window</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="fits_tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>FITS Window</phrase>
+ </textobject>
+</mediaobject>
+</screenshot>
<indexterm><primary>Configure &kstars; window</primary>
<secondary>FITS page</secondary></indexterm>
<para><abbrev>FITS</abbrev> (Flexible Image Transport System) is a popular open standard for storage, transmission and processing of digital data. For the details, one is referred to the <ulink url="https://en.wikipedia.org/wiki/FITS">corresponding Wikipedia article</ulink>. This page allows you to configure presentation and processing of FITS data in &kstars;.
@@ -1009,16 +1067,16 @@ Scheme</guibutton> button.
<para>
Check the <guilabel>Use FITS Viewer</guilabel> item if you want automatically display received images in the FITS Viewer.
</para>
-<para>The <guilabel>Single Preview Tab</guilabel> item is to display all captured FITS images in a single tab instead of multiple tabs
-per image. The <guilabel>Single Window Capture</guilabel> item is to display captured FITS images from all cameras in a single FITS Viewer window
-instead of a dedicated window to each camera. The <guilabel>Single Window Open</guilabel> item is to display opened FITS images in a single FITS Viewer window instead of a
+<para>The <guilabel>Single Preview Tab</guilabel> item is to display all captured FITS images in a single tab instead of multiple tabs
+per image. The <guilabel>Single Window Capture</guilabel> item is to display captured FITS images from all cameras in a single FITS Viewer window
+instead of a dedicated window to each camera. The <guilabel>Single Window Open</guilabel> item is to display opened FITS images in a single FITS Viewer window instead of a
dedicated window to each file and the <guilabel>Independent Window</guilabel> item is to make FITS Viewer window independent from &kstars;.
</para>
<para>
-The right panel lists processing options. The <guilabel>Auto Stretch</guilabel> item is to always apply auto stretch to images in FITS Viewer, <guilabel>Limited Resources Mode</guilabel> is to enable limited resource mode to turn off any resource-intensive operations, namely: <guilabel>Auto Debayer</guilabel> (bayered images will not be debayered; only grayscale images are shown), <guilabel>Auto WCS</guilabel> (World Coordinate System data
-will not be processed; WCS maps sky coordinates to image coordinates;
-equatorial grid lines, object identification, and telescope slew within an
-image are disabled), and <guilabel>3D Cube</guilabel> (RGB images will not be
+The right panel lists processing options. The <guilabel>Auto Stretch</guilabel> item is to always apply auto stretch to images in FITS Viewer, <guilabel>Limited Resources Mode</guilabel> is to enable limited resource mode to turn off any resource-intensive operations, namely: <guilabel>Auto Debayer</guilabel> (bayered images will not be debayered; only grayscale images are shown), <guilabel>Auto WCS</guilabel> (World Coordinate System data
+will not be processed; WCS maps sky coordinates to image coordinates;
+equatorial grid lines, object identification, and telescope slew within an
+image are disabled), and <guilabel>3D Cube</guilabel> (RGB images will not be
processed; only grayscale images are shown). You can switch off some of these resource-greedy operations separately as well.
</para>
</sect1>
@@ -1064,6 +1122,26 @@ see the <link linkend="tool-ekos">Ekos section of this manual</link>.
</para>
</sect1>
+<sect1 id="xplanet-configure">
+<title>Xplanet</title>
+<screenshot>
+<screeninfo>Xplanet Window</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="xplanet_tab.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Xplanet Window</phrase>
+ </textobject>
+</mediaobject>
+</screenshot>
+<para>
+<ulink url="http://xplanet.sourceforge.net/">Xplanet</ulink> (should be installed separately) is
+a solar system planet surface renderer. This page allows you to configure presentation and
+processing of <application>Xplanet</application> data in &kstars;.
+</para>
+</sect1>
+
<sect1 id="advanced">
<title>Advanced</title>
<screenshot>
diff --git a/doc/ekos_tab.png b/doc/ekos_tab.png
index c6d5dc13e..6a0c89bdc 100644
Binary files a/doc/ekos_tab.png and b/doc/ekos_tab.png differ
diff --git a/doc/fits_tab.png b/doc/fits_tab.png
new file mode 100644
index 000000000..bf5396f6a
Binary files /dev/null and b/doc/fits_tab.png differ
diff --git a/doc/guides_tab.png b/doc/guides_tab.png
index 80d945aaf..20b09078d 100644
Binary files a/doc/guides_tab.png and b/doc/guides_tab.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 8e8dfa041..540a8b73b 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -180,8 +180,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2019-12-04</date>
-<releaseinfo>3.4.0</releaseinfo>
+<date>2021-03-11</date>
+<releaseinfo>3.5.3</releaseinfo>
<abstract>
<para>
diff --git a/doc/indi_tab.png b/doc/indi_tab.png
index 567984eca..868444488 100644
Binary files a/doc/indi_tab.png and b/doc/indi_tab.png differ
diff --git a/doc/satellites_tab.png b/doc/satellites_tab.png
index ec218ee91..53b4cb489 100644
Binary files a/doc/satellites_tab.png and b/doc/satellites_tab.png differ
diff --git a/doc/solarsystem_tab.png b/doc/solarsystem_tab.png
index d54e3df13..409be6e6e 100644
Binary files a/doc/solarsystem_tab.png and b/doc/solarsystem_tab.png differ
diff --git a/doc/supernovae_tab.png b/doc/supernovae_tab.png
index a34217397..d2dc03ca2 100644
Binary files a/doc/supernovae_tab.png and b/doc/supernovae_tab.png differ
diff --git a/doc/terrain_tab.png b/doc/terrain_tab.png
new file mode 100644
index 000000000..96537200d
Binary files /dev/null and b/doc/terrain_tab.png differ
diff --git a/doc/viewops.png b/doc/viewops.png
index 51078c1dd..e912f3fba 100644
Binary files a/doc/viewops.png and b/doc/viewops.png differ
diff --git a/doc/xplanet_tab.png b/doc/xplanet_tab.png
new file mode 100644
index 000000000..2394cee5e
Binary files /dev/null and b/doc/xplanet_tab.png differ
More information about the kde-doc-english
mailing list