@DATABASE "RDAG2HTML.guide"
@NODE "Main" "Rexx Does AmigaGuide® 2 HTML"
@TOC "MAIN"

	RDAG2HTML 2.1b - Rexx Does AmigaGuide® To HTML

	RDAG2HTML ist ein aus der Not gewachsenes ARexx Programm,
	daß in der Lage ist AmigaGuide® Dokumente in HTML zu
	konvertieren.

	© 1995, 1996 - Michael Ranner

	@{"Rechtliches" LINK "Legal"}
	@{"Funktionalität" LINK "Features"}
	@{"Installation" LINK "Install"}
	@{"Benutzung" LINK "Usage"}
	@{"Änderungen, Geschichte" LINK "History"}
	@{"Autor, Support" LINK "Author"}
	@{"Bugreports und Vorschläge" LINK "Bugs"}

@ENDNODE

@NODE "Legal" "Rechtliches"
@TOC "MAIN"

	RDAG2HTML ist Public Domain.

	RDAG2HTML darf in NICHT KOMMERZIELLE Software Sammlungen inkludiert
	werden.

	RDAG2HTML darf NICHT ohne die Erlaubnis des @{"Autors" LINK "Author"}
	bei kommerzieller Software inkludiert werden.

	DER AUTOR GEWÄHRT KEINERLEI ARTEN VON GARANTIEN IN HINSICHT AUF DIESE
	SOFTWARE. IN KEINEM FALL DARF DER AUTOR HAFTBAR GEMACHT WERDEN, FÜR
	IRGENDWELCHE SCHÄDEN, VERLUST VON DATEN ODER PROFIT, WELCHE DIREKT ODER
	INDIREKT DURCH DIE BENUTZUNG DIESER SOFTWARE ENTSTANDEN SIND.

@ENDNODE

@NODE "Features" "Features"
@TOC "MAIN"

	@{b}Features von RDAG2HTML@{ub}


	° HTML 3.2 Funktionalitäten wie Hintergrundbilder, Hintergrundfarbe, Text-
	  und Linkfarbe.

	° @{"Embedded HTML" LINK "EmbeddedHTML"} in AmigaGuide® Dokumenten

	° Konvertiert AmigaGuide® in ein einzelnes HTML Dokument oder in mehrere
	  Dokumente.

	° AmigaGuide® Buttons, [Contents], [Index], [Help] und [Browse], am Kopf
	  des HTML Dokuments.

	° Benutzerdefnierte Kopf- oder Fußzeilen.

	° Unterstützt AmigaGuide® Dokumente die mit Heddley erstellt wurden
	  (Zeilennummer 0 im Link).

	° Nodenamen länger als 25 Zeichen werden gekürzt um die 30 Zeichen Beschränkung
	  des AmigaDOS zu berücksichtigen.

	° Unterstützt MS-DOS FAT 8.3 Filenamen Beschränkung


	Die folgenden Zeichenfolgen werden ersetzt:

		\\\\	durch \\

		\@	durch &#64;

		<	durch &lt;
	
		>	durch &gt;

		&	durch &amp;


	RDAG2HTML unterstützt die folgenden AmigaGuide® Tags und Attribute:

	   TAGS in alphabetischer Reihenfolge:

		\@ENDNODE	das Ende einer AmigaGuide® Node

		\@HELP		als Link zur Helpnode

		\@INDEX		als Link zum Index

		\@NEXT		als Link zur folgenden Node

		\@NODE		der Beginn einer AmigaGuide® Node

	 	\@PREV		als Link zur vorhergehenden Node

		\@TOC		als Link zur Mainnode

		\@{"Text" LINK "Node"}	als Textlink

		\@{"Text" LINK "Node" 0}	als Textlink; Die Zeilennummer wird im
					Moment ignoriert!

	   Attribute in alphabetischer Reihenfolge:

		\@{AMIGAGUIDE}	als <B>AmigaGuide</B>&reg;

		\@{B}	als <B>

		\@{I}	als <I>

		\@{U}	als <U>

		\@{UB}	als </B>

		\@{UI}	als </I>

		\@{UU}	als </U>

@ENDNODE

@NODE "Install" "Installation"
@TOC "MAIN"

	@{b}Installation@{ub}


	copy rdag2html.rexx to Rexx:


	@{b}Erfordernisse@{ub}


	ARexx installiert und gestartet!

	Die originalen AmigaDOS 'Search' und 'Delete' Befehle
	installiert im Verzeichnis 'C:'

@ENDNODE

