Grotag

"Get rid of them Amigaguides"

About Grotag

Grotag views Amigaguide documents or converts them to HTML and DocBook XML. Additionally it can validate and pretty print such documents.

It is distributed under the GNU General Public License, version 3 or later.

Follows links to other documents when converting.
Points out errors in documents but still keeps reading it.
Optional mapping for links referring to Amiga files using devices and assigns to local files.
Supports wrapping of paragraphs: @smartwrap, @wordwrap.
Supports @macro.

There are however also some limitations, most notably:

To obtain Grotag, visit the download page.

The easiest way to describe what kind of output you can expect from Grotag are examples, so here are a few:

Basics.guide is a test document that exercises several features of Amigaguide. With --docbook, you get basics.xml, which in turn can be converted to basics.html.

Note that --docbook deliberately removes all formatting attributes and simlpy preserves the document structure.This kind of output is useful if you want to migrate an existing Amigiuaguide manual and keep editing it. DocBook does not support "physical" styles such as "bold" or "italic", instead there is a huge amount of logical styles that can assign meaning to terms. Only a human author will be able to choose the proper logical style. Grotag has no way of knowing the original meaning behind a certain physical style in the original Amigaguide document.
Root.guide is a base document that links to several others: red.guide, green.guide, blue.guide. This shows how Grotag handles the different kind of links, such as @alink, @guide or @link. In practice, you should only use @link these days, but Grotag is perfectly capable of working with the legacy commands. Using --docbook again, we get root.xml which can be converted to root.html.

The User Guide describes how to work with Grotag. Currently it is a rough draft.

The Grotag project site is hosted by SourceForge.net and contains the resources used for the development of Grotag.

The source code is available from a Subversion repository which you can browse at http://grotag.svn.sourceforge.net/viewvc/grotag/. To check out the current version from the repository, use

svn checkout https://grotag.svn.sourceforge.net/svnroot/grotag/trunk grotag

After the check out, run

ant setup

This extracts some resources need for DocBook transformation. You need to do this only the first time.

After that, run

ant

to build Grotag.jar and Grotag.zip

In case you add a feature or fix a bug, feel free to submit your changes using the patch tracker.