In this example, the title is the name of the element, and the paragraphs under it are the description/notes of the element, its status, and some links to some other elements.

Inline titles

The heading is printed as a new Word heading, using the appropriate Word Heading style (“Heading 1″…”Heading..n”).

In most cases, you will just want a title which is the ‘Name’ attribute of the element, but other options are also available. You can make the heading of each element from up to three parts. Any of the element attributes e.g. name, description, alias etc, can be used to make up the title. The format will be:

Prefix : Title : Suffix

Heading Levels

Word documents (in US/UK English, and possibly in other national languages) come with a built-in set of Paragraph styles calledÂ Heading 1, Heading 2Â up toÂ Heading 9.

eaDocX will automatically use these when creating your document, but if you want to use heading levels 7, 8 or 9, you need to do a little more work. (This is because the interface into Word doesn’t understand headings above 6).

You can over-ride the Word defaults and define your own Heading Styles for all heading levels, including headings 7, 8 and 9, and link them into eaDocX using the Inline Settings.

Inline paragraphs

Fields and tagged values

In the Element Profile editor, you can choose which attributes of the element will print. Choose from:

Common fields
- Name, Element Type, Description, Alias, Status and Stereotype
Tagged values.
- When populating the drop-down of Tagged Values, eaDocX will look into your model, and show only those Tagged Values which are present for the element type you are formatting.
Sub-elements
- Children, Constraints, Scenarios, Pre and post conditions
- Attributes and methods
- Element requirements, risks, resources, etc.
Advanced fields
- e.g. version, classifier ID, path, linked document and many more
Fixed attributes
Element Summaries
Project fields

Special fields

You can add non-EA data into your document, by adding:

Fixed text. See Fixed user-defined attributes
Page or line breaks. If you install a line break, and give a title (in the title column) then this will also print that fixed text. This is useful to split-up a set of paragraphs into groups. You can also add a Style Override to this, so that your sub-heading has a readable style. see Overriding Word Styles below

Inline tables

Not all attributes need to be printed in paragraphs – so inline tables let you choose attributes to print as tables within the inline formatting definition. These tables can be configured to print as horizontal or vertical (See inline tables for more information).

Diagrams

Add Element Diagrams by choosing Package fields – diagrams and composite diagram are available.

Related elements

Single element and relationship attributes

You’ll need to specify how the two elements are related, and which single attribute of the related element you want to print. This is useful, for example, where you expect each Use Case element to be linked to an ‘Actor’ element via a ‘Use Case’ link. You could then print the Actor’s “name” attribute after each use case. Where there are several Actors, you’ll get a list of the attribute names, separated by commas.

It may be the case that the related element has its details printed elsewhere in your document. In this case, you can specify that the attribute you print should also have a hyperlink to that data, which eaDocX will insert.

Choose the relationship type and an attribute (field or tagged value) of that relationship, or
Follow the relationship type to related element types and then choose the related element information to print:
- any element field or tagged value, or
- hyperlinked: name, alias, combination of name and alias, or the classifier name. Hyperlinks will be printed to navigate between related elements that are included in the document. If a related element is not present in the document, then just the name or alias will print.

Relationship tables

Add a Table of attributes. Again you’ll need to specify how the two elements are related, but you can now specify a list of attributes of the related element, which will print in a table which you can specify. Where there are several related elements, each will print as a row in the table. This works well where you won’t be printing details of the related element anywhere else in your document.

For example, if each Use Case has some Requirements that it satisfies, you could print a table of those requirements after each use case.

Choose the relationship and related element type and then define how you want the table to be printed.

Elements

Select the relationship type then follow the tree to the element type to print. This isn’t really ALL the details. It just means that eaDocX will include the details of related elements, formatted in their default style (either Table or Inline). This is useful if the structure of packages in your EA model is quite different from the way in which you’d like your document to be structured.

Overriding Word Styles

By default, eaDocX will use the same set of Word paragraph styles as defined in your Document Settings.

You may override these for any inline paragraph. Note that if you use this a lot, it may make the formatting of your document inconsistent. See eaDocX And Word

Table formatting

Table of contents

Inline formatting