@NODE "Usage" "Usage"
@TOC "MAIN"

	@{b}Benutzung von RDAG2HTML?@{ub}


	rx rdag2html your.guide

		Konvertiert your.guide in mehrere Dateien (jede Node ergibt eine Datei).


	rx rdag2html your.guide DEST destdir

		Konvertiert your.guide und benutzt destdir als Zielverzeichnis.


	rx rdag2html your.guide DEST your.html SINGLEFILE

		Konvertiert your.guide in ein einzelnes HTML Dokument.


	rx rdag2html ?

		Gibt die Schablone der Argumente aus: Source/A,Dest/K,SingleFile/S, ...


	@{"Liste aller Shellargumente" LINK "Arguments"}

	@{"Embedded HTML" LINK "EmbeddedHTML"}

@ENDNODE

@NODE "Arguments" "Arguments"

	@{b}Allgemeine Argumente@{ub}


	@{b}Source/A@{ub}

		Quelldatei im AmigaGuide® Format.


	@{b}Dest/K@{ub}

		Zielpfad für die HTML Dokumente.

		Zusammen mit @{i}SingleFile/S@{ui} bestimmt @{i}Dest/K@{ui}
		den Filenamen der Zieldatei. Ohne dieses Argument wird das
		HTML Dokument als 'out.html' benannt.


	@{b}SingleFile/S@{ub}

		RDAG2HTML konvertiert ein AmigaGuide® Dokument in ein einzelnes
		HTML Dokument.


	@{b}ArgFile/K@{ub}

		RDAG2HTML benutzt die angegebene Argumentdatei.


	@{b}Images und Buttons@{ub}


	@{b}Icons/S@{ub}

		RDAG2HTML benutzt Bilder anstatt des Text für die [Contents],
		[Index], [Help] und [Browse] Buttons. Das HTML Document benötigt
		diese Bilder im Verzeichnis 'images/'.

		Suche in 'HTML/images/' für die Standardbilder!

		Standardfilenamen der Bilddateien:

		Filenamen der @{b}eingeschalteten@{ub} AmigaGuide® Buttons:

		[Contents] ...... 'images/content.gif'
		[Index] ......... 'images/index.gif'
		[Help] .......... 'images/help.gif'
		[Browse <] ...... 'images/prev.gif'
		[Browse >] ...... 'images/next.gif'

		Filenamen der @{b}ausgeschalteten@{ub} AmigaGuide® Buttons:

		[Contents] ...... 'images/dcontent.gif'
		[Index] ......... 'images/dindex.gif'
		[Help] .......... 'images/dhelp.gif'
		[Browse <] ...... 'images/dprev.gif'
		[Browse >] ...... 'images/dnext.gif'


	@{b}TOCIcon/K@{ub}

		Name oder URL der Bilddatei für den [Contents] Button.

		Bsp.

		rx rdag2html your.guide Icons TOCIcon "images/tocicon.jpg"
		rx rdag2html your.guide Icons TOCIcon "http://www.super.org/images/toc.jpg"

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}TOCIconDisabled/K@{ub}

		Name oder URL der Bilddatei für den deaktivierten
		[Contents] Button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}TOCText/K@{ub}

		Text für den [Contents] Button.

		Dieser Text wird auch für den Alternativtext des
		Buttonbildes benutzt. <IMG ... ALT='alternate'>


	@{b}IndexIcon/K@{ub}

		Name oder URL der Bilddatei für den [Index] button.
		
		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}IndexIconDisabled@{ub}

		Name oder URL der Bilddatei für den deaktivierten
		[Index] button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}IndexText/K@{ub}

		Text für den [Index] Button.

		Default: '[Index]'

		Dieser Text wird auch für den Alternativtext des
		Buttonbildes benutzt. <IMG ... ALT='alternate'>


	@{b}HelpIcon/K@{ub}

		Name oder URL der Bilddatei für den [Help] Button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}HelpIconDisabled/K@{ub}

		Name oder URL der Bilddatei für den deaktivierten
		[Help] Button. 

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}HelpText/K@{ub}

		Text für den [Help] Button.

		Dieser Text wird auch für den Alternativtext des
		Buttonbildes benutzt. <IMG ... ALT='alternate'>


	@{b}PrevIcon/K@{ub}

		Name oder URL der Bilddatei für den [Browse <] button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}PrevIconDisabled/K@{ub}

		Name oder URL der Bilddatei für den deaktivierten
		[Browse <] button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}PrevText/K@{ub}

		Text für den [Browse <] Button.

		Dieser Text wird auch für den Alternativtext des
		Buttonbildes benutzt. <IMG ... ALT='alternate'>


	@{b}NextIcon/K@{ub}

		Name oder URL der Bilddatei für den [Browse >] button.

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}NextIconDisabled/K@{ub}

		Name oder URL der Bilddatei für den deaktivierten
		[Browse >] button.  

		Dieses Argument benötigt @{i}Icons/S@{ui}!


	@{b}NextText/K@{ub}

		Text für den [Browse >] Button.

		Dieser Text wird auch für den Alternativtext des
		Buttonbildes benutzt. <IMG ... ALT='alternate'>


	@{b}HideDisabledLinks/K@{ub}

		Die deaktivierten AmigaGuide® Buttons werden nicht am Kopf des
		HTML Dokumentes erscheinen.


	@{b}TOC/K@{ub}

		URL für ein Inhalt-Dokument

		Dieses Argument übersteuert das AmigaGuide® Tag @TOC der
		MAIN-Node. Alle anderen Nodes werden nicht davon beeinflußt.


	@{b}Index/K@{ub}

		URL für ein Index-Dokument

		Dieses Argument übersteuert das AmigaGuide® Tag @INDEX.


	@{b}Help/K@{ub}

		URL für ein Hilfe-Dokument

		Dieses Argument übersteuert das AmigaGuide® Tag @HELP.


	@{b}Hintergrund, Text- und Linkfarbe und Style@{ub}


	@{b}Background/K@{ub}

		Name oder URL für das Hintergrundbild.

		Bsp.

		rx rdag2html source.guide Background Background "img/bg.jpg"
		rx rdag2html source.guide Background Background "http://www.highlife.org/images/bground.gif"


	@{b}BGColor/K@{ub}

		Farbwert für den Hintergrund

		Der Farbwert wird mit voranstehendem '#' in folgendem Format
		angegeben:

		Format: #rrggbb

		r ... red
		g ... green
		b ... blue

		Bsp. rx rdag2html source.guide BGColor #ff9933


	@{b}TextColor/K@{ub}

		Farbwert für den Text


	@{b}LinkColor/K@{ub}

		Farbwert für die Links


	@{b}ALinkColor/K@{ub}

		Farbwert für den gerade aktiven Link
	

	@{b}VLinkColor/K@{ub}

		Farbwert für besuchte Links


	@{b}FontSize/K@{ub}

		Schriftgröße für den Text des AmigaGuide® Dokuments.
		Gültiger Wertebereich ist von 1 bis 7. Man kann auch
		relative Werte z.B. -1 oder +2 angeben.
		Werte außerhalb des gültigen Bereiches werden vom HTML
		Browser ignoriert.


	@{b}NoHR/S@{ub}

		Es werden keine <HR> Tags für die horizontalen Trennlinien
		eingefügt.


	@{b}Kopf- and Fußzeilen@{ub}


	@{b}Header/K@{ub}

		Inkludiert eine Datei als Kopfzeilen in das HTML Dokument.


	@{b}Footer/K@{ub}

		Inkludiert eine Datei als Fußzeilen in das HTML Dokument.


	@{b}Nodenamen und Filenamen@{ub}


	@{b}NoLowerCase/S@{ub}

		Deaktiviert die Konvertierung der Nodenamen in Kleinschrift.


	@{b}8Point3/S@{ub}

		Kürzt die Nodenamen für MS-DOS FAT Filesystem.


	@{b}Suffix/K@{ub}

		Erweiterung die am Ende des Filenamen statt
		'.html' angehängt werden soll. Der Punkt ist
		unbedingt erforderlich.

		Bsp. rx rdag2html your.guide Suffix .shtml

		@{i}8Point3/S@{ui} übersteuert die angegebene
		Erweiterung!


	@{b}NoStrip/S@{ub}

		Deaktiviert die Kürzung der Nodenamen. Nodenamen
		werden ansonsten automatisch auf 25 Zeichen für
		das AmigaDOS Filesystem gekürzt.
		
		Übersteuert @{I}8Point3@{UI}!


	@{b}Namen der Variablen für die Argumente-Datei@{ub}


		Folgende Variablen können gesetzt werden:

		Type		Name				Kommentar

		Boolean	argArray.SingleFile
		String	argArray.TOC
		String	argArray.Index
		String	argArray.Help
		Boolean	argArray.Icons
		String	argArray.TOCIcon
		String	argArray.TOCIconDisabled
		String	argArray.TOCText
		String	argArray.IndexIcon
		String	argArray.IndexIconDisabled
		String	argArray.IndexText
		String	argArray.HelpIcon
		String	argArray.HelpIconDisabled
		String	argArray.HelpText
		String	argArray.PrevIcon
		String	argArray.PrevIconDisabled
		String	argArray.PrevText
		String	argArray.NextIcon
		String	argArray.NextIconDisabled
		String	argArray.NextText
		Boolean	argArray.HideDisabledLinks
		String	argArray.Background
		String	argArray.BGColor
		String	argArray.TextColor
		String	argArray.LinkColor
		String	argArray.ALinkColor
		String	argArray.VLinkColor
		String	argArray.FontSize
		Boolean	argArray.NoHR
		String	argArray.Header			Name der Headerdatei
		String	argArray.Footer			Name der Footerdatei
		Boolean	argArray.NoLowerCase
		Boolean	argArray.8Point3
		String	argArray.Suffix
		Boolean	argArray.NoStrip
		Boolean	argArray.NoInternational

		Interne Variablen:

		String	footer				Text für die Fußzeilen
		String	header				Text für die Kopfzeilen

		In der Argumente-Datei gilt ARexx-Syntax die zeilenweise
		interpretiert wird!

		Siehe auch das @{"Beispiel" LINK "ArgFile/MAIN"}


		@{B}Wichtig!!!@{UB}

		Manche Argumente der Datei können andere übersteuern:

		° @{i}argArray.Header@{ui} übersteuert @{i}header@{ui}!

		° @{i]argArray.Footer@{ui} übersteuert @{i}footer@{ui}!

		° @{i}argArray.8point3@{ui} übersteuert @{i}argArray.Suffix@{ui}!

		Weiters haben die Argumente in der Datei Vorrang gegenüber
		den Shellargumenten!

