@DATABASE "RDAG2HTML.guide"
@NODE "Main" "Rexx Does AmigaGuideŽ 2 HTML"
@TOC "MAIN"
@NEXT "Intro"
RDAG2HTML - Rexx Does AmigaGuideŽ 2 HTML 1.91
RDAG2HTML is Public Domain.
You may use it, modify it and distribute it all over the world!
RDAG2HTML may be used for commercial purposes, but it MAY NOT
be included in commercial software without @{"my" LINK "Author"} permission!
For 'Quick Starter' see @{"Installation, Requirements" LINK "Install"} and @{"Usage" LINK "Usage"}!
@{"Introduction" LINK "Intro"} What is RDAG2HTML?
@{"Changes" LINK "Changes"} Did I, what you want?
@{"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/rdag2html.html@{ub}.
There could be also beta releases not available on Aminet.
@ENDNODE
@NODE "Intro" "Introduction"
@TOC "MAIN"
@PREV "MAIN"
@NEXT "Changes"
RDAG2HTML is an AmigaGuideŽ to HTML converter written in ARexx.
HTML is the best known 'Hypertext Markup Language' widely used on
the World Wide Web. RDAG2HTML converts AmigaGuideŽ files into 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 [Contents], [Index], [Help],
[Previous] and [Next] text with inlined GIF's or JPEG's. You can use
background images, set background-, text- and link color to let look your
HTML document better.
Because of a reported problem with IBrowseŽ, german 'Umlaute' in node
names can be replaced with ae, oe, ue.
@ENDNODE
@NODE "Changes" "Changes"
@TOC "MAIN"
@PREV "Intro"
@NEXT "Features"
@{b}Last Changes@{ub}
Changes since version 1.4
° 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
Changes since version 1.6
° Enhanced argument parsing, now similar to dos.library's ReadArgs()
° Support of new HTML features like background color, text color etc.
° New argument key words for background image, background color, text
color, link color, header, footer, argument file and icons
° Important: Because of the new argument key words, please check your
argument files before use! See @{"ArgFile" LINK "ArgFile"} for further details!
@ENDNODE
@NODE "Features" "Features"
@TOC "MAIN"
@PREV "Changes"
@NEXT "Author"
@{b}Features of RDAG2HTML@{ub}
° Backgound image for the body of the HTML document.
° Support of BGCOLOR, TEXT, LINK and VLINK keywords for the BODY tag.
You can use your favorite colors for the HTML document.
° Button images for [Contents], [Next], [Previous], [Help] and [Index].
° Custom header, custom footer for the HTML document
° RDAG2HTML can convert an AmigaGuideŽ file to a single HTML document.
° [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 the AmigaDOS file system.
° Node names can even stripped down to fit M$-DOS filename limits.
ex. thifrust.htm
° RDAG2HTML is highly configurable with arguments and via the @{"ArgFile" LINK "ArgFile"}
° The following characters will be replaced:
\\\\ with \\
\\@ 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
\@{U} as
\@{UB} as
\@{UI} as
\@{UU} as
@ENDNODE
@NODE "Author" "Author"
@TOC "MAIN"
@PREV "Features"
@NEXT "Install"
@{b}The Author of RDAG2HTML@{ub}
RDAG2HTML Copyright (C) 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
Home of RDAG2HTML: http://www.sbox.tu-graz.ac.at/home/rmike/rdag2html.html
@{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 DEST your.html SINGLEFILE
converts your guide in one single file
rx rdag2html ?
prints the argument template Source/A,Dest/K,SingleFile/S, ...
@{b}Arguments@{ub}
@{"Source/A" LINK "ArgSource"} Source file in AmigaGuideŽ format.
Dest/K Destination file, only necessary for the SINGLEFILE option!
SingleFile/S Converts the AmigaGuideŽ file in a single HTML document.
@{"Icons/S" LINK "ArgIcons"} Use Icons instead of [Contents], [Previous], [Next], etc.
@{"TOCIconURL/K" LINK "ArgIcons"} Image URL for 'Contents' button. Default: 'images/main.gif'
@{"TOCText/K" LINK "ArgButtonText"} Text for 'Contents' button. Default: '[Contents]'
@{"IndexIconURL/K" LINK "ArgIcons"} Image URL for 'Index' button. Default: 'images/index.gif'
@{"IndexText/K" LINK "ArgButtonText"} Text for 'Index' button. Default: '[Index]'
@{"HelpIconURL/K" LINK "ArgIcons"} Image URL for 'Help' button. Default: 'images/help.gif'
@{"HelpText/K" LINK "ArgButtonText"} Text for 'Help' button. Default: '[Help]'
@{"PrevIconURL/K" LINK "ArgIcons"} Image URL for 'Previous' button. Default: 'images/prev.gif'
@{"PrevText/K" LINK "ArgButtonText"} Text for 'Previous' button. Default: '[Previous]'
@{"NextIconURL/K" LINK "ArgIcons"} Image URL for 'Next' button. Default: 'images/next.gif'
@{"NextText/K" LINK "ArgButtonText"} Text for 'Next' button. Default: '[Next]'
@{"Background/S" LINK "ArgBackground"} Use a background image for the HTML document.
@{"BackgroundURL/K" LINK "ArgBackground"} URL of the background image. Default: 'images/bground.gif'
@{"BGColor/K" LINK "ArgColor"} Color value for background
@{"TextColor/K" LINK "ArgColor"} Color value for text
@{"LinkColor/K" LINK "ArgColor"} Color value for links
@{"VLinkColor/K" LINK "ArgColor"} Color value for visited links
@{"Header/S" LINK "ArgHeaderFooter"} Use a custom header, read from a file, for the HTML document.
@{"HeaderFile/K" LINK "ArgHeaderFooter"} Filename of the header file. Default: 'ENV:RDAG2HTML/Header'
@{"Footer/S" LINK "ArgHeaderFooter"} Replace the standard foot line with your custom footer.
@{"FooterFile/K" LINK "ArgHeaderFooter"} Filename of the footer file. Default: 'ENV:RDAG2HTML/Footer'
NoLowerCase/S Disable the node to lower case conversion.
8Point3/S Nodenames will be stripped down to fit M$-DOS file name limits.
NoStrip/S Disable the strip option for node names. Overrides @{I}8Point3@{UI}!
NoInternational/S Enable replacement of german 'Umlaute' and sharp 's'.
@{"ArgFile/S" LINK "ArgFile"} RDAG2HTML will be forced to interpret the content of an argument file.
@{"ArgFileName/K" LINK "ArgFile"} Name of your ArgFile. Default: 'ENV:RDAG2HTML/ArgFile'
@{"Quick Starter, How to install" LINK "Install"}
@ENDNODE
@NODE "ArgSource" "Source/A"
@TOC "MAIN"
Source/A
Source file in AmigaGuideŽ format.
You may use the source file name without the @{I}Source@{UI} keyword,
but it must be the first argument. With the @{I}Source@{UI} keyword,
the source filename can be written everywhere in the argument line.
@ENDNODE
@NODE "ArgIcons" "Icons/S TOCIconURL/K IndexIconURL/K HelpIconURL/K PrevIconURL/K NextIconURL/K"
@TOC "MAIN"
Icons/S
Use Icons instead of [Contents], [Previous], [Next], etc.
To define your own filenames for the icons, you must refer to the
@{"ArgFile" LINK "ArgFile"}. There is no other way in the current
version.
The following keywords need the @{I}Icons@{UI} switch.
TOCIconURL/K
Image URL for 'Contents' button. Default: 'images/main.gif'
IndexIconURL/K
Image URL for 'Index' button. Default: 'images/index.gif'
HelpIconURL/K
Image URL for 'Help' button. Default: 'images/help.gif'
PrevIconURL/K
Image URL for 'Previous' button. Default: 'images/prev.gif'
NextIconURL/K
Image URL for 'Next' button. Default: 'images/next.gif'
@ENDNODE
@NODE "ArgButtonText" "TOCText/K IndexText/K HelpText/K PrevText/K NextText/K"
@TOC "MAIN"
TOCText/K
Text for 'Contents' button. Default: '[Contents]'
IndexText/K
Text for 'Index' button. Default: '[Index]'
HelpText/K
Text for 'Help' button. Default: '[Help]'
PrevText/K
Text for 'Previous' button. Default: '[Previous]'
NextText/K
Text for 'Next' button. Default: '[Next]'
These strings will be also used for the ![alternate]()
text.
@ENDNODE
@NODE "ArgBackground" "Background/S BackgroundURL/K"
@TOC "MAIN"
Background/S
Use a background image for the HTML document.
BackgroundURL/K
URL of the background image. Default: 'images/bground.gif'
The URL may be a local filename like @{I}images/background.jpg@{UI},
but it's also possible to use @{I}"http://www.highlife.org/images/bground.gif"@{UI}
or similar.
The @{I}BackgroundURL@{UI] keyword needs the @{I}Background@{UI} switch.
ex. rx rdag2html source.guide Background BackgroundURL "img/bg.jpg"
@ENDNODE
@NODE "ArgColor" "BGColor/K TextColor/K LinkColor/K VLinkColor/K"
@TOC "MAIN"
BGColor/K
Color value for background
TextColor/K
Color value for text
LinkColor/K
Color value for links
VLinkColor/K
Color value for visited links
The color values are written in hexadecimal with a leading #.
Format: #rrggbb
r ... red
g ... green
b ... blue
ex. rx rdag2html source.guide BGColor #ff9933
@ENDNODE
@NODE "ArgHeaderFooter" "Header/S HeaderFile/K Footer/S FooterFile/K"
@TOC "MAIN"
Header/S
Use a custom header, read from a file, for the HTML document.
HeaderFile/K
Filename of the header file. Default: 'ENV:RDAG2HTML/Header'
Footer/S
Replace the standard foot line with your custom footer.
FooterFile/K
Filename of the footer file. Default: 'ENV:RDAG2HTML/Footer'
Header file and footer file may conatin more than one line!
ex. rx rdag2html source.guide Footer FooterFile footer.inc
@ENDNODE
@NODE "ArgFile" "ArgFile/S ArgFileName/K"
@TOC "MAIN"
ArgFile/S
RDAG2HTML will be forced to interpret the content of an argument file.
ArgFileName/K
Name of your ArgFile. Default: 'ENV:RDAG2HTML/ArgFile'
ex. rx rdag2html source.guide ArgFile ArgFileName arguments.rdag2html
You may control the following variables in the ArgFile:
Argument variables
Boolean argArray.Icons
String argArray.TOCIconURL
String argArray.TOCText
String argArray.IndexIconURL
String argArray.IndexText
String argArray.HelpIconURL
String argArray.HelpText
String argArray.PrevIconURL
String argArray.PrevIconText
String argArray.NextIconURL
String argArray.NextText
Boolean argArray.Background
String argArray.BackgroundURL
String argArray.BGColor
String argArray.TextColor
String argArray.LinkColor
String argArray.VLinkColor
Boolean argArray.Header
String argArray.HeaderFile
Boolean argArray.Footer
String argArray.FooterFile
Boolean argArray.NoLowerCase
Boolean argArray.8Point3
Boolean argArray.NoStrip
Boolean argArray.NoInternational
Internal variables (Note: This may change in the future!)
String footer
String header
You may define your custome footer and header
String suffix
ex. @{I}suffix = '.shtml'@{UI}
See also the @{"ArgFile example" LINK "ArgFile/MAIN"}
@{B}Important!!!@{UB}
Some Arguments, may override others, if they are used in the ArgFile.
° @{i}argArray.Header@{ui} will override @{i}header@{ui}!
° @{i]argArray.Footer@{ui} will override @{i}footer@{ui}!
° @{i}argArray.8point3@{ui} will override @{i}suffix@{ui}!
This means for you:
If you like to define the variable @{i}footer@{ui} or @{i}header@{ui}, DO NOT
USE @{i}argArray.Footer@{ui} and @{i}argArray.Header@{ui}!
If you like your own suffix, DO NOT USE @{i}argArray.8Point3@{ui}!
@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