home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / MISC / OUT / OUTLINE.TXT < prev    next >
Encoding:
Text File  |  1993-08-25  |  20.5 KB  |  588 lines

  1.                         Outline
  2.  
  3. A shareware outliner for the Psion Series 3.
  4.  
  5. Disclaimer
  6. ==========
  7.         No warranty is given on this program. No liability for any 
  8.         damage or loss to equipment, data or software will be 
  9.         assumed.  You use this program at your own risk
  10.  
  11. Money
  12. =====
  13.         The OUTLINE program is shareware.  If you like it and use it 
  14.         after 14 days, you should send me £10.  This will ease your 
  15.         conscience and my overdraft.  I will send you a small file to 
  16.         disable the "nag" screens and show you as a registered user 
  17.         on the About screen.  If you do not have an email id, then 
  18.         please ensure I have your name and address and state whether you
  19.         have a 3.5 or 5.25 inch diskette drive (PCs only I'm afraid).
  20.         
  21.         Updates, bug-fixes etc. will be available from the lexsoft/todo 
  22.     conference on CIX.  
  23.         
  24. Errors
  25. ======
  26.         I don't know of any outstanding bugs (unless listed at the 
  27.         end of this document) but as with any piece of software I'm 
  28.         sure there are some.
  29.  
  30.         The program's error handler attempts to save the current file 
  31.         as ERROR.OUT before collapsing in the proverbial heap.  Check 
  32.         this file out if an error occurs.  If it appears ok copy it 
  33.         over your original file and continue.  Please let me know of 
  34.         any errors.
  35.  
  36. Distribution
  37. ============
  38.         This package may be freely copied, distributed as shareware so 
  39.         long as the contents remain intact and are not tampered with in
  40.         any way.
  41.  
  42.         The ZIP file should contain:
  43.                 OUTLINE.FON
  44.                 OUTNORM.FON
  45.                 OUTLINE.INI
  46.                 OUTLINE.APP
  47.                 OUTLINE1.OPA
  48.                 OUTLINE2.OPA
  49.                 OUTLINE.TXT (this file)
  50.  
  51.  
  52. INTRODUCTION
  53.  
  54. Outline is a program for the Psion Series 3 that allows you to 
  55. organise your thoughts into tree-like structures.   It is very useful 
  56. for structuring ideas or for structuring reports, meetings or 
  57. speeches.  
  58.  
  59. Type in your ideas and then move the lines around to form a tree 
  60. structure with detailed items organised under major items.  Branches 
  61. of this tree can be hidden or shown, moved to other branches etc. 
  62.  
  63. If you have not used an outliner before, don't worry, it will soon 
  64. become clear.
  65.  
  66. Similar facilities are available in most modern PC word 
  67. processors as well as dedicated PC outlining tools such as 
  68. PC-Outline.  The impetus for writing this program was to replace 
  69. the very useful Sharp IQ outliner when I moved to a Psion 
  70. Series 3.
  71.  
  72. I would be pleased to hear from anyone with ideas for enhancing
  73. the program or from anybody who, unfortunately, finds any bugs.
  74.  
  75.  
  76. INSTALLATION 
  77.  
  78. Copy the OPA files to an APP directory or another directory of 
  79. your choice on any drive.  Install the program by pressing Psion-I on 
  80. the System display, find OUTLINE and pressing Enter.  Outline behaves 
  81. just like Word, Data etc. by allowing multiple files to be open at 
  82. one time.  In technical terms, it is a type 3 OPA.
  83.  
  84. Copy the two files OUTLINE.FON and OUTNORM.FON to any \OPD 
  85. directory.
  86.  
  87. Data files are normally stored in a directory called \OUT.  
  88. Create this on any drive. Update the display by pressing the 
  89. System icon.  The program can then be started by pressing 
  90. Psion-N for a new file or moving the cursor to an existing file, 
  91. such as OUTLINE itself and pressing enter.
  92.  
  93. Outline can create a file that contains default settings to be used 
  94. for new files.  This can be created from within the program and can be 
  95. stored on any drive in a \OUT directory.  This file is called 
  96. OUTLINE.INI.
  97.  
  98. Outline checks for the presence of the font files and the .ini 
  99. file on the default drive first.  If not found there, the drives 
  100. are searched in the order Internal, A and B until found.  This 
  101. processing is carried out for each file so that each of these 
  102. files may exist on a different drive.
  103.  
  104. TUTORIAL 
  105.  
  106. Creating the First Entry
  107.  
  108.         Start an outline by positioning the highlight on the Outline 
  109.         icon and pressing Psion-N to create a new file.  Type the 
  110.         file name "test".
  111.  
  112.         The title of the outline appears at the top of the screen as 
  113.         "TEST".  To the left of this is a figure "1" which denotes 
  114.         that this entry is at level one, the top level.  To the left 
  115.         of this is the cursor (an inverse ">") which denotes the 
  116.         current line.  Change the title by pressing Enter.  An "Edit 
  117.         Entry" dialog box appears.  Type "Shopping List" and press 
  118.         Enter.  The entry which previously said "TEST", now says 
  119.         "SHOPPING LIST".
  120.  
  121. Creating the Second Entry
  122.  
  123.         Press E or Psion-E to add a new branch under the topic 
  124.         "Shopping List".  An "Enter Line" dialog box appears.  Type 
  125.         "Fruit" and press Enter.
  126.  
  127.         The new line is shown below the original line and you are 
  128.         then requested to "level the entry" (depending on the options 
  129.         settings), i.e. set the indentation level.  The new entry is 
  130.         in the right place so just press Enter.  Lines can appear on 
  131.         any level from 2 up to 256 so long as the parent of the entry 
  132.         is one less. In other words, you cannot make our new entry 
  133.         anything lower than 2. Note that only the first entry is at 
  134.         level 1.
  135.  
  136.         Add another new line by pressing E with the cursor on the 
  137.         "Fruit" item.  (You use the up and down arrow keys to move 
  138.         between items).  Type "Drink" into the "Enter Line" dialog 
  139.         box.  Level the entry such that Drink appears on the same 
  140.         level as Fruit.
  141.  
  142. Creating More Entries
  143.  
  144.         We've decided that, in general terms, we need to buy Drink 
  145.         and Fruit and now we're going to think in detail about which 
  146.         goods we're going to buy.
  147.  
  148.         We need some apples so we'll add that to the list.  Position 
  149.         the cursor to Fruit and press E.  Type "Apples" and press 
  150.         Enter. Level "Apples" indented from Fruit by pressing the 
  151.         right arrow key and pressing Enter.  Add Bananas, Oranges and 
  152.         Plums in the same way, so that they all appear under Fruit.
  153.  
  154.         We need both eating and cooking apples, so move the cursor to 
  155.         the Apples line and insert "Eating" and "Cooking" under 
  156.         (indented from) Apples.
  157.  
  158.         Now add some drinks of your choice under "Drinks".
  159.  
  160. Viewing the Outline
  161.  
  162.         We've now got quite a long list.  To get a summary press "2". 
  163.          This shows only items at level 2 or above.  Press "4","1" 
  164.         and "3" to see the effect.  End up by pressing "3".
  165.  
  166.         Notice that a "+" sign appears on the Apples line. This 
  167.         denotes that there are branches of this item which are not 
  168.         displayed.
  169.  
  170.         Position the cursor to the Apples line and press "+".  The 
  171.         hidden lines "Eating" and "Cooking"now appear and the plus 
  172.         sign disappears.
  173.  
  174.         Move the cursor to the "Fruit" line and press "-".  This 
  175.         hides the lowest branch of the Fruit "family".  Press "-" 
  176.         again to hide the next branch up.
  177.  
  178.         So, "-" and "+" hide and show one branch level at a time.  
  179.         The "*" and "/" keys show and hide all levels in the current 
  180.         branch. Try them out.
  181.  
  182. That should give you an appreciation of the most basic commands.  
  183. There are many more facilities and these are described in the 
  184. Reference section below.
  185.  
  186.  
  187. REFERENCE
  188.  
  189. In the explanations below, some terms are used which may need 
  190. In the explaining:
  191.  
  192. Family
  193.         A group of items forming a complete branch of the outline 
  194.         tree.  For example;
  195.  
  196.         1 - Shopping List
  197.           2 - Fruit
  198.             3 - Apples
  199.               4 - Eating
  200.               4 - Cooking
  201.             3 - Bananas
  202.             3 - Oranges
  203.           2 - Sugar
  204.             3 - White
  205.             3 - Brown
  206.  
  207.         In this example the "Fruit" family is the Fruit entry and all 
  208.         other entries below "Fruit" i.e.
  209.  
  210.           2 - Fruit
  211.             3 - Apples
  212.               4 - Eating
  213.               4 - Cooking
  214.             3 - Bananas
  215.             3 - Oranges
  216.  
  217.         The "Apples" family is:
  218.  
  219.             3 - Apples
  220.               4 - Eating
  221.               4 - Cooking
  222.  
  223.         A family can be just one line so "Cooking" is a family.
  224.  
  225. Parent
  226.         The parent of a family is the entry at the head.  i.e. the 
  227.         parent of the "Apples" family above is "Apples".  (All 
  228.         families in OUTLINE are one-parent families!)
  229.  
  230. Up Arrow/Down Arrow
  231.         Move the cursor to the previous or next item displayed.
  232.  
  233. E/Psion-E
  234.         Enter a new item which will be positioned under the current 
  235.         item.
  236.  
  237. Left Arrow/Right Arrow
  238.         Indent or outdent (change the level of) the current 
  239.         item.
  240.  
  241. M/Psion-M
  242.         Move the current family.  Position the cursor on the parent 
  243.         of the family that you wish to move.  Press Psion-M.  Then 
  244.         position the cursor on the line after the point at which you 
  245.         wish to move the family and press Enter.  
  246.         
  247.         Note that hidden items as well as displayed items are moved.
  248.  
  249. C/Psion-C
  250.         Copy the current family.  Processing is as for Move 
  251.         (above) except that the family is duplicated rather 
  252.         than moved. 
  253.  
  254. D/Psion-D/<-Delete
  255.         Delete the current family.  A warning prompt may be shown 
  256.         depending on your options settings (see below). Note that the 
  257.         very top level item (level 1) cannot be deleted.
  258.  
  259. L/Psion-L
  260.         Pull lines up. Deletes the current line only.  Any child 
  261.         lines move up one level.
  262.  
  263. Q/Psion-Q
  264.         Push lines down. Adds a new line at the current level and 
  265.         pushes all new child lines down.
  266.  
  267. +/Psion-+
  268.         Show another level of the current family. (see Tutorial above)
  269.  
  270. -/Psion -
  271.         Hide the lowest level of the current family.  (see Tutorial 
  272.         above)
  273.  
  274. */Psion-*
  275.         Show the entire family.
  276.  
  277. / Psion-/
  278.         Hide the entire current family (except for the top most item)
  279.  
  280. Enter/U/Psion-U
  281.         Update (edit) the text of the current item
  282.  
  283. PgUp
  284. PgDn
  285.         Move up and down one page at a time
  286.  
  287. S/Psion-S
  288.         Save the file
  289.  
  290. O/Psion-O
  291.         Open another file
  292.  
  293. N/Psion-N
  294.         Create a new file
  295.  
  296. A/Psion-A
  297.         Save the current file under, optionally, another name.
  298.  
  299. I/Psion-I
  300.         About box.  Shows version number and credits.
  301.  
  302. P/Psion-P
  303.         Prints entire outline (including all currently hidden 
  304.         items) to a parallel or serial printer or a text file.
  305.  
  306. B/Psion-B
  307.         Change Options.  
  308.  
  309.         There are two pages of options settings.  On the first page:
  310.  
  311.         i)   A header bar may be set on or off.  The header bar shows 
  312.              the current date and Outline file name.
  313.  
  314.         ii)  The font may be set to Small or Normal characters.  The 
  315.              Small character set allows more text to be displayed.
  316.  
  317.         iii) Delete Warning can be set to 0-9 or 999.  When 
  318.              deleting a family, if the number of lines to be deleted 
  319.              exceeds this number, a warning will be given.  O means 
  320.              that warnings will always be given, 999 means warnings 
  321.              will never be given.  The default is 4.
  322.  
  323.         iv)  Auto Level.  If set to "no" you will be prompted to set
  324.              the indentation level for newly entered lines.  If set
  325.              to "yes", Outline will attempt to put the new line at
  326.              a sensible level.  You can, of course,always adjust this
  327.              level.
  328.  
  329.         v)   The font for levels 1 and 2 may be set to special On or 
  330.              Off. If special is set, the first level is printed 
  331.              inverse and the second level (normal font only) is 
  332.              printed bold.  Note that this only applies when the 
  333.              Normal font is used.
  334.  
  335.         vi)  "Show Level Numbers" denotes how inverse numbers 
  336.              denoting the level of the entry are to be displayed.  If 
  337.              set to Off, then they don't appear at all.  If "On" they
  338.              appear as a leader to the entry.  If "Left" they appear 
  339.              left justified.
  340.  
  341.         On the second page:
  342.  
  343.         vii) The default characters used to denote hidden entries 
  344.              links, and leading separator characters for levels over 9
  345.              may be configured.
  346.  
  347.         viii)The character that denotes an associated note (see below)
  348.              can be configured.
  349.  
  350.         ix)  The directory in which notes are stored can be set.
  351.  
  352.         All of the settings are saved with a file so that the display 
  353.         will look the same when a file is reloaded.   The defaults 
  354.         for new files are derived from the settings held in the 
  355.         OUTLINE.INI file.
  356.  
  357. K/Psion-K
  358.         Reads, if present, the OUTLINE.INI file and allows global 
  359.         settings to be set.    As for Psion-B above except that the 
  360.         option settings are saved in OUTLINE.INI.  The directory for 
  361.         associated notes is not part of the OUTLINE.INI file but
  362.         instead is always M:\OUT.
  363.  
  364.         The settings have no effect on the current file but affect 
  365.         only new files.
  366.  
  367. Any numeric key between 1 and 9
  368.         Sets display such that only items with a level less than 
  369.         or equal to that keyed are shown.  i.e. pressing level 3 
  370.         displays only items with a level of 1, 2, or 3.  Pressing 
  371.         '9' shows all levels.
  372.  
  373. T/Psion-T
  374.         Create a link.  A link allows you to join any two items 
  375.         together so that you can use;
  376.  
  377. G/Psion-G
  378.         move between two ends of a link.
  379.  
  380. H/Psion-H
  381.         Remove Link.  Both ends of the link are removed.
  382.  
  383. ,/Psion Left Arrow
  384.         Swap family with previous family
  385.  
  386. ./Psion Right Arrow
  387.         Swap family with next family
  388.  
  389. V/Psion-V
  390.         Revert to the latest save version of the file.  Together 
  391.         with Save, this can be used as a form of "undo".
  392.  
  393. F/Psion-F
  394.         This can be used as a short cut to toggle between the two font 
  395.         sizes.
  396.  
  397. Ctrl and Psion and Up Arrow
  398.         Go to the top of the file.
  399.  
  400. W/Psion-W
  401.         Attach a note (Word document) to an entry. When this key
  402.         is pressed, a dialog box will appear which will request the
  403.         document name.  The Word application will then appear. Type
  404.         your note using all of the usual Word functions and press 
  405.         Psion-X when finished.  You will then be returned to Outline.
  406.  
  407.         If this key is pressed when a note has already been attached,
  408.         you will be positioned in Word with the note open.
  409.  
  410.         All notes will be created in the directory specified in the
  411.         Options dialogue box.  Note that if you change this directory
  412.         after notes have been created, they will become "orphaned" 
  413.         unless copied to the new directory.  Whenever a note is accessed
  414.         it is assumed to be in the default directory.
  415.  
  416. Y/Psion-Y
  417.         Delete or unlink the attached note.  A dialog box appears which
  418.         allows the note to be deleted or merely unattached from the entry.
  419.  
  420. R/Psion-R
  421.         Attach an existing note to an entry.  Again, the note must be in
  422.         the default path.  By using this option, the same note can be 
  423.         attached to multiple lines.
  424.  
  425. P/Psion-P
  426.     Print the contents of the current file to a printer or to a file.
  427.     You are offered the choice of Parallel connection, Serial connection 
  428.     or File.  Another dialog box then appears where you enter the "Lead
  429.     Character" and the List Type.  The Lead Character can be something 
  430.     like "-", and is prefixed to all printed lines.  The List Type can
  431.     be set to either "All" or "Displayed".  
  432.  
  433.     "All" shows the entire outline, including items currently hidden 
  434.     from the screen display. "Displayed" prints the items currently 
  435.     "shown" on screen.
  436.  
  437.  
  438. Most of these functions are also available from the menu.
  439.  
  440. Note that up to 70 items are allowed.  Each can be up to 50 
  441. characters long. Unregistered users will get a "nag" message when 
  442. entering all records after the first 20.
  443.  
  444.  
  445. Change History
  446. ==============
  447. 1.11    Added Tab Bar and corrected first-time only loading routine.
  448.         (22 Nov 92)
  449.  
  450. 1.12    Options Settings now saved with file so that the same options
  451.         are set when a file is reloaded.
  452.         Error fixed: Top level outline cannot now be deleted.
  453.  
  454. 1.13
  455.         Many bug fixes.
  456.         Save As and Revert options.
  457.         Small font.
  458.         Tab Bar changed to Header Bar with amended layout including time.
  459.         Configurable delete warnings.
  460.         Key usage amended to conform with Psion apps and with TODO program.
  461.         (28 Nov 92)
  462.  
  463. 1.14
  464.         ENHANCEMENTS
  465.         Open File option added
  466.         New File option added
  467.         Print File option added
  468.         Configuration options for new files can now be saved in a .INI file
  469.         Push/Pull lines facility 
  470.         All files may now exist on any drive.
  471.         Screen display speeded up by scrolling rather than redisplaying
  472.          when moving one line off the screen.
  473.         Screen display moved slightly to the left to show more of each entry
  474.         Display now more intelligent following enter line, set level and
  475.          goto link.
  476.         Headers now same as Todo program (with Todo version 1.14)
  477.         Special Fonts for levels 1 and 2 can be turned off.
  478.  
  479.         FIXES:
  480.         Pressing the '9' key now shows all levels rather than 
  481.          just levels 1-9.
  482.         Can now escape from Set Link
  483.         Error following Enter line fixed: could sometimes cause program
  484.          to abort.
  485.         (5 Dec 92)
  486.  
  487. 1.14a
  488.         FIXES
  489.         All keys should now work with CAPS LOCK on.
  490.         Credit changed to Lexsoft from John Whiting.
  491.  
  492. 1.14b
  493.         ENHANCEMENTS 
  494.         Minor Programming changes including Nag screen.
  495.  
  496. 1.14c   (18 December 1992)
  497.         FIXES
  498.         Problem with copy past end of file when using small font fixed.
  499.         Problem on Open file fixed which caused major error.
  500.  
  501.         
  502. 1.15        (31 December 1992)
  503.         ENHANCEMENTS
  504.         Notes can now be attached to any entry.
  505.         "Nag" messages appear on file opening and entry creation (after 
  506.         the first 20 entries)
  507.         Date display updated at midnight.
  508.  
  509. 1.15a        (3 January 1993)
  510.         ENHANCEMENTS
  511.         When creating note (Psion-W), program detects whether .WRD 
  512.         suffix is supplied.
  513.         Name of note on a new line not being set to blank.
  514.  
  515. 1.15b        Not released
  516.  
  517. 1.15c        (5 January 1993)
  518.         ENHANCEMENTS
  519.         Psion-R now allows existing note to be attached.
  520.         FIXES
  521.         Note path now saved with file
  522.  
  523. 1.15d   (16 January 1993)
  524.         ENHANCEMENTS
  525.         Memory Usage when application is open but dormant is reduced by 
  526.          about 10k.
  527.         Out of Memory error now displays message and allows user to shut
  528.          down existing applications before continuing.
  529.         Selection of default note path is via file selection dialog rather
  530.          than text entry.
  531.         Level number markers are now selectable.  They can be on, off or 
  532.          left justified.
  533.  
  534.         FIXES
  535.         If Psion is running in the mode where Enter closes any existing
  536.          files open for the application, then opening an existing outline or
  537.          selecting a new outline caused the open outline not to be saved.
  538.  
  539. 1.16    (19 January 1993)
  540.         ENHANCEMENTS
  541.         Up/Down cursor processing speeded up
  542.  
  543.         FIXES
  544.         Error introduced in 1.15d which caused files not to be saved if
  545.          the application is terminated from the system screen.
  546.  
  547. 1.16a   (24 January 1993)
  548.         FIXES
  549.         Fixed error in error routine which displayed "MODULE ALREADY LOADED"
  550.  
  551. 1.16b   (31 January 1993)
  552.         FIXES
  553.         Fixed error in Revert which caused spurious additional lines.
  554.  
  555. 1.16c   (2 February 1993)
  556.     ENHANCEMENTS
  557.     Removed introduction message which flashed briefly on screen at
  558.      start of program.
  559.  
  560. 1.16d   (2 May 1993)
  561.     FIXES
  562.     Fixed various obscure errors    
  563.  
  564. 1.17    (27 June 1993)
  565.     FIXES
  566.     Option to save ERROR.OUT to any drive.
  567.  
  568. 1.19    (21 August 1993)
  569.     ENHANCEMENTS
  570.     Print Option added based on previous Export option.
  571.     Top level module rewritten in C.
  572.     FIXES
  573.     Better handling of "Out of Memory" errors.
  574.  
  575. 1.19b   (24 August 1993)
  576.     FIXES
  577.     Default options set if INI file not found.
  578.  
  579. John Whiting
  580. 3 Fitzwilliam Road
  581. Colchester
  582. Essex
  583. CO3 3RZ
  584. 0206 564042
  585.  
  586. johnw@cix.compulink.co.uk
  587. 100025,3337 on Compuserve
  588.