@database HTML2Guide Documentation

@wordwrap

@node MAIN "Contents"

        HTML2Guide
    ©1997 Mark Harman

 @{" " link INTRO}    Introduction
 @{" " link REQ}    Requirements
 @{" " link USAGE}    How to Use This Program
 @{" " link TODO}    Things I May Add in Future!

 @{" " link PSOFT}    PentriSoft, the Programmers' User Group
 @{" " link DCLICK}    DoubleClick, the Diskmag!
 @{" " link ME}    Contact Me!

Check out the excellent diskmag DoubleClick! Issue 4, released early August 1997, will 
be uploaded to Aminet soon after!

@endnode

@node INTRO "Introduction"

This is a simple program that converts a set of HTML documents, and converts them into 
AmigaGuide format.

I needed a program to do this, but depite being loads of HTML to ASCII convertors, as 
well as plenty of AmigaGuide to HTML convertors, I found none to covert HTML to 
AmigaGuide. So I wrote my own ;)

Why might you need this? Well I needed for my diskmag, DoubleClick, which I produced in 
HTML. I wanted people who did not have the system requirements to be able to read my 
mag - not forgetting the fact that some may prefer to read in AmigaGuide, due to it 
being faster, hogging less memory, etc. I didn't want to go through the hassle of 
converting it myself longhand - that would take ages! With this program, it's easy!

You might think that such a progam as this is past it's time, now that most people will 
be able to read HTML documents reasonably well. But consider this: as far as program 
documentation goes (including the one you're reading now), it is almost always in 
AmigaGuide - not HTML. The only exceptions are, predictably, Web Browsers. This is 
presumeably because people find Guides easier and quicker to create, and not to mention 
you need a lot more system resources to run a Web Browser @{"i"}and@{"ui"} the program 
it documents, which is what you want to do.

But in time, as Amigas become more Powerful, I would guess that HTML would slowly 
replace Guides as the standard form of online documentation, and this program will be 
invaluable!

So there are progams that will convert from Guides to HTML? True, but if you do this, 
the HTML will be a mere copy almost of the Guide; to take advantage of HTML's better 
features, you'd need to alter it after the conversion. And then if you wanted to update 
the documents afterwards, you'd either have to update @{"i"}both@{"ui"} Guide and HTML 
(defeating the purpose of such convertors), or have to redo all your special HTML 
additions.

A far better way is to do your document in HTML, and then convert to AmigaGuide with 
this program. All the HTML bits that AmigaGuide can't do are stripped out, or done as 
best as possible. Then, when you update the document, only the HTML version needs to be 
updated, and this program re-running.

I hope you're convinced... please get in @{"touch" link ME} if you find this program 
useful; if I don't know anyone who's using it, I won't bother updating it!

Please note that this is the very first release, and as such, is pretty basic. It's 
slow, will get confused at Tables (god knows what it'll make of Frames), and will only 
copy sub drawers rather than decoding HTML docs within them. But it should still work 
reasonably well!

@endnode

@node REQ "Requirements"

HTML2Guide should be fine on all Amigas with OS2.0 or above and 1MB RAM. As it is 
unfortunately fairly slow at the moment, a fast processor is advisable (I hope to work 
on this soon). The amos.library is also required in LIBS: (not provided in the lha 
distribution, you probably already have it).

@endnode

@node USAGE "How to Use This Program"

Okay, this is really easy! Run the program, and an ASL requester will ask you for a 
source directory. This means all your HTML files should be in one directory. Go into 
that drawer, and then click OK. (NB, although files are shown, you don't need to select 
a file, just go into the required drawer!)

Now select a directory to hold the new files (you can create a new drawer from the 
requester, if you like). Then the operation begins!

For all files:
	Any ending in '.html', '.htm' or '.doc' will be converted from HTML to 
AmigaGuide. If the file contains plain ASCII, it doesn't matter.*
	Any other files, be they text, gfx, programs - whatever, are copied without 
alteration.
	Subdirectories are copied complete with their contents. As yet, they files inside 
subdirectories are not converted.

*Please note that at the moment files HTML longer than about 65k bytes will not be 
converted, only copied. Again, this should be fixed in an updated version soon.

Any files in the destination drawer with the same name as a file being copied are 
automatically overwritten! Info files are at the moment not copied.

Yeah, I know it's pretty basic, but new versions will be available soon. Unfortunately, 
I don't have Internet access, so uploading to Aminet is difficult. Probably best to 
write to me or check out AF / CD CoverCDs!

@endnode

@node TODO "To Do"

Remember, this is a very first public release, so there are probably bugs, and it 
doesn't have many features at all! Things I may do in future are:
	- Make it faster! Some things it takes ages on!
	- Give the option to go into and convert subdirectories, rather than blindly 
copying them
	- A better interface ;)
	- Option to not overwrite files in destination directory with same name
	- Er, option to halt conversion
	- Better handling of Tables, so that they come out reasonably in AmigaGuide!
	- Somehow handling of Frames?

Any ideas you have? Just write to @{"me" link ME}!

@endnode

@node PSOFT "PentriSoft"

Join the Programmers' User group, and benefit from the following:
	- Make contact with like minded people to exchange ideas, make friends, swap 
code, work on joint projects
	- Get others to beta test your programs
	- Contribute to the PentriSoft diskmag @{"DoubleClick" link DCLICK}
	- and Receive DoubleClick
	- Advertise your programs in other member's programs, and DoubleClick
	- Get hold of PD from other members
	- Free membership
	- Graphics artists and musicians are welcomed too
	- No ties or catches, this isn't a commercial organisation or anything, more like 
making friendly contacts ;)

Just write to @{"me" link ME} for details. A blank disk and SAE would be appreciated 
for me to send some stuff back to you. Altenatively, email me!

@endnode

@node DCLICK "DoubleClick"

Amiga Format described issue 1 as 'looks very promising' and 'this could be the 
ultimate diskmag'! Make up your own mind with the latest issue, by sending @{"me" link 
ME} £1.30. There are two versions, the HTML version (AWeb demo included, or use another 
viewer - requires 2MB Chip RAM, OS3, hard drive minimum) or the AmigaGuide version 
(Requires OS minimum. Runs from floppy), so specify which version you want! Issue 5 
released December 1997.

Alternatively, go to my webpage at members.tripod.com/~Mark_Harman to download issues, 
or check out aminet under docs/mags (under the name DC...)

@endnode

@node ME "Contact Me!"

Please write to give me money, bug reports, ideas, donations, PentriSoft memberships, 
DoubleClick subscriptions, Power Amigas, etc:
	Mark Harman
	(H2G)
	3 Highlea Close
	St Leonards on-sea
	East Sussex
	TN37 7SS

Or you can now email me (term time only!) at mdwh2@cam.ac.uk

Oh yes, check out my web site at members.tripod.com/~Mark_Harman (lots of DoubleClick 
past articles!)

Bye...

@endnode