home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1998 November / PCO_1198.ISO / filesbbs / os2 / hmakeos2.arj / HMAKEOS2.ZIP / English / MakeDocu.INF (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1998-02-28  |  9.8 KB  |  206 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. About HyperMake ΓòÉΓòÉΓòÉ
  3.  
  4.  
  5. Martin Vieregg 100661.626@compuserve.com, March 1998 
  6.  
  7. With HyperMake (up to version 2.0 "MakeIPF"), you can easily create HTML files, 
  8. Microsoft Winhelp files, MS HTML-Help files (Windows 98 Help) or IBM INF/HLP 
  9. files (operating systems OS/2 and PC-DOS). Instead of editing the HTML, RTF or 
  10. IPF files directly, you enter a more simple ASCII source text. HyperMake 
  11. enables you to write a text in all these target formats simultaneously. Links 
  12. are created automatically; windows of different headings levels can be shown 
  13. simultaneusly with only one command; at the end of a chapter, links to 
  14. subchapters are created automatically and a lot of more. HyperMake has got a 
  15. reverse conversion mode from IPF and RTF to HyperMake source. 
  16.  
  17. Actually HyperMake is a stand-alone compiler which can be executed from HMP 
  18. files (HyperMake project files) by using the graphical interface of Windows 
  19. 95/NT or OS/2; you can also use the command line. The graphical HyperMake 4.0 
  20. is under development. Please visit the HyperMake Homepage. 
  21.  
  22. HyperMake has some powerful functions: 
  23.  
  24.      Automatic linking and indexing 
  25.       Marking a word or a phrase of several words with a special character will 
  26.       generate a link from all other occurrences of the word or phrase in the 
  27.       document to the marked position and an entry in the index. External links 
  28.       are supported in different ways. From OS/2 and Winhelp4 Help files, links 
  29.       to the WWW are possible. 
  30.  
  31.      Automatic division into several HTML files 
  32.       When creating HTML files, from one source file HyperMake creates several 
  33.       target files in a new folder. This improves the performance while viewing 
  34.       with browsers. Neither the author of the text nor the reader of the files 
  35.       notices the separation into several files. 
  36.  
  37.      Automatic creation of contents 
  38.       You will get a contents page with links to all chapters. In HTML you can 
  39.       choose between an unordered list view and a Javascript contents tree view 
  40.       where you can open and close subchapters. 
  41.  
  42.      Automatic generation of helptables and constants 
  43.       For OS/2 and Windows help files, in the HyperMake source file you can 
  44.       directly enter ID constants like "ID_buttonOK" to associate chapters of 
  45.       your HLP file with buttons of your program. HyperMake generates a 
  46.       helptable file you can include in your RC, C or PAS file. 
  47.  
  48.      Automatic Writing of links to subchapters 
  49.       At the end of a window of a higher heading level, links to all 
  50.       subchapters and to the next chapter at the same level will be created. 
  51.  
  52.      Automatic arrangement of several heading level windows 
  53.       With only one command, two (IPF three) heading levels are placed 
  54.       simultaneously on the screen (Frames). 
  55.  
  56.      Simple creation of footnotes 
  57.       The HTML footnotes are realized by frames, Winhelp, IPF and HTML-Help 
  58.       footnotes appears in a small footnote window for each footnote text. 
  59.  
  60.      Tables 
  61.       You enter tables in the source text like in an ASCII text with a fixed 
  62.       font. HyperMake transforms this simple formatting to HTML, RTF or IPF 
  63.       table commands. 
  64.  
  65.      Automatic line drawing to generate boxes 
  66.  
  67.      Short commands 
  68.         -  for heading levels 
  69.         -  for choosing fonts 
  70.         -  to include bitmaps within a line of text 
  71.         -  to generate unordered lists and ordered lists. 
  72.  
  73.  
  74. ΓòÉΓòÉΓòÉ 2. How to generate the HyperMake documentation? ΓòÉΓòÉΓòÉ
  75.  
  76. This text helps you creating your "individual" HyperMake documentation. You 
  77. will need to make minor changes to the HMP files (see the marked sections ). 
  78. Don't click to the HMP files before editing them. 
  79.  
  80. You can choose which of the four target formats will be created and which topic 
  81. will be part of "your" documentation. 
  82.  
  83. Before you can continue, you need to run HMINSTAL. This will generate file 
  84. associations for HMP files. 
  85.  
  86. Available Subjects: 
  87. HyperMake project files HMP 
  88. Creating sample text and documentation in HTML 
  89. Creating sample text and documentation in other formats 
  90.  
  91.  
  92. ΓòÉΓòÉΓòÉ 2.1. HyperMake project files HMP ΓòÉΓòÉΓòÉ
  93.  
  94. HMP files are new in HyperMake 3.5. They are a substitute for using the command 
  95. line. Although HyperMake is a commandline program, you can handle it by using 
  96. the graphical interface of Win95/NT or OS/2. 
  97.  
  98. Please click to the file icon of HTMLDOCU.HMP with the right mouse button. Then 
  99. choose in the context menu: 
  100. Open - edit project file. 
  101.  
  102. You will see one setting in each line. On the right side of the = character you 
  103. are allowed to modify the setting. 
  104.  
  105.  
  106. ;HyperMake Project file
  107.  
  108. source files = docu.txt
  109. ini file = docu.ini
  110. target = HTML
  111. conditions = HTMLDOC IPFDOC WINHELPDOC MSHTMLHELPDOC OS2EXEDOC WINHELPEXEDOC
  112.  
  113. graphic path = ..\Buttons\Icon;..\Buttons\English;
  114.  
  115.  
  116. ΓòÉΓòÉΓòÉ 2.2. Creating sample text and documentation in HTML ΓòÉΓòÉΓòÉ
  117.  
  118.  
  119. The HMP file of the sample text is HTML_SMP.HMP. Here you won't edit anything 
  120. so you can double click to this file. 
  121.  
  122. Now take a look at the settings in the file HTMLDOCU.HMP. 
  123.  
  124.  
  125. source files = docu.txt
  126. ini file = docu.ini
  127.  
  128. Here you can enter the filename of the source text and the ini file. You can 
  129. edit the source text with an ASCII editor. The ini file has also got textual 
  130. settings. 
  131.  
  132.  
  133. conditions = HTMLDOC IPFDOC WINHELPDOC MSHTMLHELPDOC OS2EXEDOC WINHELPEXEDOC
  134.  
  135. The source text contains .IF conditions: The text between the .IF, .ELSE and 
  136. .END commands is only compiled when the condition is set. Please delete the 
  137. topics (conditions) you are not interested in. The two EXEDOC conditions are 
  138. only needed if you want to write context sensitive help for OS/2 or Windows 
  139. programs. 
  140.  
  141.  
  142. graphic path = ..\Buttons\Icon;..\Buttons\German;
  143.  
  144. In the directory Buttons there is a small Button Library. From here HyperMake 
  145. grabs the necessary graphic files. 
  146.  
  147. Now save the file HTMLDOCU.HMP, close the editor and double click to the HMP 
  148. file icon. Compilation time on a fast 486 or slow Pentium: 7 seconds. The 
  149. generated file DOCU.HTML is your entrance to the files DOCU\*.HTML (about 100 
  150. files!). 
  151.  
  152.  
  153. ΓòÉΓòÉΓòÉ 2.3. Creating sample text and documentation in other formats ΓòÉΓòÉΓòÉ
  154.  
  155.  
  156. Now edit the file HELPDOCU.HMP (context menu - edit project file). In the 
  157. conditions line, delete the topics you are not interested in. 
  158.  
  159. Also take a look at HELP_SMP.HMP. 
  160. Please generate the sample file before generating the docu, because there are 
  161. some external links from the docu help file to the sample help file which won't 
  162. work if you do not so. 
  163.  
  164.  
  165. target = IPF
  166.  
  167. HyperMake 3.5 supports four target formats: 
  168.  
  169.      HTML Hypertext Markup Language (version 3.2) 
  170.      IPF IBM Help, Hypertext format of the operating systems OS/2 and PC-DOS 
  171.       (INF and HLP files) 
  172.      WINHELP3 WINHELP4 Microsoft Help for Windows 3.1 and Windows 95/NT 
  173.      HTMLHELP Microsoft HTML-Help (compiled HTML) for Windows 98 and NT 5 
  174.  
  175.  
  176.  The HTML target format is the only format you can view without using a second 
  177.  compiler. For generating all the other hypertext formats, HyperMake generates 
  178.  only the source for a second compiler. The Microsoft compilers are free, the 
  179.  IBM IPF compiler is not free, but you will it on several IBM developer CD's 
  180.  and programming systems. WINHELP3 files can be viewed with Windows 3.1, OS/2 
  181.  and Windows 95/NT. You can download the Winhelp3 compiler HC.EXE from my 
  182.  homepage (only 100 k). You can simply create your Web pages also in Winhelp3 
  183.  format and upload it to your Homepage for off-line readers! 
  184.  
  185.  
  186.   compile = YES
  187.   view = YES
  188.  
  189.  HyperMake can execute other programs automatically. In addition to the 
  190.  HyperMake compiler window, another window for the second compiler opens 
  191.  (compile = yes) and the viewer is started (view = yes). 
  192.  
  193.  
  194.   ipf compiler = D:\TOOLS\IPFC.EXE /inf
  195.  
  196.  For doing this, HyperMake has to locate the second compiler.  Please modify 
  197.  the drive and directory. Related to the target settings, there are four 
  198.  settings: 
  199.  
  200.   ipf compiler =
  201.   winhelp3 compiler =
  202.   winhelp4 compiler =
  203.   htmlhelp compiler =
  204.  
  205.  
  206.