@database GuideCheck.guide @master GuideCheck.guide @$VER: 1.21 (21.07.00) @author "Guido Mersmann" @(c) "Guido Mersmann" @smartwrap @macro MS "@{par}@{jcenter}@{FG SHINE}$1@{par}@{JLeft}@{FG TEXT}" @macro MH "@{par}@{jcenter}@{FG HIGHLIGHT}$1@{par}@{JLeft}@{FG TEXT}" @macro MC "@{par}@{jcenter}@{FG SHINE}$1@{par}@{JLeft}@{FG TEXT}" @node "Main" "GuideCheck" @{JCenter} @{code} @{FG HIGHLIGHT}GuideCheck V1.21 (C) Guido Mersmann in 1997-2000@{FG TEXT} GUIDECHECK IS A MAILWARE PRODUCT READ THE DISTRIBUTION SECTION FOR INFORMATION ON DISTRIBUTION @{FG SHINE}Contents ----------@{FG TEXT} @{" Einführung " link "Introduction"} @{" Systemvorrausetzungen " link "SystemRequirements"} @{" Featureliste " link "FeatureList"} @{" Distribution " link "Distribution"} @{" Installieren " link "HowToInstall"} @{" GuideCheck " link "GuideCheck"} @{" Die unterstützten Kommandos " link "Commands"} @{" Tips,Tricks,Fragen und Antworten " link "FAQS"} @{" Geschichtliches " link "History" 999} @{" Zukünftiges " link "Future"} @{" Bekannte Fehler " link "Buglist"} @{" Danksagungen " link "Thanx"} @{" Der Autor " link "Author"} @{" Andere Programme von mir! " link "OtherPrgs"} @endnode @node "Introduction" "Einführung" @{MS "Einführung"} GuideCheck ist ein Tool, das jeder benötigt, der selber AmigaGuide schreiben will. GuideCheck prüft AmigaGuide Dateien auf Herz und Nieren. Es findet eine detailierte Auswertung statt, die das korrigieren der Fehler sehr leicht machen. @endnode @node "Systemrequirements" "Systemvorraussetzung" @{MS "Systemvorraussetzungen"} Sie benötigen mindestens OS2. Wenn Sie OS2.1 oder größer benutzen, dann benutzt GuideCheck die locale.library und wird dadurch multilingual. @endnode @node "Featurelist" "Featureliste" @{MS "Features"} ° Sehr kurz, da in Assembler geschrieben. ° Prüft die genaue Syntax von über 50 Befehlen. ° Links und andere Querverweise werden geprüft. ° AmigaGuides dürfen aus mehreren Dateien bestehen ° Doppelte Nodes werden ausgesondert. ° Illegale Zeichen in Nodes werden geprüft. @endnode @node "Distribution" "Distribution" @{MS "Distribution"} Dieses Programm darf auf allen jederman zugänglichen Medien veröffentlicht werden, solange im Archiv alle Files unverändert beiliegen. Bei CD Veröffentlichungen möchte ich gerne ein kostenloses Exemplar. @{b}GuideCheck ist Mailware!@{ub} Ich erwarte von jedem, der GuideCheck benutzt, daß er mir eine EMail oder eine Postkarte schickt. Ich denke das tut keinem Weh und mich spornt es an neue Features zu integrieren und schnell neue Anpassungen vorzunehmen. Updates sind über das @{b}Aminet@{ub} zu bekommen. @{b}Für Schäden oder Datenverluste, die durch GuideCheck auftreten, hafte ich nicht. Benutzung auf eigene Gefahr !!!@{ub} @endnode @node "HowToInstall" "Installieren von GuideCheck" @{MS "Installieren von GuideCheck"} Kopieren Sie einfach den "GuideCheck" Befehl in das C: Verzeichnis. Wenn Sie Ihre Landessprache benutzen wollen, dann kopieren Sie den entsprechenden Catalog nach Locale:Deutsch Das war schon alles! @endnode @node "GuideCheck" "GuideCheck" @{MS "GuideCheck"} GuideCheck ist nur im CLI/Shell zu gebrauchen und benutzt folgendes Template: @{"Name" link "PT_Name"}/A,@{"NoDeepScan" link "PT_NoDeepScan"}/S=@{"NDS" link "PT_NoDeepScan"},@{"NoOther" link "PT_NoOther"}/S=@{"NO" link "PT_NoOther"},@{"NoNodes" link "PT_NoNodes"}/S=@{"NN" link "PT_NoNodes"},@{"NoLinks" link "PT_NoLinks"}/S=@{"NL" link "PT_NoLinks"},@{"NodeNameCheck" link "PT_NodeNameCheck"}/S=@{"NNC" link "PT_NodeNameCheck"},@{"HTDS" link "PT_HTDS"}/S=@{"HT" link "PT_HTDS"},@{"DEBUG" link "PT_DEBUG"}/S @endnode @node "History" "Geschichtliches" @{MS "Geschichtliches"} @{MC "1.00"} Die erste öffentliche Version. @{MC "1.01"} BUGFIX: Fehler in der Auswertung lokaler Befehle behoben, die bei einem "}" in einem Link zu einem "Anführungszeichen fehlt" Fehler führte. @{MC "1.02 - 1.10"} FEATURE: Jetzt unterstützt GuideCheck auch @{"Multi-Guide-Dateien" link "PT_NoDeepScan"}.@{par} CHANGED: Viele kleine Berichtigungen und Verbesserungen. @{MC "1.11"} Französische Anleitung hinzugefügt (Dank an Frédéric Delacroix) @{MC "1.12"} FEATURE: Das \@{FONT} Kommando hatte ich vergessen. (gemeldet von Ronald Schmiers)@{par} BUGFIX: Die Befehle \@{BG} und \@{BPEN} erzeugten Fehler, obwohl sie richtig angegeben waren. (gemeldet von Ronald Schmiers)@{par} BUGFIX: Nicht existierende externe Guide Dateien führten zur sofortigen Beendigung von GuideCheck und einer falschen Fehlermeldung. (gemeldet von Ronald Schmiers) @{MC "1.13"} FEATURE: Die Syntax-Fehlermeldungen geben jetzt auch das Kommando aus, das den Fehler verursachte.@{par} BUGFIX: Hab noch einen Fehler im \@{SETTABS} Kommando beseitigt. @{MC "1.14"} Jetzt werden auch \@{Macros} überprüft. @{MC "1.15"} BUGFIX: Macros ohne Argumente werden jetzt auch richtig erkannt.@{Par} FEATURE: Die Ausgabe der Syntax-Fehler kann jetzt unterbrochen werden.@{Par} BUGFIX: Verschachtelte Macros sind nur noch im HTDS Modus erlaubt.@{Par} FEATURE:Anleitung um die Kommandos erweitert. @{MC "1.16"} FEATURE: Neuer italienischer Katalog und italienische Anleitung (Danke an Walter Cazzola)@{par} FEATURE: Den FAQ-Punkt @{"Dateiverknüpfung" link "FAQSFLINK"} in die Anleitung eingebaut. @{MC "1.17"} FEATURE: GuideCheck.rexx ins Archiv gepackt. Dieses Script öffnet ein GUI und erlaubt so die Benutzung von GuideCheck direkt von der Workbench! (Danke an Nils Goers) @{MC "1.18"} BUGFIX: Habe das Bilder/Datentyp Problem behoben! @{MC "1.19"} FEATURE: Die volle Prüfung der Nodenamen ist jetzt nur noch @{"optional" link "PT_NodeNameCheck"}, da hier wohl die Meinungen auseinandergehen, was erlaubt ist und was nicht. ":" und "/" bleiben allerdings drin, weil diese AmigaGuide auf einen Dateinamen schließen lassen @{MC "1.20 = 1.19"} FEATURE: Spanische Anleitung und spanischen Katalog hinzugefügt (Danke an Victor M. Gutiérrez) @{MC "1.21"} FEATURE: Styleprüfung wird durchgeführt. (Beispiel: "\@{b} fehlt")@{par} FEATURE: \@Database muß vorne in der Datei stehen, damit GuideCheck die Datei als Guide ansieht.@{par} FEATURE: Die Schriftfarbe der \@FG und \@BG Kommandos wird jetzt vollständig geprüft!@{par} FEATURE: @{"DEBUG" link "PT_Debug"} Option erlaubt die Ausgabe aller Dateien, die vom Guide angesprochen werden.@{par} FEATURE: Der Dateityp wird jetzt ausgegeben. (Guide, Text, Binär) @endnode @node "Future" "Zukünftiges" @{MS "Zukünftiges"} Keine Ahnung (-8 Ich richte mich da voll nach Ihren Wünschen. @endnode @node "Buglist" "Bugliste" @{MS "Buglist"} Es sind keine Fehler bekannt. @endnode @node "Thanx" "Danksagungen" @{MS "Danksagungen"} Danke an @{b}Frédéric Delacroix@{ub} der mir das, von einem unbekanntem Autor stammende, CheckGuide Programm zusannte. Es brachte mich dazu das vor Jahren angefangene GuideCheck zu vollenden. Natürlich auch großen Dank für die französische Anleitung. Vielen Dank auch an @{b}Walter Cazzola@{ub} für die italienische Übersetzung. Vielen Dank für das GuideCheck-GUI an @{b}Nils Goers@{ub}! Danke an @{b}Silke Bormann@{ub} für ihre SchlumpfDatenbank und die Möglichkeit das Programm mal an einem unbekannten und ungeprüften Guide zu testen. @endnode @node "Author" "Der Autor" @{MS "Der Autor"} Sollten Sie Bugs in GuideCheck finden, so bitte ich um Mitteilung, damit ich diese in neuen Versionen beseitigen kann. Auch für Anregungen zur Erweiterungen von GuideCheck bin ich jederzeit dankbar. @{code} Guido Mersmann Glatzer Straße 12 48477 Hörstel Deutschland FIDONET : 2:2449/246.15 INTERNET: geit\@gmx.de <- Wenn Sie ein "\\" sehen, dann ignorieren! TEL : 05978-225 FAX : 05978-705 @endnode @node "OtherPrgs" "Andere Programme von mir!" @{MS "Andere Programme von mir!"} @{MS "BoulderDäsh [game/jump/boulderdaesh.lha]"} Ein Klone des Original Boulderdäsh für den Amiga. Dies ist die einzige Version, die auf dem Amiga schneller ist als das Original. Sie sieht genauso aus und verhält sich genauso. Ich wurde schon gefragt, wo sich der C64 befindet. (-8 Das alles schon auf einem 68000 ohne Fastmem. Grafikkartenbenutzer wird freuen, daß dieses Spiel uneingeschränkt auf Grafikkarten funktioniert. @{MS "SimpleCat [dev/misc/simplecat.lha]"} Dieses Tool ist für Programmierer und Anwender. Mit diesem Programm können die auf einfachste Weise mit ihrem lieblings Texteditor Kataloge von Programmen ändern. Diese Programme müssen allerdings ein CS-File beiliegen haben. Sehen Sie dazu im Archiv in der Catalogs-Schublade nach. @{MS "AFind [util/misc/afind.lha]"} Dieses Programm ermöglicht es ihnen auf einfachste Weise ihre AminetCDs zu durchsuchen. Es funktioniert eigentlich wie das Originaltool von der CD, nur werden hier AminetCDs und AminetSets gemischt benutzt und man ist z.B nicht gezwungen die ersten 5 Aminets zu durchsuchen, um ein Programm zu finden, das auf Set1 Diskb liegt. @{MS "AView [util/misc/AView.lha]"} AView ist ein Programm, das eigentlich wie Multiview funktioniert. Es arbeitet allerdings ohne Datentypen, sondern benutzt eigene Definitionen. Man kann für jeden Dateityp ein eigenes Programm angeben, daß benutzt werden soll. @{MS "Guideformat [text/edit/guideformat.lha]"} GuideFormat ist ein kleines Tool, das Blocksatz auch bei AmigaGuide Dateien ermöglicht. Dabei ist es egal, ob in der Zeile "Links" oder sonstige Kommandos vorkommen. @{MS "GuideCheck [text/edit/guidecheck.lha]"} GuideCheck ist ein Tool, das es erlaubt ein Guidefile vollständig zu prüfen und alle eventuellen Fehler aufzudecken. @{MS "SiedlerBoot [game/patch/siedlerboot.lha]"} Dieses Programm erlaubt das Spielen von Siedler direkt von der Amiga Plus Sonderheft 9 CD. Das geht auch ohne? Klar, aber die Spielstände können nicht gespeichert werden. Mit SiedlerBoot befindet sich nur ein kleines Programm und die Spielstände auf der Platte. Der Rest bleibt auf CD. @{MS "Execute64 [misc/emu/execute64.lha]"} Execute64 erlaubt es Programme direkt in den Speicher des C64 zu laden und zu starten. Das ermöglicht z.B den Amiga mit seiner Festplatte als riesigen Fileserver (z.B Spiele) zu benutzen. @{MS "R [util/cli/r.lha]"} "R" erzeugt für jedes Dos-Programm eine Oberfläche. Es gibt also kein kompliziertes studieren der Templates mehr! @{MS "DVBControl [comm/misc/dvbcontrol.lha]"} DVBControl ist eine Zusatzsoftware für den Nokia Mediamaster (D-Box). Im Zusammenspiel mit der DVB2000 Firmware dieses Digital-TV Dekoders ist es auf einfachste Weise möglich die Firmware zu updaten, die Senderliste zu editieren und vieles mehr! Wer also die DVB2000 und einen Amiga benutzt, kommt um DVBControl nicht herum! @{MS "MCControl [hard/hack/mccontrol.lha]"} MCControl (MemoryCard Control) ist ein Kartenleserprojekt, das speziell für die MemoryCards der Playstation entwickelt wurde. Dazu wird lediglich eine kleine Hardware (Kosten im paar Euro) und die kostenlose Software benötigt! @{MS "VBRControl [util/sys/vbrcontrol.lha]"} VBRControl verlegt die Prozessorvektoren ins Fastmem und beschleunigt dadurch das System. @{MS "AvailCPU [util/sys/availcpu.lha]"} AvailCPU ist ein Programm, das die Prozessorauslastung mittels der PowerLED anzeigt! @{MS "TrackDisplayClock [util/time/trackdisplaycl.lha]"} Hardware Track-Displays sind sehr nützlich, wenn Sie gebraucht werden. Die meiste Zeit aber macht diese Hardware nichts anderes als den Raum zu beleuchten! Das wird geändert, wenn Sie TrackDisplayClock benutzen! TrackDisplayClock zeigt die aktuelle Uhrzeit auf Ihrem TrackDisplay an. Es ist cool, es ist nützlich und natürlich ist die Zeit immer in visueller Reichweite. Löschen Sie alle Programme die die Uhrzeit in Bildschirmen, Fenstern oder gar Piktogrammen anzeigen und vergessen Sie nicht Ihr NoClick Tool wegzuwerfen! TrackDisplayClock übernimmt all diese Aufgaben und als Belohnung ist Ihr Rechner auch noch ein wenig schneller als vorher! (-8 @endnode @node "PT_Name" "Das Pattern von GuideCheck: Name" @toc "GuideCheck" @{MS "Name"} Hier geben Sie den Dateinamen des zu testenden Guidefiles an. @endnode @node "PT_NoDeepScan" "Das Pattern von GuideCheck: NoDeepScan" @toc "GuideCheck" @{MS "NoDeepScan"} Normalerweise prüft GuideCheck alle AmigaGuide-Dateien, die ihm begegnen. Wenn also ein Link auf eine Node in einer anderen Datei verweist, dann wird diese Datei ebenfalls geprüft. Diese Option schaltet dieses Verfahren ab. GuideCheck prüft nur die @{"angegebene" link "PT_Name"} Datei und fertig. Links die auf andere Dateien verweisen, werden ignoriert. @endnode @node "PT_NoOther" "Das Pattern von GuideCheck: NoOther" @toc "GuideCheck" @{MS "NoOther"} Dieser Schalter führt dazu, daß GuideCheck nur die Befehle selber prüft, aber die Nodes und Links nicht mehr gegeneinander prüft. @endnode @node "PT_NoNodes" "Das Pattern von GuideCheck: NoNodes" @toc "GuideCheck" @{MS "NoNodes"} Mit diesem Argument schalten Sie die das Prüfen von Nodes ab. Es wird also nicht mehr festgestellt, ob eine Node überhaupt angesprungen wird. @endnode @node "PT_NoLinks" "Das Pattern von GuideCheck: NoLinks" @toc "GuideCheck" @{MS "NoLinks"} Dieser Schalter deaktiviert das Prüfen von \@Links. Es wird nicht also mehr geprüft, ob ein \@Link, \@TOC, \@Next, \@Prev oder \@Index auch auf eine Node zeigt, die wirklich existiert. @endnode @node "PT_NodeNameCheck" "Das Pattern von GuideCheck: NodeNameCheck" @toc "GuideCheck" @{MS "NodeNameCheck"} Dieser Schalter aktiviert eine zusätzliche Prüfung von Node Namen. Anstatt nur die Zeichen ":" und "/" zu prüfen, werden in diesem Modus noch zusätzliche Zeichen geprüft, die man nicht benutzen sollte. @endnode @node "PT_HTDS" "Das Pattern von GuideCheck: HTDS" @toc "GuideCheck" @{MS "HTDS"} Mit diesem Schalter wird die Prüfung von HTDS Dateien aktiviert. HTDS ist ein Datentyp System, daß den AmigaGuide Befehlssatz erweitert und flexibler macht. Derzeit werden nur einige @{"Kommandos" link "Commands"} und eine gesonderte Behandlung von @{"Macros" link "CMD_LMacro"} durchgeführt. @endnode @node "PT_DEBUG" "Das Pattern von GuideCheck: DEBUG" @toc "GuideCheck" @{MS "DEBUG"} Mit diesem Schalter wird jede Datei, die von GuideCheck eingeladen wird, angezeigt. Es werden auch Dateien angezeigt, die keine Fehler enthalten. Nunja, ich brauche sowas! (-8 @endnode @node "Commands" "Alle unterstützten Kommandos" @toc "MAIN" @{MS "Alle unterstützten Kommandos"} @{code} @{b}Kommandos die eine ganze Zeile einnehmen:@{ub} \@Author \@CopyRight \@DataBase \@EndNode \@Font \@Height \@Help \@Index @{"@Macro" link "CMD_LMacro"} \@Master \@Next \@Node \@OnClose \@OnOpen \@Pref \@Remark \@SmartWrap \@Tab \@Title \@Toc \@Ver \@Width \@WordWrap @{b}HTDS Kommandos:@{ub} \@Annotation @{"@Hyperguide" link "CMD_LHyperGuide"} @{"@Include" link "CMD_LInclude"} @{b}Kommandos, die innerhalb des Textes benutzt werden:@{ub} \@{Body} \@{BPen} \@{BG} \@{B} \@{UB} \@{UU} \@{UI} \@{U} \@{I} \@{JLeft} \@{JCenter} \@{JRight} \@{LinDent} \@{Line} \@{Pard} \@{Pari} \@{Par} \@{Plain} \@{FG} \@{APen} \@{AmigaGuide} \@{SetTabs} \@{ClearTabs} \@{Code} \@{Tab} @{b}HTDS Kommandos:@{ub} \@{Font} \@{Separator} \@{Deffont} \@{HyperGuide} @endnode @node "CMD_LHyperGuide" "Das Kommando @HyperGuide" @toc "Commands" @{MS "Das Kommando \@HyperGuide"} Dieses Kommando wird zwar geprüft, wenn es vorhanden ist, aber wenn es fehlt oder am Ende steht, dann passiert derzeit nix. Ich denke das kann man verschmerzen, denn wer das nicht hinbekommt, sollte die Finger von HyperGuide-Dateien lassen. @endnode @node "CMD_LMacro" "Das Kommando @Macro" @toc "Commands" @{MS "Das Kommando \@Macro"} Das Macro Kommando ist sehr komplex. Man kann Argumente übergeben und kann, sofern man @{"HTDS" link "PT_HTDS"} benutzt, sogar Macros innerhalb von Macros aufrufen. Nehmen wir folgendes Macro: \@macro "Test" "lindent $1" GuideCheck prüft derzeit nicht, ob das angegebene Argument ($1) auch wirklich eine Zahl (\@indent erwartet immer eine Zahl) ist. Ich weis auch nicht, ob ich das jemals einbauen werde. Es wird nur die Anzahl der Argumente gezählt. Obigem Macro muß man beim Aufruf also mindestens ein Argument mitgeben: \@{test 4} Wie man sieht ist das Macro nicht sehr sinnvoll. (-8 @{b}HTDS@{ub} @{"HTDS" link "PT_HTDS"} erlaubt das Verschachteln von Macros. Da ich selber kein HTDS benutze und eigentlich nur den original AmigaGuide unterstützte, ist dieses Feature zwar drin, aber mit Einschränkungen: Ein Macro muß @{b}vor@{ub} seinem Aufruf definiert worden sein. HTDS ließt anscheinend alle Macros ein, ohne die Funktion zu prüfen. Dazu kommt, daß ich derzeit das @{"@include" link "CMD_LInclude"} Kommando nicht vollständig unterstütze. Damit sind externe Macros nicht vorhanden. Man kann sich aber helfen, imdem man diese vorne in das GuideFile hängt. @endnode @node "CMD_LInclude" "Das Kommando @Include" @toc "Commands" @{MS "Das Kommando \@Include"} Der Include Befehl gehört zum HTDS Befehlssatz und wird derzeit nicht wirklich unterstützt. Es wird nur geprüft, ob die Syntax stimmt, also ob eine Datei angegeben wurde. Ob die Datei existiert und was drinsteht ist GuideCheck derzeit egal. @endnode @node "FAQS" "Fragen, Antworten und vieles mehr!" @toc "MAIN" @{MS "Fragen, Antworten und vieles mehr!"} Zum AmigaGuide Format: @{"Meine EMail Adresse wird immer als Fehler erkannt! Wieso?" link "FAQSEMAIL"} @{"Links in andere Dateien werden als fehlerhaft erkannt! Wieso?" link "FAQSFLINK"} @endnode @node "FAQSEMAIL" "FAQ: Meine EMail Adresse wird immer als Fehler erkannt! Wieso?" @toc "FAQS" @{MS "Meine EMail Adresse wird immer als Fehler erkannt! Wieso?"} Die Sache mit der EMail Adresse is sehr einfach! Der "\@" wird von GuideCheck als Kommando interpretiert und geprüft. Generell ist es nicht erlaubt Klammeraffen einfach so zu benutzen. Je nach AmigaGuide Version verhält sich der Guide anders. Man kann einen "\@", so wie ich gerade benutzen, wenn man einen "\\" davor schreibt. Im Guide sieht das dann so "\@" aus und im Textfile selber "\\\@"! Der Backslash erlaubt also das Einbauen von Zeichen, die eine besondere Bedeutung haben. Ein Backslash selber wird durch einen zweifachen Backslash "\\\\" ausgedrückt. @endnode @node "FAQSFLINK" "FAQ: Links in andere Dateien werden als fehlerhaft erkannt! Wieso?" @toc "FAQS" @{MS "Links in andere Dateien werden als fehlerhaft erkannt! Wieso?"} Ich nehme an, das die AmigaGuide Version, die Sie benutzen, ist nicht die Version von Kickstart 3.1. Einige ältere Versionen erlauben eine Definition von Links in andere Guide-Dateien, die so nicht erlaubt sind, aber denoch funktionieren. Es is da! Es funktioniert! Es ist verboten! Es wird trotzdem benutzt. Commodore hat immer gesagt: "Alles was nicht erlaubt ist und doch funktioniert, wird später garantiert nicht mehr funktionieren." \@{"Link in eine Datei" link "Datei2/Main"} @{b}Das ist die korrekte Version. Es ist nicht erlaubt das "/Main" wegzulassen, auch wenn es auf Ihrem System funktioniert.@{ub} @endnode