Home : Home : Warfare Centers : NSWC Carderock : Resources : Technical Information Systems : Navy XML/SGML Repository : DTDs & Schemas : PMS : Data Dictionary
Data Dictionary - PMS Document Type Definition (DTD) Description

0.1 INTENT

This document type definition (DTD) models the Fleet Technical Support Center (FTSC) Planned Maintenance System (PMS) document classes. The two classes of FTSC PMS documents and their acronyms are:

  • Maintenance Index Page (MIP)
  • Maintenance Requirement Card (MRC)

Even though the Locator Card (LOCCARD) document is an optional form of the MRC document, it is modelled as a separate document class in the PMS DTD for convenience. The PMS DTD also models NOFORN, CONFIDENTIAL, and SECRET MRC document classes. However, for modelling purposes they are regarded as MRC options.

Even though the Integrated Class Maintenance Plan (ICMP) document is not defined as an element type per se, seven element types accommodate ICMP use.

0.2 TERMINOLOGY

The element types of the PMS DTD are described as follows.

  • Commonly used CALS element types (such as those comprising the CALS table/chart model, sequential lists, warnings, cautions, notes etc.) are described in section 1.
  • Element types used in the MIP, MRC, and (in some cases) the LOCCARD modellings are described in section 2.
  • Element types used only in the MIP modelling are described in section 3.
  • Element types used only in the MRC and LOCCARD modelling are described in section 4.
  • Element types used only in the LOCCARD modelling are described in section 5.
  • Elements used to accommodate the ICMP documet are described in section 6.

The term "text" occurs in some of the definitions. It means any combination of character data and the following element type markup: "subscrpt", "supscrpt", "emphasis", "ftnref" "xref", "extref", "formula", and "dialink" defined below as provided by the "%text;" options.

The "paracon" parameter entity used to define the content of some element types provides the options of "paratext" element markup or markup of the three list types.

The term "list" also occurs in some of the definitions. It means the markup of a sequential, random, or definition list.

All PMS DTD element types have required start- and end-tags with the exception of those element types that have declared content of EMPTY such as "spanspec", "colspec", "testcode", "dpmeth", etc.

Some element types have an ID type attribute (usually named "id") to enable implicit cross-referencing within the document using the value of an IDREF type attribute (usually named "idref") of another element type. The "xref" element type enables explicit cross-referencing (e.g., "See table 3.") within the document. The "extref" element type enables the cross-referencing of an external document (e.g., "See section 3 of the NAVSEA-47-15 directive.").

Some element types have a CDATA attribute "label" for identification or enumeration. This attribute is rarely specified on tags since its value is usually generated by the formatter.

The "yesorno" parameter entity which is referenced to provide the declared value of "NUMBER" in some attribute definitions implies the CALS convention that such attributes take either a "1" value for "yes" or a "0" for "no".

1. COMMONLY USED CALS ELEMENTS

1.1 CAUTION: Caution

This tag identifies a caution. The formatted text of a caution is preceded by "CAUTION:". The content consists of "paratext" markup. Cautions can occur throughout the PROCEDURE block of an MRC document but do not occur at all in an MIP document.

This element type has the customary ID and IDREF attributes "id" and "idref" as well as the CDATA attribute "label". It also has the CDATA attribute "xlink" to enable external linkages. Finally, it has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.2 CHANGE: Change

This tag identifies a text change. The numerical value of the "level" attribute identifies the change level. This element type is not used at present in PMS documents.

The value of the "change" attribute ("add" or "delete") specifies whether the change is an addition or deletion. The "yes or no" value of the "mark" attribute indicates how the change is to be identified. The optional CDATA attributes "author" and "date" identify the author and date of the change.

1.3 CHART: Chart

The "chart" element type is synonymous with the "table" element type. That is, it is jointly defined with the same content model and set of attributes, and is allowed and disallowed in the same places in a PMS document instance. See item 1.24, "TABLE: Table" for a description of the common content model and attributes. The "chart" element type is not used in the PMS application at present.

1.4 COLSPEC: Column Specification

This element type specifies a column of a table/chart.

Always specify the "colname" attribute as "1", "2", "3", etc. on each "colspec" tag for each consecutive column. (Do not confuse the "colname" attribute with the "colnum" attribute which is not specified on the "colspec"tag.) Specify the value of the "colwidth" attribute as the column width in terms of the maximum number of characters the column can hold. Do not specify the "colnum", "charoff", or "char" attributes on the "colspec" tag. The "%yesorno;" attributes "colsep" and "rowsep" specify column and row separation by vertical and horizontal rules respectively for that column. The "left", "right", or "center" values of the "align" attribute can be used to specify the vertical alignment of that column. (Do not specify the "justify" or "char" values for the "align" attribute.)

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

1.5 DEF: Definition

This tag identifies the definition in a term-definition pair in a definition list. The content consists of markup of the "%paracon;" options and "table"/"chart" markup.

1.6 DEFLIST: Definition List

This tag identifies information provided in the term-definition pair format. The content consists of an optional title followed by one or more pairs of "term" and "def" markups.

1.7 EMPHASIS: Emphasis

