File: RoutePlanner.guide

package info (click to toggle)
routeplanner 0.17
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,836 kB
  • ctags: 264
  • sloc: python: 3,282; makefile: 58; sh: 40
file content (843 lines) | stat: -rw-r--r-- 32,707 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
@database RoutePlanner.guide
@master RoutePlanner.guide
@$VER: RoutePlanner.guide 1.7 (1.3.96)
@author "Chris Lawrence"
@(c) "1994-96 Chris Lawrence"
@index HeddleyAutoIndex
@remark Created with Heddley v1.1 (c) Edd Dumbill 1994

@node "main" "RoutePlanner 1.7 AmigaGuide documentation"
RoutePlanner 1.7 User's Guide

Introduction

  @{"AboutRoutePlanner" link "About" 0}
  @{"What'sNew" link "WhatsNew" 0}
  @{"Features" link "FeatureList" 0}
  @{"Credits" link "Credits" 0}

  Copyright
    @{"RoutePlannerandRouteConv" link "LegalStuff" 0}
    @{"RouteEdit" link "LegalStuff-RouteEdit" 0}

  @{"Registration" link "Registration" 0}

Using RoutePlanner

  @{"HowtouseRoutePlanner" link "HowToUse" 0}
  @{"TheMainWindow" link "MainWindow" 0}
  @{"ThePreferencesWindow" link "PrefsWindow" 0}
  @{"TheTripWindow" link "TripWindow" 0}

Appendices

  @{"Convertingdatabases" link "RouteConv" 0}fromRoadRoutetoRoutePlannerformat
  Available @{"HighwayClassifications" link "HwyClasses" 0}

  RouteEdit @{"Documentation" link "RouteEdit" 0}

  @{"ToDolistandcompletedsectionsofNorthAmericadatabase" link "ToDo" 0}
@endnode

@node "About" "Purpose and Requirements"
RoutePlanner is a highway trip planner program for Amigas with Release 2 or
later.  It works out the best available route between two (or more cities)
by consulting a map file, also known as a database. With @{"RouteEdit" link "RouteEdit" 0}, an
included utility, you can create and edit your own map files.

See @{"What'sNew" link "WhatsNew" 0} for changes in this release.

System Requirements:

 Amiga Release 2 or later
 At least 1.5 MB of memory (2 MB required to use more detailed map files)
 Magic User Interface 3.1 (or later) @{"*" link "Readme.mui/main" 0}

Recommended System:

 Amiga Release 2 or later
   [For PostScript printing, Amiga Release 2.1 or later]
 At least 2 MB of memory
 A compatible version of Magic User Interface
 A 68020 or higher processor
 A hard disk drive with at least 3 MB free
 A Preferences-supported printer
@endnode

@node "WhatsNew" "What's New"
New in release 1.7:

 Now including the German highway database from RoadRoute.  The converted
database is called Deutschland.route, and is mainly included so someone will
decide to improve it.

 RouteConv now features a "Default Grade" setting.  You can now override
the hardcoded time values to save some time in RouteEdit.

 All of the contiguous United States (the lower 48) are now complete.
Alaska will be added after Canada is completed.  I really don't see any need
for a Hawaii database (but if you want to contribute one, I'd be happy to
distribute it).

 Automatic fuel efficiency computations.  You now only have to enter city
