@DATABASE "RDAG2HTML.guide"
@NODE "Main" "Rexx Does AmigaGuideŽ 2 HTML"
@TOC "MAIN"
@NEXT "Intro"
@{b}RDAG2HTML - Rexx Does AmigaGuideŽ 2 HTML 1.4@{ub}
RDAG2HTML is Public Domain.
You may use it, modify it and distribute it all over the world!
RDAG2HTML may not be included in commercial software without my permission!
For 'Quick Starter' see @{"Installation, Requirements" LINK "Install"} and @{"Usage" LINK "Usage"}!
@{"Introduction" LINK "Intro"} What is RDAG2HTML?
@{"Features" LINK "Features"} The Features of RDAG2HTML
@{"Author" LINK "Author"} Who is the author of RDAG2HTML
@{"Installation" LINK "Install"} Installation and Requirements
@{"Usage" LINK "Usage"} How to use RDAG2HTML
@{"History" LINK "History"} History about RDAG2HTML
@{"Bugs" LINK "Bugs"} What's about bug reports, known bugs.
@{"Suggestions" LINK "Author"} Suggestions for RDAG2HTML
@{"Future" LINK "Future"} What will bring us the future?
@{"Disclaimer" LINK "Disclaimer"} A must be!
The latest version of RDAG2HTML is always available on:
@{b}http://www.sbox.tu-graz.ac.at/home/rmike/projects.html@{ub}.
There could be also beta releases not available on Aminet.
@ENDNODE
@NODE "Intro" "Introduction"
@TOC "MAIN"
@PREV "MAIN"
@NEXT "Features"
RDAG2HTML is a AmigaGuideŽ to HTML2 converter written in ARexx.
RDAG2HTML converts a AmigaGuideŽ file in a single or in several
HTML documents. Some of the new V39 AmigaGuideŽ features like
@{i}italic@{ui} and @{b}bold@{ub} text are supported. RDAG2HTML provides
the [Next] and [Previous] links similar to AmigaGuideŽ or MultiView.
It's also possible to replace the simple [Main], [Index], [Help],
[Previous] and [Next] text with inlined GIF's. You can use a background
image for the HTML document to let it look better. Because of a reported
problem with IBrowseŽ, german 'Umlaute' can be replaced with ae, oe, ue.
@ENDNODE
@NODE "Features" "Features"
@TOC "MAIN"
@PREV "Intro"
@NEXT "Author"
@{b}Features of RDAG2HTML@{ub}
* RDAG2HTML allows the use of a backgound image for the body.
* RDAG2HTML can convert an AmigaGuideŽ file to a single HTML document.
* Use of optional inline images for [Main], [Next], [Previous] etc. links.
* [Next] and/or [Previous] will be always added, also if there is no
@NEXT or @PREV command. in the current node.
* Node names larger than 25 charcaters will be stripped down to fit the
30 character limitation of AmigaDOS file system.
* A custom header can be added to the HTML document.
* Also a custom footer can replace the standard foot line.
* The following characters will be replaced:
\\@ with @
< with <
> with >
& with &
* RDAG2HTML supports the following AmigaGuideŽ commands and attributes
Commands in alphabetical order:
@ENDNODE the end of a AmigaGuideŽ node
@HELP as link to the help file of the guide document
@INDEX as link to the index of the guide document
@NEXT as link to the next node
@NODE the begin of a AmigaGuideŽ node
@PREV as link to the previous node
@TOC as link to the table of contents, default to the MAIN node
\@{"Name" LINK "Node"} as text link
Attributes in alphabetical order:
\@{AMIGAGUIDE} as AmigaGuide®
\@{B} as
\@{I} as
\@{UB} as
\@{UI} as
@ENDNODE
@NODE "Author" "Author"
@TOC "MAIN"
@PREV "Features"
@NEXT "Install"
@{b}The Author of RDAG2HTML@{ub}
RDAG2HTML was written 1996 by Michael Ranner
Michael Ranner
Maiffredygasse 12a
A-8010 GRAZ
AUSTRIA
E-Mail: mranner@focus.co.at
rmike@sbox.tu-graz.ac.at
Homepage: http://www.sbox.tu-graz.ac.at/home/rmike
@{b}Bugreports or suggestions should be mailed or e-mailed to the adresses above!@{ub}
@ENDNODE
@NODE "Install" "Installation"
@TOC "MAIN"
@PREV "Author"
@NEXT "Usage"
@{b}Installation and Requirements for RDAG2HTML@{ub}
RDAG2HTML is simple to install:
copy RDAG2HTML to Rexx:
Please consider, that you have to run ARexx! If you have some problems
with it, refer to your Amiga manuals.
You will also need the original AmigaDOS 'Search' and 'Delete' command
installed in the 'C:' drawer!
@{"Quick Starter, How to use" LINK "Usage"}
@ENDNODE
@NODE "Usage" "Usage"
@TOC "MAIN"
@PREV "Install"
@NEXT "History"
@{b}How can I use RDAG2HTML?@{ub}
Change in the directory, where you want the HTML documents.
rx RDAG2HTML your.guide
converts your guide in several files (each node, one file)
rx RDAG2HTML your.guide your.html SINGLEFILE
converts your guide in one single file
rx RDAG2HTML ?
prints the argument template Source/A Dest/A SingleFile/S ...
@{b}RDAG2HTML Arguments@{ub}
Source/A Source file in AmigaGuideŽ format. Must be the first argument!
Dest/A Destination file, only necessary for the SINGLEFILE option!
Must be the second argument!
SingleFile/S Converts the AmigaGuideŽ file in a single HTML document.
Icons/S Use Icons instead of [Main], [Previous], [Next], etc.
The image files must be named as 'main.gif', 'index.gif',
'help.gif', 'prev.gif' and 'next.gif'. The images must be
located in a drawer named 'images'.
Background/S Allows the use of a background image. This file must be
named as 'bground.gif'. The image must be located in a
drawer named 'images'.
Header/S Add a custom header to the HTML document. An environment variable
called 'ENV:RDAG2HTML/Header' is needed, simple to make with
the AmigaDOS command 'SetENV RDAG2HTML/Header your text'.
Footer/S Replace the standard foot line with your own. An environment
variable 'ENV:RDAG2HTML/Footer' is needed, simple to make with
the AmigaDOS command 'SetENV RDAG2HTML/Footer your text'.
The environment variables may conatin more than one line!
NoLowerCase/S Disable the node to lower case conversion. Bad for case sensitive
filesystems.
NoStrip/S Disable the strip option for node names.
NoInternational/S Enable replacement of german 'Umlaute' and sharp 's', included
cause of a reported problem of IBrowseŽ
@{"Quick Starter, How to install" LINK "Install"}
@ENDNODE
@NODE "History" "History"
@TOC "MAIN"
@PREV "Usage"
@NEXT "Bugs"
@{b}RDAG2HTML History@{ub}
Version 1.0 Initial release
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.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 @
Node names up to 49 charcaters are now possible.
Version 1.3 [Next] and [Previous] link always possible, also if there is no
@PREV or @NEXT command in the current node. Added and