This tag identifies author discretionary emphasis (as opposed to any such formatting specified emphasis) such as underlining or bolding for the content between the "emphasis" start- and end-tags. Its content is markup of the "%text;" options.

The value of the "type" attribute ("bold" or "underline") specifies the emphasis desired.

1.8 ENTRY: Entry

This tag identifies an entry in a table/chart heading or table/chart row. The content consists of the markup options of "%text;" and "%list;".

Always specify the "colname" attribute on the "entry" tag as "1", "2", etc. in accordance with the entry's column "colspec" tag. Specify the "namest" and "nameend" attributes in the same way if the entry spans columns. The value of the "spanname" attribute is the name of a column span previously defined on a "spanspec" tag. Use either (or both) the "spanname" attribute or "namest" and "nameend". Do not specify the "rotate", "valign", "charoff", or "char" attributes on the "entry" tag. The "%yesorno;" attributes "colsep" and "rowsep" specify column and row separation by vertical and horizontal rules respectively for that entry. The value of the "idref" attribute (which must be that of an ID type attribute on some element type's tag) enables implicit cross-referencing within the document. The "left", "right", or "center" values of the "align" attribute can be used to specify the vertical alignment of that column. (Do not specify the "justify" or "char" values for the "align" attribute.) The "morerows" attribute is not used in the PMS application.

1.9 ENTRYTBL: Entry Table

The CALS table/chart model element type "entrytbl" is not used at present in the PMS application.

1.10 EXTREF: External Cross-Reference

This element type identifies a cross-reference to an external document. Its content consists of markup of the "%text;" options or "mrccno" markup (only in the MIP instances).

This element type has three required attributes. The value of the CDATA attribute "docno" identifies the location of the external document to be linked to the PMS document. The ID attribute "xrefid" value is used for cross-reference linkage of the reference itself within the PMS document. The attribute "xidtype" takes the values of "figure", "table", or "text" depending on the nature of the external cross-reference. The information provided by this last attribute is required for some application software implementations.

1.11 FIGURE: Figure

This tag identifies a figure. The content consists of one or more "graphic" tags followed by optional "title" markup. Figures can occur in the preliminary and procedural steps of an MRC document but do not occur at all in a MIP document.

This element type has the customary ID attribute "id" and the CDATA attribute "label". It also has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.12 FTNOTE: Footnote Text

This tag identifies the text of a footnote. The content consists of markup of the "%paracon;" options.

Its ID attribute "id" must be given the value of the IDREF attribute "idref" of the "ftnref" element type to enable linkage. The "label" or "mark" attributes are not used in the PMS application.

1.13 FTNREF: Footnote Reference

This tag provides a footnote reference.

Its IDREF attribute "xrefid" must be given the value of the ID attribute "id" on a "ftnote" tag to enable their linkage.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

1.14 GRAPHIC: Graphic

This tag identifies an externally-stored graphic. Graphics without a title can occur only in the markup of mathematical notation in the preliminary and procedural steps of an MRC document.

The value of the required "boardno" attribute is the name of an externally-stored non-SGML (NDATA) data content notation general entity declared in the declaration subset of the Document Type Declaration (DOCTYPE) heading the instance. This ENTITY declaration identifies the appropriate graphic file.

This element type also has the customary ID attribute "id" and the CDATA attribute "label". It also has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

1.15 ITEM: List Item

This tag identifies an item of a sequential or random list. The content consists of "paratext" markup followed by an optional "seqlist" markup.

This element type has the customary "id" and "idref" attributes as well as the CDATA attribute "label". However, while the "id" attribute has its usual declared value of ID, the "idref" attribute has the declared value of IDREFS to accommodate the hyperlinking of a repeated warning in the Procedure block with the corresponding safety precaution in the Safety Precautions block. It also has the optional CDATA attribute "spinno" used to provide the spin numbers in the "materials", "parts", "tools", and "misc" contents in PMS MRC documents. Finally, it has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.16 NOTE: Note

This tag identifies a note. The formatted text of a note is preceded by "NOTE:". Its content consists of "paratext" markup followed by optional "seqlist" markup. In a MIP document a note can occur only after a required maintenance procedure list in the MAINTENANCE REQUIREMENT DESCRIPTION section. In an MRC document a note can occur throughout the PROCEDURE block.

This element type has the customary ID and IDREF attributes "id" and "idref" as well as the CDATA attribute "label". It also has the CDATA attribute "xlink" to enable external linkages. Finally, it has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.17 PARATEXT: Paragraph Text

This tag identifies paragraph text consisting of markup of the "%text;" options. It differs from the traditional CALS "para" element type in that it does not contain included tables/charts, figures, or graphics.

1.18 RANDLIST: Random List

This tag identifies a random list. The content consists of optional "title" markup followed by one or more "item" markups.

This element type has the optional CDATA attribute "prefix" used to specify an optional common prefix (such as a bullet) for all the items of the list in place of enumeration.

1.19 ROW: Table/Chart Row

This tag identifies a row of a table/chart heading or a table/chart body. The content consists of one or more "entry" or "entrytbl" markups. (The "entrytbl" element type is not used in the PMS application.)

This element type has one optional "%yesorno;" attribute "rowsep" specifying whether or not the row is to be underlined.

