Amigaguide ist unter AmigaOS das Standardformat für Handbücher und Hilfstexte. Es besteht aus einer Reihe von Kommandos und Knoten mit Text. Mit Ausnahme von @$VER: spielt Groß- und Kleinschreibung keine Rolle. Das Amigaguide-Format hat sich im Laufe der Zeit mehrmals geändert. Die Angaben in diesem Dokument gelten für V40 (Workbench 3.1). Eine ausführlichere Beschreibung befindet sich im Aminet unter dem Namen aguidehowwrite.lha
Globale und lokale Kommandos müssen jeweils auf einer eigenen Zeile stehen. An erster Stelle steht ein @-Zeichen. Darauf folgt, ohne Leerzeichen dazwischen, das Kommando.
Im Gegensatz dazu stehen Textkommandos innerhalb des Textes. Sie haben das Schema @{...}. Dabei darf zwischen @ und { kein Leerzeichen stehen.
Wenn das @-Zeichen sichtbar geschrieben werden soll, muss ein \-Zeichen vorangestellt werden. Dies ist aber nur erforderlich, wenn das @-Zeichen auf Grund seiner Position mit einem Kommando oder einer Formatieranweisung verwechselt werden kann. Das \-Zeichen muss \\ geschrieben werden, um es sichtbar zu machen.
Die in der Spalte "Lokal" gekennzeichneten Kommandos können auch innerhalb eines Knotens angewendet werden. Das heißt, sie stehen zwischen @NODE und @ENDNODE. Sie gelten dann sinngemäß nur innerhalb des Knotens.
| Kommando | Lokal | Beschreibung |
|---|---|---|
| @DATABASE <Name> | Muss an erster Stelle in der Datei stehen. Wenn <Name> Leerzeichen enthält, muss er mit "-Zeichen umschlossen werden. | |
| @AUTHOR <Name> | Hier kann der Name des Erstellers angegeben werden. | |
| @(C) <Text> | Für Copyright-Vermerke | |
| @FONT <Name> <Größe> | * | Schriftart (Bsp: @FONT garnet.font 16) |
| @HELP <Knotenname> | Knoten, der beim Klick auf [Hilfe] angezeigt wird. | |
| @INDEX <Knotenname> | Knoten, der beim Klick auf [Index] angezeigt wird. | |
| @MACRO <Makroname> <Kommandos> | * | Bsp: @MACRO Multistyle
"@{B}$1@{U}$2@{I}$3@{UB}@{UU}@{UI}" @{Multistyle "fett" "fett+unterstrichen" "fett+unterstrichen+kursiv" |
| @MASTER <Text> | Hier kann man angeben, aus welcher Datei der Guide entstanden ist. | |
| @REM bzw. @REMARK <Text> | * | Kommentar |
| @ONOPEN <Dateiname> | * | Das AREXX-Script wird beim Öffnen der Guide-Datei ausgeführt. |
| @ONCLOSE <Dateiname> | * | Das AREXX-Script wird beim Schließen der Guide-Datei ausgeführt. |
| @SMARTWRAP | * | Aktiviert den automatischen Zeilenumbruch. Einzelne Zeilenumbrüche im Text werden wie bei HTML als Whitespace behandelt. Als Absatzende gelten 2 Zeilenumbrüche oder @{PAR}. |
| @TAB <n> | * | Setzt Tabulatorabstand. Voreinstellung ist 8. |
| @$VER: Name Version.Revision (Tag.Monat.Jahr) | Angabe eines Versionsstrings. "VER" muss groß
geschrieben werden. Bsp. @$VER: OpenOffice 5.17 (1.4.2024) |
|
| @WORDWRAP | * | Aktiviert den automatischen Zeilenumbruch. Im Gegensatz zu @SMARTWRAP werden Zeilenumbrüche als Absatzende interpretiert. |
| @NODE <Knotenname> <Titel> | Leitet einen neuen Knoten ein. Beim Aufruf einer Guide-Datei wird zuerst der Knoten mit dem Namen "MAIN" angezeigt. Der Titel wird als Fenstertitel angezeigt. | |
| @ENDNODE | Jeder Knoten muss mit @ENDNODE abgeschlossen werden. Beim letzten Knoten ist nach @ENDNODE ein Zeilenumbruch erforderlich. |
Die folgenden Kommandos können nur innerhalb eines Knotens verwendet werden
| Kommando | Beschreibung |
|---|---|
| @NEXT <Knotenname> | Hier kann eine Knoten angegeben werden, der beim Klick auf [Blättern >] angesprungen wird. Voreinstellung ist der nächste Knoten in der Datei. |
| @PREV <Knotenname> | Hier kann eine Knoten angegeben werden, der beim Klick auf [Blättern <] angesprungen wird. Voreinstellung ist der vorhergehende Knoten in der Datei. |
| @TOC <Knotenname> | Hier kann eine Knoten angegeben werden, der beim Klick auf [Inhalt] angesprungen wird. Voreinstellung ist der Knoten mit dem Namen "MAIN". |
| @TITLE <Text> | Der Text wird als Fenstertitel angezeigt. Der Titel kann aber bereits bei @NODE angegeben werden. |
| Kommando | Beschreibung |
|---|---|
| @{<Knopftext> LINK <Knotenname>} |
Erzeugt einen anklickbaren Knopf mit dem Knopftext als
Beschriftung. Dabei gibt es 3 Möglichkeiten:
|
| @{<Knopftext> SYSTEM <Doskommando>} | Beim Anklicken wird ein Kommando über die Shell ausgeführt. |
| @{<Knopftext> RX <Scriptname>} | Beim Anklicken wird ein AREXX-Script ausgeführt} |
| @{<Knopftext> RXS <AREXX-Kommando>} | Beim Anklicken wird ein einzelnes AREXX-Kommando ausgeführt |
| @{B}, @{UB} | Fettschrift ein/aus |
| @{I}, @{UI} | Kursiv ein/aus |
| @{U}, @{UU} | Unterstrichen ein/aus |
| @{APEN <Stiftnummer>} | Wählt einen Stift für den Text. |
| @{BPEN <Stiftnummer>} | Wählt einen Stift für den Texthintergrund. |
| @{FG <Farbe>} | Ähnlich @APEN{}, jedoch kann hier für die Textfarbe einer der folgenden Werte genommen werden: "Text", "Shine", "Shadow", "Fill", "Filltext", "Background" oder "Highlight" |
| @{BG <Farbe>} | Farbe für Hintergrund. Werte wie bei @FG{} |
| @{JCENTER}, @{JLEFT}, @{JRIGHT} | Ausrichtung: zentriert, linksbündig, rechtsbündig. Wenn innerhalb einer Zeile mehrere Ausrichtungen festgelegt werden, gilt für diese Zeile die als letztes angegebene Ausrichtung. Funktioniert bei automatischem Zeilenumbruch nur mit Zeilen, die mit @{PAR}, @{LINE} oder doppelten Zeilenumbruch abgeschlossen sind. |
| @{LINE} | neue Zeile |
| @{PAR} | neuer Absatz |
| @{CODE} | Schaltet den mit @SMARTWRAP oder @WORDWRAP eingestellten automatischen Zeilenumbruch wieder aus. Er kann dann aber für den entsprechenden Knoten nicht wieder aktiviert werden. |
| @{LINDENT <n>} | Rückt linken Rand um n Zeichen ein |
| @{PARI <n>} | Rückt 1. Zeile des Absatzes um n Zeichen relativ zu dem mit @{LINDENT} festgelegten Rand ein. Gilt nur für den 1. Absatz im Knoten und nur bei aktivierten automatischen Zeilenumbruch. |
| @{PARD} | Setzt Farbeinstellungen und Einrückungen zurück |
| @{SETTABS <n1> ...} | Legt Tabulatorpositionen fest |
| @{CLEARTABS} | Löscht die mit @SETTABS{} festgelegten Tabulatorpositionen. Es gilt wieder der mit @TAB festgelegte Wert oder 8 |
| @{TAB} | Fügt ein Tabulatorzeichen in den Text ein. |
| @{AMIGAGUIDE} | Fügt den Text "AMIGAGUIDE®" ein |
@DATABASE "test.guide"
@AUTHOR Matthias Rustler
@$VER: test.guide 0.1 (2.5.2005)
@SMARTWRAP
@NODE MAIN "Hauptknoten"
Hallo @{B}Welt@{UB}. Dies ist der Hauptknoten.@{PAR}
@{"Kommandos" LINK "KOMMANDOS"}
@ENDNODE
@NODE KOMMANDOS "Übersicht der Befehle"
Links@{PAR}
Rechts@{PAR}
Vor@{PAR}
Zurück@{PAR}
@ENDNODE