Options Area

The Processing Options Area controls many aspects of how the database is rendered into a printed document. These check boxes deal primarily which how data concepts are rendered into sections. The settings affect all tables rendered; if you wish to use different values for each section you must run the tool one step at a time, and change the settings between each step as needed.

The overall flow and layout of the control matches the rendering order used for most entries. The description, a natural language section, is followed by the two code sections (ASN and XML) which are then followed by the remarks, any formula text, any representations class terms, alternative names and other meta data.  A section of linkage relationships is built up and inserted for each entry using the Links... tables and then expressed according the settings.  This provides linkage to other data concepts in the standard which make use of the current data concept. The ASN or XML provides (by inspection) a list of who is used in the data concept. Hyperlinking to these entries can be built in a variety of ways as well.

Finally, some running statistics about the document complexity are kept. These can be appended to the end of each section or step if enabled (useful in debugging).

This section provides additional information regarding the effect of setting these controls.

Proof Read Only Enable this switch when rendering a document for use by a proof reader who does not want to see the technical codes (ASN or XML) of the document.  This switch will disable the ASN or XML for each entry; in effect you will get a document containing mostly the descriptive text and the remarks sections. This can be very useful when producing a smaller document for focused proofreading use. [Top]

Include Figures Typically leave enabled. This switch allows the inclusion of figures and graphics in the build process. In time it will also allow adding UML models and other images to data concepts. Today it is mostly the terms entries that use figures.  If a figure file can not be found, the file name and path that was searched will be stated in the final document [Top]

OID in Titles Add the OID value, if one is present, into the title for the entry. [Top]

Suppress Watermark Suppress the watermark found in the Misc Text for this database when checked. This may or may not have the effect of removing the watermark. If the template document has a watermark, then that will be left untouched. When unchecked, the watermark text is taken from the Misc Text table and is used to replace the current watermark in the template document. [Top]

Add Use Text When checked, the description (or use) text is rendered at the start of the data concept. [Top]

Add ASN When checked, the ASN fields (ASN Name, Data Type, Valid Value Rule, and Message Body) are all combined into proper ASN and rendered out into a mono-spaced font. [Top]

ADD XML When checked, the XML fields (XML Tag, XML-Schema) are all combined into proper XML and rendered out into a mono-spaced font. [Top]

Add Formula When checked, any content in the formula field is rendered out (if present). This is one of the fields that is most often empty, so unless there is content in the specific record being rendered, you will not see anything. [Top]

Add Representation Class Data When checked, any content in the representation class term field is rendered out (if present). This is one of the fields that is most often empty, so unless there is content in the specific record being rendered, you will not see anything. [Top]

Add Alternative Names When checked, any content in the alternative name field is rendered out (if present). This is one of the fields that is most often empty, so unless there is content in the specific record being rendered, you will not see anything. [Top]

Add Registry ID Values When checked, any content in various registry value fields are rendered out (if present), including the ID value. This is one of the fields that is most often empty, so unless there is content in the specific record being rendered, you will not see anything. [Top]

Add Harmonization Notes When checked, any content in the harmonization notes field is rendered out (if present). This is one of the fields that is most often empty, so unless there is content in the specific record being rendered, you will not see anything. This field is used by data stewards to coordinate comments on each others work. [Top]

Include Source Document Data When checked, any content in the source field is rendered out (if present). This is used to print the full and complete name of the standard when needed. [Top]

Set tables for linking This button brings up the Links.. Dialog which is used the same as the Links Table in the Mini-Edit tool. The tables selected will be used in the Used In linking calculations. The only difference is that in the 1st Word tool only the standard table names are presented to be selected  (standards are all built using well known table names, hence user defined names are not used). [Top]

Control Link Reporting This section controls how the links found in the Links... table are processed in building the document. First, if links are to be provided in the document, the Include Cross Links switch should be enabled. The underlying switches control aspects of the style and what links are reported. If the switch Link Msgs is enabled, a summary of all top level messages that use the current data concept will be printed. If the switch Recursive is also enabled, every message data concept will also be tested for use by other messages and all found will be listed. If the switch Add ASN/XML Names is enabled, the proper names of the ASN and XML entry for the data concept will be listed after the descriptive names. If not enabled, only the descriptive name of the entry that uses the current data concept will be listed If the switch Terse Style Code Text is enabled, and the text of the ASN or XML name is changed into a hyper link, then the full name of the data concept is replaced with the phrase ASN or XML to produce a shorter and more readable listing. This can be more pleasing than listing the descriptive name, followed by the full ASN name, followed by the full XML name when in fact these names are the same string. If the switch Unused Entries Cause Warning is enabled, any data concept that DOES NOT have cross links AND are not message record types or Dialog record types, produces a warning to examine it further. Such records are questionable in a standard, where every data concept is expected to be used by something or else the question arises why is it there? This switch is typically used as a debug test by stewards. If the switch Append Final Text Line is enabled, a rather generic line is appended to each listing mentioning a cautionary warning that the data concept may in fact be used by other standards and efforts not reflected here. [Top]

Control hyperlinks This section controls how the bookmarks created during the preceding document build process are processed to create hyperlinks for the document. A variety of hyperlinks can be built up with these bookmarks, depending on what is checked. Note that the bookmarks are placed into the document event if no links are ever created. In theory, this would allow another program to post-process the document if the need arose. The overall hyper linking process is controlled by the Process Hyper Links switch. If this switch is off, no linking will occur, if on linking will occur and the underlying switches control the formatting and what will be linked. If the switch Record Entries is enabled, linking will occur to places that mention the record by name, linking to the beginning of that record entry. Typically, this will be the list of used-in places. But any place with the right string and text style could be linked. If the switch ASN.1 Entries is enabled, linking will occur to places that mention the records ASN by name, linking to the beginning of that record entry. Typically, this will only be in other well formed code segments. But any place with the right string and text style could be linked. If the switch In Text is enabled, linking will occur to places that mention the records ASN by name, linking to the beginning of that record entry. If this option is set, any place with the right string and style could be linked. If the switch Anywhere is enabled, linking will occur to places that mention the records ASN by name, linking to the beginning of that record entry. If this option is set, any place with the right string and normal text style could be linked. If the switch XML Entries is enabled, linking will occur to places that mention the records XML type by name, linking to the beginning of that record entry. Typically, this will only be in other well formed code segments. But any place with the right string and text style could be linked. If the switch In Text is enabled, linking will occur to places that mention the records XML by name, linking to the beginning of that record entry. If this option is set, any place with the right string and style could be linked. If the switch Anywhere is enabled, linking will occur to places that mention the records XML by name, linking to the beginning of that record entry. If this option is set, any place with the right string and normal text style could be linked. If the switch Acronyms is enabled, linking will occur to textual places that mention the acronym entry by name, linking to the beginning of that acronym entry and displaying its meaning in the tool tip for that link. If this option is set, any place with the right string and style could be linked. If the switch Terms is enabled, linking will occur to textual places that mention the terms name, linking to the beginning of that term entry and displaying a short portion of its meaning in the tool tip for that link. If this option is set, any place with the right string and style could be linked. If the switch Suppress Tool Tip Text is enabled, then a short summary of the descriptive text entry is not loaded into the tool tip for that link. [Top]

Add Remarks When checked, the Remarks text is rendered for the data concept. If the item Insert Remarks after Use Text is enabled, the remarks follows the description text area. Otherwise, it follows after the Used-In section of text. [Top]

Processing Statistics The processing statistics display a number of counters regarding how complex the document is becoming. These include how many database records were used to produce the document, the document page count, how many document style changes were needed, and how many bookmarks and links were created. [Top]