home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 604b.lha / SubStore_v1.3 / SubStore.Doc.pp / SubStore.Doc
Encoding:
Text File  |  1992-02-06  |  21.3 KB  |  628 lines

  1.  
  2.                      <><><><><><><><><><><><>
  3.                      <>                    <>
  4.                      <>  S u b S t o r e   <>
  5.                      <>  ---------------   <>
  6.                      <>   by John Lullie   <>
  7.                      <>  © Copyright 1991  <>
  8.                      <>                    <>
  9.                      <><><><><><><><><><><><>
  10.                            Version 1.3
  11.  
  12.  
  13. FEATURES:
  14. ========
  15.  
  16. SubStore is a Magazine Subscription Database that allows you to
  17. store reference information from your monthly magazines such as
  18. Articles, Reviews and other items of interest. This can be a real
  19. time-saver when searching for something later that you KNOW you saw
  20. in that stack of magazines. Features include: Slick 3D Interface,
  21. Search, Print, Queue Window w/Print, Mail Order Info w/Names,
  22. Numbers & Notes, Subscription Editor Window for attaching User
  23. defined Brush/logos to be displayed for each Magazine you're
  24. working with, Repeat toggle for Date/Vol entries and more...
  25.  
  26.  
  27.  
  28. SubStore is ShareWare!
  29. =====================
  30. The Un-Registered version is freely distributable and may be
  31. uploaded anywhere you choose provided that the files included
  32. in this archive are left intact and un-modified. The REGISTERED
  33. version however is NOT freely distributable nor is it subject
  34. to sale by anyone other than the author. Doing so is considered
  35. a breach of the author's copyright!
  36.  
  37.  
  38. If you wish to have the Registered version of SubStore -
  39. PLEASE send a ShareWare fee of $15. In return, I'll send you
  40. the fully functional version of SubStore (the latest version
  41. of course), and Laser Printed (w/graphics) Documentation.
  42.  
  43. Please send to:
  44.  
  45.   John Lullie
  46.  
  47.   10701 SW 10th Court
  48.  
  49.   Davie, FL 33324
  50.  
  51.  
  52. Thanks!
  53.  
  54.  
  55.  
  56.  
  57.  
  58. SYSTEM REQUIREMENTS:
  59. ===================
  60.  
  61.  Any AMIGA w/1MEG of RAM (or more)
  62.  
  63.  WorkBench 2.04 STRONGLY recommended but not required.
  64.  
  65.  Hard Drive recommended but not required.
  66.  
  67.  
  68.  
  69.  
  70.  
  71. INSTALLATION:
  72. ============
  73.  
  74.  If you were using the Un-Registered version and wish to retain the
  75.  data you already input, then do the following: (Skip these three
  76.  steps if you have no data to save.)
  77.  
  78.  1) Do NOT delete the Un-Registered version of SubStore, its
  79.     drawer or anything in it yet, we'll need the data from it.
  80.  
  81.  2) Inside the directory of your Un-Registered version, you will
  82.     find a directory called "SubData". This is where all your data is
  83.     kept. Copy this directory into the NEW SubStore directory on the
  84.     disk I sent you. This can be easily done with a decent disk utility
  85.     like "Directory Opus" or "DiskMaster".
  86.  
  87.  3) Drag the "SubStore" drawer icon from the floppy disk anywhere
  88.     onto your hard drive. You can now delete your old version of
  89.     SubStore.
  90.  
  91.  
  92.   Double-Click the Sub.Installer icon. All this Installer will do is
  93.   copy a small file to your "C" directory which SubStore needs in
  94.   order to run. As for SubStore, you can place it anywhere you choose
  95.   but it should be in its own directory.
  96.  
  97.  
  98. Hard Drive Users: (Skip this section if you've done the steps above.)
  99. ----------------
  100.  Simply drag the "SubStore" drawer anywhere onto your hard drive. If
  101.  you wish to create another directory for its files please do NOT
  102.  use spaces in the directory name.
  103.  
  104.  You may want to create one other directory called "Brushes" and
  105.  place it inside SubStore's directory IF you plan to use the
  106.  Brush/Logo option explained below.
  107.  
  108.  (I have supplied a "Brushes" drawer already, with the Brush/Logos
  109.  inside)
  110.  
  111.  
  112.  
  113. Floppy Drive Users:
  114. ------------------
  115.  Please buy a Hard Drive! Although SubStore will run fine on a
  116.  floppy based system, it will be a lot slower when accessing files
  117.  (which it does a lot of). The procedure for installing SubStore on
  118.  a floppy system is the same as for Hard Drive Users.
  119.  
  120.  
  121.  
  122.  
  123.  
  124. * TUTORIAL *
  125.   ========
  126.  
  127. After launching SubStore, a small credit window will open. Click
  128. anywhere on this window to make it go away.
  129.  
  130.  
  131. SUBSCRIPTION EDITOR:
  132. ===================
  133.  Go to the ToolBox and click on the Subscription Editor button (see
  134.  Figure-1). This is where new Subscriptions are entered into
  135.  SubStore. On the upper right you will see three buttons (New, UnDo
  136.  and Trash). Below these buttons, a string gadget (or field) for
  137.  entering Subscription names, and below that, a List window which
  138.  will display all the current Subscriptions.
  139.  
  140.  Click on the "New" button. A cursor will be placed into the field
  141.  awaiting your input. Type in a Subscription title (Amiga World) for
  142.  example, and press [Return]. The title "Amiga World"
  143.  
  144.  (I'll use that for reference) will appear in the List window.
  145.  
  146.  The Subscription is created and the cursor will be placed back into
  147.  the field for your next entry. That's all you need to do to create
  148.  new Subscriptions. You can either close the SubScription Editor now
  149.  or continue and use the brush/logo option described below.
  150.  
  151.   NOTE: If you're not interested in using the Brush/Logo option,
  152.         skip ahead to "Adding Articles, Reviews and Other".
  153.  
  154.  
  155.  
  156. CREATING A BRUSH/LOGO:
  157. ---------------------
  158.  A brush may be attached to each particular magazine subscription
  159.  that will be displayed in the main window when referencing that
  160.  Subscription. For example, the "Amiga World" brush/logo (that is
  161.  included) would be displayed when you are working with or
  162.  referencing that magazine. If you were working with "Amazing
  163.  Computing" - the brush/logo for that magazine would be displayed.
  164.  
  165.  In order to use the brush/logo option, you will need to have a
  166.  brush or several brushes available to select from. I've included a
  167.  few with the program already: Amiga World, Amazing Computing and
  168.  .info magazine. These were created using a template called
  169.  "Brush.Grid" in DeluxePaint and saved as brushes. You can use these
  170.  brushes or modify them to your own liking. The only thing you MUST
  171.  remember is to use the palette that the "Brush.Grid" uses. (The
  172.  "Brush.Grid" is explained below).
  173.  
  174.  
  175.  There are some rules to follow when creating these brushes for use
  176.  in SubStore, and are as follows:
  177.  
  178.   1) Load "Brush.Grid" into DPaint as a picture (not a brush).
  179.  
  180.   2) Each brush MUST be within a certain size (shown on the
  181.      Brush.Grid).
  182.  
  183.   3) The new brush MUST use the same color palette as the Brush.Grid.
  184.  
  185.   4) Save the brush into the "Brushes" directory inside the SubStore
  186.      directory.
  187.  
  188.  
  189. Using the Brush.Grid file:
  190. -------------------------
  191.  Open "Brush.Grid" as a picture in DPaint or any paint program for
  192.  that matter that supports 16 color IFF.
  193.  
  194.  This template will display the exact area with which you can create
  195.  or paste your brush. When you are finshed with your brush, use the
  196.  brush tool and clip only the area of your brush that you will need.
  197.  You don't have to clip your brush to the exact dimension lines
  198.  shown in the grid as long as you are WITHIN this area. You can fine
  199.  tune the position later in the Subscription Editor. Once the brush
  200.  has been picked up, save it AS a brush using any name you choose
  201.  ("AmigaWorld.Br" for example) into the "Brushes" drawer in
  202.  SubStore's directory.
  203.  
  204.   NOTE: Please do not use any spaces in the filename.
  205.  
  206.  
  207. ATTACHING A BRUSH/LOGO:
  208. ----------------------
  209.  Launch SubStore and open the Subscription Editor. Click on a
  210.  Subscription title (in the List window) that you want a brush/logo
  211.  attached to. If a brush was already attached, it will be displayed.
  212.  Otherwise, click the "Load Brush" button.
  213.  
  214.  A file requester will open into SubStore's "Brushes" directory. If
  215.  you saved your brush here - it should already be listed on the
  216.  right side of this requester. Click on the brush you want and then
  217.  click the "Ok" button. The requester will close and your brush will
  218.  be displayed in the brush area of the Subscription Editor window.
  219.  
  220.  The small box that your brush is displayed in is a representation
  221.  of the brush area on SubStore's Main screen. In other words, the
  222.  position of your brush here in the Subscription Editor will be in
  223.  the same position on the Main Screen.
  224.  
  225.  To adjust or center your brush in this box, use the "[+]" and "[-]"
  226.  buttons for the X (horizontal) and Y (vertical) positions.
  227.  
  228.  The button specifications are as follows:
  229.  
  230.     X: [+]  =  Move brush right 2 pixels per click.
  231.     X: [-]  =  Move brush left 2 pixels per click.
  232.     Y: [+]  =  Move brush down 2 pixels per click.
  233.     Y: [-]  =  Move brush up 2 pixels per click.
  234.        [.]  =  Start over. (Will move the brush to its
  235.                original load position)
  236.        [X]  =  Clears the brush area.
  237.  
  238.  When you are satisfied with the position of your brush, click on
  239.  the "Attach/Save" brush button. If you have more Subscriptions and
  240.  have brushes for each, just follow the same steps as above for each
  241.  one. Click the "Ok" button in the Subscription Editor when you are
  242.  finished.
  243.  
  244.  If you wish to verify the attached brush/logos for your
  245.  Subscriptions, you can call up the Editor again and click in the
  246.  List box on any Subscription title that has a brush attached. It
  247.  will be displayed in the brush area.  Or, on SubStore's Main
  248.  screen, click on the Left or Right arrow buttons under the "Current
  249.  Subscription" box.
  250.  
  251.  
  252. Removing a Brush/Logo:
  253. ---------------------
  254.  If you want to remove a brush/logo that has been attached to a
  255.  Subscription, click on the Subscription name in the List window,
  256.  click on the Clear button [X] and then click "Attach/Save". Since
  257.  NO brush is displayed - no brush will be attached.
  258.  
  259.  
  260. Adding Articles, Reviews and Other:
  261. ----------------------------------
  262.  Once you have a new Subscription name entered, you can begin to add
  263.  the names of Articles, Reviews or Other that may be of interest to
  264.  you along with the Issue Date or Volume and Page numbers.
  265.  Of course, you will not have to enter every article and  review
  266.  unless you wish to. I usually only key in the items I may be
  267.  interested in sometime in the future. Like many people, my interests
  268.  change from time to time, or, I may decide to buy another Hard Drive
  269.  and want to locate all the reviews on them.
  270.  
  271.  
  272. Current Subscription Box:
  273. ------------------------
  274.  Located in the upper left area of the screen, you'll see the
  275.  "Current Subscription" box with left and right arrow buttons.
  276.  This box displays the current Subscription Brush/Logo that you
  277.  are working with, that is - IF you attached a brush/logo. Either
  278.  way, as you click on either the left or right arrows, the
  279.  Subscription names will be displayed in the "Magazine" field at
  280.  the bottom of the screen. Click either of these arrows until the
  281.  Subscription name you want is displayed in the "Magazine" field.
  282.  
  283.  Next, you'll have to tell SubStore what type of entry you'll be
  284.  making; Article, Review or Other. To do this, click on one of the
  285.  three "Add.." buttons located under the three List windows (Add
  286.  Article, Add Review or Add Other). A checkmark symbol will appear
  287.  on the button and a hand pointer will point to the corresponding
  288.  List window.
  289.  
  290.  This hand pointer means that anything you enter into the fields at
  291.  the bottom of the screen will be entered into that List window.
  292.  
  293.  Now you are ready to key in the actual data. The cursor should
  294.  already be positioned in the "Date/Vol#" field ready for your
  295.  input. Begin by entering the Date or Volume#  of the issue (i.e
  296.  12/91 or Vol 6). The format you use for the Date or Volume is not
  297.  really important. You could type "Dec 91", "December 91" or "Issue
  298.  45", it doesn't matter. (Automatic sorting is alphabetical by
  299.  Articles, Reviews or Other, not by date.)
  300.  
  301.  
  302.  After pressing [Return], the cursor will move to the "Page#" field.
  303.  Enter the page number of the Article, Review or Other, and press
  304.  [Return]. The cursor will again move to its last position in one of
  305.  the three fields corresponding to the entry type you've selected.
  306.  
  307.  For example, if you are entering reviews and the "Add Reviews"
  308.  button was toggled on - then the cursor will be waiting in the
  309.  "Review" field.
  310.  
  311.  Type in the title of the Review, Article or Other and press
  312.  [Return]. This will complete the entry and store it. It will show
  313.  up in the selected List window and the cursor will be placed back
  314.  in the "Date/Vol#" field for your next entry.
  315.  
  316.  
  317.  
  318. Using the Repeat Option: [Rpt] button:
  319. -------------------------------------
  320.  Next to the "Date/Vol#" field is a "Rpt" toggle button. What this
  321.  does (when toggled on) is allow you to automatically have the
  322.  previous date or volume number remain in the field until you change
  323.  it again. The cursor will skip this field and go directly to the
  324.  "Page#" field. This seemed like the logical thing to do since you
  325.  will most likely be working with one Subscription issue at a time.
  326.  Once the very first entry for an issue has been made, you'll only
  327.  need to enter the page number and title for each entry.
  328.  
  329.  
  330.  
  331. Using the Note Option: [Note] button:
  332. ------------------------------------
  333.  Next to the "Note" field is a "Note" toggle button. What this does
  334.  (when toggled on) is place the cursor into the Note field after
  335.  pressing [Return] in any of the three title fields (Article,
  336.  Review, Other). This allows you to attach a note to each (or any)
  337.  entry. If you do not wish to attach a note to EVERY entry, just
  338.  leave the note field empty and press [Return]. Or, you can just
  339.  toggle the button off and the Note field will be bypassed. You can
  340.  also attach notes to current entries (already input) by clicking on
  341.  the item in the List window, typing a note in the Note field and
  342.  pressing [Return]. This will update that entry with a your note.
  343.  
  344.  
  345.  
  346. THE ToolBox:
  347. ===========
  348.  
  349.  HELP:
  350.  ----
  351.   Opens the OnLine Help System. This is a trimmed down version of
  352.   this Manual with a description of each function.
  353.  
  354.  
  355.  TRACKS:
  356.  ------
  357.   Opens the Subscription Tracker window. This is a simple editor to
  358.   enter the starting and ending dates for your Subscriptions, number
  359.   of issues ordered (i.e. 12,24,36 etc) as well as a note. The
  360.   procedure for entering information is similar to the MailOrder
  361.   option. Click on the Subscription you want, then enter the
  362.   information. Press [Return] in each field (especially the Note
  363.   field) to save the entry.
  364.  
  365.   To edit an entry, click on the Subscription title, click into the
  366.   field you wish to edit, when finished, press [Return] in the Note
  367.   field.
  368.  
  369.  
  370.  Search Button (Magnifying Glass):
  371.  -------------
  372.   Opens the Search requester. In this requester you will see four
  373.   buttons and one field. The three toggle buttons at the top tell the
  374.   program which List window to perform the search in (Articles,
  375.   Reviews or Other). At present, you can only select one at time. In
  376.   the center, there is a field for entering the text you wish to
  377.   search for. And finally the "Done" button at the bottom is for
  378.   closing the Search window.
  379.  
  380.   To perform a search, select one of the three buttons, type the text
  381.   you wish to search for and press [Return]. The "Next" button that
  382.   appears, allows you to continue the search. When you're finished,
  383.   click on the "Done" button.
  384.  
  385.  
  386.  Subscription Editor (Stack of Magazines):
  387.  -------------------
  388.   Opens the Subscription Editor. This is where new Subscription
  389.   Titles are entered. See "SUBSCRIPTION EDITOR" above which describes
  390.   step by step how to create and enter a new Subscription.
  391.  
  392.  
  393.  Print Button (Printer):
  394.  ------------
  395.   Opens the Print Requester. In order for this button to respond, one
  396.   of the three List windows must be selected (the hand pointer must
  397.   be displayed over Articles, Reviews or Other). You will have two
  398.   options:
  399.  
  400.    Selected Only:
  401.    -------------
  402.     Prints the Magazine name, Date/Vol, Page#, Title and Note of the
  403.     selected item in the selected List window.
  404.  
  405.    Entire List:
  406.    -----------
  407.     Prints the Magazine name, Date/Vol, Page#, Title and Note for each
  408.     of the items in the selected List window.
  409.  
  410.  
  411.  Queue Window (Letter "Q" with tiny stacked documents):
  412.  ------------
  413.   Opens the Queue Window. This Queue window allows you to temporarily
  414.   store individual items from any of the three List windows. The
  415.   items that are held in this window can then be printed or exported
  416.   as an ASCII (text) file.
  417.  
  418.         The Queue Window Buttons:
  419.  
  420.   [X]:    Deletes the selected item from the Queue window.
  421.   [!]:    UnDo the last deleted item from the Queue window.
  422.  
  423.   Clear:  Removes all the items in the Queue window.
  424.  
  425.   Export: Opens a file requester for saving the contents of the Queue
  426.           Window. This file will be saved as an ASCII (text) file
  427.           containing all the information for each item (Magazine,
  428.           Date/Vol#, Page#'s, Titles and Notes).
  429.  
  430.   Print: Prints entire contents of Queue window. This functions the
  431.          same as the Export option but the Queue contents is sent
  432.          to the printer.
  433.  
  434.   To close the Queue window, click on the close box in the upper left
  435.   corner of this window.
  436.  
  437.  
  438.  Mail Order (Airplane):
  439.  ----------
  440.   Opens Mail Order Info Window. This was included mostly because
  441.   I LOVE Mail Order AND UPS trucks! Since 99% of computer magazines
  442.   contain several Mail Order companies, I find it easy to store the
  443.   new ones as well as the old and have the entire list of them at my
  444.   disposal. Besides the name and number, a note can be attached to
  445.   each entry. For example, if a Mail Order company specializes in
  446.   computer chips - I'll key that in the Note field for reference. If
  447.   one offers $3.00 overnight shipping - I'll enter that and so on.
  448.   You may find it useful.
  449.  
  450.   To make a new Mail Order entry, click on the "New" button. The
  451.   cursor will be placed in the "Name" field. Enter the name of the
  452.   Mail Order company and press [Return]. The cursor will move to the
  453.   "Number" field. Enter the phone number and press [Return]. Finally,
  454.   the cursor will be placed in the "Note" field. Type in anything for
  455.   this Mail Order company that sets it apart from the rest (if
  456.   anything).
  457.  
  458.    NOTE: You must press [Return] in the "Note" field to complete
  459.          the entry.
  460.  
  461.   Once an entry has been made, it is stored in the Mail Order List
  462.   window. To view an entry, click on any Mail Order title name in the
  463.   List window. All three fields will show the information pertaining
  464.   to the selected item.
  465.  
  466.    Mail Order Buttons:
  467.    ------------------
  468.     New:     Activates the "Name" field for a new entry.
  469.  
  470.     Print:   Prints all info for the selected Mail Order company
  471.              (Name, Number and Notes).
  472.  
  473.     Trash:   Deletes the selected Mail Order company.
  474.  
  475.     UnTrash: Will UnDelete the last deleted Mail Order company.
  476.  
  477.     Done:    Closes the Mail Order Info Window.
  478.  
  479.  
  480.  Prefs (Question Mark):
  481.  -----
  482.   Opens The Preferences Window. Same as selecting the "Preferences"
  483.   menu option. See "Preferences" under "MENU DESCRIPTIONS:".
  484.  
  485.  
  486.  
  487. OTHER BUTTON DESCRIPTIONS:
  488. =========================
  489.  
  490. Quit Gadget: (Upper left corner of the main window.)
  491. -----------
  492.  Exits SubStore.
  493.  
  494.  
  495. Front/Back Gadget:
  496. -----------------
  497.  Standard gadget for sending SubStore's screen to the back and
  498.  bringing WorkBench to the front.
  499.  
  500.  
  501. Brush/Logo Arrows: (Under the "Current Subscription" Box)
  502. -----------------
  503.  Moves back and forth through Subscription titles. The titles of
  504.  each Subscription entered will be displayed in the Magazine field.
  505.  If a brush has been attached to a Subscription title - it will be
  506.  displayed in the Brush/Logo box.
  507.  
  508.  
  509. "Q" Buttons: (Located under each List Window)
  510. -----------
  511.  Sends a selected item to the Queue window (IF the Queue window is
  512.  open). If the Queue window is NOT open, this button will be
  513.  ignored.
  514.  
  515.  
  516. Add Articles:
  517. ------------
  518.  Tells SubStore that all actions will be directed to the Articles
  519.  window.
  520.  
  521.  
  522. Add Reviews:
  523. -----------
  524.  Tells SubStore that all actions will be directed to the Reviews
  525.  window.
  526.  
  527.  
  528. Add Other:
  529. ---------
  530.  Tells SubStore that all actions will be directed to the Others
  531.  window.
  532.  
  533.   NOTE: By "Actions", I mean data entry, queues and printing.
  534.  
  535.  
  536.  
  537. MENU DESCRIPTIONS:
  538. =================
  539.  
  540. Project:
  541. -------
  542.  
  543.  About SubStore:
  544.  --------------
  545.   Displays the Credits window. Click this window to make it go away.
  546.  
  547.  
  548.  Preferences:
  549.  -----------
  550.   Opens the Prefs window. The options in this window are as follows:
  551.  
  552.    At Startup, Load:
  553.    -----------------
  554.     The options here are mainly for those with a minimal amount of
  555.     memory or those who might be interested in one particlular kind of
  556.     information. You may only want to use the Reviews option for
  557.     example.
  558.  
  559.    Always Start With:
  560.    ------------------
  561.     This tells SubStore the default Subscription to start with. For
  562.     example, if you wish  to always start with Amiga World - then the
  563.     Brush/Logo (if there is one) for Amiga World would be displayed
  564.     along with the "Magazine" field defaulting to "Amiga World" at
  565.     startup. This setting will stay until you change it or delete the
  566.     Subscription entirely.
  567.  
  568.    Repeat On/Off:
  569.    --------------
  570.     Sets the default state for the [Rpt] button on the main window.
  571.     (See "Using the Repeat Option".)
  572.  
  573.    Note On/Off:
  574.    -----------
  575.      Sets the default state for the "Note" button on the main window.
  576.      (See "Using the Note Option".)
  577.  
  578.    Cancel Button:
  579.    -------------
  580.      Cancels the changes and exits preferences.
  581.  
  582.    Save Button:
  583.    -----------
  584.      Saves the changes and exits preferences.
  585.  
  586.  
  587. Quit:
  588. ----
  589.  Exits the program.
  590.  
  591.  
  592. Edit Menu:
  593. =========
  594.  
  595.  UnDo Delete:
  596.  -----------
  597.   Un-Deletes a deleted entry.
  598.  
  599.  Clear All Fields:
  600.  ----------------
  601.   Empties the contents all fields except "Magazine".
  602.  
  603.  Delete Selected...:
  604.  ------------------
  605.   Article:
  606.   -------
  607.    Removes the selected Article from the List window and database.
  608.  
  609.   Review:
  610.   ------
  611.    Removes the selected Review from the List window and database.
  612.  
  613.   Other:
  614.   -----
  615.    Removes the selected Other from the List window and database.
  616.  
  617.  
  618.  
  619. --------------------------------------------------------------------
  620.  
  621.    Please send suggestions, comments or bug reports to:
  622.  
  623.    CompuServe: John Lullie/ UserID 70700,2454
  624.  
  625.    GEnie: UserID - J.LULLIE
  626.  
  627.  
  628.