@ENDNODE

@NODE "EmbeddedHTML" "Embedded HTML"

	@{b}Embedded HTML in AmigaGuide®@{ub}


	Diese Funktion ist im Moment eher experimentell, da sie in
	AmigaGuide® keinen Nutzen hat.

	Embedded HTML Tags werden automatisch erkannt, wenn man sie in
	Form von AmigaGuide® Attributen \@{!<HTML-TAG>} angibt. Diese
	Attribute werden von AmigaGuide® oder Multiview ignoriert.
	RDAG2HTML erkennt sie aber und baut sie an der entsprechenden
	Stelle im HTML Dokument ein. Siehe auch den Source dieser Node
	und der Node "Author" in diesem AmigaGuide® File.

	Das Ergebnis der folgenden Beispiele sieht man nur im entsprechenden
	@{"HTML Dokument" LINK HTML/embeddedhtml.html/main}!

	Bsp:

	\@{!<A HREF="mailto:rmike@sbox.tu-graz.ac.at">}rmike@sbox.tu-graz.ac.at\@{!</A>}

	ergibt

	@{!<A HREF="mailto:rmike@sbox.tu-graz.ac.at">}rmike@sbox.tu-graz.ac.at@{!</A>}

	\@{!<A HREF="main.html"><IMG SRC="images/content.gif"></A>}

	ergibt

	@{!<A HREF="main.html"><IMG SRC="images/content.gif"></A>}

