summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurkhard Lück <[email protected]>2016-07-09 14:23:31 +0200
committerBurkhard Lück <[email protected]>2016-07-09 14:23:31 +0200
commit22fef4da19294a3d60c4ba6ff0e46e6e921a6c40 (patch)
tree7f159a75b67b83349926cd2a748e18982151e64a
parent65ee6df5182d5cfd235bec906c01afe7d3dc923b (diff)
Fix markup in updated kstars docbooks
improve markup remove recently added ellipses (...) in <gui*> markup, has a meaning only in the GUI use entites (&kstars; &ie;) use preferred words (Internet) partly already committed by yurchor with http://commits.kde.org/kstars/c9cfaf90e2f6ece1eed97627e90a235ba7a5dcb9 REVIEW:128407
-rw-r--r--doc/commands.docbook67
-rw-r--r--doc/config.docbook20
2 files changed, 28 insertions, 59 deletions
diff --git a/doc/commands.docbook b/doc/commands.docbook
index 41f491f..1717028 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -664,7 +664,7 @@ dialog to download additional data for &kstars;.
<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 data from internet. The data will be downloaded for the current user account only.
+elements as well as recent supernovae data from 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 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 of &kstars; Settings window.</para>
@@ -696,7 +696,7 @@ tool</para></listitem>
<keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo>
</shortcut>
<guimenu>Observation</guimenu>
-<guimenuitem>Execute the session Plan...</guimenuitem>
+<guimenuitem>Execute the session Plan</guimenuitem>
</menuchoice></term>
<listitem><para>Opens <link linkend="tool-obsplanner">session plan wizard</link> or execute the planned session.</para></listitem>
</varlistentry>
@@ -760,14 +760,14 @@ the left-click mouse button and dragging it to the new position.
<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 (i.e. Zoom in and Zoom out) and for controlling KStars clock as well.
+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.
+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 <guilabel>Settings -> Configure Toolbars...</guilabel> submenu.
+Main Toolbar can be configured using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -777,12 +777,12 @@ Main Toolbar can be configured using <guilabel>Settings -> Configure Toolbars...
<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
+<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 <guilabel>Settings -> Configure Toolbars...</guilabel> submenu.
+View Toolbar can be configured using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -795,18 +795,7 @@ View Toolbar can be configured using <guilabel>Settings -> Configure Toolbars...
<listitem><para>Toggle display of the INDI Toolbar. By default, INDI Toolbar contains three shortcut icons:
<guilabel>Toggle Ekos</guilabel>, <guilabel>Toggle INDI Control Panel</guilabel> and
<guilabel>Toggle FITS Viewer</guilabel>.
-INDI Toolbar can be configured using <guilabel>Settings -> Configure Toolbars...</guilabel> submenu.
-</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.
+INDI Toolbar can be configured using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice>.
</para></listitem>
</varlistentry>
@@ -872,12 +861,12 @@ the symbols list. You can also define your own symbols (or modify existing symbo
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
-<guisubmenu>Artificial Horizon...</guisubmenu>
+<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 (i.e. tall trees or building). The window is split in two sections: in the left side is
+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
<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
@@ -891,13 +880,13 @@ If you want to modify a point's coordinates, just double click on its Az/Alt tex
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: "Region " plus an index (i.e. "Region 1" or "Region 2"). For renaming a region, all you need
+named as: <quote>Region </quote> plus an index (&ie; <quote>Region 1</quote> or <quote>Region 2</quote>). For renaming a region, all you need
to do is to 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.
+next time when you will open &kstars; they will be automatically marked on the skymap.
</para></listitem>
</varlistentry>
@@ -908,7 +897,7 @@ next time when you will open KStars they will be automatically marked on the sky
</shortcut>
<guimenu>Settings</guimenu>
<guisubmenu>Configure Observation Logging</guisubmenu>
-<guimenuitem>List your Equipment...</guimenuitem>
+<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>,
@@ -925,13 +914,13 @@ button. You can also save or remove an equipment from the list.
</shortcut>
<guimenu>Settings</guimenu>
<guisubmenu>Configure Observation Logging</guisubmenu>
-<guimenuitem>Manage Observer...</guimenuitem>
+<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
+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
+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>
@@ -956,26 +945,6 @@ location</link>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
-<guimenuitem>Configure Shortcuts...</guimenuitem>
-</menuchoice></term>
-<listitem><para>
-TODO
-</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure Toolbars...</guimenuitem>
-</menuchoice></term>
-<listitem><para>
-TODO
-</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
<guimenuitem>Configure &kstars;...</guimenuitem>
</menuchoice></term>
<listitem><para>Modify <link linkend="config">configuration
@@ -985,7 +954,7 @@ options</link></para></listitem>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
-<guimenuitem>Startup Wizard...</guimenuitem>
+<guimenuitem>Startup Wizard</guimenuitem>
</menuchoice></term>
<listitem><para>
TODO
@@ -1086,7 +1055,7 @@ Print XPlanet view
<term>[All]</term>
<listitem><para>
<guimenuitem>Show ... Image</guimenuitem>: download an image of the
-object from the internet, and display it in the Image Viewer tool.
+object from the Internet, and display it in the Image Viewer tool.
The "..." text is replaced by a short description of the image's
source. An object may have multiple image links available in its
popup menu.
diff --git a/doc/config.docbook b/doc/config.docbook
index 57c2b16..031b973 100644
--- a/doc/config.docbook
+++ b/doc/config.docbook
@@ -34,10 +34,10 @@ in the map.
It is not practical to scroll through the full list of 3400 locations,
looking for a specific city. To make searches easier, the list can be
filtered by entering text in the boxes below the map. For example, in
-the screenshot, the text <quote>A</quote> appears in the
-<guilabel>City Filter</guilabel> box, while <quote>Te</quote> has been
+the screenshot, the text <userinput>A</userinput> appears in the
+<guilabel>City Filter</guilabel> box, while <userinput>Te</userinput> has been
entered in the <guilabel>Province Filter</guilabel> box, and
-<quote>USA</quote> is in the <guilabel>Country Filter</guilabel>
+<userinput>USA</userinput> is in the <guilabel>Country Filter</guilabel>
box. Note that all of the cities displayed in the list have city,
province, and country names that begin with the entered filter
strings, and that the message below the filter boxes indicates that 6
@@ -66,8 +66,8 @@ the new location. Note that all fields except the optional
location can be added to the list. &kstars; will automatically load
your custom locations for all future sessions. Please note, at this
point, the only way to remove a custom location is to remove the
-appropriate line from the file
-<filename>~/.kde/share/apps/kstars/mycities.dat</filename>.
+appropriate line from the file <filename>kstars/mycities.dat</filename>
+in your folder <userinput><command>qtpaths</command> <option>--paths GenericDataLocation</option></userinput>.
</para><para>
If you add custom locations (or modify existing ones), please send us
your <filename>mycities.dat</filename> file so that we can add your
@@ -160,7 +160,7 @@ displaying the names and/or magnitudes of stars. Below the stars section,
the <guilabel>Deep-Sky Objects</guilabel> section controls the display of
several non-stellar object catalogs. By default, the list includes the
Messier, NGC and IC catalogs. You can add your own custom object catalogs
-by pressing the <guibutton>Import Catalog...</guibutton> or <guilabel>Load Catalog...</guilabel> button. For
+by pressing the <guibutton>Import Catalog</guibutton> or <guilabel>Load Catalog</guilabel> button. For
detailed instructions on preparing a catalog data file, see the
<filename>README.customize</filename> file that ships with &kstars;. It is possible to define
faint limits for sky objects for zoomed in and zoomed out states of the rendering. When
@@ -192,11 +192,11 @@ light red filled circles with an optional dark red name label next to them. You
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 colors of the dots representing satellites and their name labels can be easily customized using
-the <guilabel>Colors</guilabel> page from the same <guilabel>Configure &kstars;...</guilabel> window.
+the <guilabel>Colors</guilabel> page from the same <guilabel>Configure &kstars;</guilabel> window.
In addition, satellites can be drawn just like regular stars by checking the <guilabel>Draw satellites
like stars</guilabel> checkbox. To display only the visible satellites from your current geographic location
and time, select <guilabel>Show only visible satellites</guilabel>.
-&kstars; can draw artificial satellites from many predefined groups. Thus, you can select to display a particular
+&kstars; can draw artificial satellites from many predefined groups. Thus, you can select to display a particular
group, multiple groups or partially select subgroups. Under each group, a list of individual satellites is
presented. To select all satellites from a group, you need to check the group checkbox. You can also select
only the satellites of interest in each group.
@@ -221,7 +221,7 @@ As for satellites, the color of supernovae can be easily customized using the <g
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
+&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.
The list of recent supernovae can be updated via the internet by pressing the <guibutton>Update List of Recent
@@ -268,7 +268,7 @@ 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 Current Colors</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