home *** CD-ROM | disk | FTP | other *** search
/ PC User 1997 July / PCU_JULY97.ISO / general / dos / quickref / quickref.man < prev    next >
Encoding:
Text File  |  1997-03-23  |  20.1 KB  |  385 lines
  1.          WaverlyStreet QuickRef Project Assistant (tm) User's Manual
  2.  
  3. -----------------------------------------------------------------------------
  4. (If you have not already done so, you may want to print this manual on paper.
  5. Press "P" if viewing it from the QuickRef help utility.)
  6.  
  7. -----------------------------------------------------------------------------
  8. Setup Options
  9. -----------------------------------------------------------------------------
  10. When you first start QuickRef, please go into the setup area by pressing F10
  11. at the main screen. You will find the following options:
  12.  
  13. Current User Name: Change this to either your or your company name
  14.  
  15. Current User Initials: Enter your initials here (don't leave blank!)
  16.  
  17. Current Passcode: optional
  18.  
  19. Multiple Users   : If set to "N", then you will never even know that the
  20.                    program can handle multiple "workers". If set to "Y", then 
  21.                    you will need to build a "worker" data file, and data entry 
  22.                    and reporting sections will have one more step in them.
  23.  
  24. Sub Divisions    : Both time and money records may be tagged with a
  25.                    sub-division label. You may have up to nine divisions for
  26.                    each. Toggle through the four options available.
  27.  
  28. Change Screen Colors: Hey, have fun!
  29.  
  30. Main Data Path   : (optional) Enter in a DOS file path where you want QuickRef
  31.                    to keep it's everyday working files. Caution! - do not
  32.                    share a (network) data path with someone else unless it
  33.                    will NEVER be the case that you are both in the program at
  34.                    the same time! (It may seem to work OK, but eventual file
  35.                    corruption is inevitable.)
  36.  
  37. Scratch File Path: (optional) If you use a RAM drive, identify it here.
  38.                    (Quicker reporting. 1 MB minimum recommended)
  39.  
  40. Backup/Share Path: (optional) For network use - enter in a DOS file path where
  41.                    you want to "mirror" your records, so that other users on
  42.                    your office LAN may look at them.
  43.  
  44. Archive Path     : (optional) The directory where old records on closed out
  45.                    projects will be stored.
  46.  
  47. Please refer to the end of this manual for installation and file details.
  48.  
  49. -----------------------------------------------------------------------------
  50. Adding Projects
  51. -----------------------------------------------------------------------------
  52. Press the right arrow key, then <INSERT>. Add a name, then a project number.
  53. Duplicate numbers not allowed.
  54.                                                          
  55. -----------------------------------------------------------------------------
  56. Single project screen
  57. -----------------------------------------------------------------------------
  58. When the program first starts, records for ALL projects are shown. To narrow
  59. your view to only those records for a particular project, press the right
  60. arrow, then point to and select a project. The "header" information for that
  61. project is shown at the top of the screen. Press <F3> to change it.
  62.  
  63. -----------------------------------------------------------------------------
  64. Switch between TIME and MONEY modes
  65. -----------------------------------------------------------------------------
  66. Press <F8> at either the main screen or the single project screen to toggle
  67. between modes. Note the indicator in the bottom right corner of the screen.
  68.  
  69. -----------------------------------------------------------------------------
  70. Add Records - edit / delete records
  71. -----------------------------------------------------------------------------
  72. Make sure you are in the mode (TIME/MONEY) that you want.
  73.  
  74. From main screen, press <INSERT>, then select a project. From single project
  75. screen, just press <INSERT>. Press <ENTER> to accept current date, or type in
  76. a new one. (Note - if record is for the current year, then you only need enter
  77. the month and the day and press <ENTER>. If for another year, you must type in
  78. the entire four-digit number - ie: 1997). When correct date is shown, press
  79. <ENTER>. Type in a numeric value to indicate either hours or money, and press
  80. <ENTER>. Type in a note, or use the up and down arrow keys to scroll through
  81. past notes. When the note is as you want it, press <ENTER>. Finally, confirm
  82. the new entry.
  83.  
  84. To either edit or delete a record, pick it from the screen by pointing to it
  85. and pressing <ENTER>.
  86.  
  87. -----------------------------------------------------------------------------
  88. "To-Do" items and MACRO utility
  89. -----------------------------------------------------------------------------
  90. If, when making a new entry, you leave the amount field blank (either time or
  91. money), then the entry will appear as a reminder. These will be printed as
  92. "to-do" items on "Snapshot" reports.
  93.  
  94. You may have the program automatically insert pre-defined lists of "to-do"
  95. items by using the MACRO utility. At the main screen, press <F3>, pick "make a
  96. new macro", and follow instructions.
  97.  
  98. -----------------------------------------------------------------------------
  99. Reports
  100. -----------------------------------------------------------------------------
  101. QuickRef creates two basic report types, "Snapshot" reports on single
  102. projects, and larger reports that combine projects and compare them to each
  103. other. In either case, note that you may edit the report before printing it.
  104. You may create reports from either your own data, another person's data that
  105. has been placed in a network "Backup/Share" directory, or archived records 
  106. on closed projects.
  107.  
  108. To generate a "Snapshot", you need to be at a single project screen. Press
  109. <F4>, and answer the prompts that follow.
  110.  
  111. To generate other reports, you must be at the main screen. Press <F4>. Press
  112. "A" to select all projects, "S" to select only certain projects. If you chose
  113. to select projects, there are more choices to be made:
  114.  
  115.      Press "W" to select by word. What this does is prompt you for a word, and
  116.      then it searches all the project header information to find it. When a
  117.      match is found, the header is displayed, and you must confirm whether or
  118.      not to include it.
  119.  
  120.      Press "P" to search by project number. A string of eight stars are
  121.      displayed, which you may edit to look for project numbers that match. For
  122.      example, suppose your numbering system uses a single letter code in the
  123.      third place to identify various types of projects, and you wish to have a
  124.      report on projects of type "t". Change the line of stars to look like
  125.      this -> **t***** and press <ENTER>.
  126.  
  127.      Finally, you may also simply pick projects from the main list one at a
  128.      time. Press "O" to do this. Scroll through the projects and press <ENTER>
  129.      to select.
  130.  
  131.      Whichever search method is employed, you are shown a list of selected
  132.      projects. If you wish to add more, press <INSERT>. If you wish to remove
  133.      one, point to it and press <ENTER>. When the list is as you want it,
  134.      press <ESC> to continue.
  135.  
  136. Once you have selected projects, you must specify a range of dates to include.
  137. Again, press "A" to select all dates, "S" to specify dates.
  138.  
  139. Next, indicate summary or full report. Full reports include all time and money
  140. line items (and so can get to be rather long).
  141.  
  142. There are a few more prompts (depending on whether or not you are in
  143. multi-user mode), and then the report is displayed on screen.
  144.  
  145. -----------------------------------------------------------------------------
  146. Closing out a finished project
  147. -----------------------------------------------------------------------------
  148. Once a project is finished, you will want to transfer it's records from your
  149. main (active) data area to the archive area. First of all, make sure that you
  150. have created an archive directory, and that you have correctly specified it in
  151. SETUP.
  152.  
  153. To close out a project: Activate the project selection box (right arrow at the
  154. main screen). Press <DEL>. Point to the project you wish to close and press
  155. <ENTER>. Answer the prompts, and it's done. Verify that the records are being
  156. transfered correctly by pressing "F" back at the main screen (see "Network
  157. notes" below).
  158.  
  159. -----------------------------------------------------------------------------
  160. Completely removing a project
  161. -----------------------------------------------------------------------------
  162. In order to completely remove a project's records from the system, it must
  163. first have been transfered to the archive directory. Change to the archive
  164. directory ("F" at the main screen...), and proceed as if you were closing the
  165. project out. This time, however, the project is completely removed!
  166.  
  167. Print a report first! THIS IS YOUR LAST CHANCE!!!!!
  168.  
  169. Note: unless a project is a mistake or a "test" project, don't remove it. Huge
  170. archive files do not hinder normal program operation.
  171.  
  172. -----------------------------------------------------------------------------
  173. Network notes
  174. -----------------------------------------------------------------------------
  175. Although QuickRef is designed to operate stand-alone, it includes provisions
  176. for sharing data with other users on a LAN. (See the end of this manual for
  177. suggested network directory structure.) Other users may view, but not change
  178. each other's records.
  179.  
  180. To update you own network data "mirror", press "Q" at the main screen, to run
  181. the Quick Data Backup utility. This simply shells to DOS and copies all your
  182. data to the network directory you specify in setup. ("Laptop" users might
  183. specify a floppy drive for this, then copy the files from the disk to the
  184. server, or upload the files via modem.)
  185.  
  186. To view someone else's data, press "D" at the main screen. To view archived
  187. records on finished projects, press "F". In either case, then change the
  188. directory shown to the one you are after, and press <ENTER>. The program title
  189. and directory listing on the bottom of the screen will change to the "warning
  190. box" colors, to remind you that you are not in your usual files. You can
  191. browse and generate reports just as if you were in your own data, but all data
  192. entry and editing functions are locked out.
  193.  
  194. Press "D" or "F" again to return to your normal data directory.
  195.  
  196. -----------------------------------------------------------------------------
  197. Project list
  198. -----------------------------------------------------------------------------
  199. Print a quick list of all your projects by pressing "P" when the "Select
  200. Projects" window is "on".
  201.  
  202. -----------------------------------------------------------------------------
  203. The FILE BROWSER & text editors
  204. -----------------------------------------------------------------------------
  205. All reports and project note files are initially sent to a built-in viewer,
  206. for on-screen preview. All viewer control options are shown at the bottom of
  207. the screen. The viewer is capable of displaying huge files (in excess of
  208. 32,000 lines in length) with great speed. If you are not satisfied with the
  209. viewer's print output, print to a file instead, and then read that into your
  210. favorite word processor. (Set the word processor margins to handle 78
  211. columns (very wide)). QuickRef does not include it's own text editor. To edit
  212. files, the viewer shells out to an external editor of your choosing. Specify
  213. the text editor on the DOS command line, or in your Windows program item,
  214. properties, command line space, in this format:
  215.  
  216.      QR [name of editor's executable file]
  217.  
  218.      (Note the space between QR and the editor name.)
  219.  
  220. Any DOS text editor that will accept a file name to open on the command line
  221. should work (depending on available memory). An excellent editor for the
  222. purpose is READ by WellsCom. READ can be found at all the major software
  223. archives and on all the major shareware CDs, generally in the DOS editor or
  224. text directory. READ uses very little memory, has a number of nice "word
  225. processor-like" features, and can handle very large files. If no editor is
  226. specified on the command line, QuickRef will attempt to use EDIT. (EDIT works,
  227. but READ is vastly superior.) One other point - the editor needs to be either
  228. in the same directory as Quickref, or in the PATH.
  229.  
  230. -----------------------------------------------------------------------------
  231. Installation, and "What the heck are all those files?"
  232. -----------------------------------------------------------------------------
  233. It is recommended that the program distribution files be placed in a directory
  234. called C:\QUICKREF (for illustration purposes, let's assume drive C:), and
  235. that a subdirectory of C:\QUICKREF be made for the program data, say
  236. C:\QUICKREF\DATA.
  237.  
  238. So, here is what that might look like, including files:
  239.  
  240. Directory of C:\QUICKREF
  241.  
  242. .            <DIR>
  243. ..           <DIR>
  244. DATA         <DIR>
  245. QR       EXE          (the program)
  246. VBDRT10  EXE          (required run-time module)
  247. STATION  INI          (program creates this - contains SETUP information)
  248. STANDARD FRM          (sample/default project note file header)
  249. QUICKREF TXT          (the "about" file called at the help screen)
  250. TEMPLATE MCR          (macro file template with instructions)
  251. QUICKREF MAN          (this file - called from help screen)
  252. MY_NOTES TXT          (user's own help file - called from help screen)
  253. STANDARD MCR          (sample/default macro file)
  254. SWAN     ICO          (nifty WaverlyStreet Windows icon)
  255.  
  256. Now, if you have made a DATA directory as shown above, and if you have
  257. specified that directory as the Main Data Path in setup, you should have
  258. something like this also (after running the program through all it's paces):
  259.  
  260. Directory of C:\QUICKREF\DATA
  261.  
  262. .            <DIR>
  263. ..           <DIR>
  264. TIME     DAT          (time records)
  265. PROJECTS DAT          (project header records)
  266. WORKER   DAT          (worker info - only if multi-user set to "Y" in setup)
  267. MONEY    DAT          (money records)
  268. [proj]   REC          (plain text file(s) containing your project notes where
  269.                          [PROJ] is your project's number)
  270. TIME     SDV          (time sub division labels)
  271. MONEY    SDV          (money sub division labels)
  272.  
  273. After a while, you may want to create an archive directory to store records on
  274. closed projects. (If you are connected to a LAN, then I highly recommend
  275. placing it on the server.) Wherever you put it, it will contain these files:
  276.  
  277. [proj]   REC          (same as above)
  278. PROJECTS DAT          (same as above)
  279. TIME     DAT          (same as above)
  280. MONEY    DAT          (same as above)
  281.  
  282. Note: In the archive directory, the records of all QuickRef users on a LAN are
  283. combined together in single .DAT files. I strongly suggest printing a final
  284. full report on paper before sending a project to the archives.
  285.  
  286. Also note that the worker data and the subdivision data do not carry over to
  287. the archives! Reports from the archives include totals only - no worker or
  288. subdivision breakdowns. The reason for this is that worker information (rates,
  289. for instance) will change over time, and various users may have different
  290. subdivisions set up. With all this information changing over time, the
  291. breakdowns would soon become distorted and misleading. If you wish to preserve
  292. the labor costs and subdivision breakdowns, do this before placing records in
  293. the archives: Print a report showing the information. Make a single MONEY
  294. entry for the entire labor cost. Type the subdivision breakdown information
  295. you wish to preserve into the project note (.REC) file. *Now* save to the
  296. archives. (Since there is no worker rate information in the archives for
  297. QuickRef to reference, reports from the archives will not show the double cost
  298. that you might expect.) 
  299.  
  300. If you are connected to a LAN, and wish for other QuickRef users to be able to
  301. view your records, create a directory on the server, and specify it as your
  302. Backup/Share path in setup. When you press "Q" at the main screen, the Quick
  303. Backup utility will copy all the files from your data directory to this spot.
  304.  
  305. Suggested network server directory structure (assuming drive "F"):
  306.  
  307.      F:\QRDATA - Have all users specify this as their archive path.
  308.            |
  309.           F:\QRDATA\[user's initials] - A sub directory for each user. Have
  310.                                         each user specify this as their
  311.                                         Backup/Share path.
  312.  
  313. (Obviously, the users need full rights to the server directories)
  314.  
  315. Finally, the program creates and removes numerous temporary "scratch" files
  316. during the course of normal operation. These files have several different
  317. names, and are used in any or all of three different places: The main QUICKREF
  318. directory, the DATA directory, and the place specified as the Scratch File
  319. Path (in setup). They all have the extension ".@@@". Under certain
  320. circumstances (power failures, insufficient space in the scratch file path),
  321. the program may fail to delete these files, and you might get some odd results
  322. such as "extra" information pasted onto reports. Once the problem
  323. circumstances are corrected, the program should clear the stray scratch
  324. files on it's own. At any time, however, you are safe to delete any files with
  325. the .@@@ extension from the QuickRef file structure.
  326.  
  327. -----------------------------------------------------------------------------
  328. SWAN.ICO (Windows Icon)
  329. -----------------------------------------------------------------------------
  330. Who says DOS programs can't have Windows Icons? Windows won't find it without
  331. your help, but you can specify it anyway with File, Properties..., Change 
  332. Icon..., Browse..., C:\QUICKREF\SWAN.ICO (assuming you have installed QuickRef
  333. in C:\QUICKREF).
  334.  
  335. -----------------------------------------------------------------------------
  336. Limitations
  337. -----------------------------------------------------------------------------
  338. I believe QuickRef is set up to handle more than large enough numbers of this
  339. and that for normal usage, but just so you know, here are some limits:
  340.  
  341. The maximum number of active line items in either the TIME or the MONEY data
  342. files is 32,767 (each may have that many). The program will warn you that you
  343. are approaching the limit at 20,000, and again (more urgently) at 30,000. In
  344. general, the smaller the data files, the faster the operation. Closed projects
  345. should be retired if the data files are getting too large. (I have tested all
  346. functions of the program with computer-generated test data files over 32,000
  347. entries. No problems except that it gets rather slow!)
  348.  
  349. Note: If archive records are approching the limit, make another archive
  350. directory and change everyone's SETUP to show it as the default. (There can be
  351. as many as you need)
  352.  
  353. The maximum number of projects and workers is also 32,767.
  354.  
  355. Individual line item values for money should not exceed six places to the left
  356. of the decimal point ($ 999,999.99). For time, four places (9999.99 hours).
  357.  
  358. Project subtotals for money should not exceed eight places to the left of the
  359. decimal point ($ 99,999,999.99). For time, six places (999,999.99 hours)
  360.  
  361. Grand totals for money (all records in the system) should not exceed nine
  362. places to the left of the decimal point ($ 999,999,999.99). For time, seven
  363. places (9,999,999.99 hours).
  364.  
  365. (Actually, the program can handle the math required for fifteen places to the
  366. left of the decimal, but it seems a little silly to accomodate that in the
  367. screen and report layouts. If you are dealing with numbers that large, go buy
  368. an accounting firm!)
  369.  
  370. The maximum number of text lines (largest report) that the file browser can
  371. handle is also the magical 32,767.
  372.  
  373. QuickRef makes extensive use of temporary disk files. Depending on what you
  374. are doing, the free disk space required in the "scratch file" area can be
  375. several times larger than the data file in use. If you are using a RAM drive,
  376. and are having strange problems, try switching to the hard drive instead. If
  377. that fixes the problem, make the RAM drive bigger (or use the disk instead).
  378.  
  379. -----------------------------------------------------------------------------
  380.       Please report bugs & make suggestions to:  dgjess@infinet.com
  381. ----------------------------------------------------------------------------
  382. QuickRef (tm) Project Assistant - (C) 1997 WaverlyStreet. All Rights Reserved
  383. ----------------------------------------------------------------------------- 
  384.  
  385.