@ENDNODE

@NODE "History" "History"
@TOC "MAIN"

	@{b}RDAG2HTML Geschichte@{ub}

	Version 2.1b	Bugfixes: Leerzeichen am Beginn und Ende der Titel
			werden nun entfernt. Fehler der SingleFile/S Option,
			wenn Leerzeile zwischen Anfang des Dokuments und dem
			Beginn einer Node, behoben.

	Version 2.1a	Änderungen an Version 2.1 um RDAG2HTML leicht für
			Rexx-IMC auf UNIX Plattformen zu portieren.

	Version 2.1	Neue Funktionen: FontSize/K, NoHR/S, Suffix/K als
			Shellargument. Titel für Nodes im SingleFile Modus.

			Änderungen: Unterstützung von \@{"Text" LINK "Node" 0}
			Links. Dies ist vor allem für AmigaGuide® Dokumente von
			bedeutung die mit Hilfe von Heddley erstellt wurden.

			Bugfixes: MyReadArgs funktionierte in 2.0a nicht korrekt
			wenn man '?' benutzte. Eine falsche Leerzeile zwischen
			Buttons und Node wird nun nicht mehr eingefügt. Korrektur
			bei TOC-, Index- und Help-Links.

	Version 2.0a	Basiert auf Version 2.0 mit Modifikationen von
			Magnus Holmgren und einigen Modifikationen und Bugfixes
			vom Autor. Deutsches AmigaGuide® inkludiert.
			Die Shellargumente wurden überarbeitet. TOC/K beeinflußt
			nur die MAIN-Node.

	Version 2.0	AmigaGuide® Buttons am Kopf des HTML Dokuments.
			Unterstützt HTML Tags eingebettet im AmigaGuide®
			Dokument. Die deaktivierten Buttons werden nun
			auch angezeigt.

	Version 1.92	Bugfixes für die Homepage. Fehlermeldungen für
			den Benutzer

	Version 1.91	Bugfixes für Aminet

	Version 1.9	Added Arguments for button images and button text.

	Version 1.8	Support of BGCOLOR, TEXT, LINK and COLOR keywords
			for the BODY tag. Added some needful arguments and
			features. RDAG2HTML is now more configurable then ever.

	Version 1.7	Added the new ReadArgs() function. Some further
			changes were necessary to keep things running. This
			was only a step forward to version 1.8 and its new
			feature.

	Version 1.6	Support of underlined text. Fixed nextNode; [Next]
			- link didn't work since version 1.5. \\\\ will be
			converted to \\. Use of unique ID for the temporary
			file. Now it should possible to run more than one
			RDAG2HTML at the same time. Bugfix in replaceString

	Version 1.5	8Point3/S forces strip down to M$-DOS file names.
			An ArgFile can be defined for RDAG2HTML to override
			some internal variables.

	Version 1.4	Node names will be always converted to lowercase,
			to prevent problems on case sensitive file systems.
			Some other minor fixes.

	Version 1.32	Cause of reported problems with case sensitive file
			systems changed the argument processing from "ARG"
			to "PARSE ARG". Footer and comment: It should be
			"Converted on ..." instead of "Converted at ...".
			Now next the footer a custom header is possible.
			The footer and header environment variables may
			contain more than one line.

	Version 1.31	Now all node names longer than 25 characters will
			be stripped down. Further cosmetic changes.

	Version 1.3	[Next] and [Previous] links will be always displayed,
			also if there are no @PREV or @NEXT commands in the
			current node. Added </HEAD> and </HTML>.

	Version 1.2	@TOC command will be recognized. Optional use of
			background images. \@{AMIGAGUIDE} to @{AmigaGuide}.
			The standard footline can be replaced with your own.
			Replacement of \@ with &#64; Node names up to 49
			charcaters are now possible.

	Version 1.1	@INDEX and @HELP token will be recognized.
			Replacement of german 'Umlaute' and sharp 's' in
			filenames because of a bug report. Seems to be a
			problem with non international file systems, but
			I have to investigate this more accurate. Use of
			icons for 'Previous', 'Next', etc.

	Version 1.0	Initial release

