XML for Aircraft Checklist Procedures

Related documents

• Template Markup Language (TML) Reference

Table of Contents

• Introduction
  • Checklist XML philosophy
  • Defining procedures
  • Checklist procedure elements
  • Step numbers
  • Amplifications
  • References to other procedures
  • Crew alert messages
  • Labels
  • Next and previous procedure
  • When to use <ClDecisionGroup>
  • Speaking procedures
  • Common checklist attributes
  • Including the content of other procedures.
• Correspondence with Daher procedure XML elements
• Procedure elements
  • <ClProcedureGroup>
  • <ClProcedure>
  • <ClInformation>
  • <ClDescription>
• Simple checklist elements
  • <ClAdvisoryNote>
  • <ClAmplifiedText>
  • <ClCautionNote>
  • <ClCustomLine>
  • <ClDirective>
  • <ClEop>
  • <ClFigure>
  • <ClSituation>
  • <ClStep>
  • <ClText>
  • <ClWarningNote>
• Group elements
  • <ClAlternativesGroup>
  • <ClConditionalGroup>
  • <ClDecisionGroup>
  • <ClBody>
  • <ClMemoryGroup>
  • <ClNamedGroup>
• Other elements
  • <ClAlert>
  • <ClConditionHeading>
  • <ClCustomText>
  • <ClHeading>
  • <ClLabel>
  • <ClShortConditionHeading>
  • <ClShortTitle>
  • <ClStepAction>
  • <ClStepAmplification>
  • <ClStepNote>
  • <ClStepObject>
  • <ClTitle>

Introduction

Aircraft checklist procedures are specified in Template Markup Language (TML). TML will accept formal XML as input (without the <?xml> header). However, you are free to use TML's looser formatting. For example, single-word attribute values need not be quoted, and closing tags need not include the opening tag name. TML is required because the checklist contents may contain instantiations of app components, including state variables, TML entities, and references to pages, help, diagrams, and other procedures.

The checklist elements are designed to accommodate a variety of information that a pilot might need in the cockpit, including flight procedure checklists, avionics procedures, information for non-procedural indications, and longer system descriptions.

Typically, the procedures for each model are kept in separate .tml files that are read and converted into templates when the user defines an aircraft. A .tml file is read and processed as text, not as a template string. This means that dynamic references (i.e., ${...}) are not processed and will be treated as text. However, references to state variables (e.g., {{stateVarName}}) and defined TML entities (e.g., &directTo;) are permitted.

The TML is processed using a tagNamespace property containing checklist-specific tags. The app template tags are still available since the tagNamespace overlays the others.

Checklist XML philosophy

The checklist XML is designed so that the tags carry the checklist semantics, the attributes contain metadata such as procedure IDs or applicability, and the contents contain the procedure text, including HTML or TML tags for state variables and formatting.

Defining procedures

The file contains one or more <ClProcedureGroup> elements, each containing procedures for aircraft that match the applicability string in the value of the appliesTo attribute. See Common checklist attributes below. Each <ClProcedureGroup> element contains one or more of the following elements:

• <ClProcedure>
  A formal checklist procedure.
• <ClInformation>
  A brief piece of information, usually a single paragraph of prose associated with aircraft indications that lack formal checklist procedures (e.g., a G1000 message). These are presented in a suitable form, such as pop-up notices.
• <ClDescription>
  A longer description. It may contain several paragraphs and headings. For example, a description of the fuel system from POH section 7. These are presented in a suitable form, such as a pop-up scrollable page.

Each element has an id attribute containing the element's ID string. After processing, the template for each procedure in the model will appear in acData.checklist.procedures.<id> when the aircraft model is currently selected. See acData.

Each of the above elements may contain a <ClTitle> element with the title of the procedure. It may also optionally include a <ClShortTitle> element with a shortened title. If present, the shortened title is used instead of the procedure title as the text in a selectable list element or button. A shortened title is appropriate where the procedure title is too long, or it's more appropriate to use a <ClAlert> element as the selectable title. If the above elements don't have a title, then the element is not directly selectable by users, but it is available for inclusion in other procedures.

Checklist procedure elements