and highway MPGs (or km/l's), and RoutePlanner will calculate the fuel
efficiency data from that.
@endnode

@node "FeatureList" "Features"
RoutePlanner replaces Jim Butterfield's RoadRoute program, the only other
highway trip planner for the Amiga.  The following enhancements have been
made:

 A graphic user interface has been added, using Stefan Stuntz's Magic User
  Interface system.

 The program now incorporates fuel consumption data as part of its output.

 Highway classifications have been added. You can adjust the master speed
  values for each classification, depending on your driving habits. *

 You can make the program choose routes based on your preference of
  driving on that type of road. (Preferred routing) *

 You may choose up to 20 intermediate cities on your route, making
  realistic "round trips" possible.

 Named map files can be loaded using extended selection, double-clicking
  on map file icons, or on the command line.

 Includes comprehensive documentation, supplemental utilities, and two
  map files, designed for small and large machines.

 Notification of crossing political boundaries, and arriving in
  intermediate cities.

Best of all, you can use your existing RoadRoute database files with
RoutePlanner. Simply use the included @{"RouteConv" link "RouteConv" 0}utility to import the basic
structure, then use @{"RouteEdit" link "RouteEdit" 0}to add any necessary highway classification
data.

* Requires enhanced databases.
@endnode

@node "Credits" "Many Thanks To..."
RoutePlanner comes to you, courtesy of:

Edd Dumbill -- Author of the Heddley AmigaGuide document editor.

Jim Butterfield -- General god of Commodore software writing (particularly
in the "good old days" of the Commodore 64), and author of RoadRoute 1.6,
the source of RoutePlanner's navigation routines, and the Basic-USA
database.

Gnter Kirrbach -- Author of the German database (included here as
Deutschland.route) from Fred Fish disk no. 504.

Brian Martz -- Suggested the automatic MPG calculation feature.

Aminet -- The world's best Amiga software archives (which could teach every
Unix archive I know of a thing or two about decent organization and
readmes).

Waters Computing Center, Rose-Hulman Institute of Technology -- Because they
give me my net access.  'Nuff said.

SAS/C 6.51 -- Still the best C programming environment under AmigaOS.  You
know, it would be nice if they'd come back...

RevUp -- A nifty little version numbering tool.

Stefan Stuntz and the SASG -- For Magic User Interface 3.2.  Yes, it's
slower than I'd like, but (1) MUI 3.2 is noticably faster than 2.x, even on
my Amiga 4000/040 and (2) it means I can modify the GUI without rewriting
the entire user interface.  Adding the "Extend..." button in RouteEdit was a
snap with MUI; with GadTools, you'd still be waiting for it. Besides, even
AT is including it with their Internet surfer package, so it can't be 100%
bad. :)

End users like you -- Who send in $5 (US) or $10 (US) and make me waste time
on RoutePlanner I could be wasting on other things.  Hint, hint :)
@endnode

@node "LegalStuff" "Copyright Issues"
@next "HowToUse"
Copyright:

The program RoutePlanner is derived, in part, from a public domain software
product, Jim Butterfield's RoadRoute. In the interest of supporting Jim's
intention of keeping the core of the software freely available, the
following copyright applies:

All portions of the archive, except the navigation module, are (C) 1994-96
Chris Lawrence.  No registration fee is required or requested for the use of
RoutePlanner and RouteConv.

RouteEdit is an original work of the author. It is copyrighted shareware.
Please refer to the RouteEdit @{"legalese" link "LegalStuff-RouteEdit" 0} for further details.

The NorthAmerica database is also an original work of the author.  If you
@{"register" link "Registration" 0} RouteEdit, you will receive an unlocked copy of the database for
your own personal use.  Alternately, if you are interested in having an area
of the database improved further, contact the author at the address below
for details.

Distribution Restrictions:

This archive is freely distributable, provided:

1. This archive (or its unpacked contents) must be distributed as a unit.

2. No file in the archive may be altered.

3. Additional files (BBS advertisements, Fred Fish readmes, etc) may be
   added to the archive provided that the files do not solicit payment
   for services and do not contradict any of the supplied documentation.

This archive may be included on the Fred Fish/Amiga Library Services CD
series (Frozen Fish, Fresh Fish, etc.) and any CD-ROM of the Aminet
archives. If you are interested in some other form of distribution, contact
the author at the address below.

Usage for commercial purposes:

There are no restrictions on commercial use.  However, if you manage to use
this software as part of a profitable business, please consider @{"registering" link "Registration" 0}
RouteEdit.

