Analyzing a Document with the Word Pattern Template

The purpose of this template is to capture, in a Word document, identifiers that will be used to create traceability links in a scope.

The Word pattern template:

• Parses the document to find section or paragraph with a title starting with "REQ")
• Captures this title to create an identifier and display the element in the scope view
• Captures attribute values to be displayed in the properties panel

Root Pattern

The root pattern definition contains a Resource to describe the content of the document to be analyzed.

Recommendation: We advise you to organize the structure of your document in several pattern definitions. Here, the Word content is described in the pattern definition below.

Word Content

The Word Content pattern definition matches with elements in the Word document to capture identifiers.

Depending on the matched Word elements, the Choice occurrence defines an action.

This pattern	Matches with	Then
Entity named Requirement	A Paragraph Word element With a title starting with "REQ"	This title is captured as an identifier. Note: This identifier capture will display the Word element in a scope view. This enables you to create traceability links.
	Something else (Zero or more)	The pattern analysis goes on with the Details analysis (for more information, see Details below).
		Every matched element is defined as requirement. This information is displayed in the properties area.
Resource	A Section Word type With a title equals to "frontmatter"	Nothing is captured. The pattern analysis goes deeper on the document (hasPart) with the Word Content pattern definition.
Entity named Section	A Section Word type With a title	The title (Label) is captured. Note: This label will be displayed in the coverage view and in the properties area. The pattern analysis goes deeper on the document (hasPart) with the Word Content pattern definition.
Reference to Details	Nothing	For those Word elements that do not match with the 3 pattern elements, the Details pattern definition applies.

Details Pattern Definition

The Details pattern definition matches with elements in the Word document to capture attribute values.

Depending on the matched Word elements, the Choice occurrence defines an action.

This pattern	Matches with	Then
Resource	A Paragraph Word type With no title containing "REQ" Note: This element avoids capturing requirements.	If the title contains "Mandatory", then a Mandatory attribute is created and displayed in the properties panel with a value set to Yes. If the title contains "Version", then a Version attribute is created and displayed in the properties panel with the version value. For every matched element, the text is captured.
Resource	A Table Word type	Nothing is captured. The pattern analysis goes deeper on the document (hasPart) with the Details pattern definition.