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