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