home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / dbfd103.zip / DBF_DOC.DOC < prev    next >
Text File  |  1991-03-13  |  11KB  |  300 lines
  1.                      "dbf_DOC - Version 1.03"
  2.                        Copyright 1989,90,91
  3.                        ALL RIGHTS RESERVED
  4.  
  5.                     Registration fee: $20.00
  6.                     ------------------------
  7.  
  8. AUTHOR:                 Micro Data Assist
  9. -------                 2701-C, West 15th
  10.                         Suite 149
  11.                         Plano, Texas  75075
  12.                         (214) 736-3668 
  13.  
  14. INTENDED  USE:          dbf_DOC was developed  to  provide  dBASE 
  15. --------------          developers with a tool to maintain  their 
  16.                         file structure documentation. This system 
  17.                         will  work  with (I hope) all  dBASE  III 
  18.                         compatible file structures. 
  19.  
  20.  
  21. SYSTEM REQUIREMENTS:    IBM PC (or compatible)
  22. --------------------    MS-DOS 2.0 (or greater)
  23.                         512 K free memory
  24.                         mono or color
  25.                         printer (any dot matrix)
  26.  
  27.                         (dBASE III+ code, Clipper compiled)
  28.  
  29. FEATURES:          Menu driven.
  30. --------           Mono or color.
  31.                    ESC - To terminate any action or menu
  32.                    F1 help on all input fields.
  33.                    Self installing.
  34.                    Can be personalized. 
  35.                    Only one of a growing family of products
  36.  
  37. LIST OF FILES:     dbf_DOC.EXE    dbf_DOC program.
  38. --------------     README.1ST     Instructions on installation.
  39.                    dbf_DOC.DOC    Documentation on how to use.  
  40.  
  41. INSTALLATION:
  42. -------------
  43. Follow the instructions outlined in the 'README.1ST' file.
  44.  
  45. SYSTEM  INITIALIZATION:
  46. -----------------------
  47.  
  48. Make  the directory that you loaded 'dbf_DOC.EXE' program  module 
  49. in your current directory. 
  50.  
  51.                 Enter: dbf_DOC <return>
  52.  
  53.  
  54. The  first time that you load 'dbf_DOC.EXE' you are provided  the 
  55. opportunity  to  identify  the disk drive your  data  files  will 
  56. reside  on  and  to  personalize your system.   You  do  this  by 
  57. entering  your  business name into the  field  for  screen/report 
  58. header (the system will center it for you). 
  59.  
  60. Upon  completion of your system initialization a '*.MEM' file  is 
  61. created  that  contains your personalization and  also  signifies 
  62. that  your system has been initialized. You are now ready to  use 
  63. your system. 
  64.  
  65.  
  66. SYSTEM NORMAL USE:
  67. ------------------
  68. Make  the directory that you loaded 'dbf_DOC.EXE' program  module 
  69. in your current directory. 
  70.  
  71.                 Enter: dbf_DOC <return>
  72.  
  73. Select from the menu the function you wish to perform.
  74.  
  75. A) MAINTENANCE - This set of functions allow you to load new file 
  76. ==============   structures  into your library, delete  old  file 
  77. structures from your library, and to add/maintain you file  field 
  78. term definitions.
  79.  
  80. (L)oad  new  file:  With this function you can load  a  new  file 
  81. -----------------   structure  (or reload a modified copy  of  an 
  82. existing file structure) into your library. You identify the disk 
  83. the file structure resides on and the name of the structure.  The 
  84. system  then  retrieves that structure and loads its  image  into 
  85. your  library.  If there already exists a structure of  the  same 
  86. name in your library the old structure is deleted before the  new 
  87. structure is processed. (Note - no terms are deleted when a  file 
  88. structure  is  deleted. In this way other  structures  that  have 
  89. common  fields will retain the term definition you  have  already 
  90. loaded.)
  91.   
  92. (D)elete file: With this function you can delete the structure of 
  93. -------------  an  existing file from your library.  (Note  -  no 
  94. terms  are deleted when a file structure is deleted. In this  way 
  95. other  structures  that have common fields will retain  the  term 
  96. definition you have already loaded.)
  97.  
  98. (F)ile maintenance: With this function you enter and maintain the 
  99. ------------------  term definitions of the fields  contained  in 
  100. the structures you have loaded into your library. Just enter  the 
  101. name of the field and if it is already in your terms library  its 
  102. definition will be displayed to you. If it does not exist in your 
  103. terms  library you are provided the option to add its  definition 
  104. into your library. (Note - only one definition of a field  'term' 
  105.  
  106.  
  107. is maintained in your library even if the field is common to many 
  108. file  structures.  In  this manner you only  need  to  enter  one 
  109. definition  of  the  field and it will be  printed  in  all  file 
  110. documentation listings that use that field.)
  111.  
  112. B)  DICTIONARY LISTINGS: With this set of functions you can  list 
  113. =======================  your  existing terms definition  library 
  114. to  either the printer or to a disk file. All listings to a  disk 
  115. file can then be passed on to a text editor for inclusion in your 
  116. system documentation.
  117.  
  118. (M)aster dictionary: This option lists in alphabetical order  all 
  119. -------------------  fields contained in your terms  library  and 
  120. the definitions you have assigned to them. 
  121.  
  122. (W)here used x-ref: This option will list all occurrences of each 
  123. ------------------   field   in   your   structure   library   in 
  124. alphabetical  order along with the field structure and the  names 
  125. of the files that use it.
  126.  
  127.  
  128. (F)ields not documented: This option will list all fields that do 
  129. -----------------------   not  have a terms  definition  in  your 
  130. terms library. 
  131.  
  132.  
  133. C)  FILE LISTINGS: This set of function all you to list the  file 
  134. =================  structures you have loaded into your  library. 
  135. Each  field with each structure is listed in the order  that  the 
  136. field is captured within the structure. Each field will have  its 
  137. term  definition printed next to it. These file listings  can  be 
  138. directed either to the printer or file. If to a file you can then 
  139. pass this generated file to a text editor for inclusion into  and 
  140. system documentation you are generating.
  141.  
  142. (A)ll  files:  This feature will produce a listing  of  all  file 
  143. ------------   structures  you have loaded into your  library  in 
  144. alphabetical  order by file name. Each file starts a new page  of 
  145. listing.
  146.  
  147. (S)pecific  file: This feature will provide you with a  displayed 
  148. ----------------- listing of all file structures you have  within 
  149. your  library. You can then identify the specific file  structure 
  150. you wish to list out.
  151.  
  152.  
  153.  
  154. D)  UTILITIES: This set of functions allow you to  maintain  your 
  155. =============  system.
  156.  
  157. (R)eindex  data  files: This utility will compress  your  dbf_DOC 
  158. ----------------------- file structures and rebuild their related 
  159. indexs.
  160.  
  161. (F)orce  color to monochrome: This utility is a valuable aid  for 
  162. -----------------------------  those  of  you that  use  lap  top 
  163. computers.  With  this  feature you can force  the  normal  color 
  164. display to that of monochrome. This will make all displays easier 
  165. to view.
  166.  
  167. (D)elete unused terms: This utility will remove from your terms -
  168. ----------------------    library   all   terms,   and    related 
  169. definitions,  that  do  not have a matching  field  in  the  file 
  170. structure  library.  (Note - this is the only way  that  you  can 
  171. delete terms that are no longer used.)
  172.  
  173. (U)pdate personalization: This utility allows you to update  your 
  174. ------------------------   system  personalization   information. 
  175. PLEASE  REVIEW THE INFORMATION CONTAINED IN YOUR  PERSONALIZATION 
  176. FILE BEFORE YOU FILE FOR SYSTEM REGISTRATION. 
  177.  
  178. (P)rint   registration   form:  This  utility  will   print   the 
  179. -----------------------------  registration form that you need to 
  180. complete and send in to register your use of 'dbf_DOC' with. 
  181.  
  182.  
  183.                       *********************
  184.  
  185.  
  186. dbf_DOC has built into it a limited word processor. The following 
  187. keys are used to control your editing of your letters:
  188.  
  189. KEY                        PURPOSE
  190. -------------------------  --------------------------------------
  191. Uparrow or Ctrl-E          Move up one line
  192. Dnarrow or Ctrl-X          Move down one line
  193. Leftarrow or Ctrl-S        Move left one character
  194. Rightarrow or Ctrl-D       Move right one character
  195. Ctrl-Leftarrow or Ctrl-A   Move left one work
  196. Ctrl-Rightarrow or Ctrl-F  Move right one word
  197. Home                       Beginning of current line
  198. End                        End of current line
  199. Ctrl-Home                  Beginning of current window
  200. Ctrl-End                   End of current window
  201. PgUp                       Previous edit window
  202. PgDn                       Next edit window
  203. Ctrl-PgUp                  Beginning of letter
  204. Ctrl-PgDn                  End of letter
  205. Return                     Move to beginning of next line
  206. Delete                     Delete character at cursor
  207. Backspace                  Delete character to left of cursor
  208. Tab                        Insert tab character or spaces
  209. Printable characters       Insert character
  210. Ctrl-Y                     Delete the current line
  211. Ctrl-T                     Delete work right
  212. Ctrl-B                     Reform paragraph
  213. Ctrl-V,Ins                 Toggle insert mode
  214. Ctrl-W                     Finish editing and save
  215. Esc                        Abort edit and return original
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222. FULL SCREEN NAVIGATION KEYS:
  223. ---------------------------
  224. KEY                  PURPOSE
  225. -----------------------------------------------------------------
  226. Leftarow,            Character left. Does not move cursor to
  227. Ctrl-S               previous GET. 
  228.  
  229. Rightarrow,          Character right. At end of GET, cursor moves
  230. Ctrl-D               to next GET.
  231.  
  232. Ctrl-Leftarrow,      Word left.
  233. Ctrl-A
  234.  
  235. Ctrl-Rightarrow,     Word right.
  236. Ctrl-F
  237.  
  238. Uparrow,             Previous GET.
  239. Ctrl-E 
  240.  
  241. Dnarrow,             Next GET.
  242. Ctrl-X,
  243. Return,
  244. Ctrl-M
  245.  
  246. Home                 Beginning of GET.
  247.  
  248. End                  Last character of GET.
  249.  
  250. Ctrl-Home            Beginning of first GET.
  251.  
  252. Ctrl-End             Beginning of last GET.
  253.  
  254.  
  255. FULL SCREEN EDITING KEYS:
  256. -------------------------
  257.  
  258. KEY                  PURPOSE
  259. -----------------------------------------------------------------
  260. Del,                 Delete character at cursor position.
  261. Ctrl-G
  262.  
  263. Backspace,           Destructive backspace.
  264. Ctrl-H
  265.  
  266. Ctrl-T               Delete word right.
  267.  
  268. Ctrl-Y               Delete from cursor position to end of GET.
  269.  
  270. Ctrl-U               Restore current GET to original value.
  271.  
  272.  
  273.  
  274.  
  275. FULL SCREEN ESCAPE KEYS:
  276. ------------------------
  277.  
  278. KEY                  PURPOSE
  279. -----------------------------------------------------------------
  280. Ctrl-W,              Terminate READ saving current GET.
  281. Ctrl-C,
  282. PgUp,
  283. PgDn
  284.  
  285. Return,              Terminate READ from last GET.
  286. Ctrl-M
  287.  
  288. Esc                  Terminate READ without saving current GET.
  289.  
  290.  
  291. FULL SCREEN MODE KEYS:
  292. ----------------------
  293.  
  294. KEY                  PURPOSE
  295. -----------------------------------------------------------------
  296. Ins,                 Toggle insert mode.
  297. Ctrl-V
  298.  
  299.  
  300.