Contacting the author:

 Chris Lawrence
 3975 Muirfield Drive
 Memphis, Tennessee 38125-2505
 United States of America

 Internet mail:  @{fg highlight}lawrenc@rosevc.rose-hulman.edu@{fg text}
 World Wide Web: @{fg highlight}http://www.rose-hulman.edu/~lawrenc/routeplanner.html@{fg text}

For my PGP public key, please point your Web browser to my web page and
choose to see my Info page, or use the finger program to see my .plan.

Please Note:

Many terms used in this document are trademarks or registered trademarks.
This is generally indicated by the use of capital letters, i.e. AmigaGuide.
@endnode

@node "LegalStuff-RouteEdit" "Copyright Issues and RouteEdit"
Copyright for RouteEdit

The program RouteEdit, and the NorthAmerica.route database, are (C) 1994-96
Chris Lawrence.  They are distributed as copyrighted shareware.

If you @{"register" link "Registration" 0} RoutePlanner/RouteEdit, you imply your consent to the
following agreement:

AGREEMENT FOR THE USE OF KEYFILES FOR ROUTEPLANNER

If you have registered the program, you are entitled to a keyfile that
enables the saving of locked database files in RouteEdit. Upon receipt of
the keyfile, you may use the keyfile on one system at any given time. The
file may be duplicated onto any computers that you may own, lease, or rent,
but must not be allowed to be distributed to computers owned, leased, or
rented by another individual. Additional keyfiles for additional systems
under your control may be issued at the discretion of the author for $2
each. (These keyfiles will bear different registration numbers for tracking
purposes.) Additional keyfiles are licenced from the main keyfile, and all
of your keyfiles are considered a indivisible unit.

In essence: you may use a specific RoutePlanner keyfile on one Amiga at a
time. To use the Save As Locked... option on two Amigas at one time, you
must have two keyfiles. Additional keyfiles are $2 each. All additional
keyfiles must be retained by the owner of the main keyfile.

You may transfer all of your keyfiles to another individual, provided that
you destroy all copies of all of your keyfiles, the other individual has
read and understood this license, and you inform the author within thirty
(30) days of the transfer. You must inform the author of the name, address,
and email address (if applicable) of the transferee. The transferee will
receive all of the rights that a registered RoutePlanner user is entitled
to, and you will be required to either re-register or be transferred the
rights to another person's keyfiles in order to be considered a registered
user again. There is no fee for a keyfile transfer. You may charge the
transferee for the rights to your keyfiles if you wish. You must transfer
all of your keyfiles, or not transfer any of them. Renting or leasing of
keyfiles is not permitted.  If you transfer your keyfiles to someone else,
that person cannot transfer those keyfiles back to you within six (6) months
of the original transfer.

In essence: you may sell ALL of your keyfiles to another individual. The
other individual will receive all of the rights to RoutePlanner that you had
previously received, and you will revert to having the rights of an
unregistered user. There is no limit to the number of transfers that can be
made of a specific set of keyfiles.  Rental or leasing of keyfiles is a
violation of this agreement, as are short-term repurchases.

Keyfiles may not be placed in (a) download directories of Bulletin Board
Systems, (b) world-readable directories of an AFS-based system, (c)
world-readable directories of an FTP site, (d) world-readable directories of
an FSP site, or (e) any place where an anonymous or unentitled (person who
has not registered RoutePlanner or been transferred someone else's
registration) user might be able to receive a copy of the file (excepting
floppy diskettes used for personal storage).

IIt is illegal for an unentitled user to use a keyfile. Violations will be
prosecuted to the fullest extent of the law.

By receiving a keyfile and using it, you imply consent to this agreement.

Exceptions to this agreement must be made by the author (me) in writing.

If you register, you also receive the right to use an unlocked version of
the NorthAmerica.route database.  The following condition for its use
applies:

