Export to external formats

Documents you prepare can be exported to external formats such as MS Word, OpenDocument, PDF, and HTML. When exporting to MS Word, you can use a document sample (template) into which the text is exported. The sample can declare styles, headers and footers, title pages, and so on.

Export options

Export template

A configured export template that contains an MS Word sample to export into, and/or rules for formatting documentation sections:

  • Iterator HTML template - HTML with substitutions for requirement-section attributes. This HTML is applied to the document sections being exported. Use it to format document sections as you need without changing the text of the requirements themselves, or to export the same requirements with different formatting.
  • Filter query - specifies which requirement sections this template applies to. Some sections are then exported with the system formatting, and others with the formatting defined in this template.

Export templates can also be applied to other export formats: HTML, PDF, and OpenDocument.
Include heading numbering The section number in the document structure is added to the heading of each document section. When you import a file that the document was previously exported to, the section number is used to find the section whose text should be updated from the document.
Add the section identifier to the heading The unique identifier of the section or requirement is added to the heading of each document section. When you import a file that the document was previously exported to, the unique identifier is used to find the section whose text should be updated from the document.
Export UML model and formula source UML models and formulas can be edited in the system, but after export to a document they become images. If you want to import the document back into the system, use this option. The source of the UML models and formulas is then exported into the document text. If the export is for printing or for handing documentation over to be followed or read, you can turn this option off.
Export child sections Clear the checkbox if you want to export the selected requirement without its child sections.
Export parent sections Select the checkbox if you want to export the whole documentation branch upward from the current requirement, that is, including all of its parent requirements

Importing a document again

A document previously exported from the system can be imported again, to bring in changes made in the file by people who do not have access to the system.

The operation is available on the "Actions" button while working with a document.

Selective export

You can export more than the whole document. You can export a single section, or any set of sections selected in the list. In document mode you can also use filters to select only the document sections you want to export.

For example, if the resulting document should omit some sections, mark them with a tag. In the filter settings, select only the sections that have no tags, and export the document. The export will not include the sections you tagged.

Use the query language to select the document sections that should be exported to an external format.

Exporting document attributes in an MS Word template

When you export a document with a template, you can export attributes of the document itself, for example Name and Author, and attributes of any document section. In the template text, insert a field with a special name, for example:

{$Caption$}

so that the document name is substituted into the field on export. You can use any document attributes, including calculated attributes.

Search results