home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / txttools / magpages.lha / Magnetic_Pages.lha / Magnetic_Pages1.30 / Organiser / Organiser.docs < prev    next >
Text File  |  1992-05-22  |  9KB  |  184 lines
  1.               M A G N E T I C  P A G E S: Organiser (V1.30)
  2.              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Introduction
  5. ~~~~~~~~~~~~
  6.     This program is used to arrange the articles of your magazine into
  7. the desired order. Basically this involves creating an ordered list of
  8. article filenames and their parent pages. This list is saved as a control
  9. file that the Displayer uses.
  10.  
  11.  
  12. Running the Organiser
  13. ~~~~~~~~~~~~~~~~~~~~~
  14.     The Organiser can be run from the CLI or Workbench. To run it from the
  15. CLI, simply type in its name. To run it from Workbench, double click on its
  16. icon.
  17.  
  18.  
  19. Using the Organiser
  20. ~~~~~~~~~~~~~~~~~~~
  21.     The Organiser is used to make a list of the articles contained in your
  22. magazine. Each entry has the AmigaDOS path/name and a Parent. The
  23. Parent is the article in the list that a reader will be taken to
  24. when they use the 'Contents' command in the Displayer. Below is a sample
  25. Control File.
  26.  
  27.     Number           Article Name                  Parent
  28.     ~~~~~~           ~~~~~~~~~~~~                  ~~~~~~
  29.       1              articles/TitlePage             2
  30.       2              articles/MainContents          1
  31.       3              articles/Editorial             2
  32.       4              articles/ArticleContents       2
  33.       5              articles/Using the Editor      4
  34.       6              articles/Reviews               2
  35.       7              articles/Magnetic Pages        6
  36.  
  37.  
  38.     If a reader, reading a review of Magnetic Pages (article 7) selected
  39. the 'Contents' command, they would be taken to Reviews (article 6). To get
  40. back to the MainContents (article 2) they could again use the 'Contents'
  41. command.
  42.  
  43.  
  44. Menu Commands
  45. ~~~~~~~~~~~~~
  46.  
  47.     Just about all commands are accessed through menus. Most commands have
  48. keyboard equivalents, which can be used when you become familiar with the
  49. Organiser.
  50.  
  51. Project
  52.  
  53.     New     - Allows you to create a new list from scratch. The current list
  54.               will be erased. If you haven't saved the current list, you
  55.               will be asked if you want to continue with the operation.
  56.  
  57.     Open    - Allows you to load a control file from disk. A file requester
  58.               will prompt you for a filename.
  59.               Keyboard Equivalent: Right Amiga - O
  60.  
  61.     Save    - Allows you to quickly save any changes to the current control
  62.               file.
  63.               Keyboard Equivalent: Right Amiga - S
  64.  
  65.     Save As - Allows you to save your current list as a control file. A file
  66.               requester will prompt you for a filename.
  67.  
  68.     Print   - Allows you to print out the current list. Make sure you have
  69.               your printer set up before you use this command as it begins
  70.               printing immediately. A small window is opened which contains
  71.               a gadget which allows you to stop printing.
  72.               Keyboard Equivalent: Right Amiga - P
  73.  
  74.     About   - Information about the Organiser and the registered owner.
  75.  
  76.     Quit    - For when you've had enough.
  77.               Keyboard Equivalent: Right Amiga - Q
  78.  
  79.  
  80.  
  81. Edit
  82.  
  83.     Cut     - Allows you to remove one or more entries from your list. These
  84.               will be stored in a buffer so you may then Paste them into
  85.               the list at a new position. This command is only available
  86.               when one or more entries are highlighted. See below for more
  87.               information on this. The two primary uses for this
  88.               command are to delete one or more entries from the list or to
  89.               shift one or more entries within the list. To shift a group
  90.               of entries, you first use the Cut command and then use the
  91.               Paste command to insert the group into its new position.
  92.               When doing a Cut/Paste sequence the Parent values are
  93.               adjusted correctly. For instance, when you Cut out an
  94.               article that is a Parent to other articles, then the other
  95.               articles will have invalid Parent values. Any invalid Parent
  96.               values are represented by 'xxx' in the Parent column. Note
  97.               that you will not be able to save your list while it contains
  98.               invalid Parent values. If you then Paste the Parent article
  99.               back into the list, the invalid Parent values will be
  100.               corrected and will point to the new position of the Parent
  101.               article. If you don't Paste the Parent article back into the
  102.               list and do another Cut or Copy operation, then all invalid
  103.               Parent values will be changed to 1.
  104.               Keyboard Equivalent: Right Amiga - X
  105.  
  106.  
  107.     Copy    - Copies the selected entries into a buffer. You can then use
  108.               the Paste command to insert them into the list. Like the Cut
  109.               command this command is only available when one or more
  110.               entries are highlighted.
  111.               Keyboard Equivalent: Right Amiga - C
  112.  
  113.     Paste   - Copies the contents of the buffer into the list. This command
  114.               is only available if the buffer is not empty. If none of
  115.               the list entries in the visible window are highlighted, then the
  116.               contents of the buffer will be Pasted onto the end of the list.
  117.               Note that if there are highlighted entries in the list but
  118.               not currently visible onscreen, the buffer will still be pasted
  119.               onto the end of the list. To insert the buffer into the middle
  120.               of a list, first select the list entry you want the buffer to be
  121.               inserted before and then use the Paste command. Note that
  122.               unlike the Paste command used in Wordprocessors, highlighted
  123.               entries are not replaced by the contents of the buffer.
  124.               Keyboard Equivalent: Right Amiga - V
  125.  
  126.     Add     - Allows you to add a new entry to the end of the list. A
  127.               requester will be displayed that allows you to enter an
  128.               AmigaDOS filename and a parent value. First enter a filename.
  129.               When finished press return and you will be taken to the
  130.               parent gadget. Enter a value and press return. If you entered
  131.               an allowable parent value, the new entry will be added to the
  132.               list and the requester will be removed. If the value was out
  133.               of range, the screen will flash, and the parent value will
  134.               automatically change to 1. You can now enter another value.
  135.               Keyboard Equivalent: Right Amiga - A
  136.  
  137.     Insert  - This command is almost exactly the same as Add, except you
  138.               must first select an entry in the list. The new entry will
  139.               then be inserted in front of the selected entry.
  140.               Keyboard Equivalent: Right Amiga - I
  141.  
  142.  
  143. The Edit Command
  144. ~~~~~~~~~~~~~~~~
  145.     This command allows you to edit an existing entry in the list. There
  146. is no menu for this command. Instead, you simply double click on the entry
  147. in the list you want to edit. A requester will be displayed and you can
  148. edit the entry exactly as you would using the Add or Insert commands.
  149. If you edit an entry with an invalid Parent value (denoted by 'xxx') you
  150. will see some weird negative number in the Parent gadget. You can leave
  151. this alone if you intend to Paste the buffer back into the list at a later
  152. date or you can change it to a correct value if you wish.
  153.  
  154.  
  155. Highlighting Entries
  156. ~~~~~~~~~~~~~~~~~~~~
  157.     By clicking on an entry in the list, you can highlight it. Click on it
  158. again and it will be unhighlighted. You can highlight a group of entries by
  159. clicking on an entry and then moving the mouse up or down the list while
  160. holding the mouse button down. If you move the mouse past the top or bottom
  161. of the list window, then the list will scroll automatically. This allows
  162. you to highlight more entries than can be displayed in the window at once.
  163.  
  164.  
  165. Notes
  166. ~~~~~
  167.     It is sometimes possible to end up with parent values in your list
  168. that are out of range. eg you have a list of 20 entries but some entries
  169. have parents with values of 25. There are two known ways of doing this.
  170. Firstly if you copy an entry from a list with a parent greater than one,
  171. use the New command and then Paste the entry into the new list. The other
  172. way involves copying an entry from a large list with a large parent value,
  173. loading a smaller list and Pasting it into the smaller list. If you do end
  174. up with parent values out of range, you will not be able to save the list
  175. until you correct them.
  176.  
  177.     Although there is no specific command for Appending two control files,
  178. it is quite simple to do. Simply load the file you want to Append, Copy it
  179. to the buffer, load the other control file and Paste the buffer onto the
  180. end of the list.
  181.  
  182.  
  183.                                                         Mark Gladding.
  184.