kstars/README.customize

   1 KStars Customization Guide.
   2 copyright 2002 by Jason Harris and the KStars team
   3 This document is licensed under the terms of the GNU Free
   4 Documentation License
   5 ---------------------------
   6
   7 This document provides a brief overview of the many advanced customization
   8 features provided in the program.  If you have a useful customization that
   9 you would like to share with the KStars community, please consider
  10 submitting it to kstars@30doradus.org; we may incorporate your data into
  11 a future version of KStars!
  12
  13
  14 1. Color Schemes
  15
  16 In the "Colors" tab of the KStars Configuration window, the colors of
  17 all items drawn in the sky map can be customized.  At any time,
  18 you can save the current collection of colors into a custom color scheme.
  19 Saved schemes will appear in the listbox on the right of the Colors
  20 tab, as well as in the "Settings|Color Schemes" menu.  In addition,
  21 the custom color schemes are automatically reloaded when KStars starts up,
  22 so they will always be available.
  23
  24 You can remove a custom color scheme at any time by highlighting it in the
  25 listbox and then pressing the "remove" button.
  26
  27
  28 2. Geographic Locations
  29
  30 The Change Location window allows you to set the geographic location
  31 by choosing from a list of over 2000 predefined cities around the world.
  32 If you would like to use a location that is not on the list, enter the
  33 relevant information (longitude, latitude, city name, province name, and
  34 country name), then press "Add to list".  All fields must be filled, except
  35 the optional province field.
  36
  37 In addition, you can also modify the values for an existing city, by
  38 simply changing the values in the window, and adding it to the list.
  39
  40
  41 3. Object Catalogs
  42
  43 You can easily add your own object data to KStars.  First, prepare the
  44 object catalog data file.  Each line in the file should contain the
  45 following space-separated fields:
  46
  47 for stars:
  48 type(0 for stars), RA, Dec, mag, SpType, name(optional)
  49
  50 other types:
  51 type(3-8), RA, Dec, mag, name(optional)
  52
  53 The types are:
  54 0: star
  55 1: star (in object catalog...probably don't want to use this)
  56 2: planet (don't use this in custom catalog)
  57 3: open cluster
  58 4: globular cluster
  59 5: gaseous nebula
  60 6: planetary nebula
  61 7: supernova remnant
  62 8: galaxy
  63
  64 The SpType is a short string for the spectral type.  For example, "B5" or "G2"
  65 The coordinates should be given as floating-point values, in the J2000.0 epoch.
  66 The name can be anything you wish.  If the name is more than one word, it
  67 must be enclosed in quotation marks.
  68
  69 Once you have constructed a custom data file, open the Configuration window
  70 to the Catalogs tab, and press the "Add Custom Catalog" button.  A popup
  71 window appears in which you can specify a name for the catalog, and the
  72 name of the file (including the path).
  73
  74 When you press Ok, KStars will attempt to read the lines of your data file.
  75 It will report any problems, and if any lines at all were successfully parsed,
  76 you are given a choice to accept the data file (ignoring any unparsed lines),
  77 or to cancel the operation to attempt to resolve the problems first.
  78
  79 Once the data file has been accepted, your custom catalog will be loaded on
  80 startup along with the standard catalogs, and there will be a checkbox in the
  81 Configuration window to toggle the display of your catalog objects.
  82
  83 You can remove custom catalogs by highlighting its checkbox in the
  84 Configuration window, and pressing the "Remove Custom Catalog" button (this
  85 button is only active if a custom catalog is highlighted in the list
  86 of checkboxes).
  87
  88
  89 4. URL Links
  90
  91 You can add your own internet links to any object by selecting the
  92 "Add Link..." item from the object's right-click popup menu.  A
  93 window opens in which you can enter text to appear in the new menu item,
  94 and the URL which should be opened.  You should also specify whether the
  95 link points to an image or an HTML page (Image links open the Image Viewer,
  96 HTML links open a Konqueror window).  The menu text is filled
  97 with a default string at first; feel free to modify it.
  98
  99 Note that the URL can point to a file on your hard drive, so this is an
 100 interesting way to catalog your own astrophotos, or perhaps to keep
 101 observing notes about different objects...
 102