You may redistribute a modified NorthAmerica.route database if you lock it
so that unregistered users will be unable to edit it.  Any other
redistribution is prohibited unless you also transfer your Keyfile License
at the same time to the same individual.
@endnode

@node "Registration" "Registering RouteEdit"
Registration

To register RouteEdit and the NorthAmerica database, please send the
registration fee and your contact information (see below) to:

  Chris Lawrence
  3975 Muirfield Drive
  Memphis, Tennessee 38125-2505

Please put your return address on the outside of the envelope somewhere,
just in case you forget to mention it inside the envelope.

Fees

$5 (US) for a keyfile (only) via email.  I can't send the database via
electronic mail, since it is far too large.

$10 (US) for a keyfile and the latest RoutePlanner distribution (including
your copy of the unlocked database) on disk.

After registration, your keyfile will be good for all future releases.  If,
after registering, at any time you want a floppy update, send $5 (US) and
you will receive the latest release of RoutePlanner on disk with the latest
unlocked NorthAmerica database.  (Essentially, the $10 registration is $5
for the keyfile and $5 for the floppy update.)

Special Deals

Since I'm a nice guy, I'll accept Canadian currency at favorable rates: $6
for keyfile only by email; $12 for the floppy and registration.

I also accept one-for-one registrations if you're a shareware author
yourself.  Send me email and we'll make an arrangement.

Payment

Cash, check or money order.  Checks and money orders must be denominated in
U.S. dollars and checks are accepted only from U.S. banks (money orders from
non-U.S. banks and IPOs denominated in U.S. currency will be accepted).
Personal checks accepted with a discretionary 10-day hold.

Cash is accepted in U.S. and Canadian currency; bills only -- please don't
send coins.  If you are sending cash, I recommend that you use a plain,
opaque (non-translucent) envelope, and place your money inside your letter
(i.e. the money is inside the letter, rather than loose in the envelope).

I can't accept credit cards yet.  If there's enough interest in credit card
payment, I'll look into it.  Similarly, if there's interest in electronic
payment, I'll look into that too.

Your contact info

Include your name, an address that can be delivered to by your local postal
service, and your Internet email address (if you have one).  Also, if you
have a personal World Wide Web page, please send its URL.
@endnode

@node "HowToUse" "Getting up and running"
@prev "LegalStuff"
Installation:

There is no specific installation procedure required. Just decompress the
archive, and drag the RoutePlanner drawer somewhere convenient. Separating
the files is not recommended, mainly for the sake of convenience.

Note that to use the large database, you will need either a high-density
floppy disk drive or a hard drive, and at least 2 MB of memory.

Starting:

The easiest way to start RoutePlanner is to double-click on the RoutePlanner
icon. This will automatically open the default map file (Basic-USA.route)
and allow you to plan a route.

To use a map file other than the default, it is easiest to double-click on
the map file's icon, to automatically open that file in RoutePlanner.

For example, let's try a simple route. Click on the "From..." button, or
press the underlined character (F), to bring up the @{"cityrequester" link "CityRequester" 0}.

There are two ways to find the city you are looking for. We're going to type
the name of a city to start off with. For this example, type in "ocala" and
press Return.

After a brief pause, the list will change positions and the name "Ocala,
Florida" will be highlighted. Note that the case didn't matter.

Now, simply press Return again. To the right of the "From..." button, the
name "Ocala, Florida" will be displayed.

Now let's set the destination city. Click on the "To..." button (or press
T), and type in "wash,dc" and press Return.

The name "Washington, DC" will appear highlighted in the list. But why did
we put the ",dc" on the end? To see, click on the "Cancel" button in the
requester and then click on the "To..." button again.

This time, type in just "wash" and press Return. If you are using the simple
(default) map file, the result is the same as it was before. But if you use
the extended (high detail) map file, you will see a list of cities that
start with "Wash", such as "Washington Park, Illinois", and "Washington
Court House, Ohio". To select Washington, DC, you would either have to add
the ",dc" now, click on "Washington, DC" in the list, or use the cursor keys
to select it.

