# Package sigmlgen

This package imlements the generation of SiGML documents in various forms.

See: Description

- Class Summary
  Class | Description
  --- | ---
  CASMMToMetres | Main class, whose main method converts all the length/position values in a CAS file from mm to metres, using a simple XSLT transform.
  GSiGMLSign | Gestural-SiGML sign data: each instance of this class records the data for a single sign within a SiGML sequence: this includes SiGML text for the associated `<hamgestural_sign>` wrapped in a `<sigml>` element, the sign's gloss name, and any associated player settings.
  HNSSiGMLNonManuals | A collection of static data and method definitions relating to the non-manual aspects of a sign as represented in the `<hamnosys_nonmanual>` element used in HML and HNS-SiGML.
  HSDocParameters | Provides standard definitions of various global parameters for HML and SiGML documents, such as encoding, DTD system ID, and document element type, and defines class methods that form "prefixes" and "suffices" for HML/SiGML documents, in accordance with the values of these parameters.
  HSDocWrapping | This class provides "wrappers" for HML and SiGML document output streams; a wrapper provides an efficient mechanism for inserting the appropriate HML/SiGML document prefix and suffix into the stream at the appropriate stages in the output process.
  SiGMLChildNodesProcessor | Support class for the `SiGMLDocToGSiGMLSigns` class, allowing the apppropriate sequence of gestural SiGML signs to be generated from the child nodes of a SiGML document element, taking into account any occurrences of either `<signing_ref>` or `<player_settings>` elements among these children.
  SiGMLDocHNSToGestural | A converter for a SiGML document: it generates a new copy of the document in which each `<hns_sign>` element in the original is replaced by the result of translating that element to a semantically equivalent `<hamgestural_sign>` element.
  SiGMLDocsFromHNSSource | An instance of this class takes the sequence of `HNSSign`s generated by a given `HNSInputAsSignSequence`, and from these signs it constructs a pair of SiGML documents, one containing <hns_sign> elements and one containing <hamgestural_sign> elements.
  SiGMLDocToGSiGMLSigns | Converter for a SiGML document, generating the sequence of `GSiGMLSign`s for it.
  SiGMLDocToSync | A converter for a SiGML document: it generates a new copy of the document in which null `<hns_sign>` elements are inserted to produce signing that synchronises with `begin` attributes.
  SiGMLDocToTimed | A converter for a SiGML document: it generates a new copy of the document in which each `<hns_sign>` and `<hamgestural_sign>` element has a `duration` attribute based on timings from a matching CAS file.
  SiGMLResolver | A SAX entity resolver for the standard SiGML DTDs, that is, for the SiGML DTD, the HamNoSysML (HML) DTD, and the SiGML-stream DTD.
  SiGMLTagDefs | Definitions of names and values for SiGML and HML (HamNoSysML) elements and attributes.
  SigningRefProcessor | Processor for a SiGML `<signing_ref>` element, for which it generates the appropriate sequence of gestural-SiGML signs.

- Exception Summary
  Exception | Description
  --- | ---
  SiGMLDocHNSToGestural.SiGMLConvertException | Exception class for SiGML HNS-to-Gestural conversion.
  SiGMLDocToGSiGMLSigns.SignGenException | Exception class for `SiGMLDocToGSiGMLSigns`.
  SiGMLDocToSync.SiGMLConvertException | Exception class for SiGML HNS-to-Gestural conversion.
  SiGMLDocToTimed.SiGMLConvertException | Exception class for SiGML HNS-to-Gestural conversion.

## Package sigmlgen Description

This package imlements the generation of SiGML documents in various forms. This includes the conversion between different forms of SiGML, for example the replacement in a SiGML document of each a `<hns_sign>` by the corresponding `<hamgestural_sign>` element.