The <ClProcedure> element must have a <ClBody> element as a direct child. The <ClBody> element contains the body of the procedure; its steps, text, notes, etc. If a procedure has an amplified version, then there can be two <ClBody> elements, each containing the amplified and unamplified version.

Procedure bodies may have:

• Numbered steps.
  Each step must contain an action (a.k.a., a response). It may optionally contain an object (a.k.a., a challenge), a note, a condition, or an amplification. Steps are defined by the <ClStep> element.
• Textual items that provide information.
  Textual items typically describe symptoms or aircraft states. For example, systems that will be unavailable after an action. Steps are defined by the <ClText> element.
• Textual directives that are emphasized.
  Directives are typically used for general decisive action to take, such as "Fly the airplane" outside of a numbered step, and are defined by the <ClDirective> element.
• Memory item steps, text, or directives.
  Memory items are expected to be memorized. They are distinguished visually and are not selectable. Memory items are defined by the <ClMemoryStep>, <ClMemoryText>, and<ClMemoryDirective> elements.
• Highlighted notes.
  The notes are distinguished visually according to whether they are advisory, cautionary, or warning notes. They are defined by the <ClAdvisoryNote>, <ClCautionNote>, and<ClWarningNote> elements.
• Conditions to wait for.
  These are textual descriptions of conditions to wait for before proceeding with the checklist. Examples of conditions to wait for are: "When Ng is > 50%:" or "Wait for 10  seconds". These conditions are defined by the <ClSituation> element.
• Conditional groups
  Groups of procedure items that should only be executed if a condition is true and are skipped if the condition is not true. When displayed, the child elements are preceded by the condition and are visually differentiated (e.g., by indenting) to show that they should be executed only when the condition applies. The conditional group is defined by the <ClConditionalGroup> element. The procedure to be executed under the condition is defined by a child <ClBody> element.
• Procedure branches
  Groups of procedure items where only one group should be executed based on a condition. When displayed, the user sees a condition to evaluate and a selector to choose one of the possible states of the condition. Only the steps associated with the selected state are shown. The group is defined by the <ClDecisionGroup> element. Each branch is defined by a child <ClConditionalGroup> element.
• Alternative procedures
  Groups of procedure items that represent alternative ways of executing a procedure. When displayed, each alternative is visually represented as an alternative method of completing a task. Each alternative is defined by a child <ClBody> element.
• Named groups
  When displayed, the child elements are preceded by the heading and are visually differentiated (e.g., by indenting) to show that they are part of the group. Typically used when the grouped procedure elements are all associated with a common system. The group is defined by the <ClNamedGroup> element.

The textual content or procedure elements can contain any valid TML, including HTML (e.g., tables), state variables, and app components.

Step numbers

The checklist automatically calculates the step numbers. This allows for the seamless insertion of steps related to optional POH Supplements in the appropriate position within the checklist. However, the step numbers displayed in the procedure may not precisely align with those in the POH.

Amplifications

Aircraft checklists often have "amplified" versions of some procedures. These contain additional details that the pilot should know when executing the procedure. Some manufacturers provide the additional details only within each step. This is represented using a <ClStepAmplification> element in the relevant steps, which are displayed only when an amplified procedure is requested. Others have expanded checklists with additional elements. This can be accommodated by setting the type attribute in procedure elements or groups to amplified. This will display the element only when an amplified procedure is requested. Setting the type attribute to unamplified will hide the element when an amplified procedure is requested. Setting the type attribute to normal or omitting it will display the element when either an amplified or unamplified procedure is requested.

References to other procedures

The textual content may include references to other procedures. The <Ref> component ref attribute recognizes values of the form cl.<procedureId> as a reference link to procedureId. Clicking the link will display a popup page with the linked procedure. The referencing procedure will again be displayed when the popup page is dismissed.

Crew alert messages

The textual content may include crew alert messages. These typically have a distinctive formatting that depends on the source device (e.g, G1000), the system within the device (e.g., MFD engine indication system), and the alert type (e.g., warning). The <ClAlert> element formats the message to appear as it does on the device.

Labels

Many checklist items involve acting on buttons or switches named by their labels. You may use the <ClLabel> element to contain the label text.
When displayed, the label text will be distinguished from the surrounding prose to avoid confusion.