Click on "Ok" in the requester to choose Washington, DC. The button labeled
"Plan Route..." will no longer be ghosted, so click on it (or press P) to
see your route.

Depending on how your @{"preferences" link "PrefsWindow" 0} are set, the route may list every
intersection between Ocala and Washington, or just the intersections where
there is a turn to be made. If you use the enhanced database, you will find
that exit numbers are given where applicable.
@endnode

@node "MainWindow" "RoutePlanner window"
This is where you actually set up the trip that you want to take. There are
several buttons and a listview in this window.

Use the @{"From..." link "MainWindow" 4} button to specify your starting location.

Use the @{"To..." link "MainWindow" 6} button to specify your ending location.

To set up an intermediate destination, see @{"the`Via'listview" link "ViaCities" 0}.

To actually plan the route, press the @{"PlanRoute..." link "TripWindow" 0} button.  This will
result in the display of the Trip window.

When you are done using RoutePlanner, click on the @{"QuitRoutePlanner" link "MainWindow" 12}
button.

The window also has two menus.

Project
  Open Map... (Amiga-O)    Open another map file
  About... (Amiga-?)       Get information on RoutePlanner
  Information... (Amiga-I) Get information on the current database
  Hide (Amiga-H)           Iconify the window
  Quit (Amiga-Q)           Quit RoutePlanner

Settings
  Preferences... (Amiga-P) Bring up the @{"Preferenceswindow" link "PrefsWindow" 0}.
@endnode

@node "ViaCities" "The `Via' listview"
This section allows you to specify what cities you want to visit on your
route.

To add a new city to the list, click on the @{"Add..." link "ViaCities" 4} button. Cities are
added to the end of the list.

To remove the highlighted city from the list, click on the @{"Remove..." link "ViaCities" 7}
button.

To change the highlighted city, click on the @{"Change..." link "ViaCities" 10} button.

To move the highlighted city up or down, click on the arrow buttons.

Please note that cities will be visited in the order they are listed (from
top to bottom).

For example: To travel from Washington, DC to Las Vegas, Nevada via
Chattanooga, Tennessee and Barstow, California, you would:

  Set the From city to Washington, DC
  Set the To city to Las Vegas, Nevada
  Add Chattanooga, Tennessee to the Via listview
  Add Barstow, California to the Via listview
  Click on the Plan Route... button
@endnode

@node "CityRequester" "City selection requester"
The city selection requester is used to choose starting, ending, and
intermediate cities.  The largest element of the requester is the scrolling
listview, which contains the current city choices.

Below the listview is a string gadget labelled "Search:", along with the
@{"All" link "CityRequester" 5} button. To look for a city or a subset of cities, enter a pattern into
the search gadget. Generally, you can enter the first few letters of the
city's name, a comma, and the first letter of the state name and the city
will be found automatically.

[The following examples assume you are using the larger database,
@{fg highlight}NorthAmerica.route@{fg text}. However, the concepts are the same for all databases.]

For example, "jack,f" will only match "Jacksonville, Florida," so the city's
name will be highlighted.  If a city name is highlighted, you need only
press Enter to select it (or click on the @{"Ok" link "CityRequester" 17} button).

However, if you were to enter "ocean,calif" there would be two matches:
Ocean Beach and Oceanside.  The list will only display these two cities, to
allow you to choose between the two.  If you made a mistake, click on the
All button (or clear the Search gadget of text and press Enter) to return to
the full city listing.

This can be very helpful if your city isn't in the database, because you can
type a comma followed by a state name in the Search gadget to find all of
the cities in the database that are in your state.

If you enter something into the search gadget that doesn't match anything
currently displayed in the listview, a requester will pop up informing you
that nothing was found; upon satisfying this requester you will return to
the same listview as before.

