home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 613a.lha / LoranNotebook_v1.4 / LoranNotebook.Doc.pp / LoranNotebook.Doc
Encoding:
Text File  |  1992-03-09  |  24.1 KB  |  511 lines

  1.                          LORAN Notebook (LNB) V1.4
  2.                               August 17, 1991
  3.  
  4.   This program is free for the taking.  It may be uploaded on any BBS
  5. and added to any public domain library as long as the following
  6. conditions are met:
  7.  
  8. 1. This documentation is included with the executable program.
  9. 2. Neither the executable program or this documentation is altered.
  10.  
  11. (I would be VERY interested in trading loran numbers with other LNB users.
  12.  I may even be willing to convert other database formats to LNB.)
  13.  
  14.   I can supply the data format if anyone has a need for it.
  15.  
  16.   As you have probably guessed from my icon, I use a Micrologic Voyager
  17. SportNav (hand heald) loran.  It carries the TDs out two decimal points
  18. and this program allows for that. (Version 1.0 was not released)
  19.  
  20.  
  21.   Release 1.1. Fixed a problem with the IDCMP messages that caused some
  22.                gadgets to stop if you moved the pointer while holding
  23.                them down.
  24.  
  25.   Release 1.2. Added error checking to the number fields.  Fixed a bug that
  26.                could hang the system if an invalid output file was given.
  27.                Added graphic plotting of longitude/latitude data.  Read about
  28.                the plot screen towards the end of this file.
  29.    
  30.   Release 1.3. Made the Box Marked routine faster.
  31.                The F1 key will locate the current site on the plot.
  32.                The F1 key will also find the current site on the main
  33.                   window (previously used the help key)
  34.                Allow user to toggle the title bar on the plot screen
  35.                Fixed a bug in the Print Current Site option.
  36.                Standardized some of the terms in this doc file.
  37.                (I did not uploaded 1.3 this on any BBS)
  38.  
  39.   Release 1.4  Added Latitude and Longitude scale to the graphic display
  40.                   with pointer guidelines
  41.                The plot speed has been improved slightly.
  42.                Land can be drawn and edited (see the plot menu)
  43.                This has been bugging me since V1.0... The LONGITUDE now
  44.                   comes before the LATITUDE everywhere (screen, printouts)
  45.                   There was something warped about having the y-axis first.
  46.                Allows you to place a hurricane icon to plot hurricane
  47.                   movement.
  48.  
  49.  
  50.    Included in the archive:
  51.  
  52.         LoranNotebook      - The program
  53.         LoranNotebook.doc  - The program's instructions
  54.         Loran_Data         - Some sample Florida sites.
  55.                              (Each file also has an icon)
  56.  
  57.                              NOTE 1: The map of Florida in the sample data
  58.                                      was hand drawn and is very rough.  I hope
  59.                                      to have a more accurate version soon.
  60.  
  61.                              NOTE 2: There is a hurricane plotted in the
  62.                                      Loran_Data file.  Press the shifted
  63.                                      minus a few times to zoom back far
  64.                                      enough to see it.
  65. >>> BETA NOTICE
  66.  
  67.     If you start the Loran Notebook from the CLI and follow the program
  68. name with a questionmark ('LoranNotebook ?') you will get a revision number
  69. and a template.  If the revision number is followed by a Beta character
  70. (a strange looking capitol 'B') you have a Beta Test.  Beta tests are
  71. still in testing and not intended for release.  If you want to play with it
  72. anyway, go ahead.
  73.  
  74.     The testing has pretty much been limited to whatever time that I can play
  75. around with the program.  Since I would rather add features than play around
  76. this is limited even further.  I need to learn to multitask.
  77.  
  78. >>> THE BEEF
  79.  
  80.   The LORAN Notebook (LNB) is a dedicated database for LORAN users.  It may
  81. be started from the CLI or workbench.  If started from the CLI the database
  82. file name may follow the program name.  It detaches itself from the CLI so
  83. there's no need to use the 'run' command with it.
  84.  
  85.   If you are starting the LNB from the workbench you may double click on its
  86. icon or double click on the icon of a previously created LBN database.  The
  87. latter will run LNB and load the selected database.
  88.  
  89.   The notebook is based on North Latitude and West Longitude (U.S.A.).
  90.  
  91.   If you are starting a new database you will be limited to 500 entries.  If
  92. you hit that limit save the database and reload it.  You will have another
  93. 500 entries available in addition to the previous entries.  The size of each
  94. of your databases is limited to your Amiga's memory (1700 entries is about
  95. 250K).  Every time you load a database you will have 500 'blank slots'
  96. available.  This should be enough for additions.  You must select ADD SITE
  97. from the menu (or Right-Amiga-A) to actually add a new site.
  98.  
  99.   Since the working database is in RAM it is EXTREMELY IMPORTANT that you
  100. re-save it after any changes.  The program will remind you to save when you
  101. exit.  I strongly recommend that you save the database after any significent
  102. changes, even if you are not ready to exit.  Always keep a backup of the LNB
  103. and, more importantly, your database on a separate disk.
  104.  
  105.   In the title bar the current number of sites loaded into the database as
  106. well as the number of sites that are selected.  These will be updated as
  107. needed during your session.  While the current database in memory is being
  108. deleted the counter will reflect the status.
  109.  
  110.   The string gadgets are, I hope, self explanatory.  Lon, Lat & TDs are
  111. stored as floating point numbers.  This will prevent you from using minute
  112. marks, hyphens, etc. in these fields.  Waypoint and Depth are stored ad
  113. intergers, thus whole numbers only will be accepted in those gadgets.
  114.  
  115.   There are three QUICK gadgets.  These are built-in descriptive info for
  116. the site.  The first one is the most important because it is on the
  117. printouts.  The other two are handy for future searches.  The left side of
  118. each QUICK gadget will cycle backwards through the options and the right
  119. side will cycle forwards.   If you have any suggestions for the list let me 
  120. know.  The program will not allow the same item twice in a site.
  121.   The list is:  WRECK, REEF, LEDGE, SAND, BRIDGE, ROCK, PASS, PORT,
  122. MARKER, CHANNEL, DANGER!, ANCHORAGE, SPEAR FISHIN, FISHING, DIVING and
  123. CONFIRMED.
  124.  
  125.  
  126. >>> COLORS (assuming that you have the original WB colors)
  127.     These are the colors in the select box (The large box at the bottom
  128.     of the window that shows up to eight sites at a time.)
  129.  
  130.     NORMAL........ Red letters with a black background.
  131.     SELECTED...... White letters with a black background.
  132.     CURRENT SITE.. Blue background (letters same as above).
  133.                    There can only be one current site at a time.
  134.  
  135.     Sites may be selected and deselected my clicking on them with the mouse
  136. pointer (left button).  You may also drag the mouse across multiple sites
  137. while holding the button down.  If you move the pointer above or below
  138. the select box while holding the button down the sites will scroll.
  139.  
  140.     All sites are deselected when loaded.
  141.  
  142.  
  143. >>> THE MAIN MENU
  144.  
  145.    NEW           - Clears memory of the current database.
  146.  
  147.    OPEN          - Loads a LNB database.  If you try to load a file that
  148.                    is not an LNB database you will be yelled at.
  149.  
  150.    SAVE          - Saves the entire database.
  151.                    (I STRONGLY recommend that you save the database, and ALL
  152.                     valuable info on at least two separate disks.  A faulty
  153.                     disk is a terrible thing!)
  154.  
  155.    SAVE MARKED   - Allows you to save the sites that you have selected
  156.                    (white text).  This is handy in breaking up a large
  157.                    database.
  158.                    NOTE 1: This does not delete the selected sites from the
  159.                            current database.
  160.                    NOTE 2: Currently there is no way in the program to
  161.                            merge databases.  If this is needed let me know.
  162.  
  163.    ABOUT         - Does nothing useful.
  164.  
  165.    QUIT          - Exits the program.
  166.  
  167.    ADD SITE      - Creates a opening for a new site.
  168.  
  169.    DELETE SITE   - Deletes the current (blue background) site.
  170.  
  171.    DELETE MARKED - Deletes all of the selected sites (white text).
  172.  
  173.    TO PRINTER    - Sends output to the printer if checked.
  174.                    The check mark status is saved with the file.
  175.  
  176.    TO FILE       - Sends output to a file if checked.  You will be asked
  177.                    for a file name.  The check mark status is saved with
  178.                    the file.
  179.  
  180.    ONE LINE      - If checked, each site  will be printed on one 80 column
  181.                    line.  If it is not checked each site will print on
  182.                    three lines.  The check mark status is saved with the
  183.                    file.
  184.  
  185.    PRINT CURRENT - Prints the current site only.  The format will depend
  186.                    on if ONE LINE is checked or not.
  187.  
  188.    ALL MARKED    - Prints all selected sites.  The format will depend
  189.                    on if ONE LINE is checked or not.
  190.  
  191.    ALL SITES     - Prints all sites in memory.  The format will depend
  192.                    on if ONE LINE is checked or not.
  193.  
  194.    WITH ICON     - If checked, all databases and text files and land point
  195.                    lists  will have an appropriate icon saved with them.
  196.                    If you alter or add your own icon the program will not
  197.                    overwrite it. The check mark status is saved with the file.
  198.  
  199.    PLOT MARKED   - Plots the individual sites that have long/lat numbers
  200.                    entered AND are selected (white).  The sites will be scaled
  201.                    to fill the screen.
  202.                    
  203.    PLOT ALL      - Plots the individual sites that have long/lat numbers
  204.                    entered.  The colors match the select box: Red for normal
  205.                    and white for selected.
  206.                    
  207.  
  208. >>> KEYBOARD
  209.  
  210.     (No string gadgets can be selected for these keys to work)
  211.  
  212.     F1............... Locates the current site.
  213.     F2............... Toggles the way sites are sorted (Site Name or County)
  214.     UP ARROW......... Scrolls up one site.
  215.     SHIFT UP ARROW... Scrolls up one window of sites (8).
  216.     DOWN ARROW....... Scrolls down one site.
  217.     SHIFT DOWN ARROW. Scrolls down one window of sites (8).
  218.     LEFT ARROW....... Scrolls current site up one.
  219.     RIGHT ARROW...... Scrolls current site down one.
  220.  
  221.  
  222. >>> SEARCHING
  223.  
  224.   All of the string gadgets except ERR have a search button connected to
  225. them.  To search for a specific county make sure that the county name is in
  226. the string gadget (or part of the name, case doesn't matter) and click on
  227. the word 'County:'.  When the search is done all of the matches will be
  228. highlit and at the top of the list.  All string searches are non-case
  229. sensitive (upper case and lower case are the same).  Leading and trailing
  230. spaces are stripped prior to the search.
  231.  
  232.   All number searches (Lon, Lat, TDs, Depth & WP) work with the ERR factor.
  233. An Error factor of 0 (zero) would require an exact match.  An error factor
  234. of 10 (ten) would match if the site is -10 to +10 from the search number.
  235. In this way you could search for all sites with a depth between 60 and 80
  236. feet by entering 10 for the error factor and 70 for the depth to search for.
  237.  
  238.   The plus sign between LAT and LON does a double search.  It searches a
  239. rectangle around the entered numbers.  The size of the rectangle will depend
  240. on the error factor.  TDs may be searched the same way but since they are
  241. not parallel and at right angles to the equator the results could be a
  242. strange shape.  (I know, Latitudes are not parallel either, but they're close
  243. enough for most purposes).
  244.  
  245.   Error factors may be entered in decimal points or whole numbers.  For
  246. depth searches only whole numbers are used (no rounding).  The error factor
  247. is saved with the file.
  248.  
  249.   Searches on the QUICK gadgets must match any that are not blank.  If you
  250. have REEF, FISHING and a blank gadget and start the search all sites REEF and
  251. FISHING will be found, the blank will be ignored.  The match may be in any
  252. of the three QUICK boxes.  (Remember to use the LOCKED gadget described
  253. below to prevent changing the current site.)
  254.  
  255.  
  256. >>> LOCKED GADGET
  257.  
  258.   This allows you to enter text or numbers into a string gadget without
  259. actually changing the current site's info.  The QUICK gadgets will also
  260. be locked.  This is handy for searches when what you are looking for is
  261. not currently on the screen.
  262.   When you deselect the locked gadget the current site's information
  263. will be redisplayed.
  264.  
  265.  
  266. >>> MARKED SEARCHES
  267.  
  268.   If you click the MARKED gadget your next searches will only be against the
  269. previously selected sites.  By using this you could isolate a group of sites
  270. 10 miles E-W and 100 miles N-S in a particular county.
  271.   You will not be able to select the MARKED gadget if there are no selected
  272. sites.
  273.  
  274.  
  275. >>> SORT ARROW
  276.  
  277.   At the bottom of the window is a small arrow pointing either left or
  278. right.  If it points left the sites will be sorted by the site name.
  279. If it points right the sites will be sorted by county.
  280.   Any sites that are selected will be moved to the top of the list and
  281. sorted independently of unselected sites.  The arrow's direction is saved
  282. with the file.
  283.  
  284.  
  285. >>> SELECT/DESELECT GADGET
  286.  
  287.   Located to the left of select box is a tall, thin gadget that will
  288. select or deselect all of the sites in memory.  What it does depends
  289. on the condition of the first site in the list.  If it is active clicking
  290. this will deselect all of the sites and if it is not active it will
  291. select all of the sites.
  292.  
  293.  
  294. >>> ABOUT THE PLOT SCREEN
  295.  
  296.   First things first... DO NOT USE THE GRAPHIC PRINT FOR NAVIGATIONAL
  297. PURPOSES!
  298.  
  299.   Whenever you select plot from the menu there will be a slight delay while
  300. the program scales the data.  A minimum of three sites with longitude and
  301. latitude must be available for plotting.  (If I knew how to turn TDs to
  302. long/lats I would use them too.)
  303.  
  304.   The plots will have the latitude and longitude scale at the left and bottom,
  305. respecivately.  These will be anamorphically adjusted to fit the chosen
  306. display.  Minutes markers are displayed without numbers.  There are two
  307. guidelines that follow the pointer for reference, they are cleared before
  308. printing.
  309.  
  310.   Because of the scaling you have to be a little careful.  If you have 300
  311. numbers for Florida and one for New York the plot will have one dot for
  312. New York at the top, a big gap, and a bunch of dots at the bottom.  My testing
  313. consisted of 1775 Florida numbers and when plotted the entire outline of the
  314. state is visible (without the land).
  315.  
  316.   The plot screen has the usual forward/backward gadgets in the upper right
  317. corner, but you can't see them.  They're actually quite easy to find. 
  318. I like using the LEFT-AMIGA-M and LEFT-AMIGA-N keys to flip screens.  You may
  319. also turn on the title bar for the usual gadgets (see below).
  320.  
  321.   There are three menu choices from the plot screen.  They are:
  322.  
  323.  PLOT SCREEN MENU *******
  324.  
  325.    PRINT SCREEN  - To successfully pull this off you need a graphic
  326.                    compatable printer and the proper driver selected in
  327.                    preferences.  During the print the screen will change
  328.                    colors to reflect the printed output (and save your
  329.                    ribbon or toner).  The background will be white with
  330.                    the sites represented as black dots.  Currently
  331.                    selected and unselected sites print the same unless boxed
  332.                    (see below).
  333.  
  334.    PLOT MARKED   - Plots the individual sites that have long/lat numbers
  335.                    entered AND are selected (white).  The sites will be scaled
  336.                    to fill the screen.  This is the same as the menu option
  337.                    from the main loran window.  Sites that are not selected
  338.                    will not be displayed.
  339.                    
  340.    PLOT ALL      - Plots the individual sites that have long/lat numbers
  341.                    entered.  The colors match the select box: Red for normal
  342.                    and white for selected.  PLOT ALL will also return the
  343.                    display (zoom %) to the original settings.  This is the
  344.                    same as the menu option from the main loran window.
  345.  
  346.    BOX MARKED    - This will draw small boxes around all selected (white)
  347.                    sites.  This can be handy prior to printing to show
  348.                    selected sites better.
  349.                    
  350.    REDRAW        - Redraws the screen clearing any boxes.  This is also used
  351.                    to update plot screen if you make any changes (add/delete/
  352.                    select/deselect) on the main window.  (This isn't done
  353.                    automatically because it would take too long every time
  354.                    that you made a change.)  REDRAW is the same as PLOT ALL
  355.                    except that it keeps the current zoom level.
  356.  
  357.    TOGGLE TITLE  - Selecting this will either display or hide the title
  358.                    bar.  Showing the title bar will allow you to drag the
  359.                    window up and down.  When the title bar is not visible
  360.                    the hidden forward & backward gadgets are still available
  361.                    in the upper right hand corner.  The way that you leave
  362.                    the title bar will be saved with the file.
  363.  
  364.  FUNCTION MENU *******
  365.  
  366.    NORMAL        - This is the 'Normal' arrow pointer.  It will allow you to
  367.                    draw boxes around any areas that you want.  It does not
  368.                    select, zoom or clear anything.
  369.  
  370.    MARK          - This is the 'Crosshair' Pointer.  Selects all sited within
  371.                    the box (inclusive).  All other selected sites are
  372.                    deselected and any boxes are erased.  Any selected sites
  373.                    will also be selected in the normal loran window on the
  374.                    workbench screen. The pointer will return to NORMAL after
  375.                    the sites are selected.
  376.  
  377.    ZOOM          - This is the 'Double Box' Pointer.  The boxed area will
  378.                    be enlarged to fill the screen.  All selected sites will
  379.                    remain selected.  The pointer will return to NORMAL after
  380.                    the sites are selected.  To 'unzoom' choose PLOT ALL
  381.                    from the menu.
  382.  
  383.  LAND MENU *******
  384.  
  385.    CREATE        - Allows you to draw a land area by selecting points with
  386.                    the left mouse button.  Up to 1000 points may be created.
  387.                    To separate land areas select a point outside of the main
  388.                    display area (left or bottom of screen).  Points may be
  389.                    added at any zoom level.  Choosing any other menu item
  390.                    will cancel CREATE.  When in CREATE the pointer will become
  391.                    a small arrow.
  392.                    NOTE: A file with ANY land points will be about 8K larger
  393.                          on disk than a file without land points.
  394.  
  395.    EDIT          - Allows you to EDIT any land points previously created.  All
  396.                    land points will become white dots and all loran sites will
  397.                    be deselected and displayed as red.  As you position the
  398.                    single crosshair pointer over a white dot arrow heads will
  399.                    be added to it.  When this happens you may use the left
  400.                    mouse button to move the point.  If you have many land
  401.                    points the guidelines may be a little slow.
  402.    
  403.    IMPORT        - Reads an ASCII file to create the land points.  If land
  404.                    already exists the program will ask you if you want to
  405.                    delete it first, otherwise it will be appended.
  406.                    NOTE 1: This file may be edited with any word processor
  407.                            that does not add any formatting information.
  408.                            the format is: +AAAA.AA  +BBBB.BB
  409.                            Where 'A' is the LONGITUDE and 'B' is the LATITUDE.
  410.                            They may be separated by spaces, commas or tabs.
  411.                            The longitude must begin with a plus (+) sign
  412.                            to let the program know to convert it to the
  413.                            internal format.  A plus before the latitude is
  414.                            optional.  To separate land areas enter zeros,
  415.                            the plus sign is optional.  This will allow
  416.                            advanced users to create map files from nautical
  417.                            maps.  Numbers with plus signe may be mixed with
  418.                            exported data.
  419.                    NOTE 2: IMPORT will attempt to read whatever file that
  420.                            you tell it to, even if it isn't a long/lat list.
  421.  
  422.   EXPORT         - Writes the current land points to an ASCII file that is
  423.                    compatable with the IMPORT option.  This is handy to move
  424.                    land points from one file to another.  If the WITH ICON
  425.                    menu item (main window menu) is selected a palm tree icon
  426.                    will be created also.
  427.                    NOTE: The program does not store land points as longitudes
  428.                          and latitudes, but with a more base 10 friendly 
  429.                          system to speed things up.  Therefore if you attempt
  430.                          view this file you will find that the numbers are 
  431.                          similar to, but NOT longitudes and latitudes.
  432.  
  433.   CLEAR          - Asks you if you want to delete all of the land points. 
  434.                    If there are no land points nothing will happen.
  435.  
  436.  
  437.   KEYBOARD
  438.  
  439.     F1 .............. Locates the current site by drawing a box around it.
  440.                       The box color will depend on if the site is selected
  441.                       (white) or not (red).
  442.  
  443.     F6 .............. Adds a hurricane symbol at the present pointer location.
  444.                       This will be saved with the file ONLY land has been
  445.                       created.  The size of the symbol remains the same
  446.                       regardless of the magnification.
  447.  
  448.     F7 .............. Deletes the hurricane symbol.
  449.  
  450.     F10 ............. While you are in EDIT and have a land point selected
  451.                       (arrow heads on the crosshair) this will insert
  452.                       another land point.  You may then move land point
  453.                       freely.  (sorry, but my old A1000 doesn't have an
  454.                       insert key)  If you have many land points there will be
  455.                       a slight delay.
  456.  
  457.      DEL ............ While you are in EDIT and have a land point selected
  458.                       (arrow heads on the crosshair) this will delete the
  459.                       current land point.   If you have many land points there
  460.                       will be a slight delay.
  461.  
  462.      - .............. (Unshifted Minus Key) Will zoom the display out about
  463.                       one minute from each side.  There are no limits on
  464.                       how far out you can zoom.
  465.  
  466.      _ .............. (Shifted Minus Key) Will zoom the display out about one
  467.                       degree from each side.
  468.  
  469.      = .............. (Unshifted Plus Key) Will zoom the display in about
  470.                       one minute from each side.  The maximum zoom in is
  471.                       two minutes on the screen (The program will tell you).
  472.  
  473.      + .............. (Shifted Plus Key) Will zoom the display in about one
  474.                       degree from each side.  The maximum zoom in is
  475.                       two minutes on the screen (The program will tell you).
  476.                       NOTE: You can zoom in closer with the ZOOM pointer.
  477.  
  478.      LEFT ........... Moves the display 1/4 of the current resolution (screen
  479.                       that's visible) to the left. (SHIFTED LEFT moves 1
  480.                       screen left)
  481.  
  482.      RIGHT .......... Moves the display 1/4 of the current resolution to the
  483.                       right. (SHIFTED RIGHT moves 1 screen right)
  484.  
  485.      UP ............. Moves the display 1/4 of the current resolution up.
  486.                       (SHIFTED UP moves 1 screen up)
  487.  
  488.      DOWN ........... Moves the display 1/4 of the current resolution down.
  489.                       (SHIFTED DOWN moves 1 screen down)
  490.  
  491.   You may have noticed that there is no way to close the plot screen once it
  492. has been opened.  It will close up when you quit the program.
  493.  
  494.  
  495. >>> DOCUMENTATION
  496.  
  497.   I really hate writing these doc files.
  498.  
  499.  
  500. >>> COMMENTS & FLAMES
  501.  
  502.   Comments and suggestions are welcome.
  503.  
  504.      Allen Maroney
  505.      2009-66th Ave. S.
  506.      St. Petersburg, FL 33712
  507.      813-867-4781
  508.  
  509.      GEnie - A.MARONEY
  510.  
  511.