ReadRefs Version 1.1 (C) 1992 von H.P.G FreeWare Index: Index Allgemeine Beschreibung Rechtliches System Vorraussetzungen Benutzung Technisches Adresse Liste der Dateien Allgemeine Beschreinbung: ========================= ReadRefs is ein Support Programm daß einen Begriff in einer dme.refs (oder autodoc) Referenz-Datei sucht. Findet ReadRefs den angegebenen Begriff indieser Refs-Datei, kopiert es die Referenz zu der Datei 't:Refs.dat'. Diese datei kann dann einfach mit einen Texteditor geladen und benutzt werden, der normalerweise keine Refs unterstützt. Ich habe einen relativ schnellen Suchalgorythmus benutzt, der sogar noch ein bißchen schneller arbeitet, als der des DME. Benutzt man ReadRefs aber mittels REXX or Batch-Dateien, ist die Geschindigkeit der Suche sowieso nicht das größte Problem. I habe diese Programm geschrieben. um es mit dem TurboText Programm zu benutzen, daß bis jetzt noch keine Refs Funktion unterstützt. Bevor ich TTX benutzt habe, schrieb ich mit DMe (Dillons berühmter Makro Editor). TTX is ein bißchen mehr professionell, aber da ich nicht auf eine Refs- Funktion verzichetn wollte, war dieses Programm nötig. Für alle anderen, die auch TTX benutzen habe ein TTX-script beigelegt. Am einfachsten kann man ReadRefs mittels eine Shell Aliases benutzen und die gefundene Referenz im Cli-Fenster ausgeben. Z.B.: (angenommen es befindet sich eine Refs-Datei im C:-Verzeichnis mit dem Namen MyRefs und es wird die CShell benutzt) `alias Refs "%s ReadRefs c:MyRefs $s ; if -f t:Refs.dat ; cat t:Refs.dat;endif"' Benutzt man immernoch die Standart-Shell, ist es das Beste, eine Batch- Datei zu schreiben. Z.B. ---------------------- Start der Datei .key Wort ReadRefs c:MyRefs if Exists t:Refs.dat type t:Refs.dat else echo "Keine Referenz für gefunden" endif --------------------- Ende der Datei Angenommen diese Datei heißt `s:Refs', kann man im Cli einfach 'Refs NewWindow' eingeben. Gibt es in der Reference-Datei einen Eintrag zu NewWindow, wird dieser ins Cli-Fenster ausgegeben. Rechtliches: ============ Ich habe mich entschlossen dieses Programm und alle beigefügten Dateien und Scripts, sowie aller Anleitungen, als FREEWARE zu deklarieren. D.h.: Jeder kann ReadRefs benutzen. Jeder darf ReadRefs weitergeben, wenn: 1. Alle unten aufgeführten Programme mit weitergegeben werden, 2. Keinerlei Veränderungen der unten aufgeführten Pro- grammen (am Ende der Anleitung) vorgenommen wurden, 3. Bei Nachkompilierungen der QuellCodes muß ein Hin- weis auf den Orginalprogrammierer beigefügt sein, bei Herausgabe dieser, muß eine Kopie an mich gesandt werden. 4. ReadRefs darf nicht verkauft werden. Außnahme: Es darf eine geringe Kopiergebühr er- hoben werden, die aber 5 DM bzw. den entsprechenden Gegenwert in anderen Währungen nicht übersteigt. 5. ReadRefs darf nur als Teil eines kommerziellen Produktes herrausgegeben werden, mit ausdrücklicher schrift- licher Genehmigung des Autors (Adresse siehe unten). Zuwiderhandlungen der oben Aufgeführten Konditionen werden Zivilrechtlich verfolgt. Ferner wird für die Funktion des Programmes ,sowie möglicher Folgen der Benutzung des Programmes sowie der u. a. Dateien, keinerlei Gewährleistung übernommen. !!! Alle Risiken trägt der Benutzer allein !!! System Vorraussetzungen: ======================== ReadRefs ist ein OS 2.xx only Tool. Es nimmt die Vorteile einiger neuer OS 2.xx Features wahr und ist deshalb unter älteren Kickstart Versionen leider nich lauffähig. (sorry). Auch Kickstart Version 36 könnte Probleme haben. Benutzung: ========= Die Syntax von ReadRefs ist sehr einfach. Sytax: ReadRefs HilfsDatei/A Begriff/A mit HilfsDatei : Dies ist die Refs Datei z.B. dme.refs etc. in welcher ReadRefs suchen soll Begriff   : Dies ist der Begriff, nachdem ReadRefs suchen soll Eine Bemerkung zu der Refs-Datei. Wenn jemand die Features von Refs-Dateien benutzen möchte, aber keine Ahnung hat, worum es sich überhaupt handelt, so sollte er nach älteren Dme-Veröffentlichungen suchen, die auf verschiedenen Fish- oder anderen PD-Serien erschienen sind. Zum generieren der Refs-Dateien kann man autorefs benutzen. AutoRefs ist ebenfalls Teil der DMe Veröffentlichungen, die copyrighted sind bei Matt Dilon. AutoRefs benutzt zwei verschiedene Dateinformate für seine Refs-Dateien. Eine für Dokumentationen und eine for C_Header Dateien. ReadRefs versteht beide. Wird autorefs korrekt gestartet, sollte nicht schiefgehen. Wenn ReadRefs gestartet wird kann man die resultierende Datei, `t:Refs.dat`, mit der Datei, die von DMe erzeugt wird vergleichen und man findet keinerlei Unterschiede. I habe außerdem noch zwei Rexx-Dateien im Rexx-Verzeichnis auf dieser Disk beigelegt. Die Erste ist von TTX aus zu benutzen. Diese Datei heißt 'TX_Refs.ttx'. Die zweite Datei ist ein allgemeines Beispiel einer Rexx- Datei. Dieses Script kann mittels `RX` gestartet werden. Die zweite Datei heißt 'RX_Refs.rexx'. Ich habe auch zwei weitere Dateien beigefügt, die sich im Batch-Ver- zeichnis auf dieser Diskette befinden. Die erste dieser Dateien heißt `DOSRefs.bat' und ist mit der StandartAmigaShell zu benutzen. Die zweite Datei heißt CSHRefs.sh und ist mit der CSH Shell zu benutzen. (Csh ist copyrighted von U. Dominik Mueller. (Danke Dominik für die beste Shell in der AMIGA Welt). Wenn man eine andere Shell benutzt, sollte es nicht allzu schwierig sein, dieses Script in die Sprache der Shell umzu- setzen. Ich habe dieses Programm herausgegeben, um mehr Programmierern den Ge- brauch von Refs-Dateien zu ermöglichen. Dadurch kann man hunderte (millionen ....) Seiten Beschreibungen ersetzen. Technisches: ============ ReadRefs ist mit dem the Manx Aztec C Compiler V5.2 geschrieben worden. ReadRefs benutzt einen schnellen Suchalgorythmus, der Groß- und Klein- schreibung unterscheidet, d.h. Newwindow ist nicht gleich NewWindow. Deshabl brauchte ich nicht so etwas seltsames wie strnicmp etc. Routinen in das Programm einuzubauen, daß machmal langsamen, aber immer großen Code hervorbringt. Zuerst vergleicht ReadRefs nur den ersten Buchstaben des übergebenen Begriffs mit dem Inhalt der Refs-Datei. Wird dieser Begriff gefunden, wird erst jetzt zu einer Unterroutine gesprungen. So geht das Filtern relativ schnell. Ich möchte aber trotzdem empfehlen, ReadRefs auf einen Harddisk-System zu bentzen. Ich habe außerdem noch folgende Programme benutzt: AutoRefs,Dme : (C) by Matt Dillon ARexx : (C) by Chris Hames TurboText : (C) by Oxxi Directory Opus : (C) by Jonathan Potter Adresse: ======== Hans-Peter Günther Grüner Weg 5 D-3501 Fuldatal 2 Liste der Dateien: ================== Alle diese Dateien sollten in dieser Veröffentlichung enthalten sein. Fehlt eine der aufgeführten Dateien,ist diese Veröffentlichung nicht komplett. Ich möchte bitten, mich dieses wissen zu lassen. ReadRefs : Das Programm ReadRefs.info ReadRefs.doc : Die englische Dokumentation ReadRefs.doc.info ReadRefs.dok : Dhe deutsche Dokumentation ReadRefs.dok.info Rexx/TTX_Refs.ttx : Script-Datei zum Benutzen mit TTX Rexx/TTX_Refs.ttx.info Rexx/RX_Refs.rexx : AREXX-Script Rexx/RX_Refs.rexx.info Rexx.info Batch/DOSRefs.bat : Eine Batch-Datei für die standart AmigaDOS- Shell Batch/DOSRefs.bat.info Batch/CSHRefs.sh : Eine Batch-Datei für die Csh-Shell. Batch/CSHRefs.sh.info Batch.info