home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / odtlktv4.zip / ODTLKT / TOOLKIT / BETA / BOOK / PMEISTER.INF (.txt)
OS/2 Help File  |  1995-12-15  |  8KB  |  220 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Overview ΓòÉΓòÉΓòÉ
  3.  
  4. PartMeister is a wizard for creating OpenDoc components from templates. In this 
  5. initial release, a template is provided for creating parts derived from the 
  6. ContainerPart sample part shipped with the toolkit. 
  7.  
  8. By using PartMeister to generate a new component, you may immediately compile 
  9. the code, register the component and test it out. 
  10.  
  11. Templates may be added and modified, allowing the tool to be extended. 
  12.  
  13.  
  14. ΓòÉΓòÉΓòÉ 2. Copyright ΓòÉΓòÉΓòÉ
  15.  
  16. IBM PartMeister 
  17. Copyright (c) 1995, IBM Corporation 
  18. all rights reserved 
  19.  
  20.  
  21. ΓòÉΓòÉΓòÉ 3. Support ΓòÉΓòÉΓòÉ
  22.  
  23. Updates for PartMeister will be available on the WorldWide Web at ClubOpenDoc 
  24. http://www.software.ibm.com/clubopendoc 
  25.  
  26. Support for this tool and accompanying documentation is available 
  27. electronically from, 
  28.  
  29.      Club OpenDoc (see URL above) 
  30.  
  31.      CI-Labs list server (OpenDoc-Interest@CILabs.ORG) 
  32.  
  33.      Internet mail to opendoc@austin.ibm.com 
  34.  
  35.      the OPENDOC CFORUM on TalkLink 
  36.  
  37.      for IBM staff, OPENDOC FORUM on IBMPC 
  38.  
  39.  
  40. ΓòÉΓòÉΓòÉ 4. Installation ΓòÉΓòÉΓòÉ
  41.  
  42. If you received PartMeister with the OpenDoc toolkit, then the product is 
  43. installed with the regular installation of the toolkit, no further installation 
  44. steps are required. Proceed with configuration. 
  45.  
  46.  
  47. ΓòÉΓòÉΓòÉ 4.1. If installed with the OpenDoc toolkit ΓòÉΓòÉΓòÉ
  48.  
  49. PartMeister is automatically installed with the toolkit.  No further 
  50. installation steps are required. Proceed with configuration. 
  51.  
  52.  
  53. ΓòÉΓòÉΓòÉ 4.2. If received electronically, separate from the toolkit ΓòÉΓòÉΓòÉ
  54.  
  55. PartMeister may be installed in any directory.  It is recommended that it be 
  56. installed into its own directory under your Toolkit directory for example 
  57. C:\TOOLKIT\PMEISTER. 
  58.  
  59. The recommended install procedure is as follows, 
  60.  
  61.      change to toolkit directory (ie. C:\TOOLKIT) 
  62.  
  63.      create subdirectory PMEISTER 
  64.  
  65.      change to new subdirectory (ie. C:\TOOLKIT\PMEISTER) 
  66.  
  67.      unzip PartMeister (ie. UNZIP \PMEISTER.ZIP) 
  68.  
  69.      proceed to configuration 
  70.  
  71.  The files installed include, 
  72.  
  73.      PMEISTER.EXE - program file 
  74.  
  75.      PMEISTER.DAT - template list and related information 
  76.  
  77.      PMEISTER.INF - this file 
  78.  
  79.      PMEISTER.HLP - help file 
  80.  
  81.      *.T* - templates 
  82.  
  83.      README - release information 
  84.  
  85.  
  86. ΓòÉΓòÉΓòÉ 5. Configuration ΓòÉΓòÉΓòÉ
  87.  
  88. Settings (on the 'Settings' notebook page) should be set before generating any 
  89. components with PartMeister. 
  90.  
  91. The 'Copyright' area specifies the information that will be contained in the 
  92. header comments for source files. 
  93.  
  94. The 'Compiler' area selects the compiler that will be used, which affects only 
  95. the generation of the make file. 
  96.  
  97. The 'OpenDoc Directories' area requires four directories to be set, 
  98.  
  99.      Runtime - where the OpenDoc runtime executables/DLLs are located, used in 
  100.       the make file to specify where the output component should be. 
  101.  
  102.      Toolkit - the base directory for the OS/2 toolkit 
  103.  
  104.      Public files - where to locate and store files that are common to more 
  105.       than one component 
  106.  
  107.      Output - directory to use as the base for where components will be 
  108.       generated. This directory must exist, and is recommended to be a separate 
  109.       directory under the root directory (ie. C:\ODPARTS). 
  110.  
  111.  It is recommended that you create your own public directory.  If you use the 
  112.  ContainerPart as a parent class, you will need to copy some files from the 
  113.  container part directory (.xh, .xih, .lib). 
  114.  
  115.  
  116. ΓòÉΓòÉΓòÉ 6. Creating a new component ΓòÉΓòÉΓòÉ
  117.  
  118. To create a new component, all the information that is required may be filled 
  119. in on the first page ('Part'). 
  120.  
  121. Select the template to use from the selection box. 
  122.  
  123. Next fill in the name of your new class, and a short name (a short name is 8 
  124. characters or less and must container characters that are valid for a filename 
  125. - it is used as the name of the directory that the files are generated into and 
  126. for the filenames of the generated files). 
  127.  
  128. Category refers to the broad definition of the data type for the part. A list 
  129. of currently defined categories is provided, or you may fill in a new category. 
  130.  
  131. Kind is the specific data type (for example, a word-processor specific text 
  132. format) of the part. 
  133.  
  134. When the fields have been filled in to your satisfaction, select 'Generate' 
  135. from the 'Part' menu to generate the part files.  You may then use NMAKE with 
  136. the generated make file to compile and link the part. 
  137.  
  138.  
  139. ΓòÉΓòÉΓòÉ 7. Templates ΓòÉΓòÉΓòÉ
  140.  
  141. The foundation of the code generation capabilities of PartMeister are 
  142. templates. PartMeister is extended through the addition of new templates, which 
  143. may be written by individual developers or received from others. 
  144.  
  145.  
  146. ΓòÉΓòÉΓòÉ 7.1. Adding a template to PartMeister ΓòÉΓòÉΓòÉ
  147.  
  148. If you create or receive a template, you may add it to the list of available 
  149. templates. 
  150.  
  151. This function is not implemented in this version of PartMeister. 
  152.  
  153.  
  154. ΓòÉΓòÉΓòÉ 7.2. Creating a template ΓòÉΓòÉΓòÉ
  155.  
  156. Templates are used to extend the function of PartMeister by providing new 
  157. models for code generation.  Often templates will implement derived components, 
  158. and that a superclass may have more than one associated template. 
  159.  
  160.  
  161. ΓòÉΓòÉΓòÉ 7.2.1. Steps ΓòÉΓòÉΓòÉ
  162.  
  163. To create a template to generate a derived class, 
  164.  
  165.      create an OpenDoc part to be subclassed 
  166.  
  167.      implement a subclass of the part 
  168.  
  169.      replace the appropriate values with replaceable parameters 
  170.  
  171.      name the template files appropriately 
  172.  
  173.  
  174. ΓòÉΓòÉΓòÉ 7.3. Replaceable parameters and functions ΓòÉΓòÉΓòÉ
  175.  
  176. Replaceable parameters take the form %%parameter%%.  Functions that operate on 
  177. parameters take the form %%function(parameter)%%. 
  178.  
  179. Availale replaceable parameters are, 
  180.  
  181.      partname - name of the IDL interface (class name) 
  182.  
  183.      filename - file name for the new components files 
  184.  
  185.      parentname - IDL interface name of parent 
  186.  
  187.      parentfilename - file name of parent files 
  188.  
  189.      author - name of component author 
  190.  
  191.      company - company holding copyright 
  192.  
  193.      year - year, or years, for copyright notice 
  194.  
  195.      category - OpenDoc part category 
  196.  
  197.      kind - OpenDoc part kind 
  198.  
  199.      displayname - display name 
  200.  
  201.      opendocpath - OpenDoc runtime directory 
  202.  
  203.      publicpath - public files directory 
  204.  
  205.      runtimepath - OpenDoc runtime directory 
  206.  
  207.      outputpath - target path for generation 
  208.  
  209.      runtimelib - C runtime library name to link to 
  210.  
  211.      toolname - Name of tool generating files 
  212.  
  213.      toolversion - Version number of tool generating files 
  214.  
  215.  Available functions are, 
  216.  
  217.      upper - change parameter to upper case 
  218.  
  219.      lower - change parameter to lower case 
  220.