home *** CD-ROM | disk | FTP | other *** search
/ Dream 45 / Amiga_Dream_45.iso / Atari / Docs / ST-Guide / st-gui12.lzh / ST-GUIDE / DOK / ST-GUIDE.STG < prev   
Text File  |  1995-02-03  |  42KB  |  1,158 lines
  1. ##ACE-STGPAR 4 0004 
  2. @database "ST-Guide Dokumentation"
  3. @subject "Dokumentation/ST-Guide"
  4. @author "H. Weets, C. Wempe"
  5. ##CHANGED
  6. @$VER: st-guide.hyp 1.00 (@:"__DATE__")
  7. @help "Hilfsseite"
  8. @options +gz-s
  9.  
  10. @extern HCP "hcp.hyp/Main"
  11. @extern 1stConv "1st_conv.hyp/Main"
  12. @extern PC-Conv "pc_conv.hyp/Main"
  13. @extern RefLink "reflink.hyp/Main"
  14. @extern STool "stool.hyp/Main"
  15. @extern MAN2STG "man2stg.hyp/Main"
  16.  
  17. @node Main "Dokumentation des ST-Guide"
  18. @next Main
  19. @prev Main
  20. @symbol r ST-Guide
  21.  
  22. Dokumentation zum Fairware-Hypertext-System.
  23.  
  24. @{Inhalt: ignore}
  25.  Allgemeines
  26.      Die Philosophie
  27.      @{"Die Vorteile" Link Vorteile}
  28.      Rechtliches
  29.      Verwendete Software
  30.      Konfiguration
  31.      @{Dateitypen link HCP.HYP/Dateitypen}
  32.      Danksagung
  33.  
  34.  Das Anzeigeprogramm ST-Guide
  35.      Knöpfe
  36.      Tastatur
  37.      @{"Der ST-Guide und das PureC-Help-ACC" link PureC}
  38.      @{"Der ST-Guide und das AV-Protokoll" link AVProtokoll}
  39.      @{"Der ST-Guide und der 1stGuide" link 1stGuide}
  40.  
  41.  Weitere Programme
  42.      Der Compiler HCP
  43.      Der Referenz-File Linker RefLink
  44.      Der Konverter 1stConv
  45.      Der Konverter PC-Conv
  46.      Das Utility STool
  47.      Der Manual-Page Konverter MAN2STG
  48. @endnode
  49.  
  50.  
  51. @node Philosophie
  52. @prev Philosophie
  53. @toc Main
  54.  
  55. Kein Mensch liest heute Anleitungen, weil sie zu lang, zu un-
  56. übersichtlich oder zu uninteressant sind, aber vor allem deshalb, weil
  57. man nie das findet, woran man gerade interessiert ist.
  58.  
  59. Abhilfe schafft hier ein Hypertext-System, denn der Leser bekommt den
  60. Text in übersichtlicher Form und in kleinen Häppchen präsentiert,
  61. insbesondere sind bei entsprechender Aufmachung des Textes alle Punkte
  62. schnell durch ein paar Mausklicks zu ereichen.
  63.  
  64. Wichtig scheint mir in diesem Zusammenhang auch die Tatsache, da₧ ein
  65. Hypertext in einer Form erzeugt werden kann, in der er den Fachmann nicht
  66. langweilt und den Anfänger nicht überfordert.
  67.  
  68. Natürlich gibt es auch noch andere Hypertext-Systeme für den ST, jedoch
  69. ist unseres
  70.   - völlig kostenlos und kann von jedermann verwendet werden
  71.   - das flexibelste und umfangreichste von allen.
  72.  
  73. So ein Hypertextsystem wie dieses ist natürlich nicht nur dafür geeignet,
  74. Dokumentationen und Online-Hilfen zu Programmen zu schreiben. Es ist genau
  75. so gut möglich, hiermit auch andere Texte zu schreiben. Sinnvoll ist dies
  76. bei jeder Art von Text, in dem Querverweise vorkommen. Besonders
  77. interessant sind natürlich Texte über das Betriebssystem, die
  78. Programmierung und die Benutzung des ST. Aber auch Themen aus anderen
  79. Sachgebieten, wie Biologie, Musik, Mathematik usw. sind durchaus denkbar.
  80. @endnode
  81.  
  82. @node Vorteile "Die Vorteile dieses Systems"
  83. @toc Main
  84. @{U}Anmerkung:@{0}
  85.   Dieser Teil der Dokumentation wurde mir freundlicherweise von Volker
  86.   Burggräf zu Verfügung gestellt.
  87.  
  88. Abgesehen vom grundsätzlichen Vorteil von Hypertexten - der Möglichkeit
  89. der Querverweise und Verzweigungen - besitzt der ST-Guide aber auch
  90. klare @{U}Vorteile gegenüber anderen Hypertext-Systemen:@{0}
  91.  
  92.   @{B}Davon profitieren Sie beim Lesen von Hypertexten:@{0}
  93.   - Umfangreiche Grafik-Fähigkeiten
  94.   - Geringer Speicherverbrauch auf der Diskette/Festplatte
  95.   - Geringer Speicherverbrauch im Arbeitsspeicher des Computers
  96.   - Benutzung sowohl als Accessory wie auch als Programm
  97.   - Sie können auch Hypertexte anderer Formate an den ST-Guide anpassen
  98.   - Weitgehende Tastatur-Bedienbarkeit (alternativ zur Maus)
  99.   - Mehrere Suchfunktionen, darunter auch Ähnlichkeitssuche
  100.   - Sogar aus normalen ASCII-Texten kann auf Hilfeseiten verzweigt werden
  101.   - wenn GDOS läuft, kann der Anzeige-Zeichensatz selbst ausgewählt werden
  102.   - das Programm STOOL katalogisiert alle Ihre Hypertexte automatisch
  103.   - Die Benutzung ist kostenlos (Fairware), aber Spenden sind erbeten
  104.  
  105.   @{B}Davon profitieren Sie, wenn Sie selbst Hypertexte schreiben wollen:@{0}
  106.   - leicht erlernbare Syntax der Befehle
  107.   - Verweise zu anderen Seiten werden vom Compiler @{U}automatisch@{0} erstellt!
  108.   - ein Index wird vom Compiler @{U}automatisch@{0} erstellt
  109.   - alle Seiten eines Hypertextes befinden sich in einer Datei (kompakt!)
  110.   - gro₧e Vielfalt der Gestaltungsmöglichkeiten
  111. @autorefoff
  112.   - der ST-Guide taugt als kontextabhängige Online-Hilfe für Programme
  113. @autorefon
  114.   - Einbindung der Original-RSC-Files von Programmen möglich
  115.   - der ST-Guide ist sehr verbreitet! (sehr gut, aber dennoch kostenlos!)
  116. @endnode
  117.  
  118.  
  119. @node Rechtliches
  120. @toc Main
  121.  
  122. @symbol ai Fairware
  123. Dieses Hypertext-System ist Fairware, d.h. jedermann kann es unbegrenzt
  124. lange kostenlos benutzen und an jede Person weitergeben, vorausgesetzt,
  125. da₧ die Weitergabe kostenlos ist. @{B}Bei regelmä₧iger Benutzung sollte
  126. der Autor jedoch mit einer Spende bedacht werden, da nur so die
  127. Weiterentwicklung dieses Systems gewährleistet ist.@{0}
  128.  
  129. Der ST-Guide darf als Zusatz zu eigenen Programmpaketen weitergegeben
  130. werden, egal welcher Art diese sind, d.h. auch innerhalb von Shareware und
  131. kommerziellen Progammen, ohne da₧ hierfür Lizenzgebühren fällig werden
  132. (obwohl ein kleine Anerkennung in diesem Fall wohl mehr als fair wäre). Es
  133. mu₧ aber ein Hinweis vorhanden sein, da₧ der ST-Guide Fairware und von mir
  134. ist.
  135.  
  136. Nett wäre es in diesem Fall, wenn mir eine Disk mit dem betreffenden
  137. Programm und dem zugehörigen Hypertext zugesand würde, quasi als
  138. Belegexemplar.
  139.  
  140. Da es der Hauptverwendungszweck des ST-Guide ist, Dokumentationen zu
  141. anderen Programmen zu schreiben, darf er in zwei Formen weitergegeben
  142. werden:
  143.  
  144.     a) Vollständig, als komplettes Programmpaket mit allen zugehörigen
  145.        Dateien. Diese Form ist auf jeden Fall vorzuziehen, auch wenn die
  146.        Weitergabe innerhalb eines anderen Programmpaketes erfolgt.
  147.  
  148.     b) Nur der Viewer und die Dokumentation, falls die Weitergabe
  149.        innerhalb eines anderen Programmpaketes erfolgt @{B}und@{b} eine
  150.        Dokumentation zu diesem Programm im Format des ST-Guide dabei
  151.        ebenfalls mitgeliefert wird.
  152.  
  153. Soweit die Weitergabe als Zugabe zu irgendwelchen Programmen oder durch
  154. PD-Händler erfolgt, erbitten wir eine kurze Mitteilung darüber, damit wir
  155.     a) abschätzen können, wie weit das Paket sich verbreitet, und
  156.     b) evtl. Auskunft über Updates geben können.
  157.  
  158. Natürlich sind wir auch sehr daran interessiert, zu sehen, in welchen
  159. Programmen der ST-Guide verwendet wird. Wem es also möglich ist, kann uns
  160. dann ja auch eine Kopie seines Programmes zukommen lassen.
  161.  
  162. @index Spenden
  163. Spenden: In diesem Programmpaket steckt inzwischen sehr viel Arbeit.
  164.          Trotzdem haben wir uns entschieden es als Fairware zu
  165.          veröffentlichen, um jedem zu ermöglichen, damit Dokumentationen
  166.          zu seinen Programmen zu schreiben. Es wäre aber nur fair, uns
  167.          eine kleine Anerkennung für unsere Arbeit zukommen zu lassen.
  168.          Auch kleine Spenden motivieren uns, auch in Zukunft noch an
  169.          diesem Projekt zu arbeiten, es zu erweitern und zu verbessern.
  170.  
  171. Kein Programm ist wirklich fehlerfrei, deshalb können und wollen wir
  172. keinerlei Garantien für die Lauffähigkeit oder Tauglichkeit dieses Paketes
  173. für irgendeinen Zweck übernehmen und können insbesondere nicht haftbar
  174. gemacht werden für irgendwelche Schäden, die durch die Benutzung dieses
  175. Paketes theoretisch entstehen könnten.
  176.  
  177. @Index "Holgers Adresse"
  178. @ALabel "Adresse"
  179. Für Lob, Kritik, Vorschläge und Spenden sind wir folgenderma₧en
  180. erreichbar:
  181.                 Holger Weets
  182.                 Tangastrasse 45
  183.                 26121 Oldenburg
  184.                 E-Mail: Holger Weets @ OL (Mausnet)
  185.                 Bankverbindung:
  186.                 KTO: 023-182 041
  187.                 BLZ: 280 501 00
  188.                 Landessparkasse zu Oldenburg
  189.  
  190. Wer eine neue Version direkt von mir haben möchte, schicke bitte einen
  191. frankierten Rückumschlag und 10 Mark an diese Adresse. Dieser Betrag dient
  192. mir als Aufwandsentschädigung, denn schlie₧lich habe ich auch etwas
  193. besseres zu tun als Disketten zu kopieren.
  194. @endnode
  195.  
  196.  
  197. @node "Verwendete Software"
  198. @toc Main
  199.  
  200. Folgende Programme wurden zur Implementierung dieses Systemes verwendet:
  201.  
  202. * @{U}SOZOBON V2.00x10@{u}
  203.     als C-Compiler System
  204.     Autoren: die SOZOBON-Leute, Christian Wempe und Holger Weets
  205.  
  206. * @{U}ACE@{u}
  207.     als Editor und Programmierumgebung
  208.     Autor: Holger Weets
  209.  
  210. * @{U}RED@{u}
  211.     als Resource-Editor
  212.     Autor: Holger Weets
  213.  
  214. * @{U}C-RSC@{u}
  215.     als Umwandler der Resourcen in C-Quelltext
  216.     Autor: Holger Weets
  217.  
  218. * @{U}LHarc bzw. dessen Sourcecodes@{u}
  219.     als Basis für die Implementierung des Ein- und Auspackens der
  220.     Hypertext-Seiten
  221.     Autor: Yoshi, Christian Grunenberg
  222. @endnode
  223.  
  224.  
  225. @node Konfiguration
  226. @toc Main
  227.  
  228. Alle Komponenten des ST-Guide können über eine Datei konfiguriert werden,
  229. welche den Namen ST-GUIDE.INF trägt und sich im durch die
  230. Environmentvariable HOME angegebenen Ordner oder im Wurzelverzeichnis des
  231. Bootlaufwerkes befinden mu₧ (meist C:).
  232.  
  233. Sie ist i.w. so aufgebaut, wie die Environment-Dateien diverser
  234. Auto-Ordner-Environment-Setzer (tolles Wort...).
  235.  
  236. Folgende Environment-Variablen werden zur Zeit benutzt:
  237. @alabel TABSIZE
  238. * @{B}TABSIZE@{0}
  239.     enthält die gewünschte Tabulatorweite. Ist diese Variable nicht
  240.     vorhanden, so wird der Wert 8 verwendet.
  241.  
  242. @alabel WINSIZE
  243. * @{B}WINSIZE@{0}
  244.     enthält die Grö₧e des ST-Guide Fensters beim ersten Öffnen desselben.
  245.     ist diese Variable nicht vorhanden, so wird das Fenster mit voller
  246.     Bildschirmgrö₧e geöffnet.
  247.         WINSIZE=100,100,400,200
  248.     wird das Fenster des ST-Guide beim ersten Öffnen in die Mitte eines
  249.     640x400 Pixel Bildschirmes positionieren.
  250.  
  251. ##CHANGED
  252. @alabel "REFCOLOR"
  253. * @{B}REFCOLOR@{0}
  254.     REFCOLOR=<Farbe> setzt die Textfarbe für Referenzen auf <Farbe>. Wird
  255.     diese Variable gesetzt, so stellt ST-Guide Referenzen nicht mehr Fett
  256.     und Unterstrichen dar, sondern in normaler Schrift mit der angegebenen
  257.     Farbe.
  258.     Diese Variable wird in monochromen Auflösungen ignoriert.
  259.  
  260. ##CHANGED
  261. @alabel "TXTCOLOR"
  262. * @{B}TXTCOLOR@{0}
  263.     TXTCOLOR=<Farbe> setzt die Textfarbe auf <Farbe>.
  264.     Diese Variable wird in monochromen Auflösungen ignoriert.
  265.  
  266. @alabel "PATHS"
  267. * @{B}PATHS@{0}
  268.     enthält eine durch Kommata oder Semikoli getrennte Liste von Pfaden,
  269.     welche zum Auffinden von Dateien verwendet wird, welche über externe
  270.     Referenzen (siehe link) angezeigt werden sollen.
  271.         PATHS=c:\guides\;c:\;c:\bin\
  272.     wird, falls eine Datei gesucht wird, diese nacheinander in
  273.         C:\GUIDES\
  274.         C:\
  275.     und
  276.         C:\BIN\
  277.     suchen
  278.  
  279. @alabel "EXTVIEW"
  280. * @{B}EXTVIEW@{0}
  281.     enthält den Namen desjenigen ACC/PRG, welches mit dem Anzeigen von
  282.     nicht Hypertext-Dateien beauftragt werden soll, sofern für die Endung
  283.     der betreffenden Datei kein Viewer angemeldet wurde. Die Angaben
  284.     sollten mit vollständigem Pfad erfolgen, sofern nicht sichergestellt
  285.     ist, da₧ der betreffende Viewer bereits läuft (also als ACC
  286.     installiert ist)
  287.     Ein Viewer für bestimmte Dateiformate wird übrigens installiert durch
  288.         <Endung>=Programm (Beipiel: IMG=C:\BIN\1stview.prg)
  289.     Der so angegebene Viewer wird bei Bedarf zunächst gesucht und danach
  290.     entweder zum Starten an den Desktop weitergegeben oder vom ST-Guide
  291.     selbst gestartet, sofern MagiC 2 installiert ist.
  292.     Falls weder diese Variable noch die durch die Endung der Datei
  293.     vorgegebene Variable existiert, so wird die betreffende Datei im ASCII
  294.     Format vom ST-Guide angezeigt.
  295.  
  296. @alabel "HCP_OPT"
  297. * @{B}HCP_OPT@{0}
  298.     enthält die Default-Optionen für den HCP. Diese werden vor dem
  299.     Einlesen der Kommandozeile gesetzt und können somit durch direktes
  300.     Angeben beim Aufruf überschrieben werden.
  301.  
  302. @symbol ri "HCP"
  303. * @{B}HCP@{0}
  304.     enthält den vollständigen Zugriffspfad des HCP und wird zur Zeit nur
  305.     von STool verwendet, falls dessen Option COMPILE eingeschaltet ist.
  306.  
  307. @symbol ri "HYPFIND"
  308. * @{B}HYPFIND@{0}
  309.     enthält den vollständigen Zugriffspfad des HypFind, dem Tool zum
  310.     Suchen von Pattern in allen Seiten eines/aller Hypertexte. Diese
  311.     Variable wird derzeit nur vom ST-Guide verwendet, wenn der
  312.     entsprechende Button im Suchen-Dialog betätigt wird
  313.  
  314. @alabel "HYPFOLD"
  315. * @{B}HYPFOLD@{0}
  316.     enthält den Defaultpfad für Hypertexte. Wird also beim Übersetzen
  317.     keine Ausgabedatei angegeben, so erzeugt der HCP die Hypertext-Datei
  318.     in dem durch diese Variable angegebenen Verzeichnis. Der ST-Guide
  319.     nutzt diese Variable ebenfalls, und zwar als Default-Pfad für den
  320.     Fileselektor.
  321.     Auch der HypFind erzeugt seine Ausgabedatei in diesem Verzeichnis.
  322.  
  323. @alabel ARROWPATCH
  324. @{B}ARROWPATCH@{0}
  325.     Falls diese Variable definiert ist (Wert ist egal), der ST-GUIDE als
  326.     ACC gestartet wird und dies nicht unter einem MultiTask Betriebsystem,
  327.     so behebt ST-Guide den bekannten Fehler des Betriebsystems, welcher
  328.     bewirkt, da₧ die Scrollpfeile sowie die Pager an Fenstern von ACCs
  329.     nicht funktionieren.
  330.  
  331.     Die bessere Alternative zu diesem Patch ist allerdings die
  332.     Installation von ARROWFIX oder (besser) WINX im Autoordner. ST-Guide
  333.     behebt diesen Fehler nur für sich selbst, alle anderen ACCs werden
  334.     damit auch weiterhin Probleme haben!
  335.  
  336. @alabel "DEFHYP"
  337. * @{B}DEFHYP@{0}
  338.     enthält den vollständigen Zugriffspfad der Datei, die beim Aufruf des
  339.     ST-Guide @{U}ohne Parameter@{0} automatisch geladen werden soll.
  340.  
  341. @alabel "HYPTOP"
  342. * @{B}HYPTOP@{0}
  343.     enthält den vollständigen Zugriffspfad des Katalog-Hypertextes,
  344.     welcher durch STool automatisch erzeugt werden kann. ST-Guide lädt die
  345.     hier angegebene Datei automatisch, falls beim ersten Aufruf keine
  346.     Parameter angegeben wurden und auch keine Default-Datei definiert ist
  347.     (durch DEFHYP)
  348.  
  349. @alabel "FONT"
  350. * @{B}FONT@{0}
  351.     enthält den zu benutzenden Font und die gwünschte Grö₧e in folgendem
  352.     Format: FONT,SIZE
  353.       Beispiel: 98,9      (GEMINI Bold, kleiner Satz)
  354.     Der ST-Guide lädt diese Var. beim Öffnen des Fensters, der Font kann
  355.     also zwischen zwei Aktivierungen geändert werden, jedoch nicht solange
  356.     das Fenster des ST-Guide geöffnet ist. Wird FONT zu 0 angegeben (z.B.
  357.     0,9), dann wird der Systemzeichensatz mit der angegebenen Grö₧e
  358.     verwendet.
  359.  
  360.     Prinzipiell funktioniert dies natürlich auch mit Proportional
  361.     Zeichensätzen, jedoch stimmen dann die Positionen von Grafik-Objekten
  362.     evtl. nicht mehr ganz, da hier in diesem Falle mit einer gemittelten
  363.     Zeichenbreite gerechnet wird.
  364.  
  365. @alabel "REF"
  366. * @{B}REF@{0}
  367.     enthält den Pfad & Namen derjenigen REF-Datei, welche vom ST-Guide zum
  368.     Auffinden von Begriffen verwendet wird, welche nicht im aktuellen
  369.     Dokument definiert wurden. Diese Datei wird auch vom RefLink
  370.     defaultmä₧ig für alle Aktionen verwendet.
  371.  
  372. @{U}Beispiel für den Aufbau einer Zeile dieser Datei:@{0}
  373.   ...
  374.   HYPFOLD=c:\guides\
  375.   ...
  376.  
  377. Das ganze ist Zeilenorientiert und es dürfen sich keinerlei überflüssige
  378. Leerzeichen in den Zeilen befinden. Die Syntax ist
  379.   <Variable>=<Wert>
  380. Man beachte, da₧ keine Leerzeichen vor oder hinter dem '=' stehen dürfen
  381. und <Wert> @{U}ohne@{0} Hochkommata angegeben wird.
  382.  
  383. Eine Beispieldatei liegt dem System bei.
  384. @endnode
  385.  
  386.  
  387.  
  388.  
  389. @node Danksagung
  390. @toc Main
  391.  
  392. An dieser Stelle möchte ich mich bei ein paar Leuten bedanken:
  393. - @{B}Volker Burggräf@{0}
  394.   für die Arbeit, die er durch den Support des Paketes in der Maus OL
  395.   hatte, und für seine kreativen und Benutzernahen Anregungen
  396. - @{B}Christoph Zwerschke@{0}
  397.   für seine besonders ausgiebigen Tests aller Komponenten und seine
  398.   nützlichen Tips
  399. - @{B}Peter Nagel@{0},
  400.   @{B}Dirk Theisen@{0},
  401.   @{B}Jörg Westheide@{0},
  402.   @{B}Frank Rüger@{0},
  403.   @{B}Ralf Zimmermann@{0},
  404.   @{B}Gregor Duchalski@{0}
  405.   und @{B}Christian Grunenberg@{0}
  406.   für ihre Bugreports und ihre Werbung sowie die Verbreitung des Systems
  407. - @{B}Peter West@{0}
  408.   für die Übersetzung der Dokumentation ins englische
  409. - @{B}Joe Connor@{0}
  410.   für die Überarbeitung/Korrektur der englischen Dokumentation sowie den
  411.   Support in England
  412. - und natürlich allen Leuten, die mich sonst noch durch nette Post
  413.   motiviert haben
  414.  
  415. @endnode
  416.  
  417.  
  418. @node "Knöpfe" "Knöpfe im Fenster"
  419. @toc Main
  420.  
  421. Die im Fenster des ST-Guide sichtbaren Knöpfe dienen der einfachen
  422. Steuerung des Programmes sowie dem übersichtlichen Blättern im Text.
  423. Folgende Knöpfe existieren:
  424.  
  425.     zurück      Inhalt      Index
  426.     Seite <     Seite >     Extra
  427.  
  428. Siehe auch unter Tastatur.
  429. @endnode
  430.  
  431.  
  432. @node Tastatur "Tastaturbelegung"
  433. @toc Main
  434.  
  435. * Cursortasten          - Zeilen/Spaltenweise scrollen
  436.                           (wie Scrollpfeile am Fenster)
  437. * Shift Cursortasten    - Seitenweise scrollen
  438.                           (wie Klicks über/unter/neben die Slider)
  439. * Ziffernblock -
  440. * Control-Cursor hoch   - zum vorigen Knoten
  441. * Ziffernblock +
  442. * Control-Cursor runter - zum nächsten Knoten
  443.                           (wie Knopf [Seite >])
  444. * Escape, Undo          - zur übergeordneten Seite
  445.                           (wie Knopf [zurück])
  446. * Home                  - zum Anfang der aktuellen Seite
  447.                           (wie Slider ganz nach oben schieben)
  448. * Shift-Home            - zum Ende der aktuellen Seite
  449.                           (wie Slider ganz nach unten schieben)
  450. * Tab                   - Markierung auf nächste Referenz setzen
  451.                           (zyklisch)
  452. * Shift-Tab             - Markierung auf vorige Referenz setzen
  453.                           (zyklisch)
  454. * Return, Enter         - markierte Referenz anzeigen
  455. * ALT-T                 - Inhalts-Seite zeigen
  456.                           (wie Knopf [Inhalt])
  457. * ALT-X                 - Indexseite zeigen
  458.                           (wie Knopf [Index])
  459. * CTR-I                 - Programm Information (wie Extra/Info)
  460. * Help                  - zeigt Hilfsseite des aktuellen Textes
  461.                           (wie Extra/Hilfe)
  462. * ALT-K                 - Katalog laden (wie Extra/Katalog)
  463. * CTR-O                 - Datei laden (wie Extra/Laden)
  464. SFT-CTRL-O              - wie CTRL-O, nur mit *.* als Pattern im
  465.                           erscheinenden Fileselektor
  466. * CTR-F                 - Pattern suchen (wie Extra/Suchen)
  467. * CTR-G                 - Pattern erneut suchen
  468.                           (wie Extra/Weitersuchen)
  469. * ALT-M                 - Marke setzen (wie Extra/Marke setzen)
  470. * ALT-G                 - gehe zu Marke (wie Extra/gehe zu Marke)
  471. * ALT-E                 - Stack löschen (wie Extra/Stack löschen)
  472. * CTR-C                 - aktuelle Seite ins Clipboard kopieren
  473.                           (wie Extra/Copy)
  474. * CTR-V                 - Inhalt des Clipboard ins Fenster laden
  475.                           (wie Extra/Paste)
  476. * CTR-P                 - aktuelle Seite drucken
  477.                           (wie Extra/Seite drucken)
  478. * CTR-Q, CTR-U          - ST-Guide schliessen
  479.                           (wie Closer am Fenster anklicken)
  480. @endnode
  481.  
  482.  
  483. @node PureC "Der ST-Guide und das PureC-Help-ACC"
  484.  
  485. Damit der Umstieg auf den ST-Guide leichter fällt, wurde er voll
  486. kompatibel zum PureC-HelpACC gemacht, zumindest was die Meldungen angeht,
  487. d.h. der ST-Guide versteht alle Meldungen, die auch das PureC-ACC
  488. auswerten kann und beantwortet sie entsprechend.
  489.  
  490. Das bedeutet insbesondere, da₧ Programme, welche das PureC-ACC
  491. unterstützen, automatisch auch mit dem ST-Guide arbeiten, hierzu ist der
  492. Guide lediglich in "PC_HELP.ACC" umzubenennen, damit die Programme ihn
  493. auch als solchen erkennen und ansprechen.
  494.  
  495. Für Programmierer interessant ist hierzu die @{"Liste der Meldungen" link "PureC-Protokoll"}.
  496.  
  497. Ein Konvertierungsprogramm für PureC-Helptexte ist Teil des Systemes und
  498. trägt den Namen PC-Conv.
  499. @endnode
  500.  
  501.  
  502. @node AVProtokoll "Der ST-Guide und das AV-Protokoll"
  503.  
  504. Das AV-Protokoll stammt ursprünglich von GEMINI, hat jedoch mittlerweile
  505. eine sehr weite Verbreitung gefunden, so da₧ es mir sinnvoll erschien,
  506. dieses zu unterstützen.
  507.  
  508. Für Programmierer interessant ist hierzu die @{"Liste der Meldungen" link "AV-Protokoll"}.
  509. @endnode
  510.  
  511.  
  512. @node 1stGuide "ST-Guide und 1stGuide"
  513. @next 1stGuide
  514.  
  515. Ein alternatives, schon länger auf dem Markt befindliches Hyper-
  516. text-System ist der 1stGuide von Guido Vollbeding.
  517.  
  518. Um den Umstieg von diesem auf unser System zu erleichtern, wurde ein
  519. Konvertierungsprogramm Namens 1stConv geschrieben, welches die für den
  520. 1stGuide verwendbaren Texte in das ST-Guide Format umwandeln kann.
  521.  
  522. Da der 1stGuide ebenfalls das AV- und das PureC-Help Protokoll beherrscht,
  523. kann dieser einfach gegen den ST-Guide ausgetauscht werden.
  524. @endnode
  525.  
  526.  
  527. ##+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  528.  
  529. @node "Knopf [zurück]"
  530. @prev "Knopf [zurück]"
  531. @toc "Knöpfe"
  532. @alias "zurück"
  533.  
  534. Dieser Knopf ist immer dann auswählbar, wenn bereits mindestens einer
  535. Referenz gefolgt wurde, d.h. wenn ein im Text fett und unterstrichen
  536. dargestellter Begriff gewählt und daraufhin eine neue Seite dargestellt
  537. wurde.
  538.  
  539. Nach Betätigung dieses Knopfes zeigt der ST-Guide jeweils die Seite erneut
  540. an, aus der in die aktuelle Seite gesprungen wurde.
  541.  
  542. Der Stack ist als Ringbuffer organisiert und umfa₧t jeweils die letzten 16
  543. Verzweigungen.
  544. @endnode
  545.  
  546.  
  547. @node "Knopf [Inhalt]"
  548. @toc "Knöpfe"
  549. @alias "Inhalt"
  550.  
  551. Nach Betätigung dieses Knopfes zeigt der ST-Guide die (physikalisch)
  552. erste Seite des aktuellen Hypertextes an, diejenige also, auf der sich das
  553. Inhaltverzeichnis befinden sollte.
  554.  
  555. Wurde allerdings in der aktuellen Seite per '@toc' eine andere Seite als
  556. Inhaltsverzeichnis definiert, so wird diese Seite gezeigt.
  557.  
  558. Zur vorher aktuellen Seite kann per 'zurück' zurückgekehrt werden.
  559. @endnode
  560.  
  561.  
  562. @node "Knopf [Index]"
  563. @toc "Knöpfe"
  564. @alias "Index"
  565.  
  566. Nach Betätigung dieses Knopfes zeigt der ST-Guide die Seite des aktuellen
  567. Textes an, welche den Namen <Index> trägt, die Indextabelle also. Diese
  568. wird wahlweise automatisch vom HCP oder manuell vom Autor des Textes
  569. erzeugt.
  570.  
  571. Auf dieser Seite befinden sich Stichwortartig alle wichtigen Begriffe
  572. des Hypertextes, zu denen natürlich per Mausklick gesprungen werden
  573. kann.
  574. @endnode
  575.  
  576.  
  577. @node "Knopf [Seite <]"
  578. @toc "Knöpfe"
  579. @alias "Seite <"
  580.  
  581. Nach Betätigung dieses Knopfes zeigt der ST-Guide die Seite, welche durch
  582. die '@prev' Direktive bzw. die Anordnung der Seiten im Quelltext als
  583. Vorgängerseite definiert wurde.
  584.  
  585. Per Tastatur geht das mit CTRL-UP oder '-' auf dem Ziffernblock.
  586. @endnode
  587.  
  588.  
  589. @node "Knopf [Seite >]"
  590. @toc "Knöpfe"
  591. @alias "Seite >"
  592.  
  593. Nach Betätigung dieses Knopfes zeigt der ST-Guide die Seite, welche durch
  594. die '@next' Direktive bzw. die Anordnung der Seiten im Quelltext als
  595. Nachfolgerseite definiert wurde.
  596.  
  597. Per Tastatur geht das mit CTRL-DN oder '+' auf dem Ziffernblock.
  598. @endnode
  599.  
  600.  
  601. @node "Knopf [Extra]"
  602. @next "Knopf [Extra]"
  603. @toc "Knöpfe"
  604. @alias Extra
  605.  
  606. Bei Klick auf den Knopf mit der Aufschrift 'Extra' erscheint ein
  607. Popup-Menue mit folgender Auswahl:
  608. * Info              CTR-I
  609. * Hilfe             Help
  610. * Katalog           ALT-K
  611. * Font              ALT-Z
  612. * Laden             CTR-O
  613. * Suchen            CTR-F
  614. * Weitersuchen      CTR-G
  615. * Marke setzen      ALT-M
  616. * gehe zu Marke     ALT-G
  617. * Stack löschen     ALT-E
  618. * Copy              CTR-C
  619. * Paste             CTR-V
  620. * Seite drucken     CTR-P
  621.  
  622. Alle per Tastatur erreichbaren Funktionen sind entsprechend ge-
  623. kennzeichnet
  624. @endnode
  625.  
  626.  
  627. @node "Extra/Font"
  628. @prev "Extra/Font"
  629. @toc "Knopf [Extra]"
  630. @alias Font
  631.  
  632. Falls ein Fontselektor (z.B. FontSel oder [X]UFSL) im Autoordner
  633. installiert ist, so erscheint dieser bei Auswahl des Menuepunktes Font.
  634. Hier kann ein beliebiger Zeichensatz gewählt werden, mit dem der ST-Guide
  635. den Text in seinem Fenster anzeigen soll.
  636.  
  637. Falls kein Fontselektor installiert ist, so erscheint eine entsprechende
  638. Meldung, und falls kein GDOS installiert ist, kann nur der
  639. Systemzeichensatz zur Darstellung verwendet werden.
  640. @endnode
  641.  
  642. @node "Extra/Katalog"
  643. @toc "Knopf [Extra]"
  644. @alias Katalog
  645.  
  646. Mit dieser Funktion kann die von STool erzeugte Katalog-Datei nachgeladen
  647. werden. Genaugenommen wird die Datei, die durch die Variable HYPTOP
  648. festgelegt wurde, nachgeladen.
  649. @endnode
  650.  
  651. @node "Extra/Stack löschen"
  652. @toc "Knopf [Extra]"
  653. @alias "Stack löschen"
  654.  
  655. Diese Funktion löscht den Stack, auf dem die Seiten abgelegt werden, zu
  656. denen per 'zurück' hingelangt werden kann.
  657. @endnode
  658.  
  659. @node "Extra/Hilfe"
  660. @toc "Knopf [Extra]"
  661. @alias Hilfe
  662.  
  663. Falls per @help eine Hilfsseite angegeben wurde, so wird diese, ansonsten
  664. eine Seite Namens 'Help' im aktuell geladenen Text gesucht und zeigt
  665. diese an, falls sie gefunden wird. Der Sinn der Sache ist das schnelle
  666. Auffinden einer kurzen Zusammenfassung des Inhaltes eines Hypertextes,
  667. weshalb jeder Text eine solche Seite enthalten sollte.
  668. @endnode
  669.  
  670. @node "Extra/Weitersuchen"
  671. @toc "Knopf [Extra]"
  672. @alias Weitersuchen
  673. @index Weitersuchen
  674.  
  675. Durch diese Funktion wird die aktuelle Seite erneut nach dem zuletzt
  676. verwendeten Muster durchsucht, die Suche beginnt jedoch in der zweiten
  677. sichtbaren Zeile des Fensters, damit nicht erst gescrollt werden mu₧, um
  678. die Suche fortführen zu können.
  679. @endnode
  680.  
  681.  
  682. @node "Extra/Suchen"
  683. @toc "Knopf [Extra]"
  684. @symbol ai Suchen
  685.  
  686. Bei Auswahl dieser Funktion erscheint ein Dialog, in dem ein Suchbegriff
  687. eingegeben werden kann.
  688.  
  689. Dieser Begriff kann folgenderma₧en gesucht werden:
  690.  
  691. 1. @{U}in der aktuellen Indextabelle@{0}
  692.    Bei dieser Suchart können Wildcards verwendet werden und der Vergleich
  693.    erfolgt @{"case insensitive" link ins}.
  694. @symbol ai Trefferliste
  695.    Wird mehr als ein Treffer gefunden, so erscheint ein Dialog, in dem
  696.    alle passenden Namen aufgeführt sind. Der gewünschte Begriff kann hier
  697.    durch Mausklick oder Tastatur ausgewählt werden. Hierzu ist immer eine
  698.    der Trefferzeilen selektiert,
  699.         Return      wählt diese Zeile aus
  700.         Cursor Up   setzt die Selektierung auf die vorige Zeile
  701.         Cursor Down setzt die Selektierung auf die nächste Zeile
  702.         Undo        wirkt wie der Abbruch-Button
  703.         Shift Up    zeigt die vorige Seite der Liste
  704.         Shift Dn    zeigt die nächste Seite der Liste
  705.         Home        zeigt die erste Seite der Liste
  706.         Shift Home  zeigt die letzte Seite der Liste
  707.  
  708.    Der Slider bewirkt (natürlich) Onlinescrolling und funktioniert
  709.    ansonsten wie in einem GEM-Fenster.
  710.  
  711.    Die Trefferzeilen enthalten jeweils den Namen der Seite sowie das Thema
  712.    des zugehörigen Hypertextes. Wird als Treffer ein Verweis innerhalb
  713.    einer Seite gefunden, so wird dieser hinter dem Namen der Seite, durch
  714.    einen Punkt getrennt ebenfalls gezeigt.
  715.  
  716. @symbol ai Ähnliche
  717. @symbol a ähnliche
  718.    Wird kein exakter Treffer gefunden, jedoch ähnliche Begriffe, so werden
  719.    diese zur Auswahl gestellt. Ähnlich ist hierbei wie folgt definiert:
  720.    - Gro₧/Kleinschreibung wird ignoriert
  721.    - 'ä' wird wie 'ae' behandelt, 'ü' wie 'ue' etc.
  722.    - '*' passt auf beliebig viele Zeichen
  723.    - '?' passt auf genau ein Zeichen
  724.    - abhängig von der Länge des Suchwortes dürfen sich ein paar
  725.      Zeichen unterscheiden ('option' passt auf 'optoin')
  726.  
  727. 2. @{U}in der Default-Referenzdatei@{0}
  728.    Der eingegebene Begriff wird in der durch die Variable 'REF'
  729.    angegebenen Datei gesucht, ansonsten ist diese Suchart identisch mit 1.
  730.  
  731. 3. @{U}in der aktuellen Seite@{0}
  732.    Der eingegebene Begriff wird in der aktuellen Seite ab der ersten
  733.    sichtbaren Zeile bis zum Textende in allen Zeilen gesucht. Wird er
  734.    gefunden, so wird die entsprechende Zeile neue erste Zeile des
  735.    Fensters. Die Suche erfolgt ebenfalls case insensitive und kann durch
  736.    die Funktion 'Weitersuchen' wiederholt werden.
  737.  
  738. 4. @{U}In allen Seiten [aller Hypertexte]@{u}
  739.    Für diese Art der Suche bedient sich der ST-Guide eines externen Tool
  740.    Namens HypFind, welches dem Paket beiliegt und über die Variable
  741.    HYPFIND definiert sein mu₧.
  742.  
  743.    Die Suche erfolgt case insensitiv und das Tool erzeugt als Ausgabe eine
  744.    Trefferliste in Form eines Hypertextes, der vom ST-Guide nach der
  745.    Terminierung von HypFind automatisch nachgeladen wird. Damit HypFind
  746.    aufgerufen werden kann ist
  747.    - entweder MagiC installiert, dann startet ST-Guide das Tool selbst, oder
  748.    - es wird ein AV-Desktop verwendet, wie z.B. Thing oder Gemini (evtl.
  749.    funktioniert das auch mit Ease), in diesem Fall beauftragt ST-Guide den
  750.    Desktop mit dem Starten von HypFind
  751.  
  752.     Alle Anwender, bei denen keine der beiden Bedingungen erfüllt sind,
  753.     können HypFind nur von Hand starten.
  754. @endnode
  755.  
  756.  
  757. @pnode ins
  758. @noref
  759. 'case insensitive' bedeutet, da₧ Gro₧buchstaben wie Klein-
  760. buchstaben behandelt werden und umgekehrt.
  761. 'TEST', 'test' und 'Test' sind danach identische Pattern.
  762. @endnode
  763.  
  764.  
  765. @node "Extra/Info"
  766. @toc "Knopf [Extra]"
  767. @alias Info
  768. @index Info
  769.  
  770. Diese Funktion zeigt einen Dialog, aus dem Name des Programmes,
  771. Versionsnummer sowie der Autor und dessen Adresse zu entnehmen sind.
  772. @autorefoff
  773. Au₧erdem findet sich hier ein Knopf mit der Aufschrift 'Hilfe', bei dessen
  774. Betätigung die Onlinehilfe zum ST-Guide nachgeladen und gezeigt wird.
  775. @autorefon
  776. Angezeigt werden hier aber auch relevante Informationen zur aktuell
  777. angezeigten Datei, dieses sind Autor, Thema, Dateiname und Version des
  778. Textes, alle Angaben werden natürlich nur gezeigt, sofern sie im Hypertext
  779. angegeben wurden (@author, @database, @@$VER:).
  780. @endnode
  781.  
  782.  
  783. @node "Extra/Laden"
  784. @toc "Knopf [Extra]"
  785. @alias Laden
  786. @index Laden
  787.  
  788. Mit dieser Funktion kann ein Hypertext oder eine ASCII-Datei geladen
  789. werden, die Erkennung erfolgt dabei automatisch. Es erscheint hierzu ein
  790. Fileselektor, in dem die gewünschte Datei ausgewählt werden kann, wonach
  791. sie, falls ausreichend Speicher vorhanden ist, geladen wird.
  792.  
  793. Der voreingestellte Pfad für den Selektor wird folgenderma₧en gewählt:
  794. 1. Variable HYPFOLD, falls diese existiert,
  795. 2. Pfad der zuletzt geladenen Datei, falls HYPFOLD nicht ex. oder
  796. 3. aktueller Pfad, falls noch keine Datei geladen und HYPFOLD nicht ex.
  797.  
  798.  
  799. Fall es sich bei der gewählten Datei nicht um einen Hypertext handelt,
  800. verfährt ST-Guide folgenderma₧en:
  801. 1. in der INF-Datei wird die Endung dieser Datei als Variable gesucht
  802.    (also "IMG=" für eine Datei Namens BILD.IMG)
  803. 2. falls 1. fehlschlägt, wird die Variable EXTVIEW in der INF-Datei gesucht
  804. 3. falls 1. und 2. erfolglos waren, zeigt ST-Guide die Datei selber im
  805.    ASCII Format an, ansonsten wird das zugewiesene Programm zunächst unter
  806.    den bereits laufenden Applikationen gesucht, und falls es dort nicht
  807.    gefunden wird, so beauftragt ST-Guide den Desktop mit dem Start des
  808.    betreffenden Programmes. Letzteres funktioniert allerdings nur, wenn
  809.    der verwendete Desktop über entsprechende Funktionen verfügt, d.h. da₧
  810.    AV Protokoll implementiert hat.
  811.  
  812. Falls ein AV-Desktop verwendet wird, kann die anzuzeigende Datei auch
  813. direkt auf das Fenster des ST-Guide gezogen werden.
  814. @endnode
  815.  
  816. @node "Extra/Seite drucken"
  817. @toc "Knopf [Extra]"
  818. @alias "Seite drucken"
  819. @index "drucken"
  820.  
  821. Diese Funktion macht genau das, was man von ihr erwarten sollte, nämlich
  822. die aktuelle Seite als ASCII-Text auf den Drucker ausgeben.
  823. @endnode
  824.  
  825.  
  826. @node "Extra/Paste"
  827. @toc "Knopf [Extra]"
  828. @alias Paste
  829. @index Paste
  830.  
  831. Durch Betätigung dieses Knopfes wird der ST-Guide veranlasst, die Datei
  832. SCRAP.TXT vom Clipboard zu laden, falls möglich, und sie dann im Fenster
  833. anzuzeigen.
  834. @endnode
  835.  
  836.  
  837. @node "Extra/Marke setzen"
  838. @toc "Knopf [Extra]"
  839. @alias "Marke setzen"
  840.  
  841. Marke auf aktuelle Seite setzen.
  842. @endnode
  843.  
  844.  
  845. @node "Extra/gehe zu Marke"
  846. @toc "Knopf [Extra]"
  847. @alias "gehe zu Marke"
  848.  
  849. Zur gesetzten Marke springen.
  850. @endnode
  851.  
  852.  
  853. @node "Extra/Copy"
  854. @next "Extra/Copy"
  855. @toc "Knopf [Extra]"
  856. @alias Copy
  857. @index Copy
  858.  
  859. Diese Funktion schreibt die aktuelle Seite als ASCII-Text ins Clipboard
  860. und stellt sie damit allen anderen GEM-Applikationen zur Verfügung. Falls
  861. noch kein Clipboard existiert, so wird eines erzeugt, und zwar wie üblich
  862. auf dem Bootlaufwerk als Ordner CLIPBRD.
  863. @endnode
  864.  
  865.  
  866.  
  867.  
  868. @node AV-Protokoll "Das AV-Protokoll"
  869. @toc AVProtokoll
  870. @next AV-Protokoll
  871. @prev AV-Protokoll
  872.  
  873. Der grundsätzliche Aufbau einer solchen Meldung ist:
  874.     buffer[0] = <Meldungs-Typ>              (z.B. VA_START)
  875.     buffer[1] = <Sender-ID>                 (von appl_init())
  876.     buffer[2] = 0                           ('Überlänge')
  877.     buffer[3] = <Kontrolltasten>            (SENDKEY)
  878.                 <Fenster-Handle>            (ACCWINDOPEN)
  879.                 <Fenster-Handle>            (ACCWINDCLOSED)
  880.                 <Fenster-Handle>            (DRAGACCWIND)
  881.                 Zeiger auf Pfad (High)      (STARTPROG)
  882.     buffer[4] = <gedrückte Taste>           (SENDKEY)
  883.                 Zeiger auf Pfad (Low)       (STARTPROG)
  884.                 <Maus-X-Pos.>               (DRAGACCWIND)
  885.                 0                           (alle anderen)
  886.     buffer[5] = <Zeiger auf Zeile> (High)   (STARTPROG)
  887.                 <Maus-Y-Pos.>               (DRAGACCWIND)
  888.                 0                           (alle anderen)
  889.     buffer[6] = <Zeiger auf Zeile> (Low)    (STARTPROG)
  890.                 <Zeiger auf Pfad> (High)    (DRAGACCWIND)
  891.                 0                           (alle anderen)
  892.     buffer[7] = <Zeiger auf Pfad> (Low)     (DRAGACCWIND)
  893.                 0                           (alle anderen)
  894.  
  895. Folgende Meldungen werden erkannt/verwendet:
  896. @symbol ai VA_START
  897. * @{B}VA_START@{0}:     (0x4711)
  898.     @{U}APP -> ACC@{0}: "erwache aus deinem Schlaf und beginne mit der Arbeit";
  899.     @{U}ACC -> APP@{0}: evtl. AV_ACCWINDOPEN, nachdem das Fenster geöff-
  900.     net und die evtl. angegebene Datei geladen wurde. Falls eine
  901.     Kommandozeile angegeben wurde und sich mehr als ein Argument darin
  902.     befindet, so wird alles ab dem ersten Leerzeichen als Name der
  903.     anzuzeigenden Seite interpretiert.
  904.  
  905.     Laut AV-Doku müssen alle Dateinamen in Gro₧buchstaben und mit
  906.     vollständigem Pfad angegeben werden. Um diesem Umstand Rechnung zu
  907.     tragen und trotzdem zuzulassen, da₧ die aufrufende Applikation nicht
  908.     wei₧, wo sich der Hypertext befindet, wurde als Spezialfall das
  909.     'Laufwerk' "*" implementiert: Angabe von "*:\AES.HYP" veranla₧t den
  910.     ST-Guide, die Datei AES.HYP auf allen angegebenen Pfaden zu suchen.
  911.  
  912.     Aufruf mit 'C:\AES.HYP appl_init' würde also AES.HYP laden und daraus
  913.     die Seite <appl_init> anzeigen.
  914.  
  915.     Aufruf mit 'C:\AES.REF appl_init' würde den Begriff <appl_init> in der
  916.     Datei AES.REF suchen und im Erfolgsfall die Datei AES.HYP laden und daraus
  917.     die Seite anzeigen, in der das gesuchte Symbol definiert wurde.
  918.  
  919.     Aufruf mit 'C:\AES.HYP' würde die angegebene Datei laden und die erste
  920.     Seite aus ihr darstellen.
  921.  
  922.     Aufruf mit 'appl_init' würde diesen Begriff in der durch 'REF'
  923.     angegebenen Datei suchen und die passende Seite aus der betreffenden
  924.     Datei darstellen
  925.  
  926. @symbol ai VA_DRAGACCWIND
  927. * @{B}VA_DRAGACCWIND@{0}:   (0x4725)
  928.     APP -> ACC: "es wurde eine Datei auf eines deiner Fenster gezogen,
  929.     hier hast du den Pfad"; der Guide lädt daraufhin die so angegebene
  930.     Datei und zeigt sie im Fenster an. Auch hier mu₧ der vollständige
  931.     Zugriffspfad angegeben werden.
  932.  
  933. @symbol ai AV_SENDKEY
  934. * @{B}AV_SENDKEY@{0}:       (0x4710)
  935.     ACC -> APP: "es wurde eine Taste gedrückt, mit der ich nichts anfangen
  936.     kann, hier hast du sie"; hierdurch wird die Benutzung aller
  937.     Shortcuts der Applikation ermöglicht, auch wenn das ACC Besitzer des
  938.     obersten Fensters ist.
  939.  
  940. @symbol ai AV_STARTPROG
  941. * @{B}AV_STARTPROG@{0}:     (0x4723)
  942.     ACC -> APP: "starte mal das in dieser Meldung angegebene Programm mit
  943.     der ebenfalls evtl. angegebenen Kommandozeile"; Der Guide benutzt
  944.     diese Meldung für die Ausführung von SYSTEM Anweisungen. Thing und
  945.     GEMINI unterstützen hier auch die Angabe von nicht ausführbaren
  946.     Dateien, für deren Endung dann ein Programm gesucht und gestartet
  947.     wird.
  948.  
  949.     APP -> ACC: VA_PROGSTART, wird vom Guide jedoch ignoriert.
  950.  
  951. @symbol ai AV_ACCWINDOPEN
  952. * @{B}AV_ACCWINDOPEN@{0}:   (0x4724)
  953.     ACC -> APP: "ich habe gerade ein Fenster geöffnet"; da das Handle
  954.     dieses Fensters mitgeliefert wird, dient es u.a. dem Zweck, das
  955.     Window-Cycling der Hauptapplikation auf die Fenster der ACC's
  956.     auszuweiten oder dem ACC zu melden, wenn Objekte auf eines seiner
  957.     Fenster gezogen wurden (siehe VA_DRAGACCWIND);
  958.  
  959. @symbol ai AV_ACCWINDCLOSED
  960. * @{B}AV_ACCWINDCLOSED@{0}: (0x4726)
  961.     ACC -> APP: "ich habe gerade eines meiner Fenster geschlossen";
  962.     Gegenstück zu ACCWINDOPEN.
  963.  
  964. @symbol ai AV_EXIT
  965. * @{B}AV_EXIT@{0}:
  966.     ACC -> APP: "ich melde mich ab - und Tschü₧"
  967.  
  968. @symbol ai AV_PROTOKOLL
  969. *@{B}AV_PROTOKOLL@{0}:
  970.     ACC -> APP: "hier bin ich"
  971. @endnode
  972.  
  973.  
  974.  
  975. @node PureC-Protokoll "Das PureC-Help Protokoll"
  976. @toc PureC
  977. @next PureC-Protokoll
  978. @prev PureC-Protokoll
  979.  
  980. Der grundsätzliche Aufbau einer solchen Meldung ist:
  981.     buffer[0] = <Meldungs-Typ>               (z.B. AC_HELP)
  982.     buffer[1] = <Sender ID>                  (von appl_init)
  983.     buffer[2] = <Versionsnummer>             (bei AC_REPLY)
  984.                 0                            (alle anderen)
  985.     buffer[3] = Zeiger auf Suchwort (High)   (bei AC_HELP)
  986.                 <Handle des ACC-Fensters>    (bei AC_REPLY)
  987.                 0                            (alle anderen)
  988.     buffer[4] = Zeiger auf Suchwort (Low)    (bei AC_HELP)
  989.                 0                            (alle anderen)
  990.     buffer[5] = 0x1993                       (evtl. bei AC_HELP)
  991.                 0                            (alle anderen)
  992.     buffer[6] = Zeiger auf Indexdatei (High) (falls AC_HELP und 0x1993)
  993.                 0                            (sonst)
  994.     buffer[7] = Zeiger auf Indexdatei (Low)  (falls AC_HELP und 0x1993)
  995.                 0                            (sonst)
  996.  
  997. @symbol ai AC_HELP
  998. * @{B}AC_HELP@{0}     (1025)
  999.     @{U}APP -> ACC@{0}: "zeige mal die Infos zum angegebenen Begriff"
  1000.  
  1001.     @{U}ACC -> APP@{0}: AC_REPLY (siehe dort), nachdem die passende Datei
  1002.     dazu gesucht und die gewünschte Seite angezeigt, bzw. die Suche
  1003.     erfolglos abgebrochen wurde.
  1004.  
  1005.     Die Suche nach dem Begriff erfolgt in der durch 'REF' bzw. der in der
  1006.     Meldung angegebenen Datei. Gefunden werden auch ähnliche Begriffe.
  1007.  
  1008. @symbol ai AC_REPLY
  1009. * @{B}AC_REPLY@{0}    (1026)
  1010.     @{U}ACC -> APP@{0}: Antwort auf alle Meldungen;
  1011.  
  1012. @symbol ai AC_VERSION
  1013. * @{B}AC_VERSION@{0}  (1027)
  1014.     @{U}APP -> ACC@{0}: "sag mir, welche Versionsnummer Du trägst"
  1015.     @{U}ACC -> APP@{0}: AC_REPLY (siehe dort)
  1016.  
  1017. @symbol ai AC_COPY
  1018. * @{B}AC_COPY@{0}     (1028)
  1019.     @{U}APP -> ACC@{0}: "schreibe mal die aktuelle Seite ins Clipboard"
  1020.     @{U}ACC -> APP@{0}: AC_REPLY (siehe dort), nachdem die aktuelle Seite
  1021.     als ASCII-Text (SCRAP.TXT) ins Clipboard geschrieben wurde.
  1022. @endnode
  1023.  
  1024.  
  1025. @node "Grafik-Fähigkeiten"
  1026. @prev "Grafik-Fähigkeiten"
  1027. @toc Vorteile
  1028. Der ST-Guide besitzt allerhand grafische Features:
  1029.  
  1030. - Popup-Nodes als Alternative zu den normalen Seiten
  1031. - Inline-Images (in eine Seite eingebundene Grafiken)
  1032. - Linien, Pfeile und verschiedene Boxentypen
  1033. - Unterschiedliche Text-Attribute
  1034. @endnode
  1035.  
  1036.  
  1037. @pnode "Popup-Nodes"
  1038. Dies ist ein Beispiel für
  1039. eine @{B}Popup-Node.@{0}
  1040.  
  1041. Pnodes dienen für kurze
  1042. Erklärungen zu bestimmten
  1043. Begriffen, ohne da₧ dabei
  1044. ein neues Fenster geöffnet
  1045. werden mu₧.
  1046. @endnode
  1047.  
  1048.  
  1049. @pnode "Text-Attribute"
  1050. normal
  1051. @{B}fett@{0}
  1052. @{U}unterstrichen@{0}
  1053. @{I}kursiv@{0}
  1054. @{G}hell@{0}
  1055. @{O}umrandet@{0}
  1056. @{S}schattiert@{0}
  1057. @endnode
  1058.  
  1059.  
  1060. @node "Diskette/Festplatte"
  1061. @toc Vorteile
  1062.  
  1063. Der ST-Guide geht sehr sparsam mit Ihren Massenspeichern um:
  1064.  
  1065. - Der Compiler ist in der Lage, Hypertexte zu packen, also ihren
  1066.   Platzbedarf zu verringern. Dazu benutzt der den LH5-Algorithmus,
  1067.   den auch der Packer LHARC verwendet. Auf diese Weise können
  1068.   Hypertexte um bis zu zwei Drittel verkleinert werden. Beim Ansehen
  1069.   des Hypertextes werden die gepackten Seiten ohne spürbaren Zeitverlust
  1070.   wieder ausgepackt und auf dem Bildschirm angezeigt.
  1071.  
  1072. - Ein weiterer Platzvorteil ergibt sich aus der Tatsache, da₧ ein
  1073.   Hypertext immer als eine Datei gespeichert wird:
  1074.   Bei Hypertext-Systemen, die für jede Hilfeseite eine neue Datei anlegen,
  1075.   entsteht der Nachteil, da₧ jede dieser Dateien - sei sie auch noch so
  1076.   klein - mindestens 1024 Bytes an Disk-/Plattenspeicher verbraucht.
  1077.   Enthält ein Hypertext viele Seiten <1024 Bytes, so erhöht sich der
  1078.   tatsächliche Speicherbedarf um ein vielfaches.
  1079.   Beim ST-Guide dagegen wird nur soviel verbraucht, wie die Seite selbst
  1080.   beträgt (bzw. noch weniger, siehe oberen Spiegelstrich)!
  1081. @endnode
  1082.  
  1083.  
  1084. @node "Arbeitsspeicher"
  1085. @toc Vorteile
  1086.  
  1087. Der Arbeitsspeicher Ihres Computers wird nur wenig belastet:
  1088.  
  1089. - das ST-Guide.ACC selbst ist sehr kurz, viel kürzer als andere vom
  1090.   Leistungsumfang her vergleichbare Programme
  1091.  
  1092. - Zwar sind Hypertexte immer als eine komplette Datei abgespeichert,
  1093.   bei der Anzeige wird aber nur ein kleiner Teil davon in den RAM-
  1094.   Speicher geladen, nämlich nur die gerade anzuzeigende Seite!
  1095.   Damit "blockiert" der ST-Guide keinen nennenswerten Teil Ihres
  1096.   Arbeitsspeichers.
  1097. @endnode
  1098.  
  1099.  
  1100. @node "Accessory"
  1101. @toc Vorteile
  1102.  
  1103. Ob Sie den ST-Guide als Accessory oder als Programm starten wollen,
  1104. bleibt Ihrer freien Entscheidung überlassen. Bei Bedarf einfach
  1105. umbenennen!
  1106.  
  1107. Um den ST-Guide aber möglichst uneingeschränkt nutzen zu können,
  1108. empfiehlt sich der Einsatz als Accessory. So kann er auch aus anderen
  1109. Programmen heraus aufgerufen werden.
  1110. @endnode
  1111.  
  1112.  
  1113. @node "ASCII"
  1114. @next "ASCII"
  1115. @toc Vorteile
  1116.  
  1117. Selbst dann, wenn die angezeigte Datei nur reinen ASCII-Text enthält,
  1118. können Sie mit dem ST-Guide auf andere Texte verzweigen.
  1119.  
  1120. Das geht so: Wenn Sie einen Begriff anklicken, der auch irgendwo als
  1121. Hilfeseite vorliegt, findet der ST-Guide diese Seite und zeigt sie an.
  1122. Dazu mu₧ dieser Begriff nicht besonders hervorgehoben sein, es kommt
  1123. lediglich darauf an, da₧ die angeklickte Zeichenkette gefunden wird.
  1124.  
  1125. Existiert sie nicht, so sucht der ST-Guide nach ähnlichen Begriffen
  1126. und zeigt eine Liste der gefundenen Verweise an.
  1127. @endnode
  1128.  
  1129.  
  1130. @node Hilfsseite
  1131. @next Hilfsseite
  1132. @prev Hilfsseite
  1133. @toc Main
  1134.  
  1135. Dieser Text stellt die Dokumentation des vorliegenden Hypertext-Sytemes
  1136. dar und beschreibt die Funktionsweise und Anwendung aller zu diesem System
  1137. gehörenden Komponenten.
  1138.  
  1139. An dieser Stelle sei aus aktuellem Anla₧ noch einmal erwähnt, da₧ der
  1140. ST-Guide Fairware ist, um Spenden in jeder Höhe also ausdrücklich
  1141. gebeten wird, um die Weiterentwicklung dieses Programmes zu
  1142. gewährleisten (ich freue mich auch über kleine Spenden...)
  1143.  
  1144. Kritik und Anregungen an
  1145.             Holger Weets
  1146.             Tangastr. 45
  1147.             26121 Oldenburg
  1148.             E-Mail: Holger Weets @ OL (Mausnet)
  1149.  
  1150. Spenden:    Landessparkasse zu Oldenburg
  1151.             Kto.: 023-182 041
  1152.             BLZ.: 280 501 00
  1153. @endnode
  1154.  
  1155.  
  1156.  
  1157.  
  1158.