Git commit cd784a2e0841c0a609c037f3e6333c92c734ec16 by Antoni Bella Pérez. Committed on 26/07/2021 at 16:01. Pushed by mutlaqja into branch 'master'.
Documentation updates * Review all items M +273 -326 doc/commands.docbook M +51 -81 doc/config.docbook M +3 -3 doc/ekos-profile-wizard.docbook M +3 -2 doc/fitsviewer.docbook M +29 -34 doc/indi.docbook M +6 -6 doc/quicktour.docbook https://invent.kde.org/education/kstars/commit/cd784a2e0841c0a609c037f3e6333c92c734ec16 diff --git a/doc/commands.docbook b/doc/commands.docbook index edd3ac551..a7b03e496 100644 --- a/doc/commands.docbook +++ b/doc/commands.docbook @@ -15,9 +15,9 @@ <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> </shortcut> <guimenu>File</guimenu> -<guimenuitem>Open FITS...</guimenuitem> +<guimenuitem>Open Image...</guimenuitem> </menuchoice></term> -<listitem><para>Open a FITS image in the FITS Viewer tool. +<listitem><para>Open a image in the FITS Viewer tool. </para></listitem> </varlistentry> @@ -45,7 +45,7 @@ <varlistentry> <term><menuchoice> <guimenu>File</guimenu> -<guimenuitem>Printing Wizard</guimenuitem> +<guimenuitem>Printing Wizard...</guimenuitem> </menuchoice></term> <listitem><para>Starts a wizard to configure capturing sky objects images using telescope and printing the results as a good looking printout for further use or catalogization. </para></listitem> @@ -251,7 +251,7 @@ object.</para></listitem> <term><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut> <guimenu>View</guimenu> -<guimenuitem>Zoom in</guimenuitem> +<guimenuitem>Zoom In</guimenuitem> </menuchoice></term> <listitem><para>Zooms view in.</para></listitem> </varlistentry> @@ -260,7 +260,7 @@ object.</para></listitem> <term><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut> <guimenu>View</guimenu> -<guimenuitem>Zoom out</guimenuitem> +<guimenuitem>Zoom Out</guimenuitem> </menuchoice></term> <listitem><para>Zooms view out.</para></listitem> </varlistentry> @@ -318,7 +318,7 @@ object.</para></listitem> <keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo> </shortcut> <guimenu>View</guimenu> -<guimenuitem>Show terrain</guimenuitem> +<guimenuitem>Show Terrain</guimenuitem> </menuchoice></term> <listitem><para>Toggle the <link linkend="terrain">terrain image</link> visibility.</para></listitem> </varlistentry> @@ -404,11 +404,12 @@ which provides full access to many of the mathematical functions used by <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>0</keycap></keycombo></shortcut> <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>, <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.</para></listitem> </varlistentry> - +<!-- <varlistentry> <term><menuchoice><guimenuitem>Telescope Wizard...</guimenuitem></menuchoice></term> <listitem><para>Opens the <guilabel>Telescope Wizard</guilabel>, which provides a step-by-step guide to help you connect to your telescope and control it with &kstars;.</para></listitem> </varlistentry> +--> <varlistentry> <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo></shortcut> <guimenuitem>Device Manager...</guimenuitem></menuchoice></term> @@ -643,335 +644,281 @@ the planned session. <title>Settings Menu</title> <variablelist> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Info Boxes</guisubmenu> -<guimenuitem>Show Info Boxes</guimenuitem> -</menuchoice></term> -<listitem><para>Toggle display of all three Info Boxes: -<itemizedlist> -<listitem><para>Time Box</para></listitem> -<listitem><para>Focus Box</para></listitem> -<listitem><para>Location Box</para></listitem> -</itemizedlist> -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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 -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 -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>, -<guilabel>Set Time</guilabel> or <guilabel>Set Geographic Location</guilabel> window. -Main Toolbar can be configured using the <menuchoice><guimenu>Settings</guimenu> -<guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -Note that when the horizon is switched off, refraction effects are temporarily disabled. -View Toolbar can be configured using the <menuchoice><guimenu>Settings</guimenu> -<guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Toolbars Shown</guisubmenu> -<guimenuitem>INDI Toolbar</guimenuitem> -</menuchoice></term> -<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 the <menuchoice><guimenu>Settings</guimenu> -<guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Statusbar</guisubmenu> -<guimenuitem>Show Statusbar</guimenuitem> -</menuchoice></term> -<listitem><para>Toggle display of the Statusbar. It is located in the bottom -of &kstars; window. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Statusbar</guisubmenu> -<guimenuitem>Show Az/Alt Field</guimenuitem> -</menuchoice></term> -<listitem><para>Toggle display of the mouse cursor's horizontal -coordinates in the statusbar. -</para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Statusbar</guisubmenu> -<guimenuitem>Show RA/Dec Field</guimenuitem> -</menuchoice></term> -<listitem><para>Toggle display of the mouse cursor's equatorial -coordinates in the statusbar. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guisubmenu>Info Boxes</guisubmenu> + </menuchoice></term> + <listitem><para>A submenu that lists the different info boxes. + + <variablelist> + <varlistentry> + <term><guimenuitem>Show Info Boxes</guimenuitem></term> + <listitem><para>Toggle display of all three Info Boxes: + <itemizedlist> + <listitem><para>Time Box</para></listitem> + <listitem><para>Focus Box</para></listitem> + <listitem><para>Location Box</para></listitem> + </itemizedlist> + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show Time Box</guimenuitem></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.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show Focus Box</guimenuitem></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.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show Location Box</guimenuitem></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.</para></listitem> + </varlistentry> + </variablelist></para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guisubmenu>Statusbar</guisubmenu> -<guimenuitem>Show J2000.0 RA/Dec Field</guimenuitem> -</menuchoice></term> -<listitem><para>Toggle display of the mouse cursor's equatorial J2000 -coordinates in the statusbar. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guisubmenu>Toolbars Shown</guisubmenu> + </menuchoice></term> + <listitem><para>A submenu that lists the different toolbars. + + <variablelist> + <varlistentry> + <term><guimenuitem>Main Toolbar</guimenuitem></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 + 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 + 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>, + <guilabel>Set Time</guilabel> or <guilabel>Set Geographic Location</guilabel> window. + Main Toolbar can be configured using the <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>View Toolbar</guimenuitem></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. + Note that when the horizon is switched off, refraction effects are temporarily disabled. + View Toolbar can be configured using the <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>INDI Toolbar</guimenuitem></term> + <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 the <menuchoice><guimenu>Settings</guimenu> + <guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> menu item.</para></listitem> + </varlistentry> + </variablelist></para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -Select any item to set that color scheme. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guisubmenu>Statusbar</guisubmenu> + </menuchoice></term> + <listitem><para>A submenu that lists the different statusbars. + + <variablelist> + <varlistentry> + <term><guimenuitem>Show Statusbar</guimenuitem></term> + <listitem><para>Toggle display of the Statusbar. It is located in the bottom of &kstars; window.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show Az/Alt Field</guimenuitem></term> + <listitem><para>Toggle display of the mouse cursor's horizontal coordinates in the statusbar.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show RA/Dec Field</guimenuitem></term> + <listitem><para>Toggle display of the mouse cursor's equatorial coordinates in the statusbar.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Show J2000.0 RA/Dec Field</guimenuitem></term> + <listitem><para>Toggle display of the mouse cursor's equatorial J2000 coordinates in the statusbar.</para></listitem> + </varlistentry> + </variablelist></para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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 -(or modify existing symbols) using the <guimenuitem>Edit FOV Symbols...</guimenuitem> menu item. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <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. Select any + item to set that color scheme.</para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<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. -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 -them such that next time when you will open &kstars; they will be automatically marked on the skymap. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <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 (or modify existing symbols) using the <guimenuitem>Edit FOV Symbols...</guimenuitem> + menu item.</para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo> -</shortcut> -<guimenu>Settings</guimenu> -<guimenuitem>Manage Observer</guimenuitem> -</menuchoice></term> -<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. -You can also remove an observer from the list using <guibutton>-</guibutton> (Remove observer) button. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <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. 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 them such that next time when + you will open &kstars; they will be automatically marked on the skymap.</para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> -</shortcut> -<guimenu>Settings</guimenu> -<guimenuitem>Geographic...</guimenuitem> -</menuchoice></term> -<listitem> -<para> -Select a new <link linkend="setgeo">geographic location</link>. -</para> -</listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo></shortcut> + <guimenu>Settings</guimenu> + <guimenuitem>Manage Observer...</guimenuitem> + </menuchoice></term> + <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. You can also remove an observer from the list using <guibutton>-</guibutton> (Remove + observer) button.</para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<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 -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; -Configure Shortcuts feature: -<itemizedlist> -<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 -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. -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 -be automatically saved, thus you can use it next time when you open &kstars;.</para></listitem> -</itemizedlist> -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut> + <guimenu>Settings</guimenu> + <guimenuitem>Geographic...</guimenuitem> + </menuchoice></term> + <listitem><para>Select a new <link linkend="setgeo">geographic location</link>.</para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guimenuitem>Configure &kstars;...</guimenuitem> -</menuchoice></term> -<listitem><para>Modify <link linkend="config">configuration options</link>. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Keyboard 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 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; Configure Shortcuts feature: + <itemizedlist> + <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 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. + 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 be + automatically saved, thus you can use it next time when you open &kstars;.</para></listitem> + </itemizedlist> + </para></listitem> + </varlistentry> -<varlistentry> -<term><menuchoice> -<guimenu>Settings</guimenu> -<guimenuitem>Startup Wizard...</guimenuitem> -</menuchoice></term> -<listitem><para> -Shows the <guilabel>Setup Wizard</guilabel> dialog. 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 <guilabel>Choose Your Home Location</guilabel> 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 -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 -<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 this button, the -<guilabel>Get Hot New Stuff</guilabel> dialog 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. -Regarding the list of add-ons, you may perform several actions by selecting an add-on from the list: you can install -or uninstall an add-on using the <guibutton>Install</guibutton> / <guibutton>Uninstall</guibutton> button, you can -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> -button. You can also use the Download Extra Data Files tool later, by selecting the <menuchoice><guimenu>Data</guimenu> -<guimenuitem>Download New Data...</guimenuitem></menuchoice> menu item. -</para></listitem> -</varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure &kstars;...</guimenuitem> + </menuchoice></term> + <listitem><para>Modify <link linkend="config">configuration options</link>.</para></listitem> + </varlistentry> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Startup Wizard...</guimenuitem> + </menuchoice></term> + <listitem><para>Shows the <guilabel>Setup Wizard</guilabel> dialog. 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 <guilabel>Choose Your Home Location</guilabel> 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 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 + <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 this button, the <guilabel>Get Hot New Stuff</guilabel> dialog 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. Regarding the list of add-ons, you may perform several actions by selecting an add-on from the list: + you can install or uninstall an add-on using the <guibutton>Install</guibutton> / <guibutton>Uninstall</guibutton> + button, you can 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> button. You can also use the Download + Extra Data Files tool later, by selecting the <menuchoice><guimenu>Data</guimenu> + <guimenuitem>Download New Data...</guimenuitem></menuchoice> menu item.</para></listitem> + </varlistentry> </variablelist> <para> diff --git a/doc/config.docbook b/doc/config.docbook index 0459466d7..aa57e46e7 100644 --- a/doc/config.docbook +++ b/doc/config.docbook @@ -189,7 +189,7 @@ Milky Way contour). <variablelist> <varlistentry> <term></term><listitem><para><indexterm><primary>Sky culture</primary></indexterm> - 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. + 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></listitem> </varlistentry> </variablelist> @@ -547,7 +547,7 @@ those are less flexible and offer no deduplication. <secondary>GUI</secondary></indexterm> <para> The catalog management &GUI; is reached via the <menuchoice><guimenu>Data</guimenu> -<guimenuitem>Manage DSO Catalogs</guimenuitem></menuchoice> menu item and is displayed +<guimenuitem>Manage DSO Catalogs...</guimenuitem></menuchoice> menu item and is displayed <link linkend="dso_manager">below</link>. <screenshot> @@ -580,9 +580,7 @@ database. </para> <variablelist> <varlistentry id="import"> -<term><menuchoice> -<guimenu>Import Catalog</guimenu> -</menuchoice></term> +<term><guibutton>Import Catalog...</guibutton></term> <listitem> <para>Import a catalog in the <literal role="extension">.kscat</literal> format from a file.</para> @@ -598,9 +596,7 @@ selected catalog (the highlighted row on the left). <variablelist> <varlistentry> -<term><menuchoice> -<guimenu>Create Catalog</guimenu> -</menuchoice></term> +<term><guibutton>Create Catalog...</guibutton></term> <listitem> <para>Create a new catalog. See <xref linkend="create_catalog"/>. </para> @@ -608,9 +604,7 @@ selected catalog (the highlighted row on the left). </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>Enable/Disable</guimenu> -</menuchoice></term> +<term><guibutton>Enable / Disable</guibutton></term> <listitem> <para>Enable or disable a catalog.</para> <para>This is reflected in the skymap upon closing the @@ -619,9 +613,7 @@ selected catalog (the highlighted row on the left). </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>Remove</guimenu> -</menuchoice></term> +<term><guibutton>Remove</guibutton></term> <listitem> <para>Remove a catalog from the catalog database.</para> <para>This is reflected in the skymap upon closing the @@ -630,21 +622,17 @@ selected catalog (the highlighted row on the left). </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>Export</guimenu> -</menuchoice></term> +<term><guibutton>Export...</guibutton></term> <listitem> <para>Export a catalog into a <literal role="extension">.kscat</literal> file.</para> - <para>The resulting file can be imported. - with <link linkend="import">Import Catalog</link>. + <para>The resulting file can be imported with + <link linkend="import"><guibutton>Import Catalog...</guibutton></link> button. </para> </listitem> </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>Clone</guimenu> -</menuchoice></term> +<term><guibutton>Clone...</guibutton></term> <listitem> <para>Make an exact copy of the catalog and insert it into the database.</para> <para>This is useful if you wish to make modifications to an @@ -662,9 +650,7 @@ selected catalog (the highlighted row on the left). </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>More</guimenu> -</menuchoice></term> +<term><guibutton>More...</guibutton></term> <listitem> <para>Open the catalog details dialog. (See <xref linkend="catalog_details"/>.) </para> @@ -740,9 +726,7 @@ selected object. <variablelist> <varlistentry> -<term><menuchoice> -<guimenu>Edit</guimenu> -</menuchoice></term> +<term><guibutton>Edit...</guibutton></term> <listitem> <para>Edit the catalog object. (See <xref linkend="add_object"/>). </para> @@ -750,9 +734,7 @@ selected object. </varlistentry> <varlistentry> -<term><menuchoice> -<guimenu>Remove</guimenu> -</menuchoice></term> +<term><guibutton>Remove</guibutton></term> <listitem> <para>Removes the object from the catalog. </para> @@ -762,13 +744,13 @@ selected object. </para> <para> - Below the <guilabel>Object</guilabel> menu, the general catalog + Below the <guilabel>Object</guilabel> section, the general catalog options are situated. <variablelist> <varlistentry> <term><menuchoice> - <guimenu>Edit Catalog Meta</guimenu> + <guimenu>Edit Catalog Meta...</guimenu> </menuchoice></term> <listitem> <para>Edit the catalog metadata displayed in the top left. This @@ -778,9 +760,7 @@ selected object. </varlistentry> <varlistentry> - <term><menuchoice> - <guimenu>Add Object</guimenu> - </menuchoice></term> + <term><guibutton>Add Object...</guibutton></term> <listitem> <para>Add an object to the catalog. (See <xref linkend="add_object"/>.) </para> @@ -788,9 +768,7 @@ selected object. </varlistentry> <varlistentry> - <term><menuchoice> - <guimenu>Import CSV</guimenu> - </menuchoice></term> + <term><guibutton>Import CSV...</guibutton></term> <listitem> <para>Import objects from a tabular text format (csv, tsv, &etc;) into the catalog. (See <xref linkend="csv_import"/>.) @@ -994,10 +972,10 @@ sky color. <secondary>Satellites page</secondary></indexterm> The <guilabel>Satellites</guilabel> page allows you to set the satellites view options. Firstly, you can see or hide the satellites on the skymap using <guilabel>Show satellites</guilabel> checkbox -from the top <guilabel>View options</guilabel> section. By default, satellites are drawn as small +from the top <guilabel>View Options</guilabel> section. By default, satellites are drawn as small light red filled circles with an optional dark red name label next to them. You can enable or disable these labels by checking or not the <guilabel>Show labels</guilabel> checkbox. It is located below -the <guilabel>Show satellites</guilabel> checkbox, within the <guilabel>View options</guilabel> section. +the <guilabel>Show satellites</guilabel> checkbox, within the <guilabel>View Options</guilabel> section. </para> <para> The colors of the dots representing satellites and their name labels can be easily customized using @@ -1013,7 +991,7 @@ presented. To select all satellites from a group, you need to check the group ch only the satellites of interest in each group. The satellites orbital elements can be updated via the internet by pressing the <guibutton>Update TLEs</guibutton> button. Another way for updating the satellites orbital elements is to use the <menuchoice><guimenu>Data</guimenu> -<guisubmenu>Updates</guisubmenu> <guimenuitem>Update satellites orbital elements</guimenuitem></menuchoice> menu +<guisubmenu>Updates</guisubmenu> <guimenuitem>Update Satellites Orbital Elements</guimenuitem></menuchoice> menu item. If you know the name of a desired satellite then you can use the search satellites method that &kstars; provides. You need to enter the name of satellite in the <guilabel>Search satellites</guilabel> text box and the list will be reduced only to its best matches. @@ -1048,18 +1026,13 @@ the <guilabel>Show supernovae</guilabel> checkbox. By default, supernovae are dr As for satellites, the color of supernovae can be easily customized using the <guilabel>Colors</guilabel> page. </para> <para> -You can configure &kstars; to check for newly discovered supernovae on startup by checking the <guilabel>Check for -Recent Supernovae on Startup</guilabel> checkbox. This way, &kstars; will be always up-to-date with the most recent -supernovae. You can enable supernova alerts using the <guilabel>Enable Supernova alerts</guilabel> checkbox. Thus, -&kstars; will automatically alert you every time it learns of a new supernova in the sky. You can set the magnitude -limit for showing a supernova as well as magnitude limit for supernova alerts using the spin boxes control. The -limiting magnitude is the faintest apparent magnitude of an skyobject that is visible with the naked-eye or a telescope. +You can set the magnitude limit for showing a supernova as well as magnitude limit for supernova alerts using +the spin boxes control. The limiting magnitude is the faintest apparent magnitude of an skyobject that is +visible with the naked-eye or a telescope. </para> <para> -The list of recent supernovae can be updated via the internet by pressing the <guibutton>Update List of Recent -Supernovae</guibutton> button. Another way for updating the supernovae list is to use the -<menuchoice><guimenu>Data</guimenu> <guisubmenu>Updates</guisubmenu> <guimenuitem>Update Recent Supernovae -data</guimenuitem></menuchoice> menu item. +The list of recent supernovae can be updated via the <menuchoice><guimenu>Data</guimenu> +<guisubmenu>Updates</guisubmenu> <guimenuitem>Update Recent Supernovae data</guimenuitem></menuchoice> menu item. </para> </sect1> @@ -1122,7 +1095,7 @@ Moreover, some speedup options can be configured to achieve the best user experi </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. + 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> @@ -1151,13 +1124,13 @@ and to define custom color schemes. The tab is split into two panels: <para> The left panel shows a list of all display items with adjustable colors. Click on any item to bring up a color selection window to -adjust its color. Below the list is the <guilabel>Star Color -Mode</guilabel> selection box. By default, &kstars; draws stars with +adjust its color. Below the list is the <guilabel>Star color +mode:</guilabel> dropdown box. By default, &kstars; draws stars with a <link linkend="ai-colorandtemp">realistic color</link> tint according to the spectral type of the star. However, you may also choose to draw the stars as solid white, black or red circles. If you are using the realistic star colors, you can set the saturation level of the star -colors with the <guilabel>Star Color Intensity</guilabel> spinbox. +colors with the <guilabel>Star color intensity:</guilabel> spinbox. </para> <para> The right panel lists the defined color schemes. There are four @@ -1167,11 +1140,10 @@ background, <guilabel>Night Vision</guilabel>, which uses only shades of red in order to protect dark-adapted vision, and <guilabel>Moonless Night</guilabel>, a more realistic, dark theme. Additionally, you can save the current color settings as a custom scheme by clicking -the <guibutton>Save Current Colors</guibutton> button. It will prompt +the <guibutton>Save As...</guibutton> button. It will prompt you for a name for the new scheme, and then your scheme will appear in the list in all future &kstars; sessions. To remove a custom scheme, -simply highlight it in the list, and press the <guibutton>Remove Color -Scheme</guibutton> button. +simply highlight it in the list, and press the <guibutton>Remove</guibutton> button. </para> </sect1> @@ -1337,7 +1309,7 @@ situations, as long as the <guilabel>Hide objects while moving</guilabel> checkbox is selected. The timestep threshold above which objects will be hidden is determined by the <guilabel>Also hide if time step larger than:</guilabel> timestep-spinbox. You can specify the objects that should -be hidden in the <guilabel>Configure Hidden Objects</guilabel> group box. +be hidden in the <guilabel>Configure Hidden Objects</guilabel> section. </para> </sect1> @@ -1348,32 +1320,30 @@ be hidden in the <guilabel>Configure Hidden Objects</guilabel> group box. There are several ways to modify the display to your liking.</para> <itemizedlist> <listitem><para> -<indexterm><primary>Color Schemes</primary><secondary>Selecting</secondary></indexterm> -Select a different color scheme in the -<menuchoice><guimenu>Settings</guimenu><guimenuitem>Color Schemes</guimenuitem></menuchoice> -menu item. There are four predefined color schemes, and you can define your own in the -<link linkend="config"><guilabel>Configure - &kstars;</guilabel></link> window. -</para></listitem> -<listitem><para> -<indexterm><primary>Toolbars</primary> -<secondary>Customizing</secondary></indexterm> -Toggle whether the Toolbars are drawn in the -<menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice> -menu item. Like most &kde; toolbars, they can also be dragged around and -anchored on any window edge, or even detached from the window completely if they are unlocked. -</para></listitem> -<listitem><para> <indexterm><primary>Info Boxes</primary><secondary>Customizing</secondary></indexterm> <indexterm><primary>Info Boxes</primary><secondary>Shading</secondary></indexterm> -Toggle whether the Info Boxes are drawn in the -<menuchoice><guimenu>Settings</guimenu><guimenuitem>Info Boxes</guimenuitem></menuchoice> -menu item. In addition, you can manipulate the three Info Boxes with the -mouse. Each box has additional lines of data that are hidden by default. -You can toggle whether these additional lines are visible by double-clicking -a box to <quote>shade</quote> it. Also, you can reposition a box by +Toggle whether the Info Boxes are drawn in the <menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Info Boxes</guisubmenu></menuchoice> submenu. In addition, you can +manipulate the three Info Boxes with the mouse. Each box has additional lines of data +that are hidden by default. You can toggle whether these additional lines are visible +by double-clicking a box to <quote>shade</quote> it. Also, you can reposition a box by dragging it with the mouse. When a box hits a window edge, it will <quote>stick</quote> to the edge when the window is resized. </para></listitem> +<listitem><para> +<indexterm><primary>Toolbars</primary><secondary>Customizing</secondary></indexterm> +Toggle whether the Toolbars are drawn in the <menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Toolbars Shown</guisubmenu></menuchoice> submenu. Like most &kde; toolbars, +they can also be dragged around and anchored on any window edge, or even detached from +the window completely if they are unlocked. +</para></listitem> +<listitem><para> +<indexterm><primary>Color Schemes</primary><secondary>Selecting</secondary></indexterm> +Select a different color scheme in the <menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Color Schemes</guisubmenu></menuchoice> submenu. There are four predefined +color schemes, and you can define your own in the +<link linkend="config"><guilabel>Configure - &kstars;</guilabel></link> window. +</para></listitem> <listitem> <para> <indexterm><primary>Field-of-View Symbols</primary><secondary>Description</secondary></indexterm> diff --git a/doc/ekos-profile-wizard.docbook b/doc/ekos-profile-wizard.docbook index 34a0a822b..05ca966ba 100644 --- a/doc/ekos-profile-wizard.docbook +++ b/doc/ekos-profile-wizard.docbook @@ -39,17 +39,17 @@ <itemizedlist> <listitem> <para> - <guilabel>Equipment is attached to your PC</guilabel>: Select this option if Ekos is running on your StellarMate (via HDMI or VNC), PC (&Windows;/&Linux;) or &MacOS;. + <guilabel>Equipment is attached to this device</guilabel>: Select this option if Ekos is running on your StellarMate (via HDMI or VNC), device (&Windows;/&Linux;) or &MacOS;. </para> </listitem> <listitem> <para> - <guilabel>Equipment is attached to a remote computer</guilabel>: Select this option if Ekos is running on your PC (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to a remote computer. + <guilabel>Equipment is attached to a remote device</guilabel>: Select this option if Ekos is running on your device (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to a remote computer. </para> </listitem> <listitem> <para> - <guilabel>Equipment is attached to StellarMate</guilabel>: Select this option if Ekos is running on your PC (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to StellarMate. + <guilabel>Equipment is attached to StellarMate</guilabel>: Select this option if Ekos is running on your device (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to StellarMate. </para> </listitem> </itemizedlist> diff --git a/doc/fitsviewer.docbook b/doc/fitsviewer.docbook index 5e6ef4df7..ae6bad51c 100644 --- a/doc/fitsviewer.docbook +++ b/doc/fitsviewer.docbook @@ -8,8 +8,9 @@ <para>The &kstars; FITS Viewer tool is automatically invoked when new images are received from the camera. It is primarily used to view and examine FITS data. It is not designed for editing of FITS Images. -To open a FITS file, select <guimenuitem>Open FITS...</guimenuitem> from the -<guimenu>File</guimenu> menu, or press <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>.</para> +To open a FITS file, select the <menuchoice><guimenu>File</guimenu> +<guimenuitem>Open Image...</guimenuitem></menuchoice> menu item, or press +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>.</para> <screenshot> <screeninfo>The FITS Viewer Tool</screeninfo> diff --git a/doc/indi.docbook b/doc/indi.docbook index e71bfbf0f..f65631399 100644 --- a/doc/indi.docbook +++ b/doc/indi.docbook @@ -330,41 +330,34 @@ menu item. The window is divided into several main categories: General, Device Updates, Display and Server Port: </para> - <itemizedlist> - <listitem><para>General</para> - <itemizedlist> - <listitem><para><guilabel>INDI server:</guilabel> Specify the binary of installed INDI server -in your system. By default, &kstars; uses <quote>/usr/bin/indiserver</quote> binary. - </para></listitem> - <listitem><para><guilabel>INDI drivers directory:</guilabel> Specify the directory where INDI -drivers are located in your system. By default, &kstars; uses <quote>/usr/share/indi</quote> directory. - </para></listitem> - <listitem><para><guilabel>Default FITS directory:</guilabel> Specify the directory where all -captured FITS images will be saved to. If no directory is specified, images will be stored in $HOME. - </para></listitem> - <!-- Telescope port & Video port: - <listitem><para><option>Telescope port:</option> The default telescope port. When you connect to a local or remote telescope service, &kstars; will automatically fill the telescope's device port with the specified default port.</para></listitem> - <listitem><para><option>Video port:</option> The default video port. When you connect to a local or remote video service, &kstars; will automatically fill the webcam's device port with the specified default port.</para></listitem> - --> - </itemizedlist> - </listitem> - <listitem><para>Time & Location Updates</para> +<itemizedlist> + <listitem><para><guilabel>General</guilabel></para> <itemizedlist> - <listitem><para><guilabel>KStars updates all devices</guilabel>: KStars is the master source for time and location settings. All INDI devices time and locations settings are synchronized to KStars settings.</para></listitem> - <listitem><para><guilabel>Mount updates KStars</guilabel>: Mount handset is the master source of time and location settings. KStars time and location settings are synchronized with controller settings.</para></listitem> - <listitem><para><guilabel>GPS updates KStars</guilabel>: GPS driver is the master source of time and location settings. KStars time and location settings are synchronized with GPS settings.</para></listitem> - <listitem><para><guilabel>Time</guilabel>: Synchronize KStars date and time automatically from the update source.</para></listitem> - <listitem><para><guilabel>Location</guilabel>: Synchronize KStars location settings from the update source.</para></listitem> + <listitem><para><guilabel>INDI server:</guilabel> Specify the binary of installed INDI server in your system. By default, &kstars; uses <quote>/usr/bin/indiserver</quote> binary.</para></listitem> + <listitem><para><guilabel>INDI drivers XML directory:</guilabel> Specify the &XML; directory where INDI drivers are located in your system. By default, &kstars; uses <quote>/usr/share/indi</quote> directory.</para></listitem> + <listitem><para><guilabel>Default FITS directory:</guilabel> Specify the directory where all captured FITS images will be saved to. If no directory is specified, images will be stored in <varname>$HOME</varname>.</para></listitem> + <!-- Telescope port & Video port: + <listitem><para><option>Telescope port:</option> The default telescope port. When you connect to a local or remote telescope service, &kstars; will automatically fill the telescope's device port with the specified default port.</para></listitem> + <listitem><para><option>Video port:</option> The default video port. When you connect to a local or remote video service, &kstars; will automatically fill the webcam's device port with the specified default port.</para></listitem> + --> </itemizedlist> - </listitem> - <listitem><para>Display</para> + </listitem> + <listitem><para><guilabel>Time & Location Updates</guilabel></para> <itemizedlist> - <listitem><para><guilabel>Telescope crosshair</guilabel>: When checked, &kstars; displays the telescope's target crosshair on the sky map. The crosshair is displayed upon a successful connection to the telescope and its location is updated periodically. The telescope's name is displayed next to the crosshair. &kstars; displays one crosshair per each connected telescope. To change the color of the telescope's crosshair, open the <link linkend="viewops">Configure - &kstars;</link> window. Select the <guilabel>Colors</guilabel> page, and then change the color of the <guimenuitem>Target Indicator</guimenuitem> item to the desired color.</para></listitem> - <listitem><para><guilabel>INDI messages in status bar</guilabel>: When checked, &kstars; displays INDI status messages in the &kstars; status bar.</para></listitem> - <listitem><para><guilabel>Independent window</guilabel>: Make <guilabel>FITS Viewer</guilabel> window independent.</para></listitem> - <listitem><para><guilabel>Message notifications</guilabel>: Show INDI messages as desktop notifications instead of dialogs.</para></listitem> + <listitem><para><guilabel>KStars updates all devices</guilabel>: KStars is the master source for time and location settings. All INDI devices time and locations settings are synchronized to KStars settings.</para></listitem> + <listitem><para><guilabel>Mount updates KStars</guilabel>: Mount handset is the master source of time and location settings. KStars time and location settings are synchronized with controller settings.</para></listitem> + <listitem><para><guilabel>GPS updates KStars</guilabel>: GPS driver is the master source of time and location settings. KStars time and location settings are synchronized with GPS settings.</para></listitem> + <listitem><para><guilabel>Time</guilabel>: Synchronize KStars date and time automatically from the update source.</para></listitem> + <listitem><para><guilabel>Location</guilabel>: Synchronize KStars location settings from the update source.</para></listitem> </itemizedlist> - </listitem> + </listitem> + <listitem><para><guilabel>Display</guilabel></para> + <itemizedlist> + <listitem><para><guilabel>Telescope crosshair</guilabel>: When checked, &kstars; displays the telescope's target crosshair on the sky map. The crosshair is displayed upon a successful connection to the telescope and its location is updated periodically. The telescope's name is displayed next to the crosshair. &kstars; displays one crosshair per each connected telescope. To change the color of the telescope's crosshair, open the <link linkend="viewops">Configure - &kstars;</link> window. Select the <guilabel>Colors</guilabel> page, and then change the color of the <guimenuitem>Target Indicator</guimenuitem> item to the desired color.</para></listitem> + <listitem><para><guilabel>Independent window</guilabel>: Make <guilabel>FITS Viewer</guilabel> window independent.</para></listitem> + <listitem><para><guilabel>Message notifications</guilabel>: Show INDI messages as desktop notifications instead of dialogs.</para></listitem> + </itemizedlist> + </listitem> <!-- <listitem><para>Update Source: Synchronize &kstars; according to either the computer or device time and location settings.</para> @@ -372,10 +365,12 @@ captured FITS images will be saved to. If no directory is specified, images will <listitem><para>Filter Wheel: Assign color codes to the filter wheel slots (⪚ Slot #0 Red, Slot #1 Blue, &etc;) You can assign color codes for up to 10 filter slots (0 to 9). To assign a color code, select a slot number from the drop down combo box, and then type the corresponding color code in the edit field. Repeat the process for all desired slots and then press OK.</para> </listitem> --> - <listitem><para>Server Port: Specify range of ports that INDI Server - will bind to when starting new drivers.</para> + <listitem><para><guilabel>Server Port</guilabel></para> + <itemizedlist> + <listitem><para>Specify range of ports that INDI Server will bind to when starting new drivers.</para></listitem> + </itemizedlist> </listitem> - </itemizedlist> +</itemizedlist> </sect1> diff --git a/doc/quicktour.docbook b/doc/quicktour.docbook index b93d1cc68..5d2a841c9 100644 --- a/doc/quicktour.docbook +++ b/doc/quicktour.docbook @@ -54,8 +54,8 @@ at any time to exit the Setup Wizard. The second page of the Setup Wizard allows you to choose the starting geographic location, by selecting from the list of the 3400+ known locations on the right side of the window. The list of locations can be -filtered to match the text you enter in the <guilabel>City</guilabel>, -<guilabel>Province</guilabel>, and <guilabel>Country</guilabel> edit +filtered to match the text you enter in the <guilabel>City filter:</guilabel>, +<guilabel>Province filter:</guilabel>, and <guilabel>Country filter:</guilabel> edit boxes. If your desired location is not present in the list, you can select a nearby city instead for now. Later on, you can add your precise location manually using the <link linkend="setgeo">Set Geographic @@ -66,7 +66,7 @@ the <guilabel>Next</guilabel> button. <para> The last page of the Setup Wizard allows you to download extra data that are not included with the standard distribution of &kstars;. -Simply press the <guilabel>Download Extra Data</guilabel> button to open +Simply press the <guilabel>Download Extra Data...</guilabel> button to open the <guilabel>Get New Stuff</guilabel> tool. When you are all done, press the <guilabel>OK</guilabel> button in the Setup Wizard to start exploring &kstars;. @@ -232,8 +232,8 @@ about the selected object. If you know of an additional &URL; with information or an image of the object, you can add a custom link to the object's popup menu. Use the <guimenuitem>Details</guimenuitem> item in the popup menu to open the <guilabel>Object Details</guilabel> dialog. -On the <guilabel>Link</guilabel> tab use the <guimenuitem>Add Link...</guimenuitem> -item. +On the <guilabel>Links</guilabel> tab use the <guibutton>Add Link...</guibutton> +button. </para> </sect2> @@ -282,7 +282,7 @@ connection. Thus, if you want to find an object that &kstars; is not aware of, you can easily do this by querying several professional astronomical databases as: SIMBAD, NED or VizieR. This can be done by entering the object's name and then press the <guibutton>or search the -internet for ObjectName</guibutton> button. After your object is found, +internet for <replaceable>ObjectName</replaceable></guibutton> button. After your object is found, you can use it exactly as any object that is already loaded into &kstars; (&ie; adding it to the Observing WishList). If the object was not found in the online databases, then a warning dialogue will pop-up. Once you
