home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1998 November / PCO_1198.ISO / filesbbs / os2 / hmakeos2.arj / HMAKEOS2.ZIP / German / MachDoku.INF (.txt) < prev   
Encoding:
OS/2 Help File  |  1998-02-28  |  12.5 KB  |  226 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Was ist HyperMake? ΓòÉΓòÉΓòÉ
  3.  
  4.  
  5. Martin Vieregg 100661.626@compuserve.com, M╨örz 1998 
  6.  
  7. HyperMake (bis Version 2.0 MakeIPF) dient der einfachen Erstellung von 
  8. HTML-Seiten, Winhelp, Microsoft HTML-Help (Windows 98 Hilfe) und IBM Hilfe 
  9. (INF- und HLP-Dateien der Betriebssysteme OS/2 und PC-DOS). Statt direkt HTML-, 
  10. RTF- oder IPF-Dateien zu editieren, wird ein ASCII-Rohtext erstellt, der 
  11. weitaus weniger Kommandos enth╨ölt und das gleichzeitige Schreiben aller 
  12. genannten Zielformate unterst╨ætzt. Querverweise werden automatisch gezogen, mit 
  13. nur einem Befehl werden Fenster verschiedener Gliederungsebenen gleichzeitig 
  14. angezeigt, am Ende eines Kapitels wird automatisch auf Unterkapitel verwiesen 
  15. und vieles mehr. HyperMake bietet eine R╨æckw╨örts-Konvertierung von IPF und RTF 
  16. nach HyperMake. 
  17.  
  18. Derzeit ist HyperMake ein reiner Compiler, der mit Hilfe von HMP-Dateien 
  19. (HyperMake Projektdateien) ╨æber die graphische Benutzeroberfl╨öche von Windows 
  20. 95/NT bzw. OS/2 oder ╨æber die Kommandozeile gesteuert wird. Auf der HyperMake 
  21. Homepage werde ich ╨æber die Fortschritte von HyperMake 4.0 mit graphischer 
  22. Benutzeroberfl╨öche berichten. 
  23.  
  24. HyperMake hat einige leistungsstarke Features zu bieten: 
  25.  
  26.      Automatische Querverweis- und Index-Erstellung 
  27.       Das Markieren eines Wortes oder eines Ausdrucks mehrerer W╨ñrter mit einem 
  28.       speziellen Zeichen erzeugt Querverweise (engl. links) von allen 
  29.       gleichlautenden Ausdr╨æcken im Text zur markierten Textstelle hin sowie 
  30.       einen entsprechenden Eintrag im Index (zu deutsch Stichwortverzeichnis). 
  31.       Es werden auf verschiedene Weise auch externe Querverweise unterst╨ætzt, 
  32.       so z.B. von OS/2- und Winhelp4-Dateien ins WWW. 
  33.  
  34.      Automatische Zerlegung in zahlreiche HTML-Dateien 
  35.       Beim Erzeugen von HTML-Dateien wird eine Quelldatei in zahlreiche 
  36.       einzelne HTML-Dateien zerlegt. Dies f╨æhrt zu h╨ñherer Performance bei der 
  37.       Benutzung von Browsern. Weder der Autor des Textes noch der Betrachter 
  38.       merkt etwas davon. 
  39.  
  40.      Automatische Erstellung von Inhaltsverzeichnissen 
  41.       Der Hypertext erh╨ölt eine Seite mit Links zu allen Kapiteln. In HTML kann 
  42.       zwischen einer Darstellung als unsortiere Liste und einer Javascript 
  43.       Darstellung gew╨öhlt werden, bei der Unterkapitel auf- und zuklappbar 
  44.       sind. 
  45.  
  46.      Automatische Erstellung von Helptables bzw. Konstanten 
  47.       F╨ær OS/2- und Windows-Hilfedateien d╨ærfen in den HyperMake 
  48.       ASCII-Quelltext direkt ID Konstanten wie "ID_buttonOK" eingetragen 
  49.       werden, um eine Verbindung zwischen dem Knopf und der erl╨öuternden 
  50.       Textpassage herzustellen. HyperMake generiert eine Helptable-Datei, die 
  51.       in die RC-, C- oder PAS-Datei eingebunden werden kann. 
  52.  
  53.      Automatische Erstellung von Querverweisen zu Unterkapiteln 
  54.       Am Ende eines Hauptkapitels, vor dem ersten Unterkapitel, werden 
  55.       Querverweise zu allen Unterkapiteln und zum n╨öchsten Hauptkapitel 
  56.       erstellt. 
  57.  
  58.      Automatische Anordnung von Kapiteln verschiedener Gliederungsebenen am 
  59.       Bildschirm 
  60.       Mit nur einem kurzen Befehl erhalten die folgenden Kapitel je nach 
  61.       Gliederungsebene verschiedene Positionen und Gr╨ñ╤üen am Bildschirm - es 
  62.       werden also Kindfenster (engl. Frames) generiert. Zwei (IPF drei) Fenster 
  63.       verschiedener Gliederungsebenen, also Kapitel, Unterkapitel, 
  64.       Unterunterkapitel, erscheinen so gleichzeitig. 
  65.  
  66.      Einfache Erstellung von Fu╤ünoten 
  67.       Bei HTML werden Fu╤ünoten ╨æber Frames realisiert, bei OS/2-Hilfe, 
  68.       Windows-Hilfe und Windows-98-Hilfe ╨ñffnet sich pro Fu╤ünote ein kleines 
  69.       Fu╤ünotenfenster. 
  70.  
  71.      Tables (Tabellen) 
  72.       Tabellen werden wie bei einer ASCII-Datei mit festen Schritten 
  73.       eingegeben. HyperMake setzt dies in HTML-, RTF- bzw. IPF-Kommandos um. 
  74.  
  75.      Automatisches Linienziehen, um K╨östchen zu erstellen 
  76.  
  77.      Kurze, einfache Befehle 
  78.         -  f╨ær Kapitel╨æberschriften und deren Gliederungsebene 
  79.         -  um Schriften auszuw╨öhlen 
  80.         -  um Grafiken allein oder im Flie╤ütext auszugeben 
  81.         -  f╨ær unsortierte Listen / sortierte Listen. 
  82.  
  83.  
  84. ΓòÉΓòÉΓòÉ 2. Wie erstelle ich die HyperMake-Dokumentation? ΓòÉΓòÉΓòÉ
  85.  
  86. Dieser Text hilft Ihnen beim Erstellen Ihrer "individuellen" HyperMake 
  87. Dokumentation. Hierf╨ær m╨æssen Sie evtl. die HMP-Dateien geringf╨ægig editieren 
  88. (siehe die markierten Textabschnitte ). Klicken Sie also bitte noch nicht 
  89. gleich "drauflos". 
  90.  
  91. Sie k╨ñnnen zum einen w╨öhlen, welches der vier Zielformate erzeugt werden soll 
  92. und zum anderen, welche Themen Sie ╨æberhaupt interessieren. 
  93.  
  94. Ich gehe davon aus, da╤ü Sie schon HMINSTAL gestartet haben und somit 
  95. HMP-Dateien schon den entsprechenden Programmen zugeordnet wurden. 
  96.  
  97. Unterkapitel: 
  98. HyperMake Projekt-Steuerdateien HMP 
  99. Erstellen von Beispielstext und Dokumentation im HTML-Format 
  100. Erstellen von Beispielstext und Dokumentation in anderen Formaten 
  101.  
  102.  
  103. ΓòÉΓòÉΓòÉ 2.1. HyperMake Projekt-Steuerdateien HMP ΓòÉΓòÉΓòÉ
  104.  
  105. HMP-Dateien sind sind mit HyperMake 3.5 neu eingef╨æhrt und dienen als 
  106. "Mausersatz" f╨ær die Kommandozeile. HyperMake kann auch weiterhin direkt ╨æber 
  107. die Kommandozeile gestartet werden. 
  108.  
  109. Holen Sie sich bitte mit der rechten Maustaste das Kontextmen╨æ von HTMLDOKU.HMP 
  110. her. 
  111. W╨öhlen Sie ╨⌐ffnen - editiere Projektdatei. 
  112.  
  113. Sie sehen nun pro Zeile einen "Schalter", rechts vom = Zeichen d╨ærfen Sie 
  114. editieren. 
  115.  
  116.  
  117. ;HyperMake Project file
  118.  
  119. source files = doku.txt
  120. ini file = doku.ini
  121. target = HTML
  122. conditions = HTMLDOC IPFDOC WINHELPDOC MSHTMLHELPDOC OS2EXEDOC WINHELPEXEDOC
  123.  
  124. graphic path = ..\Buttons\Icon;..\Buttons\German;
  125.  
  126.  
  127. ΓòÉΓòÉΓòÉ 2.2. Erstellen von Beispielstext und Dokumentation im HTML-Format ΓòÉΓòÉΓòÉ
  128.  
  129. Die HMP-Dateien des Beispielstextes lautet Html_bsp.hmp. Hier werden Sie nichts 
  130. editieren m╨æssen, Sie k╨ñnnen gleich per Doppelklick die Erzeugung starten. 
  131.  
  132. Im folgenden werden einige Schalter in der Datei HTMLDOKU.HMP besprochen. 
  133.  
  134.  
  135. source files = doku.txt
  136. ini file = doku.ini
  137.  
  138. Hier wird der Dateiname des Quelltextes und der Ini-Datei angegeben. Den 
  139. Quelltext k╨ñnnen Sie mit einem normalen ASCII-Editor ansehen. Die Ini-Datei ist 
  140. ebenfalls eine editierbare Textdatei und enth╨ölt Schalter, die diesen hier 
  141. ╨öhnlich sind. 
  142.  
  143.  
  144. conditions = HTMLDOC IPFDOC WINHELPDOC MSHTMLHELPDOC OS2EXEDOC WINHELPEXEDOC
  145.  
  146. Im Quelltext DOKU.TXT sind .IF-Bedingungen enthalten. Der zwischen .IF, .ELSE 
  147. und .END eingeschlossene Quelltext wird nur ╨æbersetzt, wenn die entsprechende 
  148. Bedingung gesetzt wurde. Streichen Sie die Themen aus den conditions 
  149. (Bedingungen) heraus, die Sie nicht interessieren. Die zwei EXEDOC-Bedingungen 
  150. ben╨ñtigen Sie nur, wenn Sie kontextsensitive Hilfe f╨ær OS/2 bzw. 
  151. Windows-Programme schreiben wollen. 
  152.  
  153.  
  154. graphic path = ..\Buttons\Icon;..\Buttons\German;
  155.  
  156. Im Verzeichnis Buttons befindet sich eine kleine Button-Bibliothek. Von hier 
  157. holt sich HyperMake die ben╨ñtigten Grafiken. 
  158.  
  159. Jetzt k╨ñnnen Sie die Datei HTMLDOKU.HMP sichern, den Editor schlie╤üen und mit 
  160. einem Doppelklick wird HyperMake gestartet. Kompilierzeit auf einem schnellen 
  161. 486/langsamen Pentium: 7 Sekunden. Die neu erzeugte Datei DOKU.HTML stellt den 
  162. Einstieg in die eigentlichen HTML-Dateien DOKU\*.HTML dar (ca. 100 Dateien!). 
  163.  
  164.  
  165. ΓòÉΓòÉΓòÉ 2.3. Erstellen von Beispielstext und Dokumentation in anderen Formaten ΓòÉΓòÉΓòÉ
  166.  
  167.  
  168. Sehen Sie sich nun bitte den Inhalt der Datei HELPDOKU.HMP an (Kontextmen╨æ - 
  169. editiere Projektdatei). Streichen Sie gleich unter conditions= die Themen, die 
  170. Sie nicht interessieren. 
  171.  
  172. Die HMP-Datei des Beispielstextes lautet Help_bsp.hmp. Sehen Sie sich bitte 
  173. diese Datei auch gleich an. 
  174.  
  175. Starten Sie die Erzeugung des Beispielstextes vor der Erzeugung der 
  176. Dokumentation, da von der Doku zum Beispielstext externe Querverweise gezogen 
  177. werden, die sonst nicht funktionieren. 
  178.  
  179.  
  180. target = IPF
  181.  
  182. HyperMake 3.5 unterst╨ætzt die folgenden Zielformate: 
  183.  
  184.      HTML Hypertext Markup Language (in der Version 3.2) 
  185.      IPF IBM Hilfe, das Hypertextformat der Betriebssysteme OS/2 und PC-DOS 
  186.       (INF und HLP-Dateien) 
  187.      WINHELP3 WINHELP4 Die Microsoft Hilfeformate f╨ær Windows 3.1 und Windows 
  188.       95/NT 
  189.      HTMLHELP Das neue Microsoft HTML-Help (compiled HTML) f╨ær Windows 98 und 
  190.       NT 5 
  191.  
  192.  
  193.  Das HTML-Format ist das einzige Format, das Sie ohne einen zweiten Compiler 
  194.  nutzen k╨ñnnen. Die anderen Formate erfordern einen weiteren Compiler, der die 
  195.  von HyperMake erzeugten Dateien weiterverarbeitet. Die Microsoft Compiler sind 
  196.  frei verf╨ægbar, der IBM IPF Compiler ist nicht frei, liegt aber diversen 
  197.  Entwicklerpaketen und IBM CD's bei. WINHELP3 Hypertexte k╨ñnnen unter Windows 
  198.  3.1, OS/2 und Windows 95/NT betrachtet werden und sind somit ╨öhnlich 
  199.  "portabel" wie HTML-Dateien. Der Winhelp3-Compiler HC.EXE (nur 100 k) kann von 
  200.  der HyperMake Homepage heruntergeladen werden. Legen Sie doch Ihrer 
  201.  Ver╨ñffentlichung im Web den gleichen Textinhalt noch als Winhelp3-Datei bei! 
  202.  
  203.  
  204.   compile = YES
  205.   view = YES
  206.  
  207.  HyperMake kann andere Programme eigenst╨öndig aufrufen. Zus╨ötzlich zum 
  208.  HyperMake-Compilerfenster ╨ñffnet sich dann noch ein weiteres Fenster f╨ær den 
  209.  zweiten Compiler (compile = YES) sowie f╨ær den Hypertext-Betrachter (view = 
  210.  YES). 
  211.  
  212.  
  213.   ipf compiler = D:\TOOLS\IPFC.EXE /inf
  214.  
  215.  Damit HyperMake den zweiten Compiler findet, mu╤ü hier das richtige Verzeichnis 
  216.  und der richtige Dateiname eingegeben werden. Korrigieren Sie deshalb den 
  217.  Verzeichnisnamen entsprechend! Entsprechend den target Einstellungen sind vier 
  218.  verschiedene Eintr╨öge m╨ñglich: 
  219.  
  220.   ipf compiler =
  221.   winhelp3 compiler =
  222.   winhelp4 compiler =
  223.   htmlhelp compiler =
  224.  
  225.  
  226.