Glossary Item Box

XML Editor BasicsXML Editor Advanced Controls

See Also MEdit Send comments on this topic.

XML Editor Controls

XML Editor Controls

 

XML Editor Controls

Even though the rendering of the ASN into XML is automatic, the user will want to control some aspects of how the documentation is created, as well as how thoroughly the tool checks for supporting records in the rest of the file. This section supports those needs. Users can leave the default settings as found, or change items as required to control precise differences in the final XML schema.

This selection of controls is part of the XML Editor Window Dialog.

1Allow Auto-Updates

Allow Auto-Updates When checked, the record will automatically be updated when the XML Dialog is run. If you will be changing your ASN, leave this checked so your XML will be updated with the changes. If unchecked, the tool presumes you want to manually control the XML process and will not change the fields. The only reason you would do this is if you have hand edited the XML, which almost no one does.

2Make an Element

Make an Element This is normally checked only for message record types. In ITS all XML is expressed as abstract types (so no element tag is in fact created), and only messages have element tags. If your record is set to be of the type Message this check box will be automatically set for you.

3Show Debug

Show Debug When checked, the tool inserts many additional comments on the conversion process which can be useful in debugging what is going on and tracking down minor ASN syntax errors that may be giving you unintended results.

4Adjust ASN

Adjust ASN When checked, a number of minor and annoying ASN syntax errors in keywords are caught and corrected before the parsing process begins.

5Skip Long Name Warning

Skip Long Name Warning When checked, the screen warning about ASN-XML names being longer than 25 characters is suppressed. In general, you want to use short ASN name to produce short XML tags.

6Skip Link Resolution

Skip Link Resolution When checked, the extra processing step of seeking for one (and only one) matching record in the tables for each type-def used, and then using the XML tag name that it has, is suppressed. This is a major quality control function, and disabling it will probably hide errors and warning messages relating to other data records, which you really need to correct. You will still see errors relating to any ill-formed parts of this record.

7Skip ITIS Link Resolution

Skip ITIS Link Resolution When checked (the default), a slightly different process is used to check out and resolve names in the ITIS space. This was originally developed to allow standards to point to the ITIS phrases without having to import the entire ITIS list of entries. Now overcome by events, most standards that need to, simply import the ITIS phrase set directly.

8Convert dashes to spaces in string constants

Convert dashes to spaces in string constants When checked (the default), any dash character "-" found in enumeration strings will be converted to spaces in the XML string. The language ASN requires that enumerations be a single token, but there is no such restriction in XML and this produces a more readable string in many instances.

9Remove all comment lines (terse output)

Remove all comment lines (terse output) When checked, all intermediate comments found in the ASN production will be stripped out in the XML schema. This produces a very tight XML only listing but can lead to misunderstanding because the comments are often usage remarks a builder needs to follow.

10Add text of Description/Use to XML App Info

Add text of Description/Use to XML App Info When checked, the Description field is converted to plain text (from rich text) and included in the <xs:annotation> section of the schema. In effect, this fattens the schema by placing useful deployment data into this section.

11Add text of Remarks to XML App Info

Add text of Remarks to XML App Info When checked, the Remarks field is converted to plain text (from rich text) and included in the <xs:annotation> section of the schema. In effect, this fattens the schema by placing useful deployment data into this section.

12Add text of Formula to XML App Info

Add text of Formula to XML App Info When checked, the Formula field is converted to plain text (from rich text) and included in the <xs:annotation> section of the schema. In effect, this will fatten the schema by placing useful deployment data into this section.

13Delimit above text with type tags

Delimit above text with type tags When checked, and if any of the above three items are checked, then the content for the above items is preceded by a tag value to delimit it. For example, the description text is preceded by the tag <description> and so on. This allows the ability to parse out each section of text if needed.

14Add HTML bolding to text

Add HTML bolding to text This is a feature that is not yet implemented, pending the outcome of debate in the W3C-XML schema committee regarding allowing of formatted text in the App-Info section of the XML production. At present, only plain text is supported (in fact, formatting is "allowed" but any formatting found is ignored). When (if) the ablity to use HTML type styles is allowed here, this check box will control its application.

11424034

   <-LAST     TOP      NEXT->  

XML Editor BasicsXML Editor Advanced Controls

 

 


© SubCarrier Systems Corp. All Rights Reserved.