Important note: RoutePlanner doesn't understand postal abbreviations.  For
example, if you want to choose a city in North Dakota, you should not type
",nd", but either ",north d" or ",n#?d".  Note that RoutePlanner allows the
use of wildcards within the search expressions.
@endnode

@node "PrefsWindow" "Preferences window"
The first page includes miscellaneous settings:

The "Measurement" cycle gadget allows you to choose whether you want the
program's output to be in metric or English (Imperial) units.

The "Display" cycle gadget allows a choice between displaying (1) all
intersections on the route, (2) only those intersections where there is a
turn, or (3) intersections where there are turns and intersections near
state/provincial boundaries.

The "Automatic Efficiency Calculation" allows you to pretty much skip the
third page.  Simply enter your vehicle's city and highway MPGs (or km/l's)
and click the "Recalculate" button.  This will calculate all the fuel
efficiency data on the third page for you.  Filling in this data and the
"Default Fuel Efficiency" should be sufficient for most users.

The "Default Fuel Efficiency" integer gadget allows setting a fuel
efficiency for unenhanced map files.

The "Default Database" is the one that is automatically loaded on startup
unless an alternate map file is loaded (by shift-clicking, etc.)

The second page allows you to specify what average speed you wish to use on
the different @{"classesofhighway" link "HwyClasses" 0}.

The third page allows you to decide what fuel efficiency to associate with
each class of highway.

The last page allows you to set the preference for each type of road.  For
example, if you'd like to avoid driving on Interstate highways, reduce the
preference level for them to a minimal level.

The @{"Save" link "PrefsWindow" 23} button will keep these settings forever.

The @{"Use" link "PrefsWindow" 25} button will keep these settings until you reboot your computer.

The @{"Cancel" link "PrefsWindow" 27} button will revert to the last settings.
@endnode

@node "TripWindow" "Trip display window"
The trip window is used to display the results from a planned route.

The From, To and Via text display gadgets indicate the route you selected in
the main window.

To alternate between viewing the most direct (shortest), quickest and
preferred routes, click on the View cycle gadget.  If some of the routes are
the same, you will only be able to choose those that are different.

The Distance, Time and Fuel used text display gadgets indicate these
statistics for the currently displayed route.

The large listview contains the computed by RoutePlanner.  Each segment of
the route appears on an individual line.

The first column indicates the distance of this segment.

The second column indicates the time it takes to complete this segment.

The third and fourth columns (in brackets) indicate the distance and time
elapsed since leaving the last specified (From or Via) city.

The remainder of the line indicates the name of the highway, and where to
turn off onto the next highway.  If supported in your database, this will
include an exit number.

The output will also indicate which state line(s) will be crossed on a
segment, ABOVE the actual segment that it pertains to.

The large button at the bottom of the window will close it and return to the
main window.

There is one menu in this window, the Project menu.  It contains four
items:

Save As...: Write both routes to a file on disk.

Print: Send both routes to the Preferences printer, separated by form
feeds.

Close Window: Close the Trip window.

Quit RoutePlanner: Exit completely from RoutePlanner.
@endnode

@node "RouteConv" "Appendix: RouteConv conversion utility"
Basically, all you need to do to convert a RoadRoute database into a
RoutePlanner database is:

1. Start up RouteConv

2. Select your RoadRoute City file (usually called "Cities")

3. Select your RoadRoute Route file (usually called "Roads")

4. Choose a name for the new database (the "Output file").

5. Specify whether the distances in the file are in kilometers or miles.