@ENDNODE

@NODE "Author" "Author"
@TOC "MAIN"

	@{b}Der Autor von RDAG2HTML@{ub}


	RDAG2HTML Copyright (C) 1995, 1996 by Michael Ranner

	Michael Ranner
	Maiffredygasse 12a
	A-8010 GRAZ
	AUSTRIA

	E-Mail:

	@{!<A HREF="mailto:rmike@sbox.tu-graz.ac.at">}rmike@sbox.tu-graz.ac.at@{!</A>}

	Homepage:

	@{!<A HREF="http://www.sbox.tu-graz.ac.at/home/rmike/">}http://www.sbox.tu-graz.ac.at/home/rmike/@{!</A>}


	RDAG2HTML Support:

	@{!<A HREF="http://www.sbox.tu-graz.ac.at/home/rmike/projects/rdag2html.html">}http://www.sbox.tu-graz.ac.at/home/rmike/projects/rdag2html.html@{!</A>}


	Bugreports, Vorschläge:

	Bugreports, Vorschläge sollen an die oben angegeben Adressen
	geschickt werden.

@ENDNODE

@NODE "Bugs" "Bugs"
@TOC "MAIN"

	@{b}Bekannte Fehler und Einschränkungen@{ub}


	° Manche Zeichen werden auch in den Nodenamen durch
	  ihren &xxx; Ersatz ersetzt. Das hat aber keinen
	  Einfluß auf die Funktion.

	° Es gibt ein Problem mit Links die im AmigaGuide®
	  Dokument die Zeilenenden kreuzen. Multiview hat
	  dieses Problem teilweise auch!

	Falls noch weitere nicht geplante Features bzw. Bugs
	entdeckt werden, dann bitte ich um eine Nachricht an
	den @{"Autor" LINK "Author"}.

@ENDNODE
