moved kdeaccessibility kdeaddons kdeadmin kdeartwork kdebindings kdeedu kdegames...
[kdeedu.git] / doc / kstars / quicktour.docbook
blob551eedb6b0505936bd02c14c2099d00b237172e1
1 <chapter id="using-kstars">
2 <title>A Quick Tour of &kstars;</title>
4 <para>
5 This chapter presents a guided tour of &kstars;, introducing
6 many of its important features.
7 </para>
9 <screenshot>
10 <screeninfo>
11 Here is a screenshot of the &kstars; main window:
12 </screeninfo>
13 <mediaobject>
14   <imageobject>
15     <imagedata fileref="screen1.png" format="PNG"/>
16   </imageobject>
17   <textobject>
18     <phrase>Main Window</phrase>
19   </textobject>
20 </mediaobject>
21 </screenshot>
23 <para>
24 The above screenshot shows a typical view of the KStars program.  You
25 can see the sky display centered on Betelgeuse, the brightest star in
26 the constellation Orion.  Orion has just risen above the eastern horizon.
27 Stars are displayed with <link linkend="ai-colorandtemp">realistic
28 colors</link> and relative brightnesses.  If you look closely, you can 
29 also see the Moon near the left edge of the window.  In three corners 
30 of the sky display, there are on-screen text labels displaying data on 
31 the current time (<quote>LT: 16:41:39 22 Jan 2005</quote>), the current 
32 Geographic Location (<quote>Tucson, Arizona, USA</quote>), and the 
33 current object in the center of the display (<quote>Focused on: Betelgeuse 
34 (alpha Orionis)</quote>).  Above the sky display, there are two toolbars.  
35 The main toolbar contains shortcuts for
36 <link linkend="kstars-menus">menu functions</link>, as well as a
37 time-step widget which controls how fast the simulation clock runs.
38 The view toolbar contains buttons that toggle the display of different
39 kinds of objects in the sky.  At the bottom of the window, there is a
40 status bar which displays the name of any object you click on, and the
41 <link linkend="ai-skycoords">sky coordinates</link> (both
42 Right Ascension/Declination and Azimuth/Altitude) of the mouse cursor.
43 </para>
45 <sect1 id="startwizard">
46 <title>The Setup Wizard</title>
47 <para>
48 <indexterm><primary>Setup Wizard</primary></indexterm>
49 The first time you run KStars, you will be presented with a Setup Wizard,
50 which allows you to easily set your geographic location and download some
51 extra data files.  You can press the <guilabel>Finish</guilabel> button
52 at any time to exit the Setup Wizard.
53 </para>
55 <para>
56 The first page of the Setup Wizard allows you to choose the starting
57 geographic location, by selecting from the list of the 2500+ known
58 locations on the right side of the window.  The list of locations can be
59 filtered to match the text you enter in the <guilabel>City</guilabel>,
60 <guilabel>Province</guilabel>, and <guilabel>Country</guilabel> edit
61 boxes.  If your desired location is not present in the list, you can
62 select a nearby city instead for now.  Later on, you can add your
63 precise location manually using the <link linkend="setgeo">Set Geographic
64 Location tool</link>.  Once you have selected a starting location, press
65 the <guilabel>Next</guilabel> button.
66 </para>
68 <para>
69 The second page of the Setup Wizard allows you to download extra data
70 that are not included with the standard distribution of &kstars;.
71 Simply press the <guilabel>Download Extra Data</guilabel> button to open
72 the <guilabel>Get New Stuff</guilabel> tool.  When you are all done,
73 press the <guilabel>Finish</guilabel> button in the Setup Wizard to
74 start exploring &kstars;.
75 </para>
77 <note>
78 <para>
79 The Download Extra Data tool is only available if you have KDE 3.3.x
80 installed.
81 </para>
82 </note>
83 </sect1>
85 <sect1 id="lookaround">
86 <title>Have a Look Around</title>
87 <para>
88 <indexterm><primary>Navigation Controls</primary>
89 <secondary>Basics</secondary></indexterm>
90 Now that we have the time and location set, let us have a look around.
91 You can pan the display using the arrow keys.  If you hold down the
92 &Shift; key before panning, the scrolling speed is increased.  The
93 display can also be panned by clicking and dragging with the mouse.
94 Note that while the display is scrolling, not all objects are
95 displayed.  This is done to cut down on the <acronym>CPU</acronym> load
96 of recomputing object positions, which makes the scrolling smoother
97 (you can configure what gets hidden while scrolling in the <link
98 linkend="config">Configure &kstars;</link> window).
100 There are seven ways to change the magnification (or
101 <firstterm>Zoom level</firstterm>) of the display:</para>
103 <orderedlist>
104 <listitem>
105         <para>Use the <keycap>+</keycap> and
106         <keycap>-</keycap> keys</para>
107 </listitem>
108 <listitem>
109         <para>Press the Zoom In/Zoom Out buttons in the toolbar</para>
110 </listitem>
111 <listitem>
112         <para>Select
113         <guimenuitem>Zoom In</guimenuitem>/<guimenuitem>Zoom Out</guimenuitem>
114         from the <guimenu>View</guimenu> menu</para>
115 </listitem>
116 <listitem>
117         <para>Select <guimenuitem>Zoom to Angular Size...</guimenuitem> from
118         the <guimenu>View</guimenu> menu.  This allows you to specify the
119         the field-of-view angle for the display, in degrees.</para>
120 </listitem>
121 <listitem>
122         <para>Use the scroll wheel on your mouse</para>
123 </listitem>
124 <listitem>
125         <para>Drag the mouse up and down with the &MMB; pressed.</para>
126 </listitem>
127 <listitem>
128         <para>Hold down &Ctrl; while dragging the mouse.  This
129         will allow you to define a rectangle in the map.  When you release the mouse
130         button, the display will zoom to match the rectangle.</para>
131 </listitem>
132 </orderedlist>
134 <para>Notice that as you zoom in, you can see fainter stars than at
135 lower zoom settings.</para>
137 <para>
138 Zoom out until you can see a green curve; this represents your local
139 <link linkend="ai-horizon">horizon</link>.  If you have not adjusted
140 the default &kstars; configuration, the display will be solid green
141 below the horizon, representing the solid ground of the Earth.  There
142 is also a white curve, which represents the <link
143 linkend="ai-cequator">celestial equator</link>, and a tan curve, which
144 represents the <link linkend="ai-ecliptic">Ecliptic</link>, the path
145 that the Sun appears to follow across the sky over the course of a
146 year.  The Sun is always found somewhere along the Ecliptic, and the
147 planets are never far from it.
148 </para>
149 </sect1>
151 <sect1 id="skyobjects">
152 <title>Objects in the Sky</title>
153 <para>
154 <indexterm><primary>Objects in the Sky</primary>
155 <secondary>Overview</secondary></indexterm>
156 &kstars; displays thousands of celestial objects: stars, planets,
157 comets, asteroids, clusters, nebulae and galaxies.  You can interact
158 with displayed objects to perform actions on them or obtain more
159 information about them.  Clicking on an object will identify it in the
160 status bar, and simply hovering the mouse cursor on an object will label
161 it temporarily in the map.  Double-clicking will recenter the display on
162 the object and begin tracking it (so that it will remain centered as
163 time passes).  <mousebutton>Right</mousebutton> clicking an object opens
164 the object's popup menu, which provides more options.
165 </para>
167 <sect2 id="popupquick">
168 <title>The Popup Menu</title>
169 <indexterm><primary>Popup Menu</primary><secondary>Example</secondary></indexterm>
171 <para>
172 Here is an example of the <mousebutton>right</mousebutton> click popup
173 menu, for the Orion Nebula:
174 </para>
176 <screenshot>
177 <screeninfo>Popup Menu for M 42</screeninfo>
178 <mediaobject>
179   <imageobject>
180     <imagedata fileref="popup.png" format="PNG"/>
181   </imageobject>
182   <textobject>
183     <phrase>Popup Menu for M 42</phrase>
184   </textobject>
185 </mediaobject>
186 </screenshot>
188 <para>
189 The appearance of the popup menu depends somewhat on the kind of
190 object you <mousebutton>right</mousebutton>-click on, but the basic
191 structure is listed below.  You can get
192 <link linkend="popup-menu">more detailed information about the popup
193 menu</link>.
194 </para>
196 <para>
197 The top section contains information labels (which are not selectable).
198 The top one to three labels display the object's name(s) and object
199 type.  The next three labels show the object's rise, transit, and
200 set times.  If the rise and set times say "circumpolar", it means that
201 the object is always above the horizon for the present location.
202 </para>
203 <para>
204 The middle section contains items for performing actions on the 
205 object, such as <guimenuitem>Center and Track</guimenuitem>,  
206 <guimenuitem>Details...</guimenuitem>, and 
207 <guimenuitem>Attach Label</guimenuitem>.  See the <link 
208 linkend="popup-menu">popup menu description</link> for a full list 
209 and description of each action.
210 </para>
211 <para>
212 <indexterm><primary>Objects in the Sky</primary>
213 <secondary>Internet Links</secondary>
214 <seealso>Popup Menu</seealso></indexterm>
215 The bottom section contains links to images and/or informative webpages
216 about the selected object.  If you know of an additional &URL; with
217 information or an image of the object, you can add a custom link to the
218 object's popup menu using the <guimenuitem>Add Link...</guimenuitem>
219 item.
220 </para>
221 </sect2>
223 <sect2 id="findobjects">
224 <title>Finding Objects</title>
225 <indexterm><primary>Find Object Tool</primary></indexterm>
226 <indexterm><primary>Objects in the Sky</primary>
227 <secondary>Finding by Name</secondary></indexterm>
228 <para>
229 You can search for named objects using the <guilabel>Find
230 Object</guilabel> tool, which can be opened by clicking on the
231 <guiicon>search</guiicon> icon in the toolbar, by selecting
232 <guimenuitem>Find Object...</guimenuitem> from the
233 <guimenu>Pointing</guimenu> menu, or by pressing
234 <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>.
235 The <guilabel>Find Object</guilabel> window is shown below:
237 <screenshot>
238 <screeninfo>Find Object Window</screeninfo>
239 <mediaobject>
240   <imageobject>
241     <imagedata fileref="find.png" format="PNG"/>
242   </imageobject>
243   <textobject>
244     <phrase>Find Object Window</phrase>
245   </textobject>
246 </mediaobject>
247 </screenshot>
248 </para>
250 <para>
251 The window contains a list of all the named objects that &kstars; is
252 aware of.  Many of the objects only have a numeric catalog name (for
253 example, NGC 3077), but some objects have a common name as well (for
254 example, Whirlpool Galaxy).  You can filter the list by name and
255 by object type.  To filter by name, enter a string in the edit box
256 at the top of the window; the list will then only contain names
257 which start with that string.  To filter by type, select a type
258 from the combo box at the bottom of the window.
259 </para><para>
260 To center the display on an object, highlight the desired object in
261 the list, and press <guibutton>Ok</guibutton>.  Note that if the
262 object is below the horizon, the program will warn you that you may
263 not see anything except the ground (you can make the ground invisible
264 in the <guilabel>Display Options</guilabel> window, or by pressing the
265 <guiicon>Ground</guiicon> button in the View toolbar).
266 </para>
267 </sect2>
269 <sect2 id="centertrack">
270 <title>Centering and Tracking</title>
271 <indexterm><primary>Objects in the Sky</primary>
272 <secondary>Tracking</secondary></indexterm>
273 <para>
274 &kstars; will automatically begin tracking on an object whenever one
275 is centered in the display, either by using the <guilabel>Find
276 Object</guilabel> window, by double-clicking on it, or by
277 selecting <guimenuitem>Center and Track</guimenuitem> from its
278 <mousebutton>right</mousebutton>-click popup menu.  You can disengage
279 tracking by panning the display, pressing the <guiicon>Lock</guiicon>
280 icon in the Main toolbar, or selecting <guimenuitem>Track
281 Object</guimenuitem> from the <guimenu>Pointing</guimenu> menu.
282 </para>
284 <note>
285 <para>
286 <indexterm><primary>Orbit Trails</primary>
287 <secondary>Attached to centered object</secondary>
288 </indexterm>
289 When tracking on a Solar System body, &kstars; will automatically
290 attach an <quote>orbit trail</quote>, showing the path of the body
291 across the sky.  You will likely need to change the clock's timestep
292 to a large value (such as <quote>1 day</quote>) to see the trail.
293 </para>
294 </note>
295 </sect2>
297 <sect2 id="objectactions">
298 <title>Keyboard Actions</title>
299 <indexterm><primary>Objects in the Sky</primary>
300 <secondary>Keyboard Actions</secondary></indexterm>
301 <para>
303 When you click on an object in the map, it becomes the
304 <firstterm>selected object</firstterm>, and its name is identified in
305 the statusbar.  There are a number of quick key commands available
306 which act on the selected object:
308 <variablelist>
309 <varlistentry>
310 <term><keycap>C</keycap></term>
311 <listitem>
312 <para>Center and Track on the selected object</para>
313 </listitem>
314 </varlistentry>
316 <varlistentry>
317 <term><keycap>D</keycap></term>
318 <listitem>
319 <para>Show the <link linkend="tool-details">Details window</link> 
320 for the selected object</para>
321 </listitem>
322 </varlistentry>
324 <varlistentry>
325 <term><keycap>L</keycap></term>
326 <listitem>
327 <para>Toggle a visible name label on the selected object</para>
328 </listitem>
329 </varlistentry>
331 <varlistentry>
332 <term><keycap>O</keycap></term>
333 <listitem>
334 <para>Add the selected object to the 
335 <link linkend="tool-observinglist">Observing List</link></para>
336 </listitem>
337 </varlistentry>
339 <varlistentry>
340 <term><keycap>T</keycap></term>
341 <listitem>
342 <para>Toggle a visible curve on the sky, showing the path of the 
343 object across the sky (only applicable to Solar System bodies)
344 </para>
345 </listitem>
346 </varlistentry>
348 </variablelist>
349 </para>
351 <note>
352 <para>
353 By holding down the <keycap>Alt</keycap> key, you can perform 
354 these actions on the centered object, rather than the selected 
355 object.
356 </para>
357 </note>
358 </sect2> <!--object actions-->
359 </sect1> <!--objects in the sky-->
361 <sect1 id="endtour">
362 <title>End of the Tour</title>
363 <para>
364 This concludes the tour of &kstars;, although we have only scratched
365 the surface of the available features.  &kstars; includes many useful
366 <link linkend="tools">astronomy tools</link>, it can directly
367 <link linkend="indi">control your telescope</link>, and it offers a
368 wide variety of <link linkend="config">configuration and
369 customization options</link>.  In addition, this Handbook includes the
370 <link linkend="astroinfo">AstroInfo Project</link>, a series of short,
371 interlinked articles explaining some of the celestial and astrophysical
372 concepts behind &kstars;.
373 </para>
374 </sect1>
376 </chapter>