XMLDESCRIPTIONS
Supported by Ginmake 1.44 and later, GIN file version 3.24.
Embeds an XML description file into the GIN file. See example_descriptions.xml.
[XMLDESCRIPTIONS,<filename.xml>]
The XML description file allows GWv4 to display descriptions about objects within the GIN file. This format file is extensible so that new features may be added to description files and GWv4 without requiring a new version of GIN file.
Example XML file:
Note some of the features here. This follows standard basic XML formatting – if you are unfamiliar, refer to http://www.w3schools.com/xml/default.asp .
The ‘descriptions’ root tag must always be present. Parameters, options, maps etc are referenced via specific tags and the mane attribute is given to identify the specific object. A short description that may show up as a tooltip in some situations in GWv4 can be defined using the ’tip’ attribute. The longer description is plain text within the tag.
Additional references may be present in the description – for example the parameter ‘Bar’ references the parameter ‘Foo’ from its description. GWv4 may show this as a hyperlink or draggable object.
Reference tags differ from the outer tags. And are prefixed with a ‘g’. This avoids overlap with existing HTML tags (param, option and map):
gparam, goption, gtable, gmap etc.
These references are equivalent to HTML anchors:
Which may also be used instead if the display text should be different to the actual name being referenced or if embedding HTML tags inside the link is required.