home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / TEXT / UTILITY / AUTRD101.ZIP / MANUAL.DOC < prev    next >
Encoding:
Text File  |  1990-07-02  |  37.9 KB  |  975 lines

  1.  
  2.       ┌────────────────────────────────────────────────────────────────┐
  3.       │                                                                │
  4.       │                                                                │
  5.       │                                                                │
  6.       │                                                                │
  7.       │                         AUTOREAD                               │
  8.       │                                                                │
  9.       │    A program to allow easy reading of large text files         │
  10.       │                       on a computer                            │
  11.       │                                                                │
  12.       │                   Author: David R Grigg                        │
  13.       │                                                                │
  14.       │                        Version 1:                              │
  15.       │                        June 1990.                              │
  16.       │                                                                │
  17.       │                                                                │
  18.       │                                                                │
  19.       │                          MANUAL                                │
  20.       │                                                                │
  21.       │                                                                │
  22.       │                                                                │
  23.       └────────────────────────────────────────────────────────────────┘
  24.  
  25.  
  26.  1:  IMPORTANT NOTICE!
  27.      ═══════════════════════════════════════════════════════════════════════
  28.  
  29.       If you are reading this file on your computer in any other way
  30.       than using AUTOREAD itself, then you are losing out on the
  31.       value of AUTOREAD, and you will also not be able to try out the
  32.       software as you follow the examples given later in this
  33.       document.
  34.  
  35.       To read this document using AUTOREAD, go back to DOS and type:
  36.          AUTOREAD MANUAL.DOC  <and press the enter key>.
  37.  
  38.  
  39.  
  40.       DISCLAIMER
  41.       ══════════
  42.  
  43.       While every effort has been made to free AUTOREAD from errors,
  44.       NO RESPONSIBILITY IS ACCEPTED for any damage that may be caused
  45.       to your computer, disks or data by the use of AUTOREAD.  If this
  46.       makes you nervous, try AUTOREAD out on a floppy disk first.
  47.  
  48.  
  49.  
  50.  
  51.  2:  Introduction
  52.      ════════════════════════════════════════════════════════════════════════
  53.  
  54.       I wrote this program because I often find myself in the
  55.       situation of having a large text file on my computer's hard
  56.       disk which I am using because it has some kind of information
  57.       of value to me.  Usually it is the manual for a shareware
  58.       program.
  59.  
  60.       I adore shareware.  I think the concept of trusting people to
  61.       pay a modest fee for software they genuinely find useful is
  62.       terrific.  And I use a lot of shareware (and pay the
  63.       appropriate registration fees).
  64.  
  65.       But the manuals for most shareware programs are distributed as
  66.       a text file unless you pay extra (and I generally don't).  So I
  67.       end up with very useful manuals in a very NON-useful form: a
  68.       large text file on my hard disk.
  69.  
  70.       Sure, I can print out the manual, but this can consume enormous
  71.       amounts of time, paper and printer ribbons (the QEDIT manual,
  72.       for example, is some 5500 lines long).  And besides, I can
  73.       never find the manual when I want it.  And even if I can,
  74.       finding the information I want can be very hard.
  75.  
  76.       Aren't computers supposed to make life easier?  Yet reading a
  77.       document on a computer screen is still extremely primitive.
  78.       Certainly you can use a useful utility like LIST, but this is
  79.       still missing something.  It's hard to navigate around in a
  80.       large text file, to find the next chapter, or to locate key
  81.       words.  Using the FIND utility in such programs is some help,
  82.       of course, but you have to type in the key word, and hope you
  83.       have spelt and punctuated it properly.
  84.  
  85.       AUTOREAD is my attempt to fill this perceived gap.  It works
  86.       very much like LIST, but it allows you to progressively
  87.       establish landmarks in the text and to go instantly to them.
  88.  
  89.       AUTOREAD allows the creation of several kinds of 'landmarks':
  90.  
  91.          * Chapter Stops
  92.  
  93.          * Pre-defined Keywords
  94.  
  95.          * Temporary Bookmarks
  96.  
  97.       These are all available via pull-down menus for easiest
  98.       possible use.
  99.  
  100.       What all this means is that you can very easily create a
  101.       comprehensive index to a particular text file, enabling you to
  102.       instantly find the section or information you are looking for.
  103.       It makes reading a text file on your computer as easy as
  104.       reading a hard copy, and in some respects easier.
  105.  
  106.  
  107.  3:  Shareware Notice
  108.      ══════════════════════════════════════════════════════════════════════
  109.  
  110.       AUTOREAD took a lot of effort to create.  And I am still
  111.       working on improving it.
  112.  
  113.       Please note that AUTOREAD is not, never has been, and never
  114.       will be free or public domain software.  It is shareware.
  115.  
  116.       The shareware concept is extremely simple.  If you obtain a
  117.       copy of a shareware program, find it useful to you, and wish to
  118.       continue using it, you must send the requested shareware fee to
  119.       the program author.
  120.  
  121.       Shareware relies entirely on trust.  But it is a concept which
  122.       has allowed the creation and distribution of a large body of
  123.       excellent software at very low cost.
  124.  
  125.       If you find AUTOREAD of use, please print out and fill in the
  126.       enclosed LICENSE.DOC document, and send it with the requested
  127.       $15 shareware fee to:
  128.  
  129.                   David R Grigg,
  130.                   1556 Main Road,
  131.                   Research,
  132.                   Victoria 3095
  133.                   Australia.
  134.  
  135.      NOTE:
  136.  
  137.      Most commercial software forbids you to make copies of it.
  138.      But because AUTOREAD is shareware software, you are positively ENCOURAGED
  139.      to share copies of AUTOREAD around, copy it for your friends,
  140.      upload it to bulletin boards, etc.  The only stipulations are that
  141.      all those who use AUTOREAD for longer than a trial period of 14 days
  142.      must pay the required shareware fee, and that AUTOREAD must be
  143.      distributed with all the associated files, being:
  144.  
  145.                     AUTOREAD EXE
  146.                     LICENSE  DOC
  147.                     MANUAL   ARD
  148.                     MANUAL   DOC
  149.                     MANUAL   IDX
  150.                     README   BAT
  151.                     STATS    DOC
  152.                     STATS    EXE
  153.  
  154.  
  155.  
  156.  
  157.  4:  Installing AUTOREAD
  158.      ══════════════════════════════════════════════════════════════════════
  159.  
  160.       AUTOREAD is extremely easy to install.
  161.  
  162.       The only file absolutely necessary to operating AUTOREAD is
  163.       AUTOREAD.EXE, which you should copy either into the same
  164.       directory as the documents you wish to use it on, or
  165.       (especially if you have a hard disk) into a directory which is
  166.       listed in your DOS PATH command (this is usually specified in
  167.       your AUTOEXEC.BAT file).
  168.  
  169.       Many hard disk users have a directory called \TOOLS on their
  170.       hard disk.  This is a good place for AUTOREAD.
  171.  
  172.       To use AUTOREAD on a particular text file (as an example, say a
  173.       file called MANUAL.DOC), you would enter the following at the
  174.       DOS prompt:
  175.  
  176.               AUTOREAD MANUAL.DOC
  177.  
  178.       If you don't enter the file name, you will be prompted for it.
  179.  
  180.  
  181.  5:  Files Created by AUTOREAD
  182.      ══════════════════════════════════════════════════════════════════════
  183.  
  184.       AUTOREAD maintains two different files of its own for every
  185.       text file that you use it on.
  186.  
  187.       If you used it on a document called MANUAL.DOC, for example,
  188.       AUTOREAD would create the following files:
  189.  
  190.            MANUAL.IDX
  191.            MANUAL.ARD
  192.  
  193.       Unless you have changed the textfile since you last read it,
  194.       the .IDX file will be created only the first time you use
  195.       AUTOREAD on the text file.  The .ARD file, however, is
  196.       constantly read and rewritten.
  197.  
  198.       The .IDX file is an index of the starting points of each line
  199.       of the text file, and enables AUTOREAD to very speedily locate
  200.       parts of the file.  If it offends you to have a lot of
  201.       additional files in a directory, you can delete this file, but
  202.       then AUTOREAD will need to recreate it each time you access the
  203.       text file that it indexes.
  204.  
  205.       The .ARD file contains such data as the current location in the
  206.       file, a list of chapter stops and their starting lines, and a
  207.       list of keywords.  Note that the .ARD file is an ordinary text
  208.       file, which means that you can use a text editor to manipulate
  209.       it directly.
  210.  
  211.  
  212.            NOTE:
  213.  
  214.            If you just wish to use AUTOREAD quickly on a small file
  215.            you wish to look at but will probably never wish to fully
  216.            index and set up chapter stops on, you can append an
  217.            option, -Q, to the command line, eg:
  218.  
  219.               AUTOREAD MANUAL.DOC -Q
  220.  
  221.            This ensures that AUTOREAD will get rid of its .IDX file
  222.            on exit, and will not access or create an .ARD file.
  223.  
  224.  
  225.  6:  The AUTOREAD screen
  226.      ══════════════════════════════════════════════════════════════════════
  227.  
  228.       If you are using AUTOREAD to read this manual, you are already in the
  229.       default screen mode - Display Mode.
  230.  
  231.     6.1  Display Mode
  232.          ──────────────────────────────────────────────────────────────────
  233.  
  234.          This is the DISPLAY mode of AUTOREAD.  Note the top line, in
  235.          reverse colours, which indicates that you can press the
  236.          ESCAPE or ESC key to bring up the AUTOREAD Menu Bar, or hold
  237.          down the ALT key and then the press the X key on your
  238.          keyboard to exit AUTOREAD.
  239.  
  240.               NOTE:
  241.  
  242.               It is most important to exit AUTOREAD in the standard
  243.               way, by pressing Alt-X.  Doing this saves important
  244.               information.  If you exit in any other way (ie, by
  245.               simply turning off the computer, or by rebooting), this
  246.               information will not be saved.
  247.  
  248.          At the bottom line of the screen you will see information on
  249.          the current line number, the current search direction, and
  250.          the pathname of the file being read.
  251.  
  252.  
  253.     6.2  Menu Mode
  254.          ─────────────────────────────────────────────────────────────────
  255.  
  256.          Pressing ESC changes the top line of the screen to a Menu
  257.          Bar.  See the section on The AUTOREAD Menu Bar for further
  258.          information.
  259.  
  260.  
  261.  
  262.  7:  Moving Around in Your Document
  263.      ══════════════════════════════════════════════════════════════════════
  264.  
  265.       The up and down arrow keys on your keyboard will scroll the
  266.       text on your screen in the indicated direction.
  267.  
  268.       Pressing PAGE UP on your keyboard will move to the previous
  269.       screen-full of information. (Unless you are at the start of the
  270.       file, of course).
  271.  
  272.       Pressing PAGE DOWN on your keyboard will move to the following
  273.       screen-full of information. (Unless you are at the end of the
  274.       file, of course).
  275.  
  276.       Holding down the Control (CTRL) key on your keyboard and
  277.       pressing HOME will go to the start of the file.
  278.  
  279.       Holding down the Control (CTRL) key on your keyboard and
  280.       pressing END will go to the end of the file.
  281.  
  282.       It is also possible to move to specific areas of the file by
  283.       using the AUTOREAD menu bar (see next section).
  284.  
  285.  
  286.  
  287.  8:  The AUTOREAD Menu Bar
  288.      ══════════════════════════════════════════════════════════════════════
  289.  
  290.       You can call up the AUTOREAD menu bar simply by pressing the
  291.       Escape (ESC) key on your keyboard.
  292.  
  293.       The top line of your screen will alter to show a series of menu
  294.       choices, like this:
  295.     ┌────────────────────────────────────────────────────────────────────────┐
  296.     │ AUTOREAD:     Go    Chapter    Keyword    Mark    Find    Screen    ???│
  297.     └────────────────────────────────────────────────────────────────────────┘
  298.  
  299.       The first entry will be highlighted.  You can move
  300.       the highlight by pressing the left and right arrow keys on your
  301.       keyboard.
  302.  
  303.       When the entry you want is highlighted, press the ENTER key on
  304.       your keyboard, and a sub-menu will appear.
  305.  
  306.       Alternatively, you can simply press the first letter of your
  307.       menu choice, and the sub-menu will immediately appear.  To
  308.       activate the Keywords sub-menu, for example, simply press the
  309.       'K' key on your keyboard.
  310.  
  311.       What follows is a brief description of each of the sub-menus
  312.       and what they do.  More detailed explanations are in following
  313.       chapters.
  314.  
  315.  
  316.     8.1  Go
  317.          ─────────────────────────────────────────────────────────────────
  318.  
  319.          The Go menu allows you to move quickly to different
  320.          positions in the file: the beginning, the middle, the end,
  321.          or to a specific line number.
  322.  
  323.  
  324.     8.2  Chapters
  325.          ─────────────────────────────────────────────────────────────────
  326.  
  327.          This is perhaps the most powerful part of AUTOREAD.  This
  328.          menu allows you to find instantly any one of up to 200
  329.          'chapter stops', by selecting a description from a pull-down
  330.          menu.  They are called 'chapter stops' because the idea is
  331.          that you can set up such stops at the beginning of chapters
  332.          or major sections in the document.
  333.  
  334.          This menu allows you to find, create, delete or change an
  335.          existing chapter stop.
  336.  
  337.          It also allows you to clear all existing chapter stops, or
  338.          to automatically make chapter stops at standard points in a
  339.          document.
  340.  
  341.  
  342.     8.3  Keywords
  343.          ─────────────────────────────────────────────────────────────────
  344.  
  345.          An AUTOREAD keyword is like a FIND command for pre-defined
  346.          strings.  It means you can create a list of common or
  347.          especially important words, perhaps from the index of the
  348.          manual, and quickly point to them.  Once you have chosen a
  349.          keyword to find, AUTOREAD will quickly scan the file looking
  350.          for the next occurrence of that keyword.
  351.  
  352.          Note that you can alter the direction of the search from
  353.          this menu.
  354.  
  355.          This menu allows you to find, create, or delete keywords.
  356.  
  357.  
  358.     8.4  Marks
  359.          ─────────────────────────────────────────────────────────────────
  360.  
  361.          'Marks' is short for 'bookmarks'.  They work in a very
  362.          similar way to chapter stops, except that they are temporary
  363.          (they vanish when you exit AUTOREAD), and the listing
  364.          entries simply give the bookmark number and the line number,
  365.          rather than a description.
  366.  
  367.          Bookmarks are intended as a quick way of placing a marker in
  368.          the text while you look for some other information, and then
  369.          being able to quickly return to where you left off.
  370.  
  371.          Note also that when you exit AUTOREAD, the current position
  372.          in the file when you exited is stored, so that the next time
  373.          you use AUTOREAD to read the file, the screen will be the
  374.          same as when you exited the previous time.
  375.  
  376.  
  377.     8.5  Find
  378.          ─────────────────────────────────────────────────────────────────
  379.  
  380.          This menu lets you search for any text (not a pre-defined
  381.          keyword).
  382.  
  383.          You can specify the direction of search from this menu.
  384.  
  385.  
  386.     8.6  Screen
  387.          ─────────────────────────────────────────────────────────────────
  388.  
  389.          This menu simply allows you to set the foreground colour and
  390.          background colour of the text on the screen.
  391.  
  392.  
  393.     8.7  ???
  394.          ─────────────────────────────────────────────────────────────────
  395.  
  396.          Choosing this option will bring up an information screen
  397.          about AUTOREAD.  It is not a help screen (this may be built
  398.          into later versions of AUTOREAD).
  399.  
  400.  
  401.  9:  Go Menu
  402.      ══════════════════════════════════════════════════════════════════════
  403.  
  404.       The Go Menu looks like this:
  405.  
  406.          ┌──────────────┐
  407.          │ Top    ^Home │
  408.          │ Middle   -   │
  409.          │ End    ^End  │
  410.          │ ------------ │
  411.          │ Line Number  │
  412.          └──────────────┘
  413.  
  414.       Move the highlight around with the up and down arrow keys.
  415.       When it is on the selection you want, press ENTER on the
  416.       keyboard.  Alternatively, simply enter the first letter of your
  417.       choice.
  418.  
  419.       You will note next to some of the entries their 'short forms',
  420.       eg for Top you will also see ^Home.  This means that you can
  421.       enter the short form and have the action take place immediately
  422.       without needing to call up the AUTOREAD Menu Bar.  In other
  423.       words, to go to the top (or start) of a file, you can either
  424.       press ESC to get the Menu Bar, then G for the Go Menu, then T
  425.       for top, or simply press down the Control Key on your keyboard
  426.       and then the HOME key.
  427.  
  428.       This menu should be self-explanatory:
  429.  
  430.  
  431.     9.1  Top      (^Home)
  432.          ─────────────────────────────────────────────────────────────────
  433.  
  434.          Goes to the start of the file.
  435.  
  436.  
  437.     9.2  Middle
  438.          ─────────────────────────────────────────────────────────────────
  439.  
  440.          Goes to the very middle line of the file.
  441.  
  442.  
  443.     9.3  Bottom    (^End)
  444.          ─────────────────────────────────────────────────────────────────
  445.  
  446.          Goes to the end of the file.
  447.  
  448.  
  449.     9.4  Line Number
  450.          ─────────────────────────────────────────────────────────────────
  451.  
  452.          Lets you enter and go to a particular line number in the
  453.          file.
  454.  
  455.  
  456. 10:  Chapters Menu
  457.      ══════════════════════════════════════════════════════════════════════
  458.  
  459.       The Chapters Menu looks like this:
  460.  
  461.            ┌────────────┐
  462.            │ Find    F2 │
  463.            │ Add        │
  464.            │ Change     │
  465.            │ Delete     │
  466.            │ ---------- │
  467.            │ Clear      │
  468.            │ Make       │
  469.            └────────────┘
  470.  
  471.       As indicated earlier, 'Chapter Stops' are perhaps the most
  472.       powerful part of AUTOREAD.  You can use it to move instantly to
  473.       the beginning of various chapters or sections within the text
  474.       file.
  475.  
  476.       This menu allows you to find instantly any one of up to 200
  477.       'chapter stops', by selecting a description from a pull-down
  478.       menu.
  479.  
  480.       The Chapters Menu also allows you to add, change and delete
  481.       such chapter stops, as described below:
  482.  
  483.  
  484.    10.1  Find   (F2)
  485.         ─────────────────────────────────────────────────────────────────
  486.  
  487.          This brings up a menu of the existing chapter stops.  You
  488.          can move the highlight to the wanted chapter stop by using
  489.          the up and down arrow keys.  Note that if there are enough
  490.          chapter stops, the listing will scroll up and down within
  491.          the box.  You can also use PAGE UP and PAGE DOWN to move
  492.          through the listing.
  493.  
  494.          Once you have selected your desired chapter stop, press
  495.          ENTER, and the screen will immediately fill with the text
  496.          starting at the desired chapter stop.
  497.  
  498.  
  499.    10.2  Add Current
  500.         ─────────────────────────────────────────────────────────────────
  501.  
  502.          This allows you to set the current line (that is, the line
  503.          currently at the top of the display screen) as a chapter
  504.          stop.  You will be prompted for a description.
  505.  
  506.  
  507.    10.3  Delete
  508.         ─────────────────────────────────────────────────────────────────
  509.  
  510.          This will allow you to get rid of a particular chapter stop,
  511.          which you identify from the same pull-down menu as for the
  512.          Find function.
  513.  
  514.          You will be prompted to confirm the delete.
  515.  
  516.  
  517.    10.4  Change
  518.         ─────────────────────────────────────────────────────────────────
  519.  
  520.          This will allow you to edit the description of a particular
  521.          chapter stop, which you identify from the same pull-down
  522.          menu as for the Find function.
  523.  
  524.          Note that in this version of AUTOREAD, Change does not allow
  525.          you to alter the line number of a chapter stop.
  526.  
  527.  
  528.    10.5  Clear
  529.         ─────────────────────────────────────────────────────────────────
  530.  
  531.          This allows you to get rid of ALL current chapter stops.
  532.          Please use this carefully!
  533.  
  534.          You will be prompted to confirm the clear.
  535.  
  536.  
  537.  
  538.    10.6  Make
  539.         ─────────────────────────────────────────────────────────────────
  540.  
  541.          This is an extremely powerful utility, and makes the job of
  542.          creating chapter stops in an existing document extremely
  543.          easy, particularly if the document author has used a
  544.          standard way of identifying chapter or section beginnings.
  545.  
  546.          Make allows you to scan the whole document, looking for a
  547.          designated string of text, and setting a chapter stop once
  548.          it has found it.  It is possible to set a line offset from
  549.          the searched for text, and a prefix for the description.
  550.  
  551.          An example will make this easy to understand.
  552.  
  553.  
  554.     10.6.1  A Make Example
  555.  
  556.             One of the first documents I used AUTOREAD on myself was
  557.             the manual for the excellent shareware text editor QEDIT.
  558.             This manual is some 5500 lines long.
  559.  
  560.             The document author had used a line of equal signs '===='
  561.             to underline each chapter heading, and a graphic line
  562.             '────' to underline each section heading.
  563.  
  564.             I first made a pass with Make, searching for the line of
  565.             equal signs.
  566.  
  567.             Once I selected Make, I was prompted for the text string
  568.             to search for.  I entered four equal signs, =====.
  569.  
  570.             I was then prompted for a line offset.  This allows you
  571.             to specify a line OTHER than the one on which the text
  572.             string was found as the actual chapter stop.  In my case,
  573.             since the wanted line was the line immediately ABOVE the
  574.             line of equal signs, I entered an offset of -1.  (If I
  575.             had wanted the line of equal signs itself, I would have
  576.             entered 0).
  577.  
  578.             I was then prompted for a prefix string.  The real value
  579.             of this is for sections or sub-sections, so I simply
  580.             pressed ENTER instead of entering a prefix.
  581.  
  582.             The program then took about 30 seconds to scan through
  583.             the whole QEDIT document and set up the chapter stops.
  584.             AUTOREAD took the first text on the line I indicated I
  585.             wanted the chapter stop on, and used this as its
  586.             description for that chapter stop.
  587.  
  588.             I then wanted to set up sections as chapter stops, so I
  589.             carried out another pass with Make.
  590.  
  591.             Once I selected Make, I was prompted for the text string
  592.             to search for.  I entered four graphic line characters,
  593.             '────'.  (I used the ALT key and the numeric keyboard to
  594.             enter these characters - refer you DOS manual if you
  595.             don't know how to do this).
  596.  
  597.             I was then prompted for a line offset.  As again the
  598.             wanted line was the one above the graphic line, I entered
  599.             an offset of -1.
  600.  
  601.             I was then prompted for a prefix string.  I now wanted to
  602.             use this feature, to distinguish the section headings
  603.             from the chapter headings in the Find Chapter pull-down
  604.             menu.  So I entered a hyphen and a space, '- '.  These
  605.             characters were placed before the description for all the
  606.             chapter stops created during this Make pass.
  607.  
  608.             Another 30-40 seconds, and I had essentially the
  609.             equivalent of the contents page of the manual in the form
  610.             of a pull-down menu.
  611.  
  612.             Here is part of the chapter stops menu I created for
  613.             QEDIT.DOC:
  614.  
  615.             ┌──────────────────────────────────────────┐
  616.             │ - COLORS                                 │
  617.             │ - TABLE OF CONTENTS                      │
  618.             │ - ACKNOWLEDGEMENTS                       │
  619.             │ - INTRODUCTION                           │
  620.             │ - FEATURES                               │
  621.             │ - SYSTEM REQUIREMENTS                    │
  622.             │ - INSTALLATION                           │
  623.             │ CHAPTER 1. USERS GUIDE FOR QEDIT         │
  624.             │ - QUICK START                            │
  625.             │ - MENUS                                  │
  626.             │ - THE STATUS LINE                        │
  627.             │ - FILES                                  │
  628.             │ - VIEWING AND GETTING AROUND IN THE TEX  │
  629.             │ - CURSOR MOVEMENT                        │
  630.             │ - USING WINDOWS                          │
  631.             └──────────────────────────────────────────┘
  632.  
  633.    10.7  Make is extremely useful if you are the author of a document
  634.          you want to use AUTOREAD with, and you need to make changes
  635.          to the document after you have already used AUTOREAD on it.
  636.          You can Clear the existing chapter stops, and use Make, to
  637.          very quickly re-establish those stops at new line numbers,
  638.          provided you have used some consistent means of identifying
  639.          chapters and sections.
  640.  
  641.          This means need not be types of underline, as in the example
  642.          above, but could be the word CHAPTER in capitals (Note that
  643.          Make distinguishes between upper and lower case, unlike Find
  644.          Text and Find Keyword), or a special character or series of
  645.          characters (eg ---> ).
  646.  
  647.          The best way to learn how Make works is to try it out.
  648.          Don't worry about making mistakes, you can always Clear and
  649.          start again.
  650.  
  651.  
  652.  
  653. 11:  Keywords Menu
  654.      ══════════════════════════════════════════════════════════════════════
  655.  
  656.       A keyword is simply a text string to be found in your document,
  657.       and the Find Keyword function works exactly as does the Find
  658.       Text function, except that you don't need to type in the
  659.       required text: you simply select it from a pull-down menu.
  660.  
  661.       The Index of a document is a great place to find useful
  662.       keywords.
  663.  
  664.       The Keywords Menu looks like this:
  665.  
  666.          ┌──────────────┐
  667.          │ Find    F3   │
  668.          │ Add          │
  669.          │ Delete       │
  670.          │ --------     │
  671.          │ Search DOWN  │
  672.          └──────────────┘
  673.  
  674.  
  675.    11.1  Find   (F3)
  676.         ─────────────────────────────────────────────────────────────────
  677.  
  678.          This brings up a menu of the existing keywords.  You can
  679.          move the highlight to the wanted keyword by using the up and
  680.          down arrow keys.  Note that if there are enough keywords,
  681.          the listing will scroll up and down within the box.  You can
  682.          also use PAGE UP and PAGE DOWN to move through the listing.
  683.  
  684.          Once you have selected your desired keyword, press ENTER,
  685.          and the screen will begin searching in the indicated
  686.          direction for the wanted keyword, putting up a display of
  687.          the current line number being searched.  If the keyword
  688.          cannot be found, an error message will appear.
  689.  
  690.          Note that unlike the Chapter Make command, Find Keyword
  691.          IGNORES the difference between upper and lower case.  That
  692.          is, 'DOS', 'Dos' and 'dos' will all be found by the same
  693.          keyword choice.
  694.  
  695.  
  696.    11.2  Add
  697.         ─────────────────────────────────────────────────────────────────
  698.  
  699.          This prompts you for the text of a new keyword, which will
  700.          be added to the list of existing keywords in alphabetical
  701.          order.
  702.  
  703.  
  704.    11.3  Delete
  705.         ─────────────────────────────────────────────────────────────────
  706.  
  707.          This will allow you to get rid of a particular keyword,
  708.          which you identify from the same pull-down menu as for the
  709.          Find function.
  710.  
  711.          You will be prompted to confirm the delete.
  712.  
  713.  
  714.    11.4  Search Direction
  715.         ─────────────────────────────────────────────────────────────────
  716.  
  717.          This specifies the current direction of search.  The default
  718.          is DOWN, ie searches on increasing line numbers from the current
  719.          line.
  720.  
  721.          UP searches to decreasing line numbers from the current line.
  722.  
  723.          GLOBAL searches from beginning of file.
  724.  
  725.          To toggle the direction, simply select this choice.
  726.  
  727.  
  728. 12:  Marks Menu
  729.      ══════════════════════════════════════════════════════════════════════
  730.  
  731.       Bookmarks are just like chapter stops - except that they are
  732.       volatile (they vanish when you exit AUTOREAD), and that they do
  733.       not have a description, just an ID number and a line number.
  734.  
  735.       Bookmarks are intended as quick reference points to 'hold your
  736.       place' when you are looking for something else in a file.  You
  737.       can only create a maximum of 10 bookmarks.
  738.  
  739.       The Marks Menu looks like this:
  740.  
  741.          ┌─────────────┐
  742.          │ Find    F4  │
  743.          │ Add Current │
  744.          │ Enter       │
  745.          │ Delete      │
  746.          └─────────────┘
  747.  
  748.    12.1  Find   (F4)
  749.         ─────────────────────────────────────────────────────────────────
  750.  
  751.          This brings up a menu of the existing bookmarks.  You can
  752.          move the highlight to the wanted bookmark by using the up
  753.          and down arrow keys.
  754.  
  755.          Once you have selected your desired bookmark, press ENTER,
  756.          and the screen will immediately fill with the text starting
  757.          at the desired bookmark.
  758.  
  759.  
  760.    12.2  Add Current
  761.         ─────────────────────────────────────────────────────────────────
  762.  
  763.          This allows you to set the current line (that is, the line
  764.          currently at the top of the display screen) as a bookmark.
  765.  
  766.          You will be prompted for the bookmark number you wish this
  767.          line to be recorded against.
  768.  
  769.  
  770.    12.3  Enter
  771.         ─────────────────────────────────────────────────────────────────
  772.  
  773.          This allows you to enter a line number directly for a new
  774.          bookmark (ie, you don't have to have the display showing that
  775.          line as the current line).
  776.  
  777.          You will be prompted for the bookmark number you wish this
  778.          line to be recorded against.
  779.  
  780.  
  781.    12.4  Delete
  782.         ─────────────────────────────────────────────────────────────────
  783.  
  784.          This will allow you to get rid of a particular bookmark,
  785.          which you identify from the same pull-down menu as for the
  786.          Find function.
  787.  
  788.          You will be prompted to confirm the delete.
  789.  
  790.  
  791.  
  792.    12.3  Function Key Setting & Finding Marks
  793.         ─────────────────────────────────────────────────────────────────
  794.  
  795.          Because bookmarks are mainly used for very rapid access to
  796.          temporary locations in the file, AUTOREAD allows you to
  797.          completely bypass the menu system in setting and finding
  798.          bookmarks.
  799.  
  800.          While you are in DISPLAY mode and at a point in the text you
  801.          wish to return to after looking somewhere else, hold down the
  802.          SHIFT key and one of the function keys F1..F10.  You will hear
  803.          a warbling sound, indicating that the equivalent bookmark has been
  804.          set at that point (ie, pressing Shift F2 sets bookmark 2).
  805.  
  806.          After you have browsed elsewhere, you can hold down the ALT key
  807.          and the function key (F1...F10) corresponding to the bookmark you
  808.          set previously.  You will immediately jump back to the place you
  809.          left.
  810.  
  811.          Note that you can use ALT and the function keys to jump to ANY
  812.          bookmark, whether set with SHIFT + function key or set through
  813.          the Marks menu.
  814.  
  815.  
  816.  
  817. 13:  Find Menu
  818.      ══════════════════════════════════════════════════════════════════════
  819.  
  820.       The Find Menu looks like this:
  821.  
  822.          ┌─────────────────┐
  823.          │ Find Text       │
  824.          │ Last Find:      │
  825.          │ --------------- │
  826.          │ Search DOWN     │
  827.          └─────────────────┘
  828.  
  829.  
  830.    13.1  Find Text
  831.         ─────────────────────────────────────────────────────────────────
  832.  
  833.          This will prompt you for the text to be found.
  834.  
  835.          Once you have entered your desired text, press ENTER, and
  836.          the screen will begin searching in the indicated direction
  837.          for the wanted text, putting up a display of the current
  838.          line number being searched.  If the text cannot be found, an
  839.          error message will appear.
  840.  
  841.          Note that unlike the Chapter Make command, Find Text IGNORES
  842.          the difference between upper and lower case.  That is,
  843.          'DOS', 'Dos' and 'dos' will all be found by the same keyword
  844.          choice.
  845.  
  846.  
  847.    13.2  Last Find
  848.         ─────────────────────────────────────────────────────────────────
  849.  
  850.          This retains a memory of the last text string you looked
  851.          for, and enables you to select it again.  Otherwise, it
  852.          works exactly like the Find Text command.
  853.  
  854.  
  855.    13.3  Search Direction
  856.         ─────────────────────────────────────────────────────────────────
  857.  
  858.          This specifies the current direction of search.  The default
  859.          is DOWN, ie searches on increasing line numbers.
  860.  
  861.          To toggle the direction, simply select this choice.
  862.  
  863.  
  864. 14:  Screen Menu
  865.      ══════════════════════════════════════════════════════════════════════
  866.  
  867.       This menu allows you to alter the foreground colour and
  868.       background colour of the displayed text for the duration of
  869.       your current session with AUTOREAD.
  870.  
  871.       The Screen Menu looks like this:
  872.  
  873.          ┌────────────────────────┐
  874.          │ Foreground WHITE       │
  875.          │ Background BLUE        │
  876.          └────────────────────────┘
  877.  
  878.       Note that the current colours are shown on the menu.
  879.  
  880.       Once you select the foreground or background colour, you will
  881.       be given a pull-down menu of the available colours.
  882.  
  883.       Note that the colour change does not take effect until you have
  884.       pressed ESC to return to the display mode of AUTOREAD.
  885.  
  886.  
  887. 15:  To Other Shareware Authors
  888.      ══════════════════════════════════════════════════════════════════════
  889.  
  890.       It seems to me that AUTOREAD would be an extremely useful
  891.       program to distribute with your shareware manuals on disk.
  892.  
  893.       However, it doesn't seem very fair to the users of your
  894.       software to be expected to pay a second shareware fee (to me)
  895.       for the use of AUTOREAD on your manual.
  896.  
  897.       For this reason, I will provide a special version of AUTOREAD
  898.       which will be set up to read only your manual file or files,
  899.       from the same directory as those files.  You will need to pay
  900.       me a shareware fee of $50 for this special version, and to
  901.       write to me with the names of the files you want it to be able
  902.       to read.  I will then provide you with the special version.  On
  903.       the other hand, your shareware users will need to pay no
  904.       additional fee to use AUTOREAD on your manual.
  905.  
  906.       You will find it very easy to set up the customised version of
  907.       AUTOREAD to work with your manual, establishing chapter stops and
  908.       appropriate keywords, so that your users will find your on-disk
  909.       manual a truly easy-to-use and valuable reference.
  910.  
  911.       However, if you do not want to set up the appropriate chapter
  912.       stops and keywords yourself, for an additional $25, if you supply
  913.       me with a copy of your manual, I will establish the appropriate
  914.       chapter stops and keywords and return the appropriate files to you.
  915.  
  916.  
  917. 16:  Acknowledgements
  918.      ══════════════════════════════════════════════════════════════════════
  919.  
  920.       AUTOREAD was written using Borland's Turbo Pascal 5.5, a great
  921.       compiler which goes on getting better and better, and making me
  922.       less and less keen to move to programming in C.
  923.  
  924.       I used QEDIT Advanced 2.08 from SEMWARE as my text editor during
  925.       programming and for some of this manual.  I've also mentioned
  926.       QEDIT in a number of places in this manual, to illustrate how
  927.       AUTOREAD can be used to make access to a large text file manual
  928.       easy, and I hope SEMWARE didn't mind me doing so!
  929.  
  930.       QEDIT is the best text editor I have ever used, and spoils you
  931.       for all others.  It is shareware, and I recommend you write to
  932.       SEMWARE at 730 Elk Cove Court, Kennesaw, Ga, USA for their
  933.       current prices.
  934.  
  935.       Most of this manual was written using PC-Outline from Brown
  936.       Bag Software, also shareware, and a program I use intensively
  937.       for manuals, reports, etc, where section numbering and renumbering
  938.       is required.  Write to Brown Bag Software, PO Box 60000, San
  939.       Francisco, CA 94160-1719, USA for current prices.
  940.  
  941.  
  942. 17:  Version History
  943.      ══════════════════════════════════════════════════════════════════════
  944.  
  945.       This is version 1.01 of AUTOREAD.  There may well be a few bugs
  946.       in it.  I would be grateful if those who find such bugs could
  947.       let me know.  Similarly, if you have any ideas for ways of
  948.       improving the product, let me know.
  949.  
  950.    17.1 Updates
  951.         ─────────────────────────────────────────────────────────────────
  952.  
  953.         1.01 : (2 July 1990)
  954.  
  955.              - GLOBAL search direction added
  956.              - fix to bug allowing line 0 to be displayed in status
  957.              - fix to bug involving embedded '/' char in chapter
  958.                description
  959.  
  960.  
  961.    17.2 Planned Enhancements
  962.         ─────────────────────────────────────────────────────────────────
  963.  
  964.         In future, I plan to add the following features to AUTOREAD:
  965.  
  966.         *  Support for 43-line and 50-line screens
  967.  
  968.         *  Short-form function keys for most functions currently available
  969.            only from the menus.
  970.  
  971.         *  Auto-capture of keywords.
  972.  
  973.         *  Mouse operation.
  974.  
  975.