Guideline Markup Tool - Readme
The Guideline Markup Tool is outdated!
See the page of the follow-on project
DELT/A.
Installation
-
Short version: Download gmt.zip or gmt.tar.gz from the
download page, unzip it and run gmt.bat/gmt.sh.
-
Long version:
Java Runtime Environment (JRE) 1.3 or 1.4 have to be properly installed.
(The GMT has been developed with JDK 1.3, so I recommend you use JRE 1.3, but it should work with JRE 1.4, too.)
If this was not done yet, you can find JRE 1.3 (with installation instructions) on
Sun's Java site.
Additional to the GMT classes, three external Java libraries (for the XML processing) are needed.
To simplify downloading, I've zipped all necessary files together - so you only have to download
gmt.zip
or
gmt.tar.gz.
After unzipping the archive, the GMT can be started with the included shell script (gmt.bat/gmt.sh).
Short Manual
The GMT is divided into 3 main parts: the upper-left part is the HTML-View,
the upper-right part is the XML-View, and the bottom part is the Macros/Structure-View.
- HTML-View: Here you can load and view any HTML file.
- If you click on a HTML link which points to XML element(s) (the mouse cursor
will change to a special XML link cursor, if it's over an HTML->XML link) the related
XML elements in the XML View will be highlighted.
- Note: To prevent these special HTML links from appearing in an external browser,
they will be removed when the HTML file is saved and re-inserted when the HTML file is re-opened.
- XML-View: Here you can create a new or edit an existing XML file.
- The "New XML file" feature creates an new Asbru file from an internal template file (in
future releases the template file can be changed by the user to support any XML language).
- If you click on any node in the XML view, you will see additional information about this node below the tree.
The toolbar of the "Node View"-part has a button to remove the currently selected node.
- If this node is an element, you see a table there which contains the attributes as key/value-pairs:
Below this table is a special toolbar, where you can insert or remove attributes.
- If you click on a "link" element - which is not included in the official Asbru Specification - (the mouse cursor
will change to a special XML link cursor, if it's over an XML->HTML link element) the related
HTML text in the HTML View will be highlighted.
- Note: Some features (insert new attributes, mark non-insertable macros) works only if the XML file is valid!
- Macros/Structure-View: Here you can load and view a macros file.
- After a *.gmt-file was loaded, the Structure View will be populated with list boxes - the first list box will show
the entries (sub-groups, macros, elements) of the top-level group.
- If you click on a group entry, the next list box will show the content of this group.
- If you click on a macro/element, you will see this macro/element in the Macro View to the right.
- All macros/elements which could not be inserted to the currently selected XML element
of the XML View according to the Document Type Definition are shown with a darkgrey background.
- To insert a (insertable) macro/element, you can
(1) click on the button on the Macro View toolbar,
(2) double-click on the entry in Structure View, or
(3) hit the return-key after you have selected the entry in Structure View.
- If you want to insert macros/elements which could only be inserted
together with other macros/elements,
you could temporary turn off the validation in the preferences dialog
(change from "Strict Insert Check" to "Insert Check" or "No Check").
To test the GMT, I recommend to load the (included) Jaundice HTML file (hyperb.htm),
create a new (Asbru) XML file and load the (included) demo-structure.gmt Macros-file.
I hope this readme is sufficient until the extensive user manual is finished.
If you have any further questions or requests regarding the Guideline Markup Tool, feel free to
contact Peter Votruba
or Silvia Miksch.