home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / opendc12.zip / od124os2.exe / od12ort1.exe / locale / en_us / pmeister.hlp (.txt) < prev    next >
OS/2 Help File  |  1997-04-02  |  11KB  |  319 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. Note:  For technical information about PartMeister and creating templates, see 
  8.        the OpenDoc Programming Guide. 
  9.  
  10. The PartMeister notebook is made up of the following pages: 
  11.  
  12.     Template 
  13.     Part 
  14.     Symbols 
  15.  
  16.  
  17. ΓòÉΓòÉΓòÉ 2. Template ΓòÉΓòÉΓòÉ
  18.  
  19. The template determines what files are generated and the content of the files. 
  20. Templates use the information provided by the user to create custom components 
  21. based on the values entered. Selecting an item in the Template list causes a 
  22. description of the template function to be displayed in the Description box. 
  23.  
  24. Note:  For information on creating your own templates, see the OpenDoc 
  25.        Programming Guide. 
  26.  
  27. For more information, select from the following: 
  28.  
  29.     Template 
  30.     Description 
  31.  
  32.  
  33. ΓòÉΓòÉΓòÉ <hidden> Template ΓòÉΓòÉΓòÉ
  34.  
  35. Select the down-arrow on the right-hand side of the Template field to display a 
  36. list of templates. From the list, you can select the template on which to base 
  37. the generated part. When you select a template from the list, a description of 
  38. what the generated part will do is displayed in the Description box. 
  39.  
  40.  
  41. ΓòÉΓòÉΓòÉ <hidden> Description ΓòÉΓòÉΓòÉ
  42.  
  43. The Description box displays a description of the template selected from the 
  44. Template drop-down list. The description explains what the part derived from 
  45. the template will do. 
  46.  
  47.  
  48. ΓòÉΓòÉΓòÉ 3. Part ΓòÉΓòÉΓòÉ
  49.  
  50. Use the Part page to specify additional information about the part you are 
  51. generating. 
  52.  
  53. For more information, select from the following: 
  54.  
  55.     Class name 
  56.     Short name 
  57.     Desktop display name 
  58.     Category 
  59.     Category display name 
  60.     Kind 
  61.     Kind display name 
  62.  
  63.  
  64. ΓòÉΓòÉΓòÉ <hidden> Class Name ΓòÉΓòÉΓòÉ
  65.  
  66. Use the Class name field to specify a class name for the part you are 
  67. generating. The class name is used as the SOM class name for the component. 
  68.  
  69.  
  70. ΓòÉΓòÉΓòÉ <hidden> Short Name ΓòÉΓòÉΓòÉ
  71.  
  72. Use the Short name field to specify a short name to use when generating the 
  73. part. A short name of 1 to 8 characters (a limitation imposed by the FAT file 
  74. system) is required for generating file names. Only valid characters for a file 
  75. name may be used (spaces are not allowed). 
  76.  
  77.  
  78. ΓòÉΓòÉΓòÉ <hidden> Desktop Display Name ΓòÉΓòÉΓòÉ
  79.  
  80. Use the Desktop display name to specify a name for the part you are generating. 
  81. This is the name used to label the icon on the Desktop after the part is 
  82. generated. During registration, OpenDoc requests a display name from the part. 
  83. This name will be returned. 
  84.  
  85.  
  86. ΓòÉΓòÉΓòÉ <hidden> Category ΓòÉΓòÉΓòÉ
  87.  
  88. Use the Category field to indicate the general data type for a part. Categories 
  89. are defined by CI-Labs or created by the part developer. Specify the category 
  90. by performing one of the following actions: 
  91.  
  92.     Select the down-arrow on the right-hand side of the field to display the 
  93.      list of supplied categories, and then select a category. 
  94.  
  95.     Specify your own category by typing the category into the field. 
  96.  
  97.  
  98. ΓòÉΓòÉΓòÉ <hidden> Category Display Name ΓòÉΓòÉΓòÉ
  99.  
  100. Use the Category display name field to specify a readable name for the 
  101. category. 
  102.  
  103.  
  104. ΓòÉΓòÉΓòÉ <hidden> Kind ΓòÉΓòÉΓòÉ
  105.  
  106. Use the Kind field to specify the specific data type of the part. For example, 
  107. the kind could refer to the format of data for a specific word processor. 
  108.  
  109. A common format for kind is Company:Kind:ClassName for unique data types. For 
  110. example: 
  111.  
  112.  IBM:Kind:MyPart
  113.  
  114.  
  115. ΓòÉΓòÉΓòÉ <hidden> Kind Display Name ΓòÉΓòÉΓòÉ
  116.  
  117. Use the Kind display name to specify a readable name for specified kind. 
  118.  
  119.  
  120. ΓòÉΓòÉΓòÉ 4. Symbols ΓòÉΓòÉΓòÉ
  121.  
  122. Use the Symbols page to display information about the symbols that have been 
  123. defined for the selected template. The list is empty if there are no additional 
  124. symbols defined for the template. 
  125.  
  126. For more information, select from the following: 
  127.  
  128.     Symbol 
  129.     Value 
  130.  
  131.  
  132. ΓòÉΓòÉΓòÉ <hidden> Symbol ΓòÉΓòÉΓòÉ
  133.  
  134. Select the down-arrow on the right-hand side of the Symbol field to display a 
  135. list of additional symbols defined for the template from which you can select. 
  136. When you select a symbol, its value is displayed in the Value box. 
  137.  
  138. Note:  Not all templates have additional symbols defined. If no symbols are 
  139.        defined, the list is empty. 
  140.  
  141.  
  142. ΓòÉΓòÉΓòÉ <hidden> Value ΓòÉΓòÉΓòÉ
  143.  
  144. The Value box displays the value associated with the symbol selected from the 
  145. Symbol list. You can view or change the value. 
  146.  
  147. Note:  Not all templates have additional symbols defined. If no symbols are 
  148.        defined, the list is empty. 
  149.  
  150.  
  151. ΓòÉΓòÉΓòÉ 5. Part ΓòÉΓòÉΓòÉ
  152.  
  153. Select the Part menu to display a menu of actions related to the creation of 
  154. parts, including source code generation and settings related to the generation 
  155. processing. 
  156.  
  157. The following menu items are available from the Part menu: 
  158.  
  159.     New 
  160.     Generate 
  161.     Settings 
  162.  
  163.  
  164. ΓòÉΓòÉΓòÉ 5.1. New ΓòÉΓòÉΓòÉ
  165.  
  166. Select the New menu item to clear all entry fields and reset initial values 
  167. where applicable. 
  168.  
  169.  
  170. ΓòÉΓòÉΓòÉ 5.2. Generate ΓòÉΓòÉΓòÉ
  171.  
  172. Select the Generate menu item to generate an OpenDoc part based on the 
  173. currently specified values and settings information. 
  174.  
  175.  
  176. ΓòÉΓòÉΓòÉ 5.3. Settings ΓòÉΓòÉΓòÉ
  177.  
  178. Select the Settings menu item to open a notebook in which you can specify the 
  179. settings for copyright information, directories, and platform-specific 
  180. generation directives. 
  181.  
  182.  
  183. ΓòÉΓòÉΓòÉ 6. Help ΓòÉΓòÉΓòÉ
  184.  
  185. Select the Help menu to display a menu of information that can assist you in 
  186. learning and using PartMeister. 
  187.  
  188. The following menu items are available from the Help menu: 
  189.  
  190.     Help index 
  191.     General help 
  192.     Using help 
  193.     Product information 
  194.  
  195.  
  196. ΓòÉΓòÉΓòÉ 6.1. Help Index ΓòÉΓòÉΓòÉ
  197.  
  198. Select the Help index menu item to display a window containing the PartMeister 
  199. help index listing. Use the index to select a help topic to view. 
  200.  
  201.  
  202. ΓòÉΓòÉΓòÉ 6.2. General Help ΓòÉΓòÉΓòÉ
  203.  
  204. Select the General help menu item to display an overview of PartMeister and its 
  205. functions. 
  206.  
  207.  
  208. ΓòÉΓòÉΓòÉ 6.3. Using Help ΓòÉΓòÉΓòÉ
  209.  
  210. Select the Using help menu item do display information about using the help 
  211. facility. 
  212.  
  213.  
  214. ΓòÉΓòÉΓòÉ 6.4. Product Information ΓòÉΓòÉΓòÉ
  215.  
  216. Select the Product information menu item to view a panel giving the release 
  217. date and version number for your version of PartMeister. This panel does not 
  218. connect to any further function. Select the OK push button after noting the 
  219. information you need. 
  220.  
  221.  
  222. ΓòÉΓòÉΓòÉ 7. Copyright ΓòÉΓòÉΓòÉ
  223.  
  224. Use the Copyright page to specify general information to include in the header 
  225. information for each source file created using PartMeister. 
  226.  
  227. For more information, select from the following: 
  228.  
  229.     Author 
  230.     Company 
  231.     Years 
  232.  
  233.  
  234. ΓòÉΓòÉΓòÉ <hidden> Author ΓòÉΓòÉΓòÉ
  235.  
  236. Use the Author field to specify a name representing the creator of the file. 
  237. The name you specify becomes the Author line in the header information of each 
  238. source file. If you leave this field blank, the author name is not included in 
  239. the header. 
  240.  
  241.  
  242. ΓòÉΓòÉΓòÉ <hidden> Company ΓòÉΓòÉΓòÉ
  243.  
  244. Use the Company field to specify the name of your company for copyright 
  245. purposes. The company name you specify becomes part of the copyright line 
  246. included in the header information of each source file. 
  247.  
  248. For example: 
  249.  
  250.  Copyright (c) 1996, ABC Inc.
  251.  
  252. Where ABC Inc. represents the company name you specify. 
  253.  
  254.  
  255. ΓòÉΓòÉΓòÉ <hidden> Years ΓòÉΓòÉΓòÉ
  256.  
  257. Use the Years field to specify the current year and other years in which the 
  258. files are copyrighted. The years you specify become part of the copyright line 
  259. included in the header information of each source file. 
  260.  
  261. For example: 
  262.  
  263.  Copyright (c) 1995, 1996, ABC Inc.
  264.  
  265. Where 1995, 1996 represents the company name you specify. 
  266.  
  267.  
  268. ΓòÉΓòÉΓòÉ 8. Directory ΓòÉΓòÉΓòÉ
  269.  
  270. Use the Directory page to specify directory and location information for the 
  271. source files. 
  272.  
  273. For more information, select from the following: 
  274.  
  275.     Runtime 
  276.     Public files 
  277.     Output 
  278.  
  279.  
  280. ΓòÉΓòÉΓòÉ <hidden> Runtime ΓòÉΓòÉΓòÉ
  281.  
  282. Use the Runtime field to specify the location of the OpenDoc runtime (the user 
  283. runtime). The makefiles included with PartMeister copy the DLL generated to 
  284. this directory of the runtime after a successful build. 
  285.  
  286.  
  287. ΓòÉΓòÉΓòÉ <hidden> Public Files ΓòÉΓòÉΓòÉ
  288.  
  289. Use the Public files field to specify the location (public directory) where all 
  290. files that are used by more than one component are stored. For example, any 
  291. part that may be used as a superclass should have its IDL, XH, and LIB files 
  292. stored in the public directory. 
  293.  
  294. You should create a new public directory in a directory that is created 
  295. specifically for creating OpenDoc parts. 
  296.  
  297. For example: 
  298.  
  299.  C:\ODPARTS\PUBLIC
  300.  
  301.  
  302. ΓòÉΓòÉΓòÉ <hidden> Output ΓòÉΓòÉΓòÉ
  303.  
  304. Use the Output field to specify the directory in which the generated source 
  305. files will be stored. When a part is generated, a subdirectory is created 
  306. inside this directory (using the short name). All source files generated are 
  307. created inside the new subdirectory. 
  308.  
  309. You should create a new directory specifically for creating OpenDoc parts, and 
  310. specify that directory here. For example: 
  311.  
  312.  C:\ODPARTS
  313.  
  314.  
  315. ΓòÉΓòÉΓòÉ <hidden> Product Info ΓòÉΓòÉΓòÉ
  316.  
  317. Displays application, copyright, and support information. 
  318.  
  319. Select the Close push button to close the dialog.