home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / text / hyper / GuideTool1_0.readme < prev    next >
Text File  |  1996-01-05  |  7KB  |  144 lines
  1. Short:    AmigaGuide Convert Tool (Contents, Index, Cross References)
  2. Author:   Reinhard Katzmann (suamor@student.uni-tuebingen.de)
  3. Uploader: Reinhard Katzmann (suamor@student.uni-tuebingen.de)
  4. Type:     text/hyper
  5.  
  6. GuideTool Version 1.0
  7.  
  8. GuideTool is FREEWARE, there are no warranties of any kind. A detailed Dis-
  9. claimer and Copyright part is in the GuideTool.guide file
  10.  
  11. GuideTool is an AmigaGuide (TM) (Short: AG) Convert Tool. It is possible to
  12. create automatically tables of contents, Indexes in alphabetic order, and
  13. insertion of cross references ("link labels" in AG jargon) in an AG file.
  14.  
  15. Short introduction to the Usage:
  16. GuideTool 0.9b Copyright (C) 1995 by Reinhard Katzmann. All Rights Reserved
  17. Usage: GuideTool FROM/A,TO/A,C=CONTENTFILE/K,X=XREFFILE/K,CONTENTS/S,INDEX/S,
  18.                  XREF/S,MAKECONT/S,MAKEXREF/S,L=LABELSIZE/K/N,R=XREFSIZE/K/N,ILN=INNERLINKS/S
  19.  
  20. FROM: Source file, normaly the AG file you want to work on. Special case:
  21.       INDEX, there it is the xref (= cross reference)) file.
  22.  
  23. TO: Output file: Dependant from the switch you choose this is the contentfile,
  24.     the xreffile or the indexfile being written as AG index file or AG contents
  25.     file or being the AG file written with link labels.
  26.  
  27. remark: All created files are written in ASCII format.
  28.  
  29. C=CONTENTFILE/K: contents file for reading when you use the switvh CONTENTS
  30.  
  31. X=XREFFILE/K: xref file for reading when you use the switch XREF or INDEX
  32.  
  33. Switches: Only _ONE_ switch may be used at the same time.
  34.  
  35. CONTENTS/S: Saves the AG table of contents with the help of a contents file
  36.             (as main node)
  37.             
  38. XREF/S: Save the AG File with all link labels with the help of a xref File
  39.         and what could be found with the help of the search function 
  40.         (see also XREF-Concept)
  41.  
  42. INDEX/S: Saves an AG index file  with the help of an INDEX file.
  43.  
  44. MAKECONT/S: Creates Contents file (own ASCII format, may be edited)
  45.  
  46. MAKEXREF/S: Creates XRef file (own ASCII format, may be edited)
  47.  
  48. L=LABELSIZE/K/N: The maximum size of a link label. Defaults to 60.
  49.  
  50. R=XREFSIZE/K/N: The maximum size of a cross reference. Defaults to 40.
  51.  
  52. ILN=INNERLINKS/S: Switch which enables that links with the same name but diff-
  53.                   erent jump number are accepted (and more)
  54.  
  55. KURZ: AmigaGuide Konvertierungs Tool (Inhalt, Register, Verweise)
  56. TYP: text/hyper
  57. AUTHOR: Reinhard Katzmann (suamor@student.uni-tuebingen.de)
  58. UPLOADER: Reinhard Katzmann (suamor@student.uni-tuebingen.de)
  59.  
  60. GuideTool Version 1.0
  61.  
  62. GuideTool ist FREEWARE. Garantien dafür gibt es keine. Ausfuehrlicher 
  63. Disclaimer und Copyright Teil sind in der GuideTool.guide Datei.
  64.  
  65. GuideTool ist ein AmigaGuide (TM) (abgekuerzt AG) Konvertierungs Tool.
  66. Es ermoeglicht das automatische Erstellen von Inhaltsverzeichnissen,
  67. Registern in alphabetischer Reihenfolge und Einfügen von Crossreferenzen
  68. ("link labels" im AG Jargon) in eine AG Datei.
  69.  
  70. Kurzeinführung in die Benutzung:
  71. GuideTool 1.0 Copyright (C) 1995 by Reinhard Katzmann. All Rights Reserved
  72. Usage: GuideTool FROM/A,TO/A,C=CONTENTFILE/K,X=XREFFILE/K,CONTENTS/S,INDEX/S,
  73.                  XREF/S,MAKECONT/S,MAKEXREF/S,L=LABELSIZE/K/N,R=XREFSIZE/K/N,ILN=INNERLINKS/S
  74.  
  75. FROM: Source Datei, normalerweise die AG Datei, die man bearbeiten moechte.
  76.       Ausnahme: INDEX , da ist es die xref (= cross reference) Datei.
  77.  
  78. TO: Ausgabedatei: Je nach switch: contentfile, Xreffile, indexfile als AG Datei,
  79.                    contents als AG file und AG mit den link labels.
  80.  
  81. Anmerkung: Alle erzeugten Dateien sind im ASCII Format abgespeichert.
  82.  
  83. C=CONTENTFILE/K: contents Datei zum Einlesen beim switch CONTENTS
  84.  
  85. X=XREFFILE/K: xref Datei zum Einlesen beim switch XREF oder INDEX
  86.  
  87. Schalter: Nur _EIN_ Schalter darf angegeben werden zur gleichen Zeit.
  88.  
  89. CONTENTS/S: Speichert mit Hilfe einer contents Datei das AG Inhaltsverzeichnis ab
  90.             (als main node)
  91.  
  92. XREF/S: Speichert mit Hilfe einer xref Datei die AG Datei mit allen link labels
  93.         ab, die mit Hilfe des Such-Funktion gefunden werden konnte (s. XREF-Konzept)
  94.  
  95. INDEX/S: Speichert mit Hilfe einer xref Datei das Register als AG Datei ab.
  96.  
  97. MAKECONT/S: Erzeugt Contents file (eigenes ASCII Format, kann editiert werden)
  98.  
  99. MAKEXREF/S: Erzeugt XRef file (Eigenes ASCII Format, editierbar).
  100.  
  101. L=LABELSIZE/K/N: Die maximale Größe eines Link Labels. Defaultwert ist 60.
  102.  
  103. R=XREFSIZE/K/N: Die maximale Größe eines Querverweises. Defaultwert ist 40.
  104.  
  105. ILN=INNERLINKS/S: Schalter, der ermöglicht, daß links mit gleichem Namen aber
  106.                   unterschiedlicher Sprungnummer akzeptiert werden (u. mehr)
  107.  
  108.  
  109. ============================= Archive contents =============================
  110.  
  111. Original  Packed Ratio    Date     Time    Name
  112. -------- ------- ----- --------- --------  -------------
  113.      993     543 45.3% 02-Dec-95 21:53:00  GuideTool.info
  114.     3798    1442 62.0% 25-Nov-95 21:59:10 +Makeguide.rexx
  115.    40060   11554 71.1% 02-Dec-95 20:21:44 +GuideTool
  116.      993     541 45.5% 02-Dec-95 21:55:14 +deutsch.info
  117.     1821     741 59.3% 19-Nov-95 15:40:24 +GuideTool.CAG
  118.     1635     690 57.7% 19-Nov-95 15:38:38 +GuideTool.cont
  119.    36331   13088 63.9% 02-Dec-95 22:16:04 +GuideTool.guide
  120.     1397     625 55.2% 02-Dec-95 21:55:14 +GuideTool.guide.info
  121.    32768   12617 61.4% 02-Dec-95 22:15:38 +GuideTool.guide.orig
  122.     2232     670 69.9% 25-Nov-95 22:52:24 +GuideTool.ind
  123.     4219     810 80.8% 25-Nov-95 22:50:44 +GuideTool.xref
  124.     2315    1056 54.3% 20-Oct-95 12:34:14 +XREF-Konzept
  125.      993     543 45.3% 02-Dec-95 21:55:30 +english.info
  126.     1883     703 62.6% 19-Nov-95 15:47:38 +GuideTool.CAG
  127.     1644     658 59.9% 19-Nov-95 15:47:30 +GuideTool.cont
  128.    33687   11931 64.5% 02-Dec-95 22:16:22 +GuideTool.guide
  129.     1397     626 55.1% 02-Dec-95 21:55:30 +GuideTool.guide.info
  130.    30505   11457 62.4% 02-Dec-95 22:15:22 +GuideTool.guide.orig
  131.     2182     658 69.8% 25-Nov-95 22:48:04 +GuideTool.ind
  132.     4133     762 81.5% 25-Nov-95 22:47:08 +GuideTool.xref
  133.     2164     952 56.0% 20-Oct-95 12:57:46 +XREF-concepts
  134.     2288    1088 52.4% 02-Dec-95 20:07:36 +GuideTool.liesmich
  135.     1410     575 59.2% 02-Dec-95 21:53:00 +GuideTool.liesmich.info
  136.     2264    1033 54.3% 02-Dec-95 20:09:32 +GuideTool.readme
  137.     1410     577 59.0% 02-Dec-95 21:53:00 +GuideTool.readme.info
  138.    29949    7804 73.9% 21-Nov-95 20:22:14 +GuideTool.c
  139.      405     220 45.6% 02-Dec-95 20:20:34 +GuideTool_rev.h
  140.      128      97 24.2% 15-Oct-95 14:19:38 +README.src
  141.      499     309 38.0% 02-Dec-95 22:01:48 +SMakefile
  142. -------- ------- ----- --------- --------
  143.   245503   84370 65.6% 03-Dec-95 10:40:56   29 files
  144.