Next and previous procedure

POH section 4 "Normal" procedures often have an obvious flow of procedures. For example, the "Engine start" procedure is often followed by the "Taxi" procedure. You can indicate the next and previous procedures by setting the nextProcedure and prevProcedure attributes in the <ClProcedure> element to the respective procedure IDs. This allows the user to advance to the next procedure by pressing the &rightCaret; button when a procedure is complete, or return the the previous procedure by pressing the &leftCaret; button.

When to use <ClDecisionGroup>

Procedure branches can be expressed as either a series of mutually exclusive conditional groups using <ClConditionalGroup> elements or as a decision group using a <ClDecisionGroup> element that contains the conditional groups. A decision group is preferable when there are more than two or three alternatives and/or when some alternatives involve several steps. This approach enables users to quickly remove undesired paths from the display. Conversely, when there are only two or three alternatives and each conditional group has only one or two steps, it may be better to use conditional groups, as all alternatives are presented in a compact visual space and the user is not required to mechanically choose one.

Speaking procedures

Procedures can be spoken using speech-to-text. This is useful when a procedure serves as a "do list," allowing users to go through each item without constantly looking down at the list. It is also helpful after performing a procedure by flow and then verifying it using the checklist. The user can choose to advance to the next step by pressing a "next" button or to advance automatically (autoplay) after a delay. Both the speech rate and delay are adjustable.

Conditional groups, procedure branches, alternatives, and situations will prevent advancing using autoplay or the "next" button. This makes procedures that have several of these elements not suitable for speech. You may indicate that a procedure is suitable for speech by setting the speak attribute in the <ClProcedure> element to true. Typically, only the POH section 4 "Normal" procedures are suitable for speech.

Common checklist attributes

Several attributes apply to <ClProcedure> elements and both simple and group procedure elements.

• appliesTo
  The appliesTo value can be an internal or external model ID with a serial number range that uses the applicability string syntax. For example, 910E1 or 910:1124-. The element is included only if the current aircraft matches the applicability string.
• notAppliesTo
  The inverse of the appliesTo attribute. True if the applicability string is false.
• option
  The option value is an option ID expression: A string containing option IDs, and the operators &, |, ^, and ! representing logical AND, OR, XOR, and NOT, respectively. Parentheses are used for grouping, along with spacing characters. The element is included only if the expression is true for the installed options on the current aircraft.
• type
  The type value can be amplified, unamplified, or normal. If the value is amplified, the element remains hidden when an unamplified checklist is requested. If the value is unamplified, the element is hidden when an amplified checklist is requested. Hidden elements will not receive a step number. Elements without a type attribute or those with a type attribute value of normal will not be hidden, regardless of amplification requests.
• ui
  The ui value can be either wide or narrow. If set to wide the element is displayed when the viewport width is considered wide (e.g., the current navigation style is tab). If set to narroe the element is displayed when the viewport width is considered narrow (e.g., the current navigation style is slide). One use of ui is to present tables in a wide vs. narrow format depending on the width of the viewport.

Including the content of other procedures.

In some cases, it is desirable to include the content of one procedure in another procedure. For example, to list the procedure under an alert message instead of the full title. The <ClBody> element has a useProcedure attribute that specifies a procedure ID. The <ClBody> elements in that procedure will be incorporated as the children of the referencing element. Any other children are ignored.

Correspondence with Daher procedure XML elements

Many of these elements roughly correspond in meaning to elements on Daher's internal checklist XML:

Procedure elements

Procedure elements define a set of procedures, information, or system descriptions that the user can choose when required.

<ClProcedureGroup>

Syntax

tml`
	<ClProcedureGroup appliesTo="...">
		...
	</ClProcedureGroup>
`

The <ClProcedureGroup> element contains procedures for particular aircraft models and/or serial numbers specified by the appliesTo attribute.

Attributes

• appliesTo
  An applicability string specifying the aircraft that this procedure group applies to.

Children

The following elements are valid children:

• <ClProcedure>
• <ClInformation>
• <ClDescription>
  All other elements are invalid and are ignored.

<ClProcedure>

Syntax

tml`
	<ClProcedure id=procedureId>
		<ClBody>
			...
		</ClBody>
	</ClProcedure>
`