6. Choose whether you want to ignore the hardcoded times in the file.  To
use those times, ignore the "Default Grade" cycle gadget; otherwise, choose
the grade you think most of the roads belong in (for example, a database of
Canadian roads the best choice would probably be "Rural Highway (2 Lane)
(Canada)").

An improved progress display will be included if there's demand for it.
@endnode

@node "HwyClasses" "Appendix: The Highway Classifications"
RoutePlanner currently supports 26 different highway classes, most of which
are currently used.  The other six will be used in the United Kingdom map
that will be released after the large United States map is completed.

The classes are:

 Rural Interstate
 Suburban Interstate
 Urban Interstate
 Rural Highway (4 Lane)
 Rural Highway (2 Lane)
 Suburban Highway
 Suburban Road
 Urban Road
 Rural Interstate (55) *
 Metro Interstate
 Rural Freeway (Canada)
 Urban Freeway (Canada)
 Rural Highway (4 Lane) (Canada)
 Rural Highway (2 Lane) (Canada)
 Urban Highway (Canada)
 Urban Road (Canada)
 Rural Motorway (UK)
 Suburban Motorway (UK)
 Urban Motorway (UK)
 Dual Carriageway (UK)
 Rural 'A' Road (UK)
 Rural 'B' Road (UK)
 Suburban Road (UK)
 Urban Road (UK)

* This is used instead of Rural Interstate in states where the legal speed
  limit is still 55 mph, and on rural controlled access highways that are
  not part of the Interstate system.
@endnode

@node "RouteEdit" "Appendix: RouteEdit Interim Documentation"
Important stuff to note:

Save As Locked... will only work if you are a registered user.  Chances are,
you aren't :)

You will only be able to edit unlocked files.  RouteConv creates unlocked
files, and the Basic-USA database is also unlocked.  The NorthAmerica
database is locked, both because it is being worked on at the moment and is
proprietary to the author.  If you register RouteEdit, you will receive an
unlocked copy of the NorthAmerica database for your own personal use.

The coordinate features have been disabled in version 1.5.  If your database
contains coordinates already, I recommend that you keep it around as a
backup copy (I will provide a conversion utility with the next version of
RouteEdit with coordinate features).

The reason why coordinates have been disabled is that I would have had to
redesign the file format otherwise.  For the next major release, 2.0, I plan
to create a smaller file format that will support coordinates, but I felt
that direct file compatibility from 1.4 to 1.5 was important.  (Note that
1.5 databases can also be used with version 1.4).

Please avoid using hard-coded times and speeds.  This allows users to
customize the routes they receive around their driving habits.  The NA
database will only contain hardcoded values for ferries and other things
that can't really be "sped up"; I advise you to do the same.

If you will be distributing map files, please make use of the Information
requester to add your name and contact info (if you don't have email, put
the name of your town or something there instead).

RouteEdit @{"registration" link "Registration" 0} is $5 US for a keyfile via electronic mail, $10 US
for a complete distribution (with other goodies) on a floppy disk, mailed
anywhere in the world.  Follow the registration link for details.

The license agreement for RouteEdit can be found @{"here." link "LegalStuff-RouteEdit" 0}

RouteEdit may be distributed according to the restrictions supplied for
RoutePlanner and RouteConv.  Please note that RouteEdit is copyrighted
shareware, and that redistribution of keyfiles is restricted by the
RouteEdit key file license agreement.

My contact information is @{"here." link "LegalStuff" 0}
@endnode

@node "ToDo" "Appendix: ToDo List"
Planned for upcoming releases (in order by priority):

  Complete the NorthAmerica database
  Bubble help
  Better documentation
  Separate RouteEdit documentation
  Multiple navigation windows
  Floating "city palette"

The following regions (states, provinces, etc.) in NorthAmerica.route are
"completed" in this release of the database:

  Alabama
  Arizona
  Arkansas
  California
  Colorado
  Connecticut
  Delaware
  District of Colombia
  Florida
  Georgia
  Idaho
  Illinois
  Indiana
  Iowa
  Kansas
  Kentucky
  Louisiana
  Maine
  Maryland
  Massachusetts
  Michigan
  Minnesota
  Mississippi
  Missouri
  Montana
  Nebraska
  Nevada
  New Hampshire
  New Jersey
  New Mexico
  New York
  North Carolina
  North Dakota
  Ohio
  Oklahoma
  Oregon
  Pennsylvania
  Rhode Island
  South Carolina
  South Dakota
  Tennessee
  Texas
  Utah
  Vermont
  Virginia
  Washington
  West Virginia
  Wisconsin
  Wyoming

[Total complete: 48 states + DC]

In addition, some areas of adjoining states are complete.

"Completed" means the data for this region has been "filled in" with many
more cities, and checked for route number and name accuracy.  Other areas
are described well enough for through travel, but probably not enough for
local (in-region) travel.
@endnode

@node HeddleyAutoIndex "Index"
@remark Index auto-generated by Heddley
Index of database RoutePlanner.guide

Documents

@{"Appendix: RouteConv conversion utility" link "RouteConv"}
@{"Appendix: RouteEdit Interim Documentation" link "RouteEdit"}
@{"Appendix: The Highway Classifications" link "HwyClasses"}
@{"Appendix: ToDo List" link "ToDo"}
@{"City selection requester" link "CityRequester"}
@{"Copyright Issues" link "LegalStuff"}
@{"Copyright Issues and RouteEdit" link "LegalStuff-RouteEdit"}
@{"Features" link "FeatureList"}
@{"Getting up and running" link "HowToUse"}
@{"Many Thanks To..." link "Credits"}
@{"Preferences window" link "PrefsWindow"}
@{"Purpose and Requirements" link "About"}
@{"Registering RouteEdit" link "Registration"}
@{"RoutePlanner 1.7 AmigaGuide documentation" link "main"}
@{"RoutePlanner window" link "MainWindow"}
@{"The `Via' listview" link "ViaCities"}
@{"Trip display window" link "TripWindow"}
@{"What's New" link "WhatsNew"}

Buttons

@{"Add..." link "ViaCities" 4}
@{"All" link "CityRequester" 5}
@{"Cancel" link "PrefsWindow" 27}
@{"Change..." link "ViaCities" 10}
@{"From..." link "MainWindow" 4}
@{"Ok" link "CityRequester" 17}
@{"PlanRoute..." link "TripWindow" 0}
@{"QuitRoutePlanner" link "MainWindow" 12}
@{"Remove..." link "ViaCities" 7}
@{"Save" link "PrefsWindow" 23}
@{"To..." link "MainWindow" 6}
@{"Use" link "PrefsWindow" 25}
@{"*" link "Readme.mui/main" 0}
@{"AboutRoutePlanner" link "About" 0}
@{"cityrequester" link "CityRequester" 0}
@{"classesofhighway" link "HwyClasses" 0}
@{"Convertingdatabases" link "RouteConv" 0}
@{"Credits" link "Credits" 0}
@{"Documentation" link "RouteEdit" 0}
@{"Features" link "FeatureList" 0}
@{"here." link "LegalStuff-RouteEdit" 0}
@{"here." link "LegalStuff" 0}
@{"HighwayClassifications" link "HwyClasses" 0}
@{"HowtouseRoutePlanner" link "HowToUse" 0}
@{"legalese" link "LegalStuff-RouteEdit" 0}
@{"preferences" link "PrefsWindow" 0}
@{"Preferenceswindow" link "PrefsWindow" 0}
@{"register" link "Registration" 0}
@{"registering" link "Registration" 0}
@{"Registration" link "Registration" 0}
@{"RouteConv" link "RouteConv" 0}
@{"RouteEdit" link "LegalStuff-RouteEdit" 0}
@{"RouteEdit" link "RouteEdit" 0}
@{"RoutePlannerandRouteConv" link "LegalStuff" 0}
@{"TheMainWindow" link "MainWindow" 0}
@{"ThePreferencesWindow" link "PrefsWindow" 0}
@{"TheTripWindow" link "TripWindow" 0}
@{"the`Via'listview" link "ViaCities" 0}
@{"ToDolistandcompletedsectionsofNorthAmericadatabase" link "ToDo" 0}
@{"What'sNew" link "WhatsNew" 0}
@endnode