1.20 SEQLIST: Sequential List

This tag identifies a sequential list. The content consists of optional "title" markup followed by one or more "item" markups. Sequential lists are commonly-occurring components of PMS documents.

This element type has the customary ID attribute "id" and the CDATA attribute "label". The optional "numstyle" attribute specifies the enumeration style of the list items as: none, arabic, lower-case alphabetic, arabic in parentheses, lower-case alphabetic in parentheses, arabic in dashes, lower-case alphabetic in dashes, upper-case roman, lower-case roman, and upper-case alphabetic.

1.21 SPANSPEC: Spanned Column Specification

This tag identifies a column span.

On the "spanspec" tag, specify the values of the "namest" and "nameend" attributes as the values of the "colname" attributes of the leftmost and rightmost columns of the span. Specify the value of the "spanname" attribute as these two values joined with a dash ("-"), e.g., "1-4". Specify the "align" attribute value as "center", "right", or "left" as the situation warrants. (Do not specify the "justify" or "char" values for the "align" attribute.) The "charoff" or "char" attributes are not used in the PMS application. The "colspec" and "rowspec" attributes specify whether the columns and the rows of the column span are ruled.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

1.22 SUBSCRPT: Subscript

This tag identifies a subscript. Its content model is (#PCDATA). Subscripts occur in text.

1.23 SUPSCRPT: Superscript

This tag identifies a superscript. Its content model is (#PCDATA). Superscripts occur very rarely (usually as exponents) in the text of PMS documents.

1.24 TABLE: Table

This tag identifies a table. Tables/charts stand alone, i.e., are not included in "item" content. The content consists of one or more "tgroup" markups followed by optional "title" markup.

The "table"/"chart" element types have eight attributes.

  1. The optional "frame" attribute provides six options: "top", "bottom", "topbot", "all", "sides" and "none" for table/chart framing. Usually the "all" or "none" values are used (depending on the situation).
  2. The optional "%yesorno;" attributes "colsep" and "rowsep" provide lines separating the table's/chart's columns and rows respectively.
  3. The optional "orient" attribute specifies whether the table/chart is portrait ("port") or landscape ("land") oriented.
  4. The optional "%yesorno;" attribute "pgwide" specifies whether the table/chart is page wide or not.
  5. The optional ID attribute "id" is used for cross-referencing.
  6. The optional "%yesorno;" attribute "calltable" specifies whether or not "TABLE"/"CHART" occurs in the table/chart title.
  7. Finally, it has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.25 TBODY: Table/Chart Body

This tag identifies the table/chart body. The content consists of one or more "row" markups.

Its "valign" attribute is not to used in the PMS application.

1.26 TERM: Term

This tag identifies the term of a term-definition pair in a definition list. The content consists of markup of the "%text;" options.

1.27 TFOOT: Table/Chart Foot

The CALS table/chart model element type "tfoot" is not used at present in the PMS application.

1.28 TGROUP: Table/Chart Group

This element type is a wrapper for the information that defines a table/chart: the table/chart headings, column specifications, and table/chart body. The content consists of optional "colspec" and "spanspec" tags, optional "thead" and "tfoot" markups, and "tbody" markup.

On the "tgroup" tag, specify the "cols" attribute value as the number of columns.

Use the "align" attribute to specify the alignment of the columns as "left", "center", or "right" (do not specify the "justify" or "char" values).

The "%yesorno;" attributes "colsep" and "rowsep" specify column and row separation by vertical and horizontal rules respectively.

The "charoff" and "char" attributes are not used in the PMS application.

1.29 THEAD: Table/Chart Head

This tag identifies the heading in a table/chart. The content consists of optional "colspec" markups followed by one or more "row" markups whose "entry" contents define the column headings.

1.30 TITLE: Title

This tag identifies the optional title of a list, table/chart, or figure. The content consists of markup of the "%text;" options.

The optional "title" CDATA attribute "label" is used for identification as opposed to the optional ID attribute "id" which is used for cross-referencing. It also has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.31 WARNING: Warning

This tag identifies a warning. The formatted text of a warning is preceded by "WARNING:". The content consists of "paratext" markup. Warnings can occur in the PROCEDURE block of a MRC document but do not occur at all in an MIP document.

This element type has the customary ID and IDREF attributes "id" and "idref" as well as the CDATA attribute "label". It also has the CDATA attribute "xlink" to enable external linkages. Finally, it has the "security" attribute which takes the values "u" (unclassified), "nf" (no foreign nationals), "c" (classified), or "s" (secret). The default value for the "security" attribute is "u".

1.32 XREF: Internal Cross-Reference

This tag identifies an internal cross-reference within a PMS document.

This element type has the required IDREF attribute "xrefid" whose value must be the value of the ID type attribute on the start-tag preceding the content of the PMS document part being referenced. It also has the optional attribute "xidtype" which takes the values "figure", "table", or "text" depending on the nature of the cross-reference. This last attribute is optional because it is required for some application software implementations.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

2. ELEMENTS COMMON TO THE MIP, MRC, AND LOCCARD MODELLINGS

2.1 BDI: Birthdate Indicator

This element contains the birthdate indicator for the PMS document. The content consists of #PCDATA and "emphasis" markup.

2.2 COMSPCODE: Commodity Specialist Code

This tag identifies the commodity specialist code for PMS documents. This information is not provided in the formatted document. Its content model is (#PCDATA).

2.3 DATE: Date

This tag identifies the PMS document's date of issue provided by referencing the "date" general entity declared in the DOCTYPE declaration subset.

The "date" element type has two required attributes. The value of the "month" attribute must be one of the following name tokens: "January", "February", "March", "April", "May", "June", "July", "August", "September, "October", "November", or "December". The value of the "year" attribute must be a four-digit integer, e.g., "1998".

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

2.4 DECLASS: Declassification Statement

This tag identifies the declassification statement (if present) for the PMS document.

2.5 DECLASSON: Declassify On Information

This tag identifies the declassification date in the Declassification Statement. The content is parsed character data.

2.6 DERIVEFROM: Derived From Information

This tag identifies the derivation information in the Declassification Statement. The content is parsed character data.

2.7 DIALINK: Diagram Link

This tag identifies the linkage of (i.e., reference in) SGML tagged text to a location within a graphic. The content model is (#PCDATA).

This element type has three attributes. The optional CDATA "ident" attribute identifies the cross-reference for back-referencing from the location in the graphic.

The value of the required "boardno" attribute is the name of an externally-stored non-SGML (NDATA) data content notation general entity declared in the declaration subset of the Document Type Declaration (DOCTYPE) heading the instance. This ENTITY declaration identifies the appropriate graphic file containing the location referred to.

The value of the required CDATA "hypdestn" attribute is information identifying the location referred to in the graphic.

2.8 DISTRIB: Distribution Statement

This tag identifies the document's distribution statement. The type ("A", "B", etc.) of distribution statement is specified as the value of the required CDATA "type" attribute.

A standard distribution statement (consisting of the "distrib" start-tag, the distribution statement text, and the "distrib" end-tag) is provided by referencing one of the distribution general entities "distriba", distribb", etc. provided in the standard text file. However, the text of a non-standard distribution statement can be entered directly between the "distrib" start- and end-tags. (Remember to specify a value for the "type" attribute on the "distrib" start-tag.)

2.9 DOCPMS: PMS Document Root Element

This tag identifies the document level (root or highest order) element type for a PMS document instance.

The value of its "security" attribute ("u", "nf", "c", or "s") specifies the security status of a PMS document as "unclassified", "NOFORN", "confidential", or "secret" respectively. The "security" default value is "u".

2.10 LCNO: Library Control Number

This tag identifies the (#PCDATA) library control number for the document.

2.11 MER: Maintenance Effectiveness Review Statement

This element contains the "&merstatement;" general entity reference providing the "Maintenance Effectiveness Review (MER) Analyzed" standard text at the top of the first page above the top line of a MIP or MRC.

There are three attributes which must be specified on this tag. The first attribute "month" takes one of the values: "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", or "December".

The second attribute "day" takes one of the values "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 11", '12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", or "31".

The third attribute "year" is the four-digit year, e.g., "1999".

2.12 MHOURS: Manhours

This tag identifies the manhours for a specific rating(s) in the MAN HOURS entries in a MIP or the MH entries in an MRC. Its content model is (#PCDATA).

2.13 MRCCNO: MRC Control Number

This tag identifies the MRC control number for an MRC referenced in a MIP document or the MRC control number identifying an MRC document. The content consists of "bdi" markup (the MRC birthdate), "lcno" markup (the library control number/SYSCOM code), and an "rpreq" tag (the repair parts required/parts indicator) where the "value" attribute must be specified as "N", "Y", or "U".

Its sole attribute "noentry" can only take the value of "yes". When this attribute is specified, the "mrccno" markup consists only of the "mrccno" start-tag (i.e., '<mrccno noentry="yes">') without any subelement markup or an "mrccno" end-tag since "noentry" is a #CONREF attribute. The purpose of the "noentry" attribute is to provide a placeholder when no MRC document occurs in the SYSCOM MRC CONTROL NO column.

2.14 RATE: Rate(s)

This tag identifies the rates, i.e., the rating(s) of the Navy personnel, required for a specific maintenance procedure in the RATES entries in a MIP or MRC. Its content model is (#PCDATA).

2.15 RPREQ: Repair Parts Required

This tag identifies the required repair parts information for an MRC control number through the value of its attribute "value" on the "rpreq" tag.

The "N", "Y", or "U" values of this required attribute specify the status of the repair parts, i.e., whether or not they are required or whether this is unknown.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

2.16 SWABGRP: Ship System SWAB Group

This tag identifies the optional CDATA SWAB group information in the ship system description in a MIP document and in the ship system, system, subsystem, and equipment of an MRC document. Its content model is (#PCDATA).

2.17 SYSDES: System Description

This tag identifies the system description in the ship system description in a MIP document and in the ship system, system, subsystem, and equipment of an MRC document. The content consists of markup of the "%text;" options.

3. ELEMENTS USED IN THE MIP MODELLING

3.1 ADDRESS: Address

The content of this element type provides the manufacturer's name as well as other optional information (street address, phone number, etc.) in the form of items of a sequential list. The content consists of "manufact" markup followed by optional "seqlist" content.

3.2 CONFIG: Configuration

This tag identifies the configuration information for a MIP document in the CONFIGURATION block. The content consists of markup of the "%paracon;" options, as well as "table"/"chart" and "address" markups along with included "ftnref", "ftnote" and "note" markups.

3.3 INACTIVE: Inactive Equipment Maintenance

This tag identifies the optional lay-up, periodic, start-up, and operational test maintenance information for an MIP document. The content consists of the "inactnote" tag followed by an optional sequence comprised of "layup", "periodic", "startup", and "optest" markups.

3.4 INACTNOTE: Inactive Equipment Maintenance Note

This element contains the "inactnote;" general entity reference providing the "The following requirements will be scheduled when equipment is inactivated for periods of prolonged idleness." standard text at the head of the INACTIVE EQUIPMENT MAINTENANCE section of an MIP document.

3.5 LAYUP: Lay-Up Maintenance

This tag identifies the lay-up equipment maintenance information (if any) in terms of "maintline" contents in an MIP document. The content consists of optional "maintline" markup.

3.6 LEGEND: Legend

This tag identifies the "ftnote" contents corresponding to those "*", "**", "#", "K", "M", "N", "R", and "X" footnote texts which are present in the MIP document. The content consists of one or more "ftnote" markups provided by referencing entities provided in the standard texts file.

3.7 MAINTLINE: Line of Maintenance Procedure

This tag identifies the information describing a maintenance procedure in the required maintenance procedures and the inactive maintenance categories of lay-up, periodic, start-up, operational test, and unscheduled maintenance.

The content consists of: "test" markup (TEST entry), "other" markup (OTHER entry), a choice of "extref" markup containing "mrccno" markup or only an "mrccno" start-tag (SYSCOM MRC CONTROL NO entry), "mrdes" markup (MAINTENANCE REQUIREMENT DESCRIPTION entry), "prdcd" markup (PERIODICITY CODE entry), optional "rateqty" markup followed by "rate" markup (RATES entry), "mhours" markup (MANHOURS entry), and "relmaint" markup (RELATED MAINTENANCE entry).

3.8 MAINTREQ: Required Maintenance Procedures

This tag identifies the required maintenance procedures. The content consists of "maintline" markups.

3.9 MANUFACT: MANUFACTURER NAME

This tag identifies the manufacturer's name in the optional "address" markup in "config" content (CONFIGURATION block). The content is parsed character data.

3.10 MBRID: Main Body Record Identification

This tag identifies the required maintenance procedures, the optional unscheduled maintenance information, and the inactive equipment maintenance in a MIP document. The content consists of "maintreq" markup followed by optional "unsched" markup, required "inactive" markup, and optional "icmpmaintreq" markup.

3.11 MIP: Maintenance Index Page

This tag identifies an MIP document instance.

The content of the "mip" element type consists of an optional "mer" start-tag, "mipcno" markup, a "date" start-tag, "comspcode" markup, "shipdes" markup, "refpubs" markup, "config" markup, "schedaid" markup, optional "legend" markup, and "mbrid" markup.

3.12 MIPCLASS: MIP Classification

This tag identifies the optional MIP classification for a maintenance procedure system in an MIP document. The content model is (#PCDATA).

3.13 MIPCNO: MIP Control Number

This tag identifies the MIP control number for an MIP document. The content consists of "mipsys" markup (the maintenance procedure system), "mrseq" markup (the maintenance requirement sequence), and "bdi" markup (the birthdate indicator).

3.14 MIPGRP: MIP Group

This tag identifies the MIP group for a maintenance procedure system in an MIP document. The content model is (#PCDATA).

3.15 MIPSYS: MIP System

This tag identifies the maintenance procedure system of a MIP control number for an MIP document. The content consists of optional "mipclass" markup (MIP classification) and "mipgrp" markup (MIP group).

3.16 MRDES: Maintenance Requirement Description

This tag identifies the description of the required maintenance for the different maintenance categories in an MIP document. The content consists of "seqlist" markup followed by optional "note" markups.

3.17 MRSEQ: Maintenance Requirement Sequence

This tag identifies the CDATA maintenance requirement sequence for a maintenance procedure system in an MIP document. The content model is (#PCDATA).

3.18 NOMEN: Ship System Nomenclature

This tag identifies the nomenclature information in the ship system description in an MIP document and in the ship system, system, subsystem, and equipment of an MRC document. The content consists of parsed character data and "subscrpt" and "supscrpt" markups.

3.19 OPTEST: Operational Test

This tag identifies the operational test maintenance equipment information in an MIP document. The content consists of optional "maintline" markups.

3.20 OTHER: Other

This tag identifies any relevant information (other than the test status and the MRC control number) necessary to identify a maintenance procedure in the OTHER entries of an MIP document. The content consists of character data or an "ftnref" tag possibly followed by character data as follows.

The "other" content could be the security classification characters "C" or "S" for the required maintenance procedure. The "other" content could also be an "ftnref" tag providing a footnote reference to one of the "K", "M", "N", "R", or "X" footnote texts. "C" and "S" could also follow one of these "K", "M", "N", "R", or "X" "ftnref" tags in the "other" content.

3.21 PERIODIC: Periodic Maintenance

This tag identifies the periodic maintenance procedures in an MIP document. The content consists of optional "maintline" markups.

3.22 PRDCD: Periodicity Code

This tag identifies the periodicity code for a procedure in the PERIODICITY CODE entries of a MIP document. The content consists of character data possibly followed by a "ftnref" tag providing a footnote reference to either the "*" or "**" footnote texts.

3.23 RATEQTY: Rating Quantity

This tag identifies the rating quantity information (number of ratings, i.e., Navy personnel) in the Maintenance Procedure line. Its content model is (#PCDATA).

3.24 REFPUBS: Reference Publications

This tag identifies the reference publications (if any) cited in the REFERENCE PUBLICATIONS block of a MIP document. Its optional content consists of one or more sequential list markups.

3.25 RELMAINT: Related Maintenance

This tag identifies the related maintenance information for a required maintenance procedure in the RELATED MAINTENANCE entry of a MIP document. The content consists of parsed character data possibly followed by a "ftnref" tag providing a footnote reference to the "#" footnote text.

3.26 SCHEDAID: Scheduling Aid(s)

This tag identifies the scheduling aid procedures in a MIP. The content consists of an optional "seqlist" markup.

3.27 SHIPDES: Ship System Description

This tag identifies the ship system description information for an MIP document. The content consists of one or more sequences comprised of "sysdes" markup (system description), optional "nomen" markups (ship system nomenclature), optional "testcode" markups (ship system test codes) and optional "swabgrp" markups (ship system SWAB groups).

3.28 STARTUP: Start-Up Maintenance

This tag identifies the start-up equipment maintenance procedures for a MIP document. The content consists of optional "maintline" markups.

3.29 TEST: Test

This tag identifies information in the TEST column. The TEST entry may contain (#PCDATA) test information consisting of one of the characters "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", or "K" for a required maintenance procedure in an MIP document.

3.30 TESTCODE: Test Code

This tag identifies the optional test code information in the ship system description of a MIP document. The content is parsed character data.

3.31 UNSCHED: Unscheduled Maintenance

This tag identifies the unscheduled maintenance procedures for an MIP document. The contents consists of optional "maintline" markups.

4. ELEMENTS USED IN THE MRC AND LOCCARD MODELLING

4.1 DENOM: Fraction Denominator

This tag identifies the denominator in the markup of a fraction in "equation" content in the "formula" markup of mathematical notation. The content is character data as well as "subscpt", "supscrpt", and "emphasis" markup.

4.2 DISPOSMETHS: Disposal Methods

This tag identifies the disposal methods in the DISPOSAL METHODS block of an MRC document as the definitions of a definition list. The content consists of "deflist" content.

NOTE: The disposal method(s) can be specified in two ways. One or more of the "disposmeth" general entities in the "PMSstandtexts" entity set can be referenced between the "disposmeths" start- and end-tags to provide the text of standard disposal methods or the text of a non-standard disposal methods can be entered directly in the format:

<term>Method Identification:</term>
<def><paratext>Method Text</paratext></def>

4.3 DPMETH: Disposal Method Number Component of HMUG Statement

This tag provides the text "Disposal Method" which is followed by the disposal method number provided by the value of the "dpmethno" attribute on the "dpmeth" tag.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

4.4 ELTIME: Elapsed Time

This tag identifies the elapsed time for the required maintenance procedures in an MRC document in the ELAPSED TIME entry. Its content model is (#PCDATA).

4.5 EQUATION: Equation

This tag identifies an equation in the content of "formula" markup of mathematical notation. The content consists of parsed character data, as well as "subscrpt", "supscrpt", "emphasis" and "frac" markup, in addition to "graphic" tags.

4.6 EQUIP: Equipment

This tag identifies the equipment for the maintenance procedures specified in the EQUIPMENT block of an MRC document. The content consists of one or more "equipline" contents.

4.7 EQUIPLINE: Equipment Line

This tag identifies the equipment comprising an equipment line in the description of equipment in the EQUIPMENT block. An equipment line contains one system description and related information for the systems comprising the maintenance procedure equipment requirements.

The content consists of the following: a choice between a pair of "sysdes" markup (system description) and optional "nomen" markups (ship system nomenclatures) or one or more "nomen" markups; this choice can be followed by optional "swabgrp" markups (ship system SWAB groups). The "equipline" subelement type is necessary because its repeated content model would be ambiguous (i.e., non-deterministic for parser processing).

4.8 FISCDATA: Fiscal Data

This tag identifies the fiscal data (ratings and time information) in an MRC document. The content consists of optional "rateqty" and "rate" markups (both provided in the RATES entry) as well as "mhours" markups (MH entry) followed by required "totalmh" (TOTAL MH entry) and "eltime" markups (ELAPSED TIME entry).

4.9 FORMULA: Formula

This tag identifies the markup of mathematical notation. The content consists of one or more "equation" markups followed by an optional "deflist" markup.

The optional "type" attribute takes the values of "inline" or "display" which determines how the mathematical notation is to be presented.

4.10 FRAC: Fraction

This tag identifies the markup of a fraction in "equation" content of a "formula" markup of mathematical notation. The content consists of "num" markup followed by "denom" markup.

4.11 GRP: HMUG Group Number Component of HMUG Statement

This tag causes the formatter to provide the text "Hazardous Material User's Guide (HMUG) Group" which is followed by the group number provided by the value of the "grpno" attribute on the "grp" tag.

NOTE: Since this element type has EMPTY declared content, no end-tag must be present.

4.12 HAZMATPARA: Hazardous Material Paragraph

This element contains the "&hazmatpara;" general entity reference providing the Hazardous Material Paragraph standard text under the heading provided by the "hazmatstate" start-tag.

4.13 HAZMATSTATE: Hazardous Material Statement

This tag causes the formatter to provide the "HAZARDOUS MATERIALS CONTROL STATEMENT(U):" heading for the Hazardous Materials ControlStatement. Its content consists of a "hazmatpara" start-tag.

4.14 HMUGSTATE: HMUG (Hazardous Material User's Guide) Statement

This tag identifies the HMUG group number and disposal method number components of the standard HMUG statement identifying a hazardous material in the TOOLS, PARTS, MATERIALS, TEST EQUIPMENT block of an MRC document. Both or either of these components may be present in an HMUG statement. The content consists of either a "grp" tag followed by an optional "dpmeth" tag or just a "dpmeth" tag.

4.15 LOC: Location

This tag identifies the location in an MRC document. The content consists of parsed character data possibly containing "subscrpt" markups.

4.16 MAINTREQDES: Maintenance Requirement Description

This tag identifies a description of the required maintenance procedures in the MAINTENANCE REQUIREMENT block of an MRC document. The content consists of at least one "topic" markup.

4.17 MATERIALS: Materials

This tag identifies a description of the required materials for the maintenance procedures in an MRC document. The content consists of "seqlist" markup possibly containing included "hmugstate" markups.

4.18 MIPSER: MIP Series

This tag identifies a MIP series in the MRC code for an MRC document. The content model is (#PCDATA).

4.19 MISC: Miscellaneous

This tag identifies any miscellaneous requirements for the maintenance procedures in an MRC document. The content is "seqlist" markup possibly containing included "hmugstate" markups.

4.20 MRC: Maintenance Requirement Card

This tag identifies an MRC document instance. The content consists of an optional "mer" start-tag, "mrccno" markup, a "date" start-tag, "mrccode" markup, optional "icmpno" markup, "comspcode" markup", "loc" markup, "shipsys" markup, "sys" markup, "subsys" markup, "equip" markup, "fiscdata" markup, "maintreqdes" markup, "safeprecs" markup, "toolsetc" markup, optional "hazmatstate" markup, "procblk" markup, and optional "disposmeths" markup.

4.21 MRCCODE: MRC Code

This tag identifies the MRC code for an MRC document. The content consists of at least one "mipser" markup followed by at least one "mrpcode" markup. Note that the number of "mipser" and "mrpcode" markups may be different, i.e., not one to one.

4.22 MRPCODE: Maintenance Requirement Periodicity Code

This tag identifies a maintenance requirement periodicity code in the MRC code for an MRC document. Its content model is (#PCDATA).

4.23 NUM: Fraction Numerator

This tag identifies the numerator in the markup of a fraction in "equation" content in the "formula" markup of mathematical notation. The content is parsed character data as well as "subscpt", "supscrpt", and "emphasis" markup.

4.24 PARTS: Parts

This tag identifies the part requirements for the maintenance procedures in an MRC document. The content is "seqlist" markup possibly containing included "hmugstate" markups.

4.25 PRESTEPS: Preliminary Steps

This tag identifies the optional preliminary steps for the maintenance procedures in an MRC document. The content consists of "seqlist" markup which may contain included "note", "caution", "warning", "table"/"chart", or "figure" markups subject to certain restrictions described in the Tagging Conventions.

4.26 PROCBLK: Procedural Block

This tag identifies the procedural block consisting of the optional preliminary steps and the required procedural steps for the maintenance procedures in the PROCEDURE block of an MRC document. The content consists of optional "presteps" markup followed by "procsteps" markup. The content may contain included "note", "caution", or "warning" contents.

4.27 PROCSTEPS: Procedural Steps

This tag identifies the required procedural steps for the maintenance procedures in an MRC document. The content consists of one or more "seqlist" markups which may contain included "note", "caution", "warning", "table"/"chart", or "figure" markups subject to certain restrictions described in the Tagging Conventions.

The "title" contents of these "seqlist" markups correspond to (and are linked to) the "topic" contents in the "maintreqdes" markup. However, these "title" and "topic" contents are capitalized differently.

4.28 SAFEPRECS: Safety Precautions

This tag identifies any required safety precautions for an MRC document. The content is "seqlist" markup.

NOTE: The safety precautions can be specified in two different ways. One or more of the general entities providing the text of commonly-used safety precautions in the Safety Message entity file can be referenced (e.g., "&SM001;") between the "<item><paratext>" and "</paratext></item> markups in the "seqlist" content. Alternately, the text of non-standard safety precautions can be entered directly in the same way.

4.29 SHIPSYS: Ship System

This tag identifies the ship system information in the SHIP SYSTEM block of an MRC document. The content consists of an optional and repeatable sequence comprised of "sysdes" markup (system description), optional "nomen" markups (ship system nomenclatures), and optional "swabgrp" markups (ship system SWAB groups).

4.30 SPMIGNOTE: Standard PMS Materials Identification Guide Note

This element contains the "&spmignote;" general entity reference providing the Standard PMS Materials Identifying Guide Note standard text at the end of the TOOLS, PARTS, MATERIALS, TEST EQUIPMENT block in an MRC document. However, if the tools, parts, materials, test equipment information consists of "None" or no spin numbers are present, this text is not present.

4.31 SUBSYS: Subsystem

This tag identifies the ship subsystem in the SUBSYSTEM block of an MRC document. The content consists of an optional and repeatable sequence of "sysdes" markup (system description), optional "nomen" markups (ship system nomenclatures), and optional "swabgrp" markups (ship system SWAB groups).

4.32 SYS: System

This tag identifies the system in the SYSTEM block of an MRC document. The content consists of an optional and repeatable sequence comprised of "sysdes" markup (system description), optional "nomen" markups (ship system nomenclatures), and optional "swabgrp" markups (ship system SWAB groups).

4.33 TESTEQUIP: Test Equipment

This tag identifies the test equipment requirements for the maintenance procedures in an MRC document. The content consists of "seqlist" markup possibly containing included "hmugstate" markups.

4.34 TOOLS: Tools

This tag identifies tool requirements for the maintenance procedures in an MRC document. The content consists of "seqlist" markup possibly containing included "hmugstate" markups.

4.35 TOOLSETC: Tools, Parts, Materials, Test Equipment

This tag identifies the tool, part, material, test equipment, or miscellaneous requirements for the maintenance procedures in the TOOLS, PARTS, MATERIALS, AND TEST EQUIPMENT block of an MRC document. The content consists of "testequip", "material", "parts", "tools", and "misc" markups (all of which are optional) followed by an optional "spmignote" tag.

4.36 TOPIC: Topic

This tag identifies a topic enumerated in the MAINTENANCE REQUIREMENT DESCRIPTION block in an MRC document. The content consists of markup of the "%text;" options.

The value of the required "idref" attribute is that of the "id" attribute on the corresponding "title" tag in the "seqlist" contents in the "procsteps" content (Procedural Steps section of the PROCEDURE Block). This element type also has the CDATA attribute "label".

4.37 TOTALMH: Total Manhours

This tag identifies the total manhours (TOTALMH entry) for the maintenance procedures in an MRC document. Its content model is (#PCDATA).

5.0 ELEMENTS USED IN THE LOCCARD MODELLING

5.1 LOCCARD: Locator Card Document

This tag identifies a Locator Card Document. The content consists of "mrccno" markup, a "date" start-tag, "mrccode" markup, optional "icmpno" markup, "comspcode" markup", "loc" markup, "shipsys" markup, "sys" markup, "subsys" markup, "equip" markup, "fiscdata" markup, "locmrd" markup, "safeprecs" markup, "toolsetc" markup, optional "hazmatstate" markup, and "locprocblk" markup.

5.2 LOCMRD: Locator Card Maintenance Requirement Description

This element contains the Locator Card Maintenance Requirement Description. Its content is a sequential list.

5.3 LOCPROCBLK: Locator Card Procedure Block

This element contains the Locator Card Procedure Block. The content consists of an optional "note" markup followed by "mrcclass" markup followed by "stowed" markup.

5.4 MRCCLASS: MRC CLASSIFICATION

This element contains the MRC security classification provided by the "&confid;", "&noforn;", or "&secret;" general entity references.

5.7 STOWED: Stowed Statement

This element contains the "&stowed;" general entity reference providing the "Maintenance Requirement Card is stowed in _________________." standard text in the Locator Card Procedure Block.

6.0 ELEMENTS USED TO ACCOMMODATE THE ICMP DOCUMENT

6.1 ICMPMAINTLINE: ICMP Maintenace Requirement

This element contains the following markups: a choice of "extref" or "mrccno" markups; a sequence of "mrdes", "icmpno", and "prdcd" markups; a required and repeatible sequence of optional "rateqty" markup, required "rate" markup, and required "mhours" markup; and required and repeatible "relmaint" markup.

6.2 ICMPMAINTREQ: ICMP Maintenance Requirements Section

This element contains optional and repeatible "icmpmaintline" markups.

6.3 ICMPNO: ICMP Serial Number

This element contains a sequence of "prefix", eswbs", "seq", and "rev" markups.

6.4 PREFIX: ICMP Task Code (one character)

This element contains the one character ICMP Task Code.

6.5 REV: ICMP Revision

This element contains the one character ICMP revision.

6.6 SEQ: ICMP Sequence

This element contains the not more than two digits ICMP sequence.

6.7 SEWBS: ICMP ESWBS Code

This element contains the five digits ICMP ESWBS code.