The <ClProcedure> element contains a checklist procedure. The id attribute specifies the procedure ID string, and the procedure template will appear in acData.checklist.procedures.<id> when the aircraft model is currently selected.

If a <ClTitle> is provided, then the procedure is user selectable. Otherwise, the procedure may be included in other procedures using the <ClBody> element with the useProcedure attribute. If a <ClTitle> is provided, you may also provide a <ClShortTitle> element to specify a short title version for the selectable list item or button. You may not provide a <ClShortTitle> element unless a <ClTitle> is provided.

The <ClBody> element has the contents of the procedures. If more than one <ClBody> elements are provided, then they must be mutually exclusive. For example, the amplified and unamplified versions of the procedure.

Attributes

• id (required)
  A procedure ID string. The procedure template will appear in acData.checklist.procedures.<id> when the aircraft model is currently selected.
• nextProcedure (optional)
  The ID of the next procedure in a procedure sequence. If omitted, there is no next procedure.
• prevProcedure (optional)
  The ID of the previous procedure in a procedure sequence. If omitted, there is no previous procedure.
• speak (optional)
  A boolean that, if true, indicates that the procedure can be spoken using speech-to-text. If omitted or false, the procedure is not suitable for speaking.

In addition, the element supports the common checklist attributes.

Children

The following elements are allowed:

• <ClBody> (required)
• <ClTitle> (optional, singular)
• <ClShortTitle> (optional, singular)
  All other elements are invalid and are ignored.

<ClInformation>

Syntax

tml`
	<ClInformation>
		...
	</ClInformation>
`

<ClInformation> contains a brief piece of information, usually a single paragraph of prose associated with aircraft indications that lack formal checklist procedures (e.g., a G1000 message). These are presented in a suitable form, such as popup notices. The prose is contained in a <ClText> element.

If a <ClTitle> is provided, then the procedure is user selectable. Otherwise, the procedure may be included in other procedures using the <IncludeGroup> element. If a <ClTitle> is provided, you may also provide a <ClShortTitle> element to specify a short title version for the selectable list item or button. You may not provide a <ClShortTitle> element unless a <ClTitle> is provided.

Attributes

This element supports the common checklist attributes.

Children

The following elements are allowed:

• <ClText> (required, singular)
• <ClTitle> (optional, singular)
• <ClShortTitle> (optional, singular)
  All other elements are invalid and are ignored.

<ClDescription>

Syntax

tml`
	<ClDescription>
		...
	</ClDescription>
`

<ClDescription> contains a longer description, usually several paragraphs that may contain headings. For example, a description of the fuel system from POH section 7. These are presented in a suitable form, such as a popup scrollable page. The description is contained in a <ClText> element.

If a <ClTitle> is provided, then the procedure is user selectable. Otherwise, the procedure may be included in other procedures using the <IncludeGroup> element. If a <ClTitle> is provided, you may also provide a <ClShortTitle> element to specify a short title version for the selectable list item or button. You may not provide a <ClShortTitle> element unless a <ClTitle> is provided.

Attributes

This element supports the common checklist attributes.

Children

The following elements are allowed:

• <ClText> (required, singular)
• <ClTitle> (optional, singular)
• <ClShortTitle> (optional, singular)
  All other elements are invalid and are ignored.

Simple checklist elements

Simple checklist elements define checklist procedure items. They must be the direct children of a <ClBody> element in procedures.

<ClAdvisoryNote>

Syntax

tml`
	<ClAdvisoryNote>
		...
	</ClAdvisoryNote>
`

A <ClAdvisoryNote> element contains a specially displayed advisory note. The note text is horizontally justified within the checklist width, by default, but it may override this with HTML.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClAmplifiedText>

Syntax

tml`
	<ClAmplifiedText>
		...
	</ClAmplifiedText>
`

A <ClAmplifiedText> element contains an unnumbered line of procedure amplification text. It will only be displayed if amplifications are shown.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClCautionNote>

Syntax

tml`
	<ClCautionNote>
		...
	</ClCautionNote>
`

A <ClCautionNote> element contains a specially displayed cautionary note with a heading in amber text. The note text is horizontally justified within the checklist width, by default, but it may override this with HTML.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClCustomLine>

