home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / pm6tool.zip / pmeister.hlp (.txt) < prev    next >
OS/2 Help File  |  1996-08-05  |  7KB  |  211 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Overview ΓòÉΓòÉΓòÉ
  3.  
  4. PartMeister is a tool for generating OpenDoc part source code, allowing rapid 
  5. creation of new components based on templates. 
  6.  
  7. For technical information PartMeister and creating templates, see the 
  8. PartMeister Developer's Guide. 
  9.  
  10.  
  11. ΓòÉΓòÉΓòÉ 2. Menu Selections ΓòÉΓòÉΓòÉ
  12.  
  13.  
  14. ΓòÉΓòÉΓòÉ 2.1. Part menu ΓòÉΓòÉΓòÉ
  15.  
  16. The part menu contains actions related to the creation of parts, including 
  17. source code generation and settings related to the generation processing. 
  18.  
  19.  
  20. ΓòÉΓòÉΓòÉ 2.1.1. New ΓòÉΓòÉΓòÉ
  21.  
  22. Clear all entry fields, reset initial values where applicable. 
  23.  
  24.  
  25. ΓòÉΓòÉΓòÉ 2.1.2. Generate ΓòÉΓòÉΓòÉ
  26.  
  27. Generates an OpenDoc part based on the currently specified values and settings 
  28. information. 
  29.  
  30.  
  31. ΓòÉΓòÉΓòÉ 2.1.3. Settings ΓòÉΓòÉΓòÉ
  32.  
  33. A notebook with the settings for copyright information, directories and 
  34. platform specific generation directives. 
  35.  
  36.  
  37. ΓòÉΓòÉΓòÉ 2.2. Help menu ΓòÉΓòÉΓòÉ
  38.  
  39. The help menu provides access to information to assist learning and using the 
  40. application. 
  41.  
  42.  
  43. ΓòÉΓòÉΓòÉ 2.3. Help index ΓòÉΓòÉΓòÉ
  44.  
  45. Index of help topics. 
  46.  
  47.  
  48. ΓòÉΓòÉΓòÉ 2.4. General help ΓòÉΓòÉΓòÉ
  49.  
  50. General overview of the application and its function. 
  51.  
  52.  
  53. ΓòÉΓòÉΓòÉ 2.5. Using help ΓòÉΓòÉΓòÉ
  54.  
  55. Guide to using the help system. 
  56.  
  57.  
  58. ΓòÉΓòÉΓòÉ 2.6. Product information ΓòÉΓòÉΓòÉ
  59.  
  60. Display product name and copyright information. 
  61.  
  62.  
  63. ΓòÉΓòÉΓòÉ 2.7. Template ΓòÉΓòÉΓòÉ
  64.  
  65. The selected template determines what files are generated and the content of 
  66. the files. Templates use the information provided by the user to create custom 
  67. components based on the values entered. As each item in the list is selected, a 
  68. description of the template's function will be displayed in the description 
  69. display. 
  70.  
  71. For information on creating your own templates, see the PartMeister Developer's 
  72. Guide. 
  73.  
  74.  
  75. ΓòÉΓòÉΓòÉ 2.8. Class name ΓòÉΓòÉΓòÉ
  76.  
  77. The class name is used as the SOM class name for the component. 
  78.  
  79.  
  80. ΓòÉΓòÉΓòÉ 2.9. Short name ΓòÉΓòÉΓòÉ
  81.  
  82. A short name, from 1 to 8 characters, is required for generating file names - 
  83. as the FAT file system imposes this limitation.  Only valid characters for a 
  84. file name may be used (ie. no spaces). 
  85.  
  86.  
  87. ΓòÉΓòÉΓòÉ 2.10. Category ΓòÉΓòÉΓòÉ
  88.  
  89. Categories are defined by CI-Labs, or created by the part developer, to 
  90. indicated the general data type for a part.  A list of defined categories is 
  91. provided in the drop-down list or you may type your own. 
  92.  
  93.  
  94. ΓòÉΓòÉΓòÉ 2.11. Kind ΓòÉΓòÉΓòÉ
  95.  
  96. Kind refers to the specific data type, for instance the format of data for a 
  97. specific word processor. 
  98.  
  99. A common format for kind is Company:Kind:ClassName for unique data types (ie. 
  100. IBM:Kind:MyPart). 
  101.  
  102.  
  103. ΓòÉΓòÉΓòÉ 2.12. Display name ΓòÉΓòÉΓòÉ
  104.  
  105. During registration, OpenDoc requests a display name from the part. This name 
  106. will be returned. 
  107.  
  108.  
  109. ΓòÉΓòÉΓòÉ 2.13. Kind display name ΓòÉΓòÉΓòÉ
  110.  
  111. The readable form of the kind. 
  112.  
  113.  
  114. ΓòÉΓòÉΓòÉ 2.14. Category display name ΓòÉΓòÉΓòÉ
  115.  
  116. The readable form of the category. 
  117.  
  118.  
  119. ΓòÉΓòÉΓòÉ 2.15. Author name ΓòÉΓòÉΓòÉ
  120.  
  121. In the header information for each source file, the author line will contain 
  122. this name. 
  123.  
  124.  
  125. ΓòÉΓòÉΓòÉ 2.16. Company name ΓòÉΓòÉΓòÉ
  126.  
  127. In the header information for each source file, the copyright line will contain 
  128. this name (ie. Copyright (c) 1995, ABC Inc). 
  129.  
  130.  
  131. ΓòÉΓòÉΓòÉ 2.17. Copyright years ΓòÉΓòÉΓòÉ
  132.  
  133. In the header information for each source file, the copyright line will contain 
  134. these years (ie. Copyright (c) 1995-1996, ABC Inc). 
  135.  
  136.  
  137. ΓòÉΓòÉΓòÉ 2.18. Runtime directory ΓòÉΓòÉΓòÉ
  138.  
  139. The runtime directory specifies the location of the OpenDoc runtime (the user 
  140. runtime). The makefiles shipped with PartMeister copy the DLL generated to this 
  141. directory of the runtime after a successful build. 
  142.  
  143.  
  144. ΓòÉΓòÉΓòÉ 2.19. Public directory ΓòÉΓòÉΓòÉ
  145.  
  146. The public directory is the location where all files that are used by more than 
  147. one component are stored. For example, any part that may be used as a 
  148. superclass should have its IDL, XH and LIB files stored in the public 
  149. directory. 
  150.  
  151. It is recommended that you create a new public directory in a directory that is 
  152. created specifically for creating OpenDoc parts (ie. C:\ODPARTS\PUBLIC). 
  153.  
  154.  
  155. ΓòÉΓòÉΓòÉ 2.20. Output directory ΓòÉΓòÉΓòÉ
  156.  
  157. When a part is generated, a subdirectory will be created inside this directory 
  158. (using the short name). All source files generated will be created inside the 
  159. new subdirectory. 
  160.  
  161. It is recommended that you create a new directory specifically for creating 
  162. OpenDoc parts, and specify that directory here (ie. C:\ODPARTS). 
  163.  
  164.  
  165. ΓòÉΓòÉΓòÉ 2.21. Product Info ΓòÉΓòÉΓòÉ
  166.  
  167. Displays application, copyright and support information. 
  168.  
  169. Click the Close pushbutton to dismiss the dialog. 
  170.  
  171.  
  172. ΓòÉΓòÉΓòÉ 2.22. Template ΓòÉΓòÉΓòÉ
  173.  
  174. List of templates from which to select the template to base the generated part 
  175. on. When a template is selected from the list, a description of what the 
  176. generated part will do is displayed in the description area. 
  177.  
  178.  
  179. ΓòÉΓòÉΓòÉ 2.23. Description ΓòÉΓòÉΓòÉ
  180.  
  181. When a template is selected from the list, a description is displayed that 
  182. explains what the part derived from the template will do in this display area. 
  183.  
  184.  
  185. ΓòÉΓòÉΓòÉ 2.24. Symbols ΓòÉΓòÉΓòÉ
  186.  
  187. If a template has defined any additional symbols, they will be listed in the 
  188. Symbols list. When a symbol is selected from the list its value is displayed in 
  189. the Value area, and may be updated by the user. 
  190.  
  191.  
  192. ΓòÉΓòÉΓòÉ 2.25. Symbol value ΓòÉΓòÉΓòÉ
  193.  
  194. The value for the currently selected symbol is displayed and may be updated by 
  195. the user. Note, not all templates have additional symbols defined, so there may 
  196. not be any symbols to set. 
  197.  
  198.  
  199. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  200.  
  201. A trademark of IBM Corporation. 
  202.  
  203.  
  204. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  205.  
  206. A trademark of Apple Computer Inc. 
  207.  
  208.  
  209. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  210.  
  211. A trademark of Microsoft Corporation.