Git commit 16d0f262531f5c369f25b61adaaf94406dce6409 by Jasem Mutlaq. Committed on 16/07/2016 at 13:36. Pushed by mutlaqja into branch 'master'.
XML and factual fixes M +81 -99 doc/config.docbook http://commits.kde.org/kstars/16d0f262531f5c369f25b61adaaf94406dce6409 diff --git a/doc/config.docbook b/doc/config.docbook index 0e74d84..9c1939c 100644 --- a/doc/config.docbook +++ b/doc/config.docbook @@ -99,7 +99,7 @@ You can set the time and date by selecting <guimenuitem>Set Time...</guimenuitem> from the <guimenu>Time</guimenu> menu, or by pressing the <guiicon>time</guiicon> icon in the toolbar. The <guilabel>Set Time</guilabel> window uses a standard &kde; Date Picker -widget, coupled with a spinbox for setting the hours and minutes. +widget, coupled with a spinbox for setting the hours and minutes. If you want to re-synchronize the simulation clock back to the current CPU time, just select <guimenuitem>Set Time to Now</guimenuitem> from the <guimenu>Time</guimenu> menu.</para> @@ -143,7 +143,7 @@ The window is depicted below: <para> The <guilabel>Configure &kstars;</guilabel> window is divided into nine pages: <guilabel>Catalogs</guilabel>, <guilabel>Solar System</guilabel>, <guilabel>Satellites</guilabel>, -<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Colors</guilabel>, +<guilabel>Supernovae</guilabel>, <guilabel>Guides</guilabel>, <guilabel>Colors</guilabel>, <guilabel>INDI</guilabel>, <guilabel>Ekos</guilabel> and <guilabel>Advanced</guilabel>. </para> @@ -191,11 +191,11 @@ The <guilabel>Colors</guilabel> page allows you to set the color scheme, and to define new custom color schemes. </para> -<para>For detailed explanation of the options on the <guilabel>INDI</guilabel> +<para>For detailed explanation of the options on the <guilabel>INDI</guilabel> page see the <link linkend="indi-configure">Configure INDI</link> section. </para> -<para>For detailed explanation of <guilabel>Ekos</guilabel> astrophotography suite, +<para>For detailed explanation of <guilabel>Ekos</guilabel> astrophotography suite, see the official <ulink url="http://www.indilib.org/about/ekos.html";>Ekos</ulink> page. </para> @@ -226,30 +226,30 @@ over the more subtle behaviors of &kstars;. <para> <indexterm><primary>Catalogs page</primary> <secondary>Short overview</secondary></indexterm> -In the <guilabel>Catalogs</guilabel> page, you can configure which object catalogs are -displayed by &kstars;, as well as how much information you would like to be included on -the Sky Map. By default, &kstars; comes with three pre-installed catalogues: -Index Catalog (<quote>IC</quote>), New General Catalog (<quote>NGC</quote>) and Messier Catalog. +In the <guilabel>Catalogs</guilabel> page, you can configure which object catalogs are +displayed by &kstars;, as well as how much information you would like to be included on +the Sky Map. By default, &kstars; includes ~300,000 named and unnamed stars up to magnitude 8. For Deep Sky Objects, +the included catalogs are New General Catalog (<quote>NGC</quote>), Index Catalog (<quote>IC</quote>), and Messier Catalog. </para> <para> -Index Catalogue of Nebulae and Clusters of Stars (abbreviated as IC) serves as a supplement to the -NGC, and contains an additional 5,386 objects, collectively known as the IC objects. +New General Catalogue of Nebulae and Clusters of Stars (abbreviated as NGC) is a catalogue of 7,840 +deep-sky objects. </para> <para> -New General Catalogue of Nebulae and Clusters of Stars (abbreviated as NGC) is a catalogue of 7,840 -deep-sky objects. +Index Catalogue of Nebulae and Clusters of Stars (abbreviated as IC) serves as a supplement to the +NGC, and contains an additional 5,386 objects, collectively known as the IC objects. </para> <para> -Messier Catalogue is a catalogue of 110 deep-sky objects, including diffuse nebulae, planetary nebulae, -open clusters, globular clusters and galaxies. Messier objects have names like M1, M2, up to M110. The -maximum apparent visual magnitude of Messier Catalogue is represented by M91's value of 10,2. +Messier Catalogue is a catalogue of 110 deep-sky objects, including diffuse nebulae, planetary nebulae, +open clusters, globular clusters and galaxies. Messier objects have names like M1, M2, up to M110. The +maximum apparent visual magnitude of Messier Catalogue is represented by M91's value of 10.2. </para> <para> -You can install new catalogues using &kstars; <quote>Add-On Installer</quote>. You can open it by opening +You can install new catalogues using &kstars; <quote>Add-On Installer</quote>. You can open it by opening the <menuchoice><guimenu>Data</guimenu><guimenuitem>Download New Data...</guimenuitem></menuchoice> submenu. You can choose from a list of catalogues, including: <itemizedlist> @@ -259,8 +259,8 @@ Steinicke NGC/IC Catalog: is a more complete NGC/IC catalog. </para></listitem> <listitem><para> -Abell Planetary Nebulae Catalog: is a catalog of 86 planetary nebulae. The -maximum magnitude is represented by Abell 47's value of 19,5. +Abell Planetary Nebulae Catalog: is a catalog of 86 planetary nebulae. The +maximum magnitude is represented by Abell 47's value of 19.5. </para></listitem> <listitem><para> @@ -272,12 +272,12 @@ Hickson Compact Groups: is a catalog consisting of 99 compact groups of galaxies </para></listitem> <listitem><para> -Tycho-2 Star Catalog: is a catalog of more than 2,5 million of the brightest stars. It contains -stars with a magnitude value from 8,0 to 12,5. +Tycho-2 Star Catalog: is a catalog of more than 2.5 million of the brightest stars. It contains +stars with a magnitude value from 8.0 to 12.5. </para></listitem> <listitem><para> -USNO NOMAD Catalog: is a catalog of about 100 million stars with magnitude from 12,5 to 16,5. +USNO NOMAD Catalog: is a catalog of about 100 million stars with magnitude from 12.5 to 16.5. Note that is requires Tycho-2 to be installed. </para></listitem> @@ -285,7 +285,7 @@ Note that is requires Tycho-2 to be installed. </para> <para> -To summarize, you can read the following table: +The following is a summary of catalogs in KStars: <table frame="top"><title>Stars Catalogues</title> <tgroup cols="4" colsep="1" rowsep="1"> @@ -303,13 +303,13 @@ To summarize, you can read the following table: <row> <entry>Default Catalog</entry> <entry>Default</entry> -<entry>126,000</entry> +<entry>~300,000</entry> <entry>Up to 8 magnitude</entry> <entry>No</entry> <entry>Yes</entry> </row> <row> -<entry>Tycho-2 Star</entry> +<entry>Tycho-2</entry> <entry>Tycho2</entry> <entry>more than 2.5 million</entry> <entry>8.0-12.5 </entry> @@ -409,29 +409,26 @@ To summarize, you can read the following table: <para> <indexterm><primary>Catalogs</primary> <secondary>Star Catalogs</secondary></indexterm> -The <guilabel>Stars</guilabel> section allows you to manage how stars are -displayed in &kstars;. You can choose to see the stars or not by checking the -<guilabel>Star Catalogs</guilabel> checkbox. If you check it, then multiple -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 show or not stars' name and stars' <link linkend="ai-magnitude">magnitude</link>. -By default, stars' label name and stars' magnitude are drawn next to the stars, with a dark -green color. You can change this default color using the <guilabel>Colors</guilabel> tab. -If stars' labels occupy too much space in the Sky Map, you can change their density using -the <guilabel>Label density</guilabel> slider. +The <guilabel>Stars</guilabel> section allows you to manage how stars are +displayed in &kstars;. You can choose to see the stars or not by checking the +<guilabel>Star Catalogs</guilabel> checkbox. If you check it, then multiple +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, increase the <guilabel>Label density</guilabel> slider. </para> <para> <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. As for the stars, you can choose to see or -not the deep-sky objects. You may also configure &kstars; to display their names and magnitude -values. By default, the list of deep-sky objects 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. -Firstly, you need to prepare the object catalog data file. Each line in the file should contain -the following space-separated fields: +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 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 <guilabel>Load Catalog</guilabel> button. + +Each line in the custom catalog file should contain the following space-separated fields: </para> <para>For stars: type(0 for stars), RA, Dec, mag, SpType, name(optional)</para> @@ -453,16 +450,16 @@ the following space-separated fields: </itemizedlist> <para> -The SpType is a short string for the spectral type. For example, <quote>B5</quote> -or <quote>G2</quote>. The coordinates should be given as floating-point values, in -the J2000.0 epoch. The name can be anything you wish. If the name is more than one +The SpType is a short string for the spectral type. For example, <quote>B5</quote> +or <quote>G2</quote>. The coordinates should be given as floating-point values, in +the J2000.0 epoch. The name can be anything you wish. If the name is more than one word, it must be enclosed in quotation marks. </para> <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 you can +to the <guilabel>Catalogs</guilabel> tab, and press the +<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> @@ -478,14 +475,14 @@ specify a name for the catalog, and the name of the file (including the path): </screenshot> <para> -When you press <guibutton>Ok</guibutton> button, &kstars; will attempt to read the lines -of your data file. It will report any problems, and if any lines at all were successfully +When you press <guibutton>Ok</guibutton> button, &kstars; will attempt to read the lines +of your data file. It will report any problems, and if any lines at all were successfully parsed, you are given a choice to accept the data file (ignoring any unparsed lines), or to cancel the operation to attempt to resolve the problems first. </para> <para> -You can load a new catalog using the <guibutton>Load Catalog...</guibutton> button. +You can load a new catalog using the <guibutton>Load Catalog...</guibutton> button. A new window will appear, asking you to specify the file that contains the catalog. </para> <screenshot> @@ -501,8 +498,8 @@ A new window will appear, asking you to specify the file that contains the catal </screenshot> <para> -Once the data file has been accepted, your custom catalog will be loaded on -startup along with the standard catalogs. In the <guilabel>Catalogs</guilabel> window +Once the data file has been accepted, your custom catalog will be loaded on +startup along with the standard catalogs. In the <guilabel>Catalogs</guilabel> window is a checkbox for each catalog which toggles the display of catalog objects. </para> <screenshot> @@ -533,8 +530,8 @@ Note that, if you want to load a catalog that is already loaded, a warning dialo </screenshot> <para> -You can remove custom catalogs by highlighting its checkbox in the -<guilabel>Catalogs</guilabel> window, and pressing the +You can remove custom catalogs by highlighting its checkbox in the +<guilabel>Catalogs</guilabel> window, and pressing the <guibutton>Remove Catalog...</guibutton> button (this button is only active if a custom catalog is highlighted in the list of checkboxes). Note that it can not be used for removing &kstars; default catalogs. @@ -566,7 +563,8 @@ of checkboxes). Note that it can not be used for removing &kstars; default catal # Flux Frequency: 1420 Mhz # Flux Unit: mJy # ID RA Dc Tp Mj Mn PA Nm Flux -J0001 12:31:23.1 +11:29:34 18 180.60 360.30 45 my_radio_source 70</programlisting> +J0001 12:31:23.1 +11:29:34 18 180.60 360.30 45 my_radio_source 70 +</programlisting> <para> Using the <guilabel>Catalogs</guilabel> window, you can define faint limits for sky objects for zoomed in and zoomed out states of the rendering. When @@ -577,7 +575,6 @@ magnitudes are unknown, or not available to &kstars;, are drawn irrespective of <sect1 id="solar_system"> <title>Solar System</title> -<para> <screenshot> <screeninfo>Solar System Window</screeninfo> <mediaobject> @@ -602,12 +599,10 @@ trail</quote> whenever a solar system body is tracked, and another to toggle whether the color of the orbit trail fades into the background sky color. </para> -</para> </sect1> <sect1 id="satellites"> <title>Satellites</title> -<para> <screenshot> <screeninfo>Satellites Window</screeninfo> <mediaobject> @@ -622,38 +617,36 @@ sky color. <para> <indexterm><primary>Configure &kstars; window</primary> <secondary>Satellites page</secondary></indexterm> -The <guilabel>Satellites</guilabel> page allows you to set the satellites view options. Firstly, +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 -light red filled circles with an optional dark red name label next to them. You can enable or disable +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 colors of the dots representing satellites and their name labels can be easily customized using +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. -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 +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 -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 +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. -The satellites orbital elements can be updated via the internet by pressing the <guibutton>Update TLEs</guibutton> +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> <guisubmenu>Updates</guisubmenu><guimenuitem>Update satellites orbital elements</guimenuitem></menuchoice> in the -<guimenu>Data</guimenu> menu. 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 +<guimenu>Data</guimenu> menu. 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. 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. +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>. </para> -</para> </sect1> <sect1 id="supernovae"> <title>Supernovae</title> -<para> <screenshot> <screeninfo>Supernovae Window</screeninfo> <mediaobject> @@ -668,25 +661,23 @@ For example: <userinput>Iridium;iridium.tle;http://celestrak.com/NORAD/elements/ <para> <indexterm><primary>Configure &kstars; window</primary> <secondary>Supernovae page</secondary></indexterm> -The <guilabel>Supernovae</guilabel> page allows you to decide if the supernovae are displayed or not by checking -the <guilabel>Show supernovae</guilabel> checkbox. By default, supernovae are drawn as small light orange <quote>+</quote> mark. -As for satellites, the color of supernovae can be easily customized using the <guilabel>Colors</guilabel> page. -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, +The <guilabel>Supernovae</guilabel> page allows you to decide if the supernovae are displayed or not by checking +the <guilabel>Show supernovae</guilabel> checkbox. By default, supernovae are drawn as small light orange <quote>+</quote> mark. +As for satellites, the color of supernovae can be easily customized using the <guilabel>Colors</guilabel> page. +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. -The list of recent supernovae can be updated via the internet by pressing the <guibutton>Update List of Recent +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 Supernovae</guibutton> button. Another way for updating the supernovae list is to use the <menuchoice><guisubmenu>Updates</guisubmenu><guimenuitem>Update Recent Supernovae data</guimenuitem></menuchoice> item in the <guimenu>Data</guimenu> menu. </para> -</para> </sect1> <sect1 id="guides"> <title>Guides</title> -<para> <screenshot> <screeninfo>Guides Window</screeninfo> <mediaobject> @@ -710,12 +701,10 @@ You can also choose whether you would like to see Latin constellation names, <acronym>IAU</acronym>-standard three-letter abbreviations, or constellation names using your local language. </para> -</para> </sect1> <sect1 id="colors"> <title>Colors</title> -<para> <screenshot> <screeninfo>Colors Window</screeninfo> <mediaobject> @@ -760,12 +749,10 @@ 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. </para> -</para> </sect1> <sect1 id="indi_tab"> <title>INDI</title> -<para> <screenshot> <screeninfo>INDI Window</screeninfo> <mediaobject> @@ -777,15 +764,13 @@ Scheme</guibutton> button. </textobject> </mediaobject> </screenshot> -<para>For detailed explanation of the options on the <guilabel>INDI</guilabel> +<para>For detailed explanation of the options on the <guilabel>INDI</guilabel> page see the <link linkend="indi-configure">Configure INDI</link> section. </para> -</para> </sect1> <sect1 id="ekos"> <title>Ekos</title> -<para> <screenshot> <screeninfo>Ekos Window</screeninfo> <mediaobject> @@ -798,19 +783,17 @@ page see the <link linkend="indi-configure">Configure INDI</link> section. </mediaobject> </screenshot> <para> -Ekos is an astrophotography suite, a complete astrophotography solution that can control -all INDI devices including numerous telescopes, CCDs, DSLRs, focusers, filters, and a lot more. -Ekos supports highly accurate tracking using online and offline astrometry solver, autofocus -and autoguiding capabilities, and capture of single or multiple images using the powerful -built in sequence manager. For detailed explanation of <guilabel>Ekos</guilabel>, +Ekos is an astrophotography suite, a complete astrophotography solution that can control +all INDI devices including numerous telescopes, CCDs, DSLRs, focusers, filters, and a lot more. +Ekos supports highly accurate tracking using online and offline astrometry solver, autofocus +and autoguiding capabilities, and capture of single or multiple images using the powerful +built in sequence manager. For detailed explanation of <guilabel>Ekos</guilabel>, see the official <ulink url="http://www.indilib.org/about/ekos.html";>Ekos</ulink> page. </para> -</para> </sect1> <sect1 id="advanced"> <title>Advanced</title> -<para> <screenshot> <screeninfo>Advanced Window</screeninfo> <mediaobject> @@ -875,7 +858,6 @@ 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. </para> -</para> </sect1> <sect1 id="customize"> _______________________________________________ kde-doc-english mailing list [email protected] https://mail.kde.org/mailman/listinfo/kde-doc-english