Syntax

tml`
	<ClCustomLine>
		...
	</ClCustomLine>
`

A <ClCustomLine> element contains an unnumbered line of non-POH content. It can be used for results from other parts of the app or a custom calculator.

Attributes

• viewWidth (optional)
  Specifies the viewport width that this line applies to. If omitted, the line applies to all widths. If provided, it can have one of the following values:
  • narrow
    A narrow viewport. This corresponds to the slide navigation style in MVCS.
  • wide
    A wide viewport. This corresponds to the tab navigation style in MVCS.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClDirective>

Syntax

tml`
	<ClDirective>
		...
	</ClDirective>
`

A <ClDirective> element contains an unnumbered line of procedure text that is displayed with emphasis. It is typically used to describe short non-procedural directives such as "Fly the airplane".

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClEop>

Syntax

tml`
	<ClEop />
`

A <ClEop> element indicated an end of procedure. If present, it should be the last element in a group or procedure.

Attributes

This element ignores all attributes.

Children

All children are invalid and are ignored.

<ClFigure>

Syntax

tml`
	<ClFigure>
		<img ...>
	</ClFigure>
`

A <ClFigure> element contains an unnumbered line that contains a procedure figure as an <img> or other element.

If a <ClHeading> element is provided, then its content will appear as the figure caption.

Attributes

This element ignores all attributes.

Children

• <ClHeading> (optional, singular)

The remaining children are a TML string that may include HTML with an <img> element.

<ClSituation>

Syntax

tml`
	<ClSituation>
		...
	</ClSituation>
`

A <ClSituation> element contains an unnumbered line of procedure text that contains a condition to wait for before checklist execution can proceed. The text must express the condition where execution can proceed. The text typically begins with "When".

If the checklist is automatically playing in spoken mode, playback will pause at this element, and must be restarted manually once the condition is satisfied.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClStep>

Syntax

tml`
	<ClStep>
		...
	</ClStep>
`

The <ClStep> element represents a numbered procedure step. It must contain one <ClStepAction> element representing the action to take. This is sometimes called the checklist "response". It may also contain <ClStepObject>, <ClConditionHeading>, <ClStepNote>, and/or <ClStepAmplification> elements, though it may only contain one instance of each. When present, a <ClStepObject> element represents the object the action is applied to. This is sometimes called the checklist "challenge". A <ClStepNote> element represents additional information that is always displayed. A <ClStepAmplification> element represents additional information that is only displayed when an amplified procedure is requested. A <ClConditionHeading> element represents a condition that must be present to execute the step.

When a <ClStepObject> element is present, the step is displayed in the traditional manner with the <ClStepObject> text (the "challenge") on the left and the <ClStepAction> text (the "response") on the right. Notes and/or amplification will appear below, if present. When a <ClStepObject> element is absent, <ClStepAction> starts on the left side of the step and occupies the width of the displayed step to the right of the number. When a <ClConditionHeading> element is present, it appears on the first line of the step, and the step contents are indented to make it clear that the contents only apply if the condition is true.

Attributes

This element supports the common checklist attributes.

Children

The following child elements are allowed:

• <ClStepAction> (required, singular)
• <ClConditionHeading> (optional, singular)
• <ClStepObject> (optional, singular)
• <ClStepNote> (optional, singular)
• <ClStepAmplification> (optional, singular)

<ClText>

Syntax

tml`
	<ClText>
		...
	</ClText>
`

A <ClText> element contains an unnumbered line of procedure text. It is typically used to describe symptoms or aircraft states. For example, systems that will be unavailable after an action. It is also used for the text contents of a <ClInformation> or <ClDescription> element.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClWarningNote>

Syntax

tml`
	<ClWarningNote>
		...
	</ClWarningNote>
`

A <ClWarningNote> element contains a specially displayed warning note with a heading in red text. The note text is horizontally justified within the checklist width, by default, but it may override this with HTML.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML, and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

Group elements

Group elements group simple checklist elements and other group elements. They must be the direct children of a <ClBody> element in procedures.

<ClAlternativesGroup>

Syntax

