home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / private / tg120.zip / GUIDE.NEW < prev    next >
Text File  |  1993-03-24  |  33KB  |  701 lines

  1.  
  2. %t Guide! Documentation File
  3. %n 2R1
  4. %s GUIDE.DOC converted into a valid entry for your pleasure
  5. %a Steve Baker  (swbaker@vela.acs.oakland.edu)
  6. %d 19930302
  7. %f FACT
  8. %i Documentation for The Guide!
  9. %i GUIDE.DOC file
  10. %x Article Writing Guide For Field Researchers And Guide Editors
  11. %x Guide! Information
  12. %e
  13.  
  14.  
  15.                                  The Guide!
  16.  
  17.                an experiment in Turbo Vision/OOP to implement
  18.                  The HitchHiker's Guide to the Known Galaxy
  19.  
  20.  
  21.  
  22.                     developed and written by Steve Baker
  23.                            Our Shadow's SoftWorks
  24.                       > swbaker@vela.acs.oakland.edu <
  25.  
  26.  
  27.  
  28.                        Initial Release Documentation
  29.                          slightly revised 03/02/93
  30.  
  31.  
  32.  
  33. 0.0 Legal Stuff
  34.  
  35.      This system is Copyright (c) 1992-1993 Steve Baker, Our Shadow's
  36.      SoftWorks.  Permission is granted to any individual or institution
  37.      to use, copy, or redistribute these executables and associated files
  38.      so long as they are not modified and that they are not sold for profit
  39.      (hence the motto, "Share and Enjoy!").
  40.  
  41.      The TG! system is provided "as is" and comes with no warranty of any
  42.      kind, either expressed or implied.  In no event will the copyright
  43.      holders be liable for any damages resulting from the use of this
  44.      software.
  45.  
  46.      There, got that stuff out of the way.  Now then, if you *do* discover
  47.      any glitches and/or problems, please feel free to email them, along
  48.      with a complete description of your PC system and configuration, to
  49.      me (swbaker@vela.acs.oakland.edu).  I will do my very best to resolve
  50.      any problems that are discovered.
  51.  
  52.  
  53.  
  54. 1.0 Introduction
  55.  
  56.      Many virtual eons ago, Douglas Adams wrote some radio scripts for a
  57.      new radio humor series entitled _The Hitchhiker's Guide to the Galaxy_.
  58.      In the shows (which have evolved into a series of novels, TV episodes,
  59.      records and CD's, and even computer games), the heroes "consult the
  60.      Guide," the best-selling book with "Don't Panic" inscribed in large,
  61.      friendly letters on the cover, in times of duress.
  62.  
  63.      Since then, the concept of consulting an on-line electronic
  64.      encyclopedia-like Guide while exploring the (known) universe has
  65.      intrigued and baffled mankind.
  66.  
  67.      Until now.
  68.  
  69.      The Guide! is my "vision" of the Hitchhiker's Guide: a DOS-based
  70.      article consultation system, similar to the "real" Hitchhiker's Guide
  71.      that Ford and Arthur consult whilst exploring the universe (suitable
  72.      for use on laptop/palmtop systems as well as full desktop and network
  73.      environments).  With TG!, the roving hitchhiker can search for, read,
  74.      print, and capture to disk the life-saving articles that roving hitch-
  75.      hikers have come to expect from the Project Galactic-Guide staff.
  76.  
  77.  
  78.  
  79. 1.01 Overview
  80.  
  81.      Before we start, let me mention that if you're impatient and want to
  82.      get going with this thing, take a look at a file called READ.ME which
  83.      describes the steps required to get up-and-running.  Anyway...
  84.  
  85.      The Guide! is a full-featured, multi-windowed, pop-up and pull-down
  86.      menu'ed, mouse-supporting anomaly.  It reads in new entry articles
  87.      from standard ASCII files, and supports multiple entries per .NEW
  88.      input file (archive).
  89.  
  90.      TG! features a nifty search and query engine, allowing the user to
  91.      search in many different ways.  The following are verbose examples of
  92.      searches you may request:
  93.  
  94.      *    Give me all entries which have the word "wazoo" in the title, are
  95.             written by Joe Schmoe, and are completely real.
  96.      *    Show me all entries written between Date1 and Date2.
  97.      *    I want any articles with "meatball" in the summary, written
  98.             before Date1, which are both real and unreal.
  99.  
  100.      ... and any combination of title, summary, author, date, and reality
  101.      (being real, unreal, or semi-real) imagineable.
  102.  
  103.      As one would expect from an encyclopediac-type device, TG! offers a
  104.      Table of Contents, a full Index, author and editor biographies, and
  105.      cross-references which link articles together (if an article has cross-
  106.      references to a second article which has not yet been added to the
  107.      system, The Guide! is aware of that "incomplete" xref and will update
  108.      it, automatically, when the second article is eventually added).
  109.  
  110.  
  111.  
  112. 1.1 Moving around in The Guide!
  113.  
  114.      TG! features what is becoming an industry-standard user interface.
  115.      This interface is comprised of three parts:
  116.  
  117.           1) the pull-down menu bar, at the top line of the screen
  118.           2) the main "desktop" area, in the middle of the screen
  119.           3) the status-line bar, at the bottom line of the screen
  120.  
  121.      The Guide! is great for those with a mouse, and is also easy to use
  122.      with the keyboard.  Access the menu bar by either pressing [F10], or
  123.      clicking the [ The Guide! ] "button" on the status bar, or by pressing
  124.      one of the Alt-letters (ie, [ Alt-F ] for the [F]ile menu, etc).
  125.  
  126.      Numerous hot-keys have been defined which bypass the menu structure
  127.      and invoke the desired function directly.  These hot-keys are listed
  128.      along side of the functions they invoke in the pull-down menus; browse
  129.      through the pull-down menu bar to note these functions.  Here are some
  130.      of the highlights:
  131.  
  132.           [F2]         Define title, summary, author, and factuality
  133.                          search parameters, without evoking a search
  134.           [F3]         Define date search parameters
  135.           [F4]         Consult the Index of the current GuideNET base
  136.  
  137.           [Alt-F3]     Close active window
  138.           [F5]         Zoom/unzoom active window
  139.           [F6]         Activate next available window
  140.           [Shift-F6]   Activate previous available window
  141.  
  142.           [F7]         Browse forward from current location
  143.           [Ctrl-F7]    Browse backward from current location
  144.  
  145.           [F8]         Define title, summary, author, and factuality
  146.                          search parameters, and begin a new search at the
  147.                          beginning of the GuideNET base
  148.           [F9]         Continue using results of most recent search
  149.  
  150.           [Alt-L]      Load a new GuideNET base
  151.           [Alt-P]      Print the current article
  152.           [Alt-T]      Consult the Table of Contents
  153.           [Alt-V]      Save the current article as an ASCII text file
  154.           [Alt-X]      Exit The Guide!
  155.  
  156.      Many functions bring up dialog boxes with modifiable data fields.
  157.      Common ways to maneuver through these dialog boxes:
  158.  
  159.           *  [TAB] moves forward one option or field
  160.           *  [Shift-TAB] moves backward one option/field
  161.           *  cursor/arrow keys moves the "radio-buttons" options around
  162.           *  the space bar toggles the "check-box" items
  163.           *  [Enter] (or click the [Ok] button) to proceed
  164.           *  [Esc] (or click the [Cancel] button) to abort the process
  165.                (where applicable)
  166.  
  167.      Mouse users may click the various "buttons" on the status line at the
  168.      bottom of the screen.  For example, the [ --> ] button is the "Browse
  169.      forward" ([F7]) command, and the [ <-- ] button is the "Browse backward"
  170.      ([Ctrl-F7]) command.  Also, you may click on the functions described
  171.      on the status line (ie, click anywhere on the "F4 Index" to bring up
  172.      the index, etc).
  173.  
  174.      ... This is pretty much standard stuff, for those who've dealt with
  175.      these types of interfaces before.  As mentioned earlier, this type of
  176.      interface is becoming an industry-standard, with more and more packages
  177.      adopting this consistant interface.
  178.  
  179.  
  180.  
  181. 2.0 Adding entries to The Guide!
  182.  
  183.      The Guide! is designed to be very flexible with its data input.  It
  184.      will read in as many new archive files (files which contain articles)
  185.      as you want to throw at it, providing they meet these criteria:
  186.  
  187.           1. The articles must conform to the current format standards.
  188.              These are described in the article "Article Writing Guide for
  189.              Field Researchers and Guide Editors" (available in TGxxx.ZIP as
  190.              FORMATS.NEW).  This paper describes the proper formatting and
  191.              article fields agreed upon by Project Galactic-Guide.
  192.              (See section 2.1, below, for more info on this stuff.)
  193.  
  194.           2. Each ASCII file must end with a [ .NEW ] extension, ie:
  195.  
  196.              FOO.NEW
  197.              BAR.NEW
  198.  
  199.              This way, whole batches of files may be processed at once,
  200.              following the simple idea that every .NEW file shall be added
  201.              to the system (ie, these are the "new" articles to add).
  202.  
  203.           3. Multiple entries may reside in a single ASCII file, but every
  204.              article MUST be terminated (ended) with this special flag:
  205.  
  206.              *EOA*
  207.  
  208.              which means "End Of Article."  This flag must appear in the
  209.              FIRST column of a line, and must be the only item on the line.
  210.              Of course, you want this *EOA* flag to be AFTER the article,
  211.              not before or somewhere inbetween.
  212.  
  213.      Available system memory cannot be exceeded.  The Guide! has built-in
  214.      protection against "out of memory" crashes, and can perform partial
  215.      updates (ie, read in some, but not all, of the articles available)
  216.      if memory becomes low.
  217.  
  218.      To avoid memory problems, and to allow greater organization of
  219.      articles into logical collections, TG! supports multiple GuideNET base
  220.      files.  Thus, when one GuideNET base becomes full, simply begin another
  221.      one, analogus to starting a new volume of an encyclopedia when the
  222.      current one becomes "full."
  223.  
  224.      The Guide! offers several ways of handling these .NEW files --
  225.  
  226.           1. Rename - the system changes their extension to [ .OLD ], so
  227.                they are not processed again, but are still available if
  228.                required (this is the system default).
  229.           2. Delete - the files are usually no longer necessary once
  230.                the articles have been loaded, and can safely be deleted to
  231.                free up additional disk space.
  232.           3. Preserve - any .NEW files found and processed will be preserved
  233.                as .NEW files.  A note of caution - when this is used, you may
  234.                inadvertantly load in the same data every time you update,
  235.                since all files with a .NEW extension are processed (and if
  236.                they are not changed to something else, they could be
  237.                processed again the next time you Update your GuideNET).
  238.  
  239.      Update options and user-interaction are fully supported.  In
  240.      particular, you may:
  241.  
  242.           1. Automatically accept each and every article found, including
  243.                duplicate articles.  If a new article has a title which is
  244.                already in the GuideNET, a special message is appended to the
  245.                new title.  This ", Entry x" message denotes that the article
  246.                is the 2nd, or 3rd, or xth, article with the same title.
  247.                (See Section 2.3, below, for more info on this ", Entry x"
  248.                message.)
  249.  
  250.           2. Automatically accept only new, unique articles, and skip any
  251.                duplicate articles found (ie, if an article already exists in
  252.                memory, then skip any new, incoming articles with the same
  253.                title).
  254.  
  255.           3. Accept new articles, and also automatically update existing
  256.                articles with data from new articles with matching titles
  257.                (if any are found).
  258.  
  259.                When this occurs, all indexes and out-going cross-references
  260.                associated with the "old" article are removed, and the new
  261.                article's indexes and out-going cross-references are inserted
  262.                in their place.  Any in-coming cross-references to the
  263.                article remain intact.
  264.  
  265.           4. Manually decide whether or not to accept each article found.
  266.                You are shown the new article's title, summary, author, date,
  267.                and factuality.  At this point, you may choose to [A]ccept
  268.                or [S]kip the article.
  269.  
  270.                When you accept an article with the same title as an entry
  271.                already in the current GuideNET, the ", Entry x" flag is
  272.                appended (see above).
  273.  
  274.      General observations:
  275.  
  276.           Each new article is "stamped" with a unique identification field
  277.           when it is approved by an editor.  This ID field (%n) is the only
  278.           way that a given article can be distinguished from other articles,
  279.           particularlly if they have the same title.
  280.  
  281.           When an existing article is updated (for example, the author has
  282.           done some more field research, or an editor decided he didn't
  283.           really like that last bit as much as he thought he did, etc), the
  284.           system updates the GuideNET base with the revised article.  This
  285.           updating is performed automatically and transparently by TG!.
  286.  
  287.  
  288.  
  289. 2.1 Format of new entry files
  290.  
  291.      The Guide! reads ASCII entry files which conform to the "Article
  292.      Writing Guide..." paper which is frequently posted on the Internet
  293.      newsgroup alt.galactic-guide.  The writing guide is also included in
  294.      this collection as the file FORMATS.NEW.
  295.  
  296.      Several extensions have been added to this format, which I believe
  297.      have been mentioned in the newsgroup:
  298.  
  299.      *    %f [ REAL | UNREAL | SEMI-REAL ]
  300.                - this is my preferred way of handling "reality"
  301.  
  302.      *    %f [ -10 .. 10 ]
  303.                Another suggested way of handling factuality.  These are
  304.                converted as follows:
  305.  
  306.                     -10..-4  : UNREAL
  307.                      -3..3   : SEMI-REAL
  308.                       4..10  : REAL
  309.  
  310.      *    Of course, if a 'U', 'R', or 'S' is present in the %n <id number>
  311.           field, then that'll work also ('U' = UNREAL, 'R' = REAL, and
  312.           'S' = SEMI-REAL ).
  313.  
  314.      In general, the case of the field identifiers is not sensitive (ie,
  315.      you can use either '%t' or '%T' for the Title identifier).
  316.  
  317.      Recall that The Guide! uses the special marker [ *EOA* ] to define a
  318.      "break" between articles in an "archive" .NEW file (one which contains
  319.      more than one entry).  Of course, this *EOA* should not appear anywhere
  320.      other than BETWEEN complete articles.
  321.  
  322.           This special marker is required since TG! does not force any
  323.           particular ordering to the field tokens.  That is, the order of
  324.           the markers is not strictly important (with one exception; the
  325.           [ %t ] title marker MUST be the first field), so the system needs
  326.           a signal that the article has indeed ended.
  327.  
  328.      The Guide! ignores any non-key lines in the input files.  This way,
  329.      users can simply capture new articles from the newsgroups, save them
  330.      as ASCII files, and let the system handle the rest.  Comments, remarks,
  331.      etc. may also be inserted before, between, and after articles.  These
  332.      will also be ignored.
  333.  
  334.      See the sample .NEW files for examples of these flexibilities.
  335.  
  336.  
  337.  
  338. 2.2 Adding new entries into the system (using UPDATE.EXE)
  339.  
  340.      There are two methods to add new articles to the system; automatically
  341.      (via the Auto-Pilot) and interactively (via dialog boxes, etc).  Both
  342.      functions are performed by a program called Update (UPDATE.EXE).
  343.  
  344.      Consult the file READ.ME for quick, let-me-get-going information on
  345.      adding articles to the system.
  346.  
  347.  
  348.  
  349. 2.21 Automatic article inclusion
  350.  
  351.      At the DOS prompt (and in the appropriate sub-directory, ie C:\GUIDE),
  352.      type [ UPDATE /AUTO ].  The system will process the supplied articles,
  353.      and then return to the DOS prompt.
  354.  
  355.           Data loading may take a few minutes (especially on slower systems,
  356.           and those without disk caching).  GuideNET Update displays a status
  357.           window to show its progress (ie, what entry number, file name, and
  358.           article name it's currently processing).
  359.  
  360.      When the program has finished, Update displays the number of articles
  361.      added into the system.
  362.  
  363.  
  364.  
  365. 2.22 Interactive article inclusion
  366.  
  367.      At the DOS prompt, type [ UPDATE ] to load the Update utility program.
  368.      Pull down the <U>tility menu, and select <U>pdate (or simply press F4).
  369.  
  370.      The first time you perform an update, the system will first ask you to
  371.      define the GuideNET NAME and DESCRIPTION.  This information is required
  372.      for TG! to proceed.  The name must be eight characters or less (and a
  373.      valid DOS filename), while the description can be up to fifty characters
  374.      of any nature.  A default name (GUIDE) and description are displayed,
  375.      unless overridden.
  376.  
  377.      Next, GuideNET Update displays the Update dialog box.  This box has
  378.      several Options and Toggles, most of which are described in Section
  379.      2.0, above.  If you desire, modify these options and toggles.  Then,
  380.      press [O]k (or Enter) to proceed, or [C]ancel (or Esc) to quit.
  381.  
  382.      The data-loading process may take a few moments, especially on slower
  383.      systems, and those without hard disk caching (see Section 5.0,
  384.      Optimizing, below).  The Guide! displays a status window displaying its
  385.      progress (ie, what new entry number, file name, and article name it's
  386.      currently processing).
  387.  
  388.      When it's finished, The Guide! displays how many articles were added
  389.      to the current GuideNET.  Before exiting the system, be sure to save
  390.      your data by either pressing [F3] (Save) or by using the <F>ile | <S>ave
  391.      pull-down menu function.
  392.  
  393.  
  394.  
  395. 2.3 Duplicate entries, indexs, and cross-references (in UPDATE.EXE)
  396.  
  397.      Duplicate entries are incoming articles which have titles that are
  398.      already in the system (thus, they are called "duplicates" even if the
  399.      articles themselves are completely different, and the fact that the
  400.      titles are the same may be "purely coincidental").
  401.  
  402.      TG! allows duplicate entries, indexs, and cross-references.  It
  403.      takes care of all the busywork, and lets you get on with using TG!.
  404.  
  405.      The Guide! distinguishes between original entries and subsequent
  406.      duplicates (if allowed into the system; see 2.0 above) by appending the
  407.      phrase ", Entry x" to the duplicate's title.
  408.  
  409.      For example, if an article entitled "Gallifrey" already exists in the
  410.      system, and another article with the same title is added to the system,
  411.      TG! will modify the second title so that it becomes "Gallifrey, Entry 2"
  412.      and so on.
  413.  
  414.      Any index and cross-reference links to duplicate entries access that
  415.      duplicate entry, just as any index and cross-reference links to the
  416.      original entry access that original entry.  From the article displayed,
  417.      you may Browse forward/backward to other duplicate entries.
  418.  
  419.      UPDATE.EXE is now especially aware of UPDATED articles.  These are
  420.      pieces which were previously released, but have since been updated with
  421.      new information.  TG! (via the GuideNET Update program) now auto-
  422.      magically updates any existing articles with their new replacements,
  423.      as they arive.
  424.  
  425.           This is possible since each article must have a UNIQUE %n (ID)
  426.           field.  Thus, if a "new" incoming article has the same %n field
  427.           as an article already in the GuideNET, then it MUST be the same
  428.           article.  To determine if the "new" one is really newer than the
  429.           existing article, their dates are compared.  If the "new" article
  430.           has a more recent date, then the update is performed.  Otherwise,
  431.           the "new" article is discarded (since you presumingly have a newer
  432.           version of the article already in the GuideNET).
  433.  
  434.  
  435.  
  436. 2.4 Saving the data (in UPDATE.EXE)
  437.  
  438.      The Guide! supports multiple data files, and each file may have a
  439.      50-character description associated with it.  Thus, you may maintain
  440.      several GuideNET files by choosing Manual Control in the Update option,
  441.      and selecting desired articles for each collection.
  442.  
  443.      The GuideNET name and description were defined before the system
  444.      performed the updating process.  If you wish to rename the current
  445.      GuideNET file, you may use the "Save [A]s..." function, in the <F>ile
  446.      pull-down menu, to modify the name and description.
  447.  
  448.      Before you exit UPDATE.EXE, you should save the updated GuideNET file
  449.      information either by pressing [F3] or by using one of the Save
  450.      commands from the <F>ile pull-down menu.
  451.  
  452.  
  453.  
  454. 3.0 Search and query (in GUIDE.EXE)
  455.  
  456.      These functions are performed in the GUIDE.EXE article reader program.
  457.      At the DOS prompt, type [ GUIDE ] to load the program.  After the
  458.      welcoming "Don't Panic!" title screen, you will see the GuideNET
  459.      index.  Press [Esc] or click on the [ Cancel ] button to bypass
  460.      this screen.
  461.  
  462.      Pull down the <S>earch | <G>o! menu, or use the hot-key F8, to define
  463.      the various search parameters you wish to use.  These parameters can
  464.      even be saved so you may restore them later.
  465.  
  466.      Note that these parameters are conjunctive; that is, if you define a
  467.      string for specific titles (ie, "Bob") AND a particular author string
  468.      (ie, "Joe"), then the search will return only the artitles with "Bob"
  469.      somewhere in its title AND "Joe" somewhere in the author field, not
  470.      EITHER.  Thus, the more parameters you define, the more specific your
  471.      search becomes.
  472.  
  473.      Selecting "Go!" first displays the Define Search Parameters dialog
  474.      box, which is used to narrow the search.  When you press [Enter] or
  475.      G[O], the system generates the complete list of all entries which match
  476.      your current Search parameters.  This list is presented in a dialog
  477.      box, from which you may select the desired article(s).
  478.  
  479.      "Continue" will display the current list of matching articles, which
  480.      was generated with the most recent "Go!" command.  This option does not
  481.      re-generate the matching articles list; it simply allows you to proceed
  482.      with the current match list.
  483.  
  484.      The index and cross-references, as well as both forward and backward
  485.      browsing, are accessed through the <C>onsult menu, and also through
  486.      their respective hot-keys.  In addition, "Browse backward/forward"
  487.      buttons are defined on the bottom "status line" for mouse-users.
  488.  
  489.      The index list, cross-reference list, table of contents, and search
  490.      results list are shown in "list-boxes".  These list-boxes support
  491.      multiple-key "speed searching."  Thus, if you press either [ R ] or
  492.      [ r ], the highlight bar moves to the first entry beginning with the
  493.      letter "R" (if available).  Then, pressing [ I ] or [ i ] moves the
  494.      highlight bar to the first entry beginning with "RI" (if availble),
  495.      etc.  Press any non-character key (ie, Backspace, Arrow keys,
  496.      Home/End/PgUp/PgDn, etc) to clear the search buffer.
  497.  
  498.  
  499.  
  500. 4.0 Print and save
  501.  
  502.      You can print and save the active entry (ie, the current on-screen
  503.      article, which is "active" with its window boarder highlighted).  The
  504.      output of Print and Save (both accessed from the <W>indow menu, and
  505.      also via hot-keys) is similar to what is diaplayed on-screen.
  506.  
  507.      "Print" formats the article with margins, and sends it to the port of
  508.      your choice: LPT1, LPT2, or LPT3.  The default is LPT1.  (This output
  509.      can be redirected to one of the COM, ie serial, ports by using the MODE
  510.      command supplied with DOS.)
  511.  
  512.      Three "check-box" options are available in the Print dialog box --
  513.           1. Page numbers may be added to the bottom of each page.  The
  514.                default is 'on', which does print page numbers.
  515.           2. "Graphical" lines may be used instead of ASCII lines.  The
  516.                default is 'on', which enables graphics characters.
  517.           3. Compressed printing (132 col) instead of normal print (80 col).
  518.                The default is 'off', which retains normal printing.
  519.  
  520.      In addition, you may specify the appropriate printer type at the bottom
  521.      of the Print dialog.  In particular, TG! supports dot-matrix printers
  522.      (which are compatable with the IBM ProPrinter) and laser printers (which
  523.      are compatable with the HP LaserJet series).  The default is dot-matrix.
  524.  
  525.      The print engine in TG! automatically enables the Compressed Printing
  526.      option if the article exceeds 80 characters in width; likewise, it
  527.      disables the option if compressed print is not required.  You may
  528.      always over-ride this default before clicking/selecting Ok.
  529.  
  530.      "Save" asks you for a destination file name, which is created as a
  531.      standard ASCII file.
  532.  
  533.  
  534.  
  535. 5.0 Optimizing The Guide!
  536.  
  537.      The Guide! does not like to work on floppy-disks.  Thus, PLEASE install
  538.      the system on your hard disk.  However, if you insist on diskettes,
  539.      TG! is operational, but is rather S-L-O-W (because of the very poor
  540.      access times of diskettes).
  541.  
  542.  
  543.  
  544. 5.1 Hard disk stuff
  545.  
  546.      The Guide! performs a lot of disk reads and writes, as it retrieves its
  547.      data.  Thus, I STRONGLY recommend that those with EMS/XMS memory use a
  548.      disk-caching utility to improve disk access.  DOS 4 & 5 ship with one
  549.      ("SmartDrive"), but third-party utilities are much better.
  550.  
  551.           Blatant but unreimbursed plug:
  552.  
  553.           I use the Norton Utility 6.0's Norton Cache, since it can perform
  554.           disk writes IN THE BACKGROUND after telling the program that the
  555.           writing is done; thus, TG! completes its Updating VERY QUICKLY
  556.           since it doesn't have to wait for the disk writing to be completed
  557.           (the cache does all the writing in one big chunk, instead of file-
  558.           by-file, in the background after a specified time-delay).
  559.  
  560.           The SMARTDRV.EXE version 4.0, which ships with the new MS Windows
  561.           3.1, also supports this write-behind feature, but I prefer NC for
  562.           other reasons as well.
  563.  
  564.  
  565.  
  566. 5.2 Memory stuff
  567.  
  568.      As far as memory itself goes, PLEASE upgrade to DOS 5.0 (or else stick
  569.      with DOS 3.3, if you don't have a 286/386/486, etc) and try to give
  570.      yourself as much memory as possible (by either loading your TSR's, etc
  571.      into high memory, or not load 'em at all).  Also, other optimizations
  572.      can be made in your CONFIG.SYS (exmaples: reduce Buffers to 5 or 10 if
  573.      you use a disk-cache; reduce Stacks to 0,0 unless Windows complains;
  574.      set LastDrive to the last drive you really use, like D or E; etc).
  575.  
  576.      Consult your DOS manual for tips on how to optimize your system (my 386
  577.      has 635k free conventional memory, cos everything's pretty much optimal
  578.      in the UMB's).  I recommend third-party memory-management software,
  579.      like Quarterdeck's QEMM 6.02, instead of DOS's HIMEM and EMM386.
  580.  
  581.  
  582.  
  583. 6.0 Testimonials...
  584.  
  585.      (written by fellow TG! user Ronald Larsen, of Oregon, USA)
  586.  
  587.      Other Uses for the The Guide! software:
  588.      ---------------------------------------
  589.  
  590.      In a network environment, The Guide! can be an extremely
  591.      astoundingly useful program to provide documentation for network
  592.      setups, help files, and other inestimable information.  In one
  593.      such lab (deliberate plug: the Social Sciences Instructional Lab
  594.      at the University of Oregon), The Guide! has been used for just
  595.      this purpose.  Our purpose in using an on-line information source
  596.      like The Guide! is to provide quick (and [hopefully] organized)
  597.      troubleshooting information for lab staff, and to provide a basic
  598.      training source for new lab staff.  The Guide! has even proven
  599.      robust enough to survive the savageries of windows.  To spread
  600.      out our limited knowledge as far as possible, we allow all users
  601.      in the Lab to access and browse through The Guide! articles.
  602.  
  603.      In place of the articles -- with two exceptions -- that come with
  604.      the program (conventently located at an FTP site near you), new
  605.      articles have been written covering such topics as:  Hours of
  606.      Operation, Network Configuration, Conventions of Naming Users,
  607.      Policies on Assigning Rights to Users and Groups, etc.  The
  608.      exceptional articles retained from the original group of articles
  609.      are The Guide! documentation and the article outlining the format
  610.      of articles.  The former is retained for obvious reasons.  The
  611.      latter is to encourage lab staff and other concerned citizens to
  612.      contribute articles to the network supervisor for inclusion.
  613.  
  614.      On the technical side (running Netware 3.11), The Guide! is
  615.      located in a sub-directory off the first network drive, flagged
  616.      as READ-ONLY.  All users may Read and Scan these files, rights
  617.      assigned to the EVERYONE group.  The UPDATE.EXE file is kept in a
  618.      sub-directory where only the supervisor has access.  A general
  619.      master archive file, for use with a normal word processor, is
  620.      also kept in this directory.  New and modified articles are cut
  621.      and pasted into a new update file.  When updating The Guide!, the
  622.      READ-ONLY flags are removed, and UPDATE.EXE and the updated
  623.      articles file are copied back into this sub-directory (done
  624.      through a batch file).  UPDATE is then run, taking advantage of
  625.      the Numbered Update option.  When the Update is done, the files
  626.      copied from elsewhere are deleted and the Read-Only flag is re-
  627.      set on all files.
  628.  
  629.      In our use of The Guide!, due to the sheer number of articles,
  630.      there are four GuideNets, named:  Hardware, Netware, Policies,
  631.      and Software.
  632.  
  633.      HARDWARE:  We use this guide to cover topics relating only to the
  634.      hardware in the lab.  Currently, this includes:  (a) inventories
  635.      with serial numbers and configurations;  (b) possible problems
  636.      with the hardware (especially the &$#+^%@(* printers);  and (c)
  637.      how to connect occasional equipment (such as a screen projector).
  638.  
  639.      NETWARE:  This GuideNet covers our specific configuration, such
  640.      as the various NLMs we normally load, Printer Configurations, and
  641.      other trivialities.
  642.  
  643.      POLICIES:  The GuideNet is required reading for all lab staff.
  644.      In this GuideNet, we cover all the policies they are expected to
  645.      follow;  such as: (a) Closing Procedures;  (b) various charges
  646.      and rates for materials or services;  (c) hours;  and (d) general
  647.      conduct in the Lab.
  648.  
  649.      SOFTWARE:  None of the articles are meant to replace any of the
  650.      manuals or other software documentation that normally comes with
  651.      the programs used on the network;  rather, the articles that
  652.      cover specific programs discuss:  (a) the special tweaking that
  653.      was necessary to get the program to run on the network;  (b)
  654.      specific problems encountered in running a program, and if known,
  655.      solutions;  (c) the vulgarities of the batch files that launch a
  656.      program from the users' menus;  and (d) registration information
  657.      (i.e., serial number and number of licenses).
  658.  
  659. --
  660. +--------------------------------------------------------------------------+
  661. | Ronald Larsen                    | BITNET: RSLARSEN@OREGON.UOREGON.EDU   |
  662. | Social Science Instructional Lab | ccmail: Ron_Larsen@ccmail.uoregon.edu |
  663. | 72 Prince Lucian Campbell Hall   | Voice:  503 346 2547                  |
  664. | University of Oregon (OR-A-GUN)  |                                       |
  665. | Eugene, Oregon 97403             | Personal:  HEY YOU!                   |
  666. +--------------------------------------------------------------------------+
  667.  
  668.  
  669.  
  670. 7.0 Conclusions
  671.  
  672.      The Guide! was written with "Borland Pascal with Objects 7.0" using the
  673.      Turbo Vision Object-Oriented Programming tools on a clone 386/33 system.
  674.  
  675.      The quotes you'll see as part of the various error messages were
  676.      lifted from _The Original HitchHiker Radio Scripts_ by Douglas Adams
  677.      (with a few from his "HitchHiker's Guide" book series to boot).
  678.  
  679.      I could add lotsa bells and whistles, like SoundBlaster/AdLib support,
  680.      and have it plot some nifty fractals during idle time, but I'll save
  681.      them for another day, if I even bother at all.
  682.  
  683.      Well, that's it for now... let me know what you all think about this
  684.      program... please send any comments, suggestions, questions, and/or
  685.      problems to me so we can make this program a hitchhiker's necessity,
  686.      right up there with the towel!
  687.  
  688.      PS, watch for "TG! for Windows" coming to FTP sites and BBS systems
  689.      near you *soon* (probably mid- to late-March, '93).
  690.  
  691. Steve
  692. swbaker@vela.acs.oakland.edu
  693. "Gravity brings me down..."
  694. %e
  695. *EOA*
  696.  
  697.  
  698. *
  699. * End of GUIDE.NEW
  700. *
  701.