home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / odas11.zip / ODAS.DAT < prev    next >
Text File  |  1993-07-09  |  9KB  |  392 lines
  1. .* Online Document Authoring System (ODAS) version 1.0
  2. .* Standard Edition for OS/2 2.X
  3. .* Information Presentation Facility (IPF) Source File
  4. .*
  5. .*
  6. :userdoc.
  7. :title.Online Document Authoring System
  8. :docprof toc=123.
  9. :h1.Copyright notice
  10. :p.
  11. Online Document Authoring System (ODAS)
  12.  
  13. :p.
  14. Version 1.0 - Standard Edition
  15.  
  16. :p.
  17. Copyright (C) - 1993 by Douglas A. Bebber
  18.  
  19. :p.
  20. All rights reserved.
  21.  
  22. :p.
  23.  
  24.  
  25. :h1.Introduction
  26. :p.
  27. Welcome to the Online Document Authoring System (ODAS) for OS/2.
  28. The ODAS program helps you to create OS/2 Information Presentation
  29. Facility (IPF) online documents without requiring knowledge of the IPF
  30. Tag Language.
  31.  
  32. :p.
  33. Using the ODAS program you create your online documents visually. The
  34. ODAS program generates the required IPF source files for you automatically.
  35. This ODAS version 1.0 - Standard Edition is a shareware product. The ODAS
  36. version 1.0 - Standard Edition has very limited capabilities. The Professional
  37. Edition has more features such as the ability to create hypertext links
  38. image
  39. capabilities
  40. indexing abilities and more.
  41.  
  42. :p.
  43. Registered users of the ODAS version 1.0 - Standard Edition package are
  44. given a free font system upgrade which allows you to set and vary font types
  45. in your online documents. You can register your ODAS version 1.0 - Standard
  46. Edition package for only $19.95 (see the How to Register section of this
  47. document).
  48.  
  49. :p.
  50. The ODAS version 1.0 - Professional Edition package retails for $99.95. To
  51. order your copy today see the information in the How to Register section of
  52. this document.
  53.  
  54. :p.
  55.  
  56.  
  57. :h1.How to Register
  58. :p.
  59. To register your copy of the Online Document Authoring System (ODAS)
  60. version 1.0 - Standard Edition send a check or money order for $19.95
  61. to:
  62.  
  63. :p.
  64. Douglas A. Bebber
  65.  
  66. :p.
  67. 1834 37th Street
  68.  
  69. :p.
  70. Rock Island
  71. Illinois 61201
  72.  
  73. :p.
  74. (Make notes payable to: Douglas A. Bebber)
  75.  
  76. :p.
  77. Registered users will receive a font upgrade package which will allow
  78. users to set different font types in their online documents. Registered users
  79. also receive an ODAS User's Manual which provides detailed examples of
  80. how to create OS/2 IPF online documents.
  81.  
  82. :p.
  83.  
  84.  
  85. :h1.System requirements
  86. :p.
  87. The Online Document Authoring System (ODAS) version 1.0 - Standard
  88. Edition executes under Microsoft Windows 3.X (standard or 386 enhanced
  89. modes) or Win-OS/2 (Standard or 386 enhanced modes).
  90.  
  91. :p.
  92. The ODAS program generates IPF source files which must then be processed
  93. by the OS/2 IPF compiler in order to generate online documents which can
  94. be read by the OS/2 IPF Viewer program.
  95.  
  96. :p.
  97. You must have the OS/2 IPF compiler to produce your final online documents.
  98.  
  99. :p.
  100.  
  101.  
  102. :h1.User interface
  103. :p.
  104. The ODAS user interface consists of a single main window that contains a
  105. Topic text box
  106. five push button controls
  107. and a Document Topic Structure
  108. list box.  The ODAS main window also has a menu which is discussed in the
  109. Main menu section of this document.
  110.  
  111. :p.
  112.  
  113.  
  114. :h2.Topic text box
  115. :p.
  116. The Topic text box is where you enter new document topics. Once you have
  117. typed in a topic and hit the <Enter> key
  118. the new topic is transfered to the
  119. Document Topic Structure list box. Topics entered in this manner are
  120. appended to the end of of the Document Topic Structure list.
  121.  
  122. :p.
  123.  
  124.  
  125. :h2.Document Topic Structure list box
  126. :p.
  127. This list box holds the entire list of topics that make up your online document.
  128. The sequential order of the topics in this list box is the same order of topics
  129. as presented in your online document.
  130.  
  131. :p.
  132. To enter the text for your topics
  133. double-click on the topic in the Document
  134. Topic Structure list box and you will be presented with a window which you
  135. can use to enter the text associated with that topic.
  136.  
  137. :p.
  138. IPF document topics can be presented in "tree" like structures. The ODAS
  139. Document Topic Structure list box visually illustrates the document's topic
  140. tree structure. You are able to define the tree structure of your topics visually
  141. using the ODAS program.
  142.  
  143. :p.
  144.  
  145.  
  146. :p.
  147.  
  148.  
  149. :h2.Push buttons
  150. :p.
  151. The following push buttons are present on the ODAS main window:
  152.  
  153. :p.
  154. + Shift Left push button
  155.  
  156. :p.
  157. + Shift Right push button
  158.  
  159. :p.
  160. + Insert push button
  161.  
  162. :p.
  163. + Delete push button
  164.  
  165. :p.
  166. + Generate push button
  167.  
  168. :p.
  169.  
  170.  
  171. :h3.Shift Left button
  172. :p.
  173. The Shift Left push button moves a topic up a level in the topic tree
  174. structure.
  175.  
  176. :p.
  177.  
  178.  
  179. :h3.Shift Right button
  180. :p.
  181. The Shift Right push button moves a topic down a level in the topic tree
  182. structure.
  183.  
  184. :p.
  185.  
  186.  
  187. :h3.Insert button
  188. :p.
  189. The Insert push button is used to insert a new topic (located in the Topic
  190. text box) before the highlighted topic in the Document Topic Structure list
  191. box.
  192.  
  193. :p.
  194.  
  195.  
  196. :h3.Delete button
  197. :p.
  198. The Delete push button is used to delete or remove the highlighted topic in
  199. the Document Topic Structure list box.
  200.  
  201. :p.
  202.  
  203.  
  204. :h3.Generate button
  205. :p.
  206. The Generate push button is used to generate an IPF source file from the
  207. information entered visually into the ODAS program. When the Generate
  208. push button is pressed
  209. the ODAS program generates the IPF source file
  210.  
  211. :p.
  212. places the source file contents into a window
  213. and then presents that window
  214. to you so that you may view the IPF source code.
  215.  
  216. :p.
  217.  
  218.  
  219. :h1.Main menu
  220. :p.
  221. The following sections describe the ODAS menu options.
  222.  
  223. :p.
  224.  
  225.  
  226. :h2.File
  227. :p.
  228. The File menu has the following options:
  229.  
  230. :p.
  231. + Open
  232.  
  233. :p.
  234. + Print
  235.  
  236. :p.
  237. + Save
  238.  
  239. :p.
  240. + Exit
  241.  
  242. :p.
  243.  
  244.  
  245. :h3.Open
  246. :p.
  247. The Open menu option when selected allows you to open an ODAS
  248. Document Definition File (DDF). ODAS stores your visual document
  249. constructs in DDF files. The DDF files are used only for long term storage
  250. of ODAS online documents.
  251.  
  252. :p.
  253.  
  254. :h3.Print
  255. :p.
  256. The Print menu option when selected will make a hard copy of your
  257. documents IPF source file.
  258.  
  259. :p.
  260. Note: You must have pressed the Generate push button prior to selecting
  261. the Print menu option. ODAS must generate the IPF source file before it can
  262. print the IPF source file.
  263.  
  264. :p.
  265.  
  266.  
  267. :h3.Save
  268. :p.
  269. The Save menu option saves the appropriate ODAS files to disk. The ODAS
  270. program saves files in two different formats:
  271.  
  272. :p.
  273.  
  274. + .DAT (IPF source file)
  275.  
  276. :p.
  277. + .DDF (ODAS Document Definition file)
  278.  
  279. :p.
  280. When the Save menu option is selected, a DDF file is always stored to disk
  281. (unless you cancel the Save dialog). A DAT file is also saved if you 
  282. generated the IPF source file (pressing the Generate push button) before
  283. selecting the Save menu option.
  284.  
  285. :p.
  286. Note: See the ODAS file formats section of this document for more
  287. information concerning ODAS related file formats.
  288.  
  289. :p.
  290.  
  291.  
  292. :h3.Exit
  293. :p.
  294. The Exit menu option, when selected, terminates the ODAS program.
  295.  
  296. :p.
  297.  
  298. :h2.Document
  299. :p.
  300. The Document menu has two options:
  301.  
  302. :p.
  303. + Title
  304.  
  305. :p.
  306. + View IPF Source File
  307.  
  308. :p.
  309.  
  310.  
  311. :h3.Title
  312. :p.
  313. The Title menu option allows you to title your online document. When you
  314. select the Title menu option, you are presented with a dialog requesting
  315. the title of the document.
  316.  
  317. :p.
  318. The title you set here becomes the title in the completed IPF online
  319. document.
  320.  
  321. :p.
  322.  
  323. :h3.View IPF Source File
  324. :p.
  325. This menu option displays the IPF source file in a window for your review.
  326.  
  327. :p.
  328. Note: You must first generate an IPF source file by pressing the Generate
  329. push button.
  330.  
  331. :p.
  332.  
  333. :h1.ODAS file formats
  334. :p.
  335. The ODAS program saves files in two different file formats:
  336.  
  337. :p.
  338. + DAT (IPF source file)
  339.  
  340. :p.
  341. + DDF (ODAS Document Definition file)
  342.  
  343. :p.
  344.  
  345.  
  346. :p.
  347.  
  348. :h2.IPF source files
  349. :p.
  350. When you press the Generate push button, the ODAS program generates
  351. an OS/2 IPF source file. To complete the creation of your OS/2 IPF online
  352. document the IPF source file must be compiled by the OS/2 IPF compiler
  353. program (this step must be accomplished before you can read your online
  354. document via the OS/2 IPF Viewer program).
  355.  
  356. :p.
  357. Example:
  358.  
  359. :p.
  360. To compile your IPF source file type in:
  361.  
  362. :p.
  363. IPFC <Filename.DAT> /INF /S /X /W
  364.  
  365. :p.
  366. Note:
  367.  
  368. :p.
  369. /INF is to create an online document as opposed to a help document.
  370.  
  371. :p.
  372.  
  373. When you select the Save menu option, an ODAS DDF file is saved and if
  374. you have generated the IPF source file, that is saved as a DAT file.
  375.  
  376. :p.
  377.  
  378.  
  379. :p.
  380.  
  381.  
  382. :h2.Document definition files
  383. :p.
  384. The ODAS DDF format is for ODAS program use only. It simply provides a
  385. means to long term storage for your ODAS visual document constructs.
  386.  
  387. :p.
  388.  
  389.  
  390. :euserdoc.
  391.  
  392.