tml`
	<ClAlternativesGroup>
		<ClBody>
			...
		</ClBody>
		<ClBody>
			...
		</ClBody>
		...
	</ClAlternativesGroup>
`

The <ClAlternativesGroup> element present a set of alternative procedures for a user to choose from. It is used when there is more than one way to accomplish a desired task. All child elements represent the alternatives and consist of <ClBody> elements. Any attributes set in the element are passed down to the children by default. For instance, the alternatives apply only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

When displayed, the alternatives are presented in order. Each alternative is separated by a line containing "Or" and is indented to indicate the scope of each alternative.

If the checklist is automatically playing in spoken mode, playback will pause before this element, and the user must manually restart playback by selecting the next appropriate step.

Attributes

This element supports the common checklist attributes.

Children

The following children are allowed:

• <ClBody> (required, singular)

<ClConditionalGroup>

Syntax

tml`
	<ClConditionalGroup>
		<ClConditionHeading>...</ClCondition>
		<ClBody>
			...
		</ClBody>
		...
	</ClConditionalGroup>
`

The <ClConditionalGroup> element displays its children under a condition specified by a <ClConditionHeading> child element. The <ClBody> element contains the procedure to be executed under the condition. If more than one <ClBody> elements are provided, then they must be mutually exclusive. For example, the amplified and unamplified versions of the procedure.

Any attributes set in the element are passed down to the children by default. For instance, when the group applies only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

The <ClConditionalGroup> element may contain an optional <ClShortConditionHeading> element that specifies a shorter label for the condition when the <ClConditionalGroup> is a child of an <ClDecisionGroup> element.

When displayed, the group is preceded by the contents of the <ClConditionHeading> child element. The other child elements are indented to clarify that they should be skipped if the condition is false.

If the checklist is automatically playing in spoken mode, playback will pause before this element, and the user must manually restart playback by choosing the next appropriate step.

Attributes

This element supports the common checklist attributes.

Children

• <ClBody> (required)
• <ClConditionHeading> (required, singular)
• <ClShortConditionHeading> (optional, singular)
  All other elements are invalid and are ignored.

<ClDecisionGroup>

Syntax

tml`
	<ClDecisionGroup>
		<ClConditionHeading>...</ClCondition>
		<ClConditionalGroup>
			<ClConditionHeading>...</ClCondition>
			<ClShortConditionHeading>...</ClShortCondition>
		</ClConditionalGroup>
		<ClConditionalGroup>
			<ClConditionHeading>...</ClCondition>
			<ClShortConditionHeading>...</ClShortCondition>
		</ClConditionalGroup>
		...
	</ClDecisionGroup>
`

The <ClDecisionGroup> element enables users to choose which of its children to display. It is used when the procedure branches into two or more mutually exclusive alternatives. The element prompts the user to evaluate the state of a condition specified by the <ClConditionHeading> child element. All other child elements represent the alternative branches composed of <ClConditionalGroup> elements. Any attributes set in the element are passed down to the children by default. For instance, when the alternatives apply only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

Each <ClConditionalGroup> element may include an optional <ClShortConditionHeading> element. If this is present, the <ClShortConditionHeading> contents are used to label the alternative in the selector presented to the user. Otherwise, the group's <ClConditionHeading> element is used.

When displayed, the group begins with a selector to allow the user to choose a branch. The selector is preceded by the contents of the <ClConditionHeading> element, which is the direct child of the <ClDecisionGroup> element. The selector is followed by the indented contents of the selected branch.

If the checklist is automatically playing in spoken mode, playback will pause before this element, and the user must manually restart playback by choosing the next appropriate step.

Attributes

This element supports the common checklist attributes.

Children

The following children are allowed:

• <ClConditionHeading> (required, singular)
• <ClConditionalGroup> (required, multiple)
  Each <ClConditionalGroup> element may have a <ClShortConditionHeading> element.

<ClBody>

Syntax

tml`
	<ClBody>
		...
	</ClBody>
	<ClBody useProcedure=procedureId />
`

The <ClBody> element displays its children. All child checklist elements comprise the content of the group. Any attributes set in the element are passed down to the children by default. For instance, when the group applies only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

If the useProcedure attribute is provided, then its value is a procedure ID. In this case, the contents of <ClBody> elements in the referenced procedure become the content of this element.

Attributes

This element supports the common checklist attributes.

Children

The following simple checklist elements are allowed:

• <ClAdvisoryNote> (optional)
• <ClCautionNote> (optional)
• <ClDirective> (optional)
• <ClEop>
• <ClSituation> (optional)
• <ClStep> (optional)
• <ClText> (optional)
• <ClWarningNote> (optional)
  The following group checklist elements are allowed:
• <ClAlternativesGroup> (optional)
• <ClConditionalGroup> (optional)
• <ClDecisionGroup> (optional)
• <ClBody> (optional)
• <ClMemoryGroup> (optional)
• <ClNamedGroup> (optional)

<ClMemoryGroup>

Syntax

tml`
	<ClMemoryGroup>
		...
	</ClMemoryGroup>
`

The <ClMemoryGroup> element displays its children as memory items. All child checklist elements comprise the content of the group. Any attributes set in the element are passed down to the children by default. For instance, when the group applies only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

When shown, the child elements are visually identified as memory items. Memory item elements cannot be selected by users.

Attributes

This element supports the common checklist attributes.

Children

The following simple checklist elements are allowed:

• <ClAdvisoryNote> (optional)
• <ClCautionNote> (optional)
• <ClDirective> (optional)
• <ClEop>
• <ClSituation> (optional)
• <ClStep> (optional)
• <ClText> (optional)
• <ClWarningNote> (optional)

The following group checklist elements are allowed:

• <ClAlternativesGroup> (optional)
• <ClConditionalGroup> (optional)
• <ClDecisionGroup> (optional)
• <ClBody> (optional)
• <ClMemoryGroup> (optional)
• <ClNamedGroup> (optional)

<ClNamedGroup>

Syntax

tml`
	<ClNamedGroup>
		<ClHeading>...</Heading>
		<ClBody>
			...
		</ClBody>
		...
	</ClNamedGroup>
`

The <ClNamedGroup> element displays its children under a heading specified by a <ClHeading> child element. The <ClBody> element contains the named procedure elements. Any attributes set in the element are passed down to the children by default. For instance, when the group applies only if a specific option is installed or if the current aircraft falls within a certain range of serial numbers. However, each child may override the group attributes by specifying their own attributes.

When displayed, the group is preceded by the contents of the <ClHeading> child element. The other child elements are indented to clarify their association with the group under the heading.

Attributes

This element supports the common checklist attributes.

Children

• <ClHeading> (required, singular)
• <ClBody> (required)
  All other elements are invalid and are ignored.

Other elements

Other elements define sub-parts or metadata (e.g. titles) of the other elments types. They often contain procedure prose, headings, or titles.

<ClAlert>

Syntax

tml`
	<ClAlert dev="..." sys="..." type="...">...</>
`

A <ClAlert> element contains an aircraft device alert message. The alert is formatted according to the devise, sub-system, and message type specified but the dev, sys, and type attributes. Only the dev and type attributes are required.

When displayed, the alert message is formatted to resemble the appearance on the actual device. This is controlled by the CSS class for the element, which is composed as follows: clAlert_${dev}${sys ? '_'+sys : ''}-${type}. For example: clAlert_gifd1x_mfdEng-warning.

Attributes

This element only accepts the following attributes:

• dev (required)
  A string representing the device issuing the alert.
• sys (optional)
  A string representing the system issuing the alert within dev.
• type (required)
  The type of alert being issued.

The following table contains the currently valid dev attribute values for Garmin Integrated Flight Deck devices:

The following table contains the currently valid dev, sys, and type values:

For example:

<ClAlert dev=gifd1x sys=mfdEng type=warning>TORQUE</>
<ClAlert dev=cas type=warning>DOOR</>

Children

A TML string that may include HTML and TML entities. Other checklist elements are not supported.

<ClConditionHeading>

Syntax

tml`
	<ClConditionHeading>
		...
	</ClCondition>
`

A <ClConditionHeading> element contains a textual condition that precedes a condtional step or a conditional group. The text usually begins with an "If" and is visually marked as a condition, for example, by using italics. If the text does not have a colon (':') at the end then one is appended. Only one <ClConditionHeading> is allowed within each parent.

If the checklist is automatically playing in spoken mode, playback will pause before this element, and the user must manually restart playback by choosing the next appropriate step.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClCustomText>

Syntax

tml`
	<ClCustomText>
		...
	</ClCustomText>
`

A <ClCustomText> element contains non-POH text, including app page references or results.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML. Other checklist elements besides <ClAlert> are not supported.

<ClHeading>

Syntax

tml`
	<ClHeading>
		...
	</ClHeading>
`

A <ClHeading> element contains a heading that precedes a group. Only one <ClHeading> is allowed within each parent.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClLabel>

Syntax

tml`
	<ClLabel>
		...
	</ClLabel>
`

A <ClLabel> element contains text that should be visually distinguished as a button or switch label to avoid being taken as part of the surrounding prose.

Attributes

This element disregards all attributes.

Children

Plain text and HTML/TML elements.

<ClShortConditionHeading>

Syntax

tml`
	<ClShortConditionHeading>
		...
	</ClShortConditionHeading>
`

A <ClShortConditionHeading> element contains an alternative shortened textual condition that precedes a conditional group. You may only provide one <ClShortConditionHeading> element per parent. The <ClShortConditionHeading> element is ignored if the parent is not a direct child of a <clDecisionGroup> If the <ClShortConditionHeading> is provided then a <ClConditionHeading> must also be provided. If omitted, the <ClConditionHeading>, if any, is used.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML. Other checklist elements besides <ClAlert> are not supported.

<ClShortTitle>

Syntax

tml`
	<ClShortTitle>
		...
	</ClShortTitle>
`

A <ClShortTitle> element contains an alternative shortened title of the procedure for use in user-selectable elements. You may only provide one <ClShortTitle> element per parent. If the <ClShortTitle> is provided then a <ClTitle> must also be provided. If omitted, the <ClTitle>, if any, is used.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML. Other checklist elements besides <ClAlert> are not supported.

<ClStepAction>

Syntax

tml`
	<ClStep>
		<ClStepAction>
			...
		</ClStepAction>
	</ClStep>
`

A <ClStepAction> element contains the step actions. This is also referred to as the checklist "response". All <ClStep> elements require one <ClStepAction> child. When <ClStepObject> is present, it appears on the right side of the step contents, and the contents of <ClStepObject> will appear on the left. When <ClStepObject> is omitted, it appears on the left side of the step contents and fills the remaining width of the step contents.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClStepAmplification>

Syntax

tml`
	<ClStep>
		<ClStepAmplification>
			...
		</ClStepAmplification>
	</ClStep>
`

A <ClStepAmplification> element contains amplified information for a step. It appears when an amplified procedure is requested. A <ClStepAmplification> element must be a direct child of a <ClStep> element, and only one <ClStepAmplification> is allowed within each <ClStep> element.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClStepNote>

Syntax

tml`
	<ClStep>
		<ClStepNote>
			...
		</ClStepNote>
	</ClStep>
`

A <ClStepNote> element contains a brief note for a step. It appears whenever the step is displayed and is typically visually associated with the <ClStepAction> text. A <ClStepNote> element must be a direct child of a <ClStep> element, and only one <ClStepNote> is allowed within each <ClStep> element.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClStepObject>

Syntax

tml`
	<ClStep>
		<ClStepObject>
			...
		</ClStepObject>
	</ClStep>
`

A <ClStepObject> element contains the object that is acted upon by the <ClStepAction>. This is also referred to as the checklist "challenge". When present, it appears on the left side of the step contents, and the contents of <ClStepAction> will appear on the right.

Attributes

This element disregards all attributes.

Children

A TML string that may include HTML and references to state variables, other procedure IDs, pages, etc. Other checklist elements besides <ClAlert> are not supported.

<ClTitle>

Syntax

tml`
	<ClTitle>
		...
	</ClTitle>
`

A <ClTitle> element contains the full title of the procedure. If omitted, the procedure is not selectable by the user, but it can be included in other procedures using <ClBody> element with a useProcedure attribute. You may only provide one <ClTitle> element per parent.

Attributes

This element ignores all attributes.

Children

A TML string that may include HTML. Other checklist elements besides <ClAlert> are not supported.