home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / desqview / qwhite.arj / QWHITE.TEC < prev    next >
Text File  |  1992-03-09  |  17KB  |  334 lines
  1. ID:QW Quarterdeck White Papers
  2. Quarterdeck Technical Note #236
  3. by Daniel Travison
  4. last revision:  2 March 1992
  5.  
  6.      Welcome aboard the Quarterdeck White Papers!  The White Papers originated 
  7. as separate documents prepared by our Technical Support Staff.  Each one 
  8. explores a single topic of importance to users of Quarterdeck products.  They 
  9. were originally written as independent items in response to inquiries from our 
  10. users.  Previous versions of these documents have been distributed by mail and 
  11. FAX as an avenue of supporting our customers.
  12.      These papers change with time; there are additions and deletions all the 
  13. time as products (both ours, DOS, and other programs) evolve.  Rather than 
  14. distribute a paper version, we hope you will enjoy our diskette version, which 
  15. respects the environment.
  16.      The Quarterdeck White Papers program (QWHITE.COM) is a DESQview-specific 
  17. program for viewing these technical notes within DESQview.  QWHITE.COM is NOT 
  18. designed to replace your favorite file viewing utilities.  It is written 
  19. specifically to provide quick access to Quarterdeck's technical notes, or your 
  20. own, using an interface similar to DESQview's Open Window menu.
  21.  
  22. USING DESQVIEW'S ADD A PROGRAM:
  23.  
  24.    > Place all of the technical notes and QWHITE programs in the  
  25.      same subdirectory.  This is normally done by the install     
  26.      program.
  27.  
  28.    > Select Open Window from the DESQview menu
  29.  
  30.    > Select Add A Program from the Open Window Menu.
  31.  
  32.    > Select 'Other (Add Program Not in List)' by pressing the O   
  33.      key or by clicking on the selection with the mouse.
  34.  
  35.    > Type the drive and subdirectory where QWHITE.COM is located  
  36.      in the path field.  For example:  If you have installed the   
  37.      Quarterdeck White Papers to the subdirectory QWHITE on the C 
  38.      drive, type in the following and press the enter key:
  39.  
  40.           C:\QWHITE
  41.  
  42.    > An entry, 'Quarterdeck White,' will be displayed.  Move the  
  43.      cursor to this entry, press the space bar, then press enter. 
  44.      The Quarterdeck White Papers program is configured to use QW 
  45.      as the keys to use on the open window menu.  If QW is        
  46.      already in use, you will be prompted to provide a different  
  47.      two-key combination.
  48.  
  49. CHANGE A PROGRAM:
  50.  
  51.      Conventional Memory:  120k
  52.      System Memory:        20k
  53.  
  54.      QWHITE.COM also requires about 20k of System Memory to function 
  55. correctly.  System memory is a block of memory DESQview allocates on behalf of 
  56. a program that uses DESQview's Applications Programming Interface (API).  This 
  57. memory is used to store some of the program's DESQview-specific data.  For 
  58. example, when you select HELP for the program, the help screen is stored in 
  59. system memory.
  60.      The System Memory field is found on the Advanced Options screen of Change 
  61. A Program.  DESQview will notify you if it runs out of system memory for the 
  62. program at any point.  If you receive an error message from DESQview 
  63. indicating there is insufficient system memory for the program, increase the 
  64. System Memory field by 1 and run the program again.  
  65.  
  66.      MAXIMUM HEIGHT:  
  67.      QWHITE detects the value you specify for MAXIMUM HEIGHT Change A Program 
  68. to determine the number of lines to use for the file view window.  If you run 
  69. DESQview in 43,50, or 60 line mode you can have QWHITE use the entire physical 
  70. screen by specifying an appropriate starting HEIGHT.  QWHITE also will adjust 
  71. the number of lines it uses for PgDn or PgUp when you have used DESQview's 
  72. resize option.
  73.  
  74. THE MAIN MENU:
  75.  
  76.   The main menu contains 5 selections:
  77.  
  78.      Open Technote: Displays a menu of technical notes in a format similar to 
  79.      DESQview's Open window menu.  This menu can contain up to 256 entries.
  80.  
  81.      Search Technote: Allows searching all technotes for a character string.
  82.  
  83.      Create New Open Menu: Tells QWHITE.COM to scan all files in the current 
  84.      directory for files that contain a specific header record.
  85.  
  86.      Help: Displays a help screen describing each menu option.
  87.  
  88.      Quit: Allows quitting the Quarterdeck White Papers.
  89.  
  90. GETTING HELP:
  91.  
  92.      QWHITE.COM has two methods for obtaining help.  The first uses DESQview's 
  93. help system.  Normally, when you bring up the DESQview menu you see an option 
  94. called 'Help for DESQview'.  When you bring up the DESQview menu while 
  95. QWHITE.COM is the foreground program, you will see an entry 'Help For 
  96. Program.'  You may press the ? key at this point to activate QWHITE.COM's 
  97. help.  Additionally, you can press the ? key from most screens to display help 
  98. specific to the screen.
  99.  
  100. OPEN TECHNOTE:
  101.  
  102.      The Open Technote menu option provides a menu of technical notes in a 
  103. manner similar to DESQview's Open Window menu.  However, instead of opening a 
  104. window to run a program, this option allows you to open a window to read a 
  105. technote.
  106.      To read a technote, highlight the entry with the mouse and click either 
  107. mouse button, -or- highlight the entry with the Up and Down cursor keys and 
  108. press the spacebar, -or- type the two letters to the right of the entry.  If 
  109. two or more entries displayed have the same two-letter combination, you will 
  110. need to select the second, third, etc. entry with the mouse or cursor keys.  
  111. The PgDn and PgUp keys are used to display the entries on other screens.
  112.  
  113. TWO-KEY LIMITATION:
  114.  
  115.      QWHITE.COM will only accept files that use the letters A through Z and 
  116. the numbers 0 through 9 for the two-key combination when building the Open 
  117. Technote list.  QWHITE.COM will allow you to specify the same two-key 
  118. sequences in more than one technical note.  Although this allows some 
  119. flexibility, it does provide certain limitations for the Open Technote menu.  
  120. Here is a description of how QWHITE.COM decides which technote to view when 
  121. you select a two-key combination that appears two or more times in the Open 
  122. Technote list:
  123.  
  124.      a) When the first key is pressed, QWHITE.COM searches its internal list 
  125.      for any entries that start with the key.  If none are found, you will 
  126.      hear a beep and the key will be ignored.
  127.  
  128.      b) When the second key is press QWHITE.COM starts with the first entry on 
  129.      the current Open Technote screen when searching for a matching two-key 
  130.      selection.
  131.  
  132.      c) If the two-key combination you type is on the screen, QWHITE.COM will 
  133.      open that technote.
  134.  
  135.      d) If the two-key combination is not on the current screen, QWHITE.COM 
  136.      will search to the end of the Open Technote list to find an entry that 
  137.      matches.  If none is found, it will go back to the top of the list and 
  138.      search from there until if finds a valid entry and opens it.  If none are 
  139.      found, you will here a beep when you press the second key.
  140.  
  141.      e) If two or more entries with the same two-key combination appear on the 
  142.      same screen, QWHITE.COM will ALWAYS open the first.  You will need to 
  143.      select the second (third, fourth, etc) manually by using the cursor keys 
  144.      to highlight the entry and pressing enter -or- by clicking on it with the 
  145.      left mouse button.
  146.  
  147. SEARCH TECHNOTES:
  148.  
  149.      The Search Technotes option allows scanning all technical notes on the 
  150. Open Technote menu for the character string you specify.  It is not case-
  151. sensitive and it will also ignore trailing spaces when scanning the files.  
  152. The START SEARCH option ALWAYS starts with the first entry in your Open 
  153. Technote list.  After a match has been found two additional options will be 
  154. available: "Continue Current File F2" and "Continue Next File F3."  The 
  155. "Continue Current File" option continues searching from the point of the last 
  156. successful match.  The "Continue Next File" option skips the file where the 
  157. last match occured and starts searching the next file.  This option is useful 
  158. when you have a search string that occurs more than one time in the same file 
  159. and you want to go on to other files.  If any of the above search options 
  160. reach the last entry in the Open Technote list the Continue Search options 
  161. will be disabled.  If any of the search options find a match, the file will be 
  162. loaded into the list window.  The page that contains the match will be 
  163. displayed and the line that contains the match will he highlighted.  If you 
  164. select either of the Continue Search options and no match is found, the last 
  165. file containing a match will be reloaded and positioned to the line you had 
  166. last viewed.
  167.  
  168. CREATE A NEW OPEN MENU:  Adding new technical notes to the Open Technote menu
  169.  
  170.      The Create new Open menu searches all files in its directory for files 
  171. that have a specific ID line at the beginning of the file (NOTE: See Technical 
  172. Note Header).  The file should be a normal ASCII file without special control 
  173. codes in it.  Your editor or word processor may refer to it as Non-Document, 
  174. Text, or ASCII files.  See the notes on Technical Note File Types.
  175.      Your own technical notes may be added to the Open Technote menu by 
  176. inserting an ID line at the beginning of the file.  Your file should be copied 
  177. to the directory where QWHITE.COM is located and the Create option should be 
  178. selected from the menu.
  179.      QWHITE.COM can only display 256 options on the Open Technote menu at a 
  180. time.  If you have more than 256 files you will need to create a second 
  181. subdirectory and divide your technical notes between the two subdirectories 
  182. and place a copy of QWHITE.COM in each.  Run DESQview's Change a Program and 
  183. modify the Directory field to point to the new subdirectory and change the 
  184. 'Keys to Use on Open Menu' create a second entry for the new subdirectory.
  185.  
  186. Technical Note Header:  Example:  See the first line of this file
  187.  
  188.      QWHITE.COM checks the first line of a file for a specific character 
  189. sequence to identify the file as a technical note for including in the Open 
  190. Technote menu.  The first three characters should be 'ID:' (NOTE: the single 
  191. quotes should not be not included.)  The next two characters are the two keys 
  192. used on the Open Technote menu.  This is similar to DESQview's own Open Window 
  193. menu except QWHITE.COM allows duplicates.  The next character MUST be a space. 
  194. Finally, the next 35 characters will be used on the Open Technote menu to 
  195. describe the file, much as the Program Name field of Change A Program is used 
  196. to identify the entry on DESQview's Open Window Menu.  Also, it is not 
  197. necessary to provide all 35 characters, QWHITE.COM will automatically stop if 
  198. it finds a linefeed character.
  199.  
  200. TECHNICAL NOTE FILE TYPES:
  201.  
  202.      QWHITE.COM will attempt to display ANY file that contains a valid header. 
  203. However, for best results you should use an editor or word processor that can 
  204. create normal ASCII format files. Your editor/word processor may refer to this 
  205. type of file as NON-DOCUMENT, ASCII, TEXT, or some similar name.
  206.      QWHITE.COM processes the following control codes, all others are ignored 
  207. and not displayed.
  208.  
  209.      LINEFEED - indicates the end of a line.  If you experience trouble 
  210. viewing your document, make sure your word processor is creating a TEXT file 
  211. instead of its own DOCUMENT file format.
  212.  
  213.      TAB - moves the 'cursor' 8 positions before printing the next character.  
  214. This is a non-standard method of displaying the TAB character.  It is designed 
  215. to allow you to compress a file that is 'slightly' larger than 64k by 
  216. replacing sequences of 8 blanks with a tab character.
  217.  
  218.      END OF FILE - indicates the end of the file.  If no END OF FILE marker is 
  219. found, the physical file size will be used.
  220.  
  221.      OTHERS - All other control codes will be ignored and not displayed.
  222.  
  223.      Additionally, QWHITE.COM will display a maximum of 78 characters/line and 
  224. drop any characters found after that position.
  225.  
  226. READING TECHNICAL NOTES:
  227.  
  228.      The view mode of QWHITE.COM provides a simple interface for reading a 
  229. technical note.  The following keys are active when reading a technote:
  230.  
  231.                 P      Print
  232.  
  233.                 Up     Scroll up
  234.                 Down   Scroll down
  235.  
  236.                 PgUp   Previous page
  237.  
  238.                 PgDn   Next page
  239.  
  240.                 Home   Top of the file
  241.  
  242.                 End    End of file
  243.  
  244.                 Esc    Exit window
  245.  
  246.             *   F2     Continue Current File
  247.  
  248.             *   F3     Continue Next File
  249.  
  250.      * The F2 and F3 keys are invisible options.  These options are available 
  251. only when the search option displays a file.  It allows you to select either 
  252. Continue Search option without having to return to the Search menu.
  253.  
  254. FILE SIZE LIMIT:  64k
  255.  
  256.      QWHITE.COM will not display files that are larger than 64k.  Since the 
  257. technical documents are written to answer specific questions or solve specific 
  258. problems, by nature they should be concise and we have found they often fit on 
  259. a single sheet of paper.  The 64k limit we choose is merely a convenience from 
  260. a programming standpoint.  In actuality, 64k is generally too large for a 
  261. technical note.  See the note on TAB in the section discussing Control Codes 
  262. above for a file that exceeds 64k.
  263.  
  264. PRINTING:
  265.  
  266.      The List window provides the option for printing a technical note.  This 
  267. option is here for those times when you want to print quickly the technical 
  268. note you are viewing.  If you have need for extensive printing or printer-
  269. specific options, you may want to open a separate window and perform your 
  270. printing from there.  When you select the Print field or press the letter P, a 
  271. window will pop up indicating the name of the file that will be printed.  You 
  272. may press Esc at this time to cancel the request or Enter to start printing.  
  273. A running total of lines printed will be displayed as the file prints.  You 
  274. may press Enter or Escape while the file is being printed to abort the print.  
  275. QWHITE.COM will send a formfeed character at this point, or when it finishes 
  276. printing the file to the printer and returns you to the list window.  
  277. QWHITE.COM prints to the standard printer device.  In other words, whatever 
  278. printer is currently assigned to PRN will be used by QWHITE.COM.  This will 
  279. allow your print spooler loaded before DESQview to capture the output from the 
  280. White Papers.
  281.  
  282. PRINTER SETUP:
  283.  
  284.      QWHITE.COM does not attempt to perform any printer setup commands.  If 
  285. you wish to have the printer set up a particular way, you have two options:
  286.  
  287.      1: Many printers provide setup capabilities from a control panel on the 
  288.      printer.  If you use this method, do so before selecting Print from the 
  289.      list screen.
  290.  
  291.      2: There are numerous utilities available that allow the user to set up 
  292.      the printer from software.  If you have DESQview configured to manage 
  293.      printer contention, you may need to run your utility prior to running the 
  294.      White Papers.  If you do not have DESQview configured to manage printer 
  295.      contention, you can open another window and run the utility prior to 
  296.      selecting the Print option from QWHITE.COM's list screen.
  297.  
  298. USING THE QUARTERDECK WHITE PAPERS ON A NETWORK:
  299.  
  300.      QWHITE.COM does not make network specific calls.  If multiple users will 
  301. be running QWHITE.COM from a network drive, the network administrator will 
  302. need to establish some constraints for file access:
  303.  
  304.      a:  Generally, only ONE user should have create rights to the file 
  305.      QWHITE.WPO.  All other users should have read-only access.  QWHITE.COM 
  306.      checks the read-only file attribute on startup and will disable the 
  307.      Create New Open Menu option for users with this file attribute set.  When 
  308.      a new technical note is added to the directory QWHITE.COM is run from, 
  309.      the user with create rights should choose the Create New Open Menu option 
  310.      to generate a new QWHITE.WPO file.  Other users can then restart the 
  311.      program to see the new Open Technote entry.
  312.  
  313.      b:  Users that do not have the read-only attribute set for QWHITE.WPO and 
  314.      also do NOT have create rights will be able to select the create option.  
  315.      QWHITE will scan the files and create the Open Technote menu in memory 
  316.      but will generate an error message when it attempts to write the file to 
  317.      disk.
  318.  
  319.      c:  QWHITE.COM attempts to open technote files in read-only mode.  If the 
  320.      file has been locked by a user then QWHITE.COM will not be able to 
  321.      display the file.  Some word processors and file viewing utilities 
  322.      disable read access to files being edited.  Technical notes are loaded 
  323.      completely into memory when selected and closed immediately.  These files 
  324.      are not left open.
  325.  
  326.      d:  QWHITE.COM loads QWHITE.WPO at startup and then closes the file.  It 
  327.      does not leave the file open after it has been loaded.
  328.  
  329.   ************************************************************************
  330.   *This technical note may be copied and distributed freely as long as it*
  331.   *is distributed in its entirety and it is not distributed for profit.  *
  332.   *         Copyright (C) 1990-2 by Quarterdeck Office Systems           *
  333.   ************************ E N D   O F   F I L E *************************
  334.