Export Documents to DOCX

Documentation / Export

You can export documents to a MS Word DOCX file for sharing, printing or conversion to PDF. To export a DOCX file, click File, mouseover Export and click DOCX File.

Export Layout

In the Export Options dialog choose the layout and style of the exported documents:

  • Book — export a single column (the displayed columns are stacked as paragraphs) using default styles
  • Table — export a table with the displayed columns using default styles
  • Custom — export content with custom layout and styles using a custom HTML template, see Custom Export Using Templates

Example Output of the Book Layout:

MS Word document with requirements and traceability links exported from ReqView

Export Options

In the Export DOCX Options dialog, select one or more additional export options:

  • Use custom MS Word template — if set then you can choose a DOCX or DOTX file with custom title page, header and footer, see the next section MS Word Template
  • Preserve filter and sorting — if set then exported data will be filtered and sorted the same way as the table view
  • Preserve section folding — if set then the content of collapsed sections will be ignored
  • Ignore links to invisible objects — if set then links to filtered out objects and to objects in closed documents, or documents not included in a custom DOCX/DOTX template are omitted.

After confirmation of the dialog, select an output folder storing the exported DOCX file.

If you use the Book or Table layout then DOCX files contain the predefined title page, table of contents, headers, footers and paragraph styles.

Note: In the WebApp, the exported DOCX file is saved in the browser download folder.

Warning: MS Word for Mac has a bug in displaying the exported images properly. To view the images please use the online version of MS Word.

MS Word Template

Create a MS Word DOCX or DOTX template to customize the title page, document order, header and footer, table of contents, or paragraph styles. For example, download the default DOCX template used by the application:

Default DOCX template structure

ReqView Content Controls

The DOCX/DOTX template must contain one or more ReqView content controls, which are MS Word plain text content controls with a special text, which are replaced by exported project data.

Insert ReqView content controls into the DOCX template as follows:

  1. Show the Developer tab, see how.

  2. Enable Design Mode on the Developer Tab.

  3. Move cursor to the place in the document where you want to insert the content control.

  4. Click on Plain Text Content Control on the Developer tab and type in a content control text:

    • ReqView.id — export the project identifier
    • ReqView.user.name — export the name of the current ReqView user
    • ReqView.user.email — export the email of the current ReqView user
    • ReqView.user.company — export the company of the current ReqView user
    • ReqView.date — export the current date, e.g. "2020-02-19"
    • ReqView.dateTime — export the current date, e.g. "2020-02-19 16:00"
    • ReqView.document — export data from the current document
    • ReqView.document.id — export the current document identifier
    • ReqView.document.name — export the name of the current document
    • ReqView.document[ID] — export data from the document with the given identifier, for instance ReqView.document[SRS]
    • ReqView.document[ID].name — export the name of the document with the given identifier
  5. Optionally, set the content control title to "ReqView" by clicking on Properties on the Developer Tab.

All ReqView documents that you refer to by ReqView.document or ReqView.document[ID] will be exported using the selected Book, Table or Custom layout.

Page Headers and Footers

You can insert a ReqView content control into a page header or footer. For example, to output the name of the exported ReqView document on page headers, open the DOCX template, double click on the page header, and insert ReqView.document.name content control as described in the previous section.

Warning: You can experience a missing images in MS Word exported document when you place an image in the Word Template header. To avoid this buggy behavior of MS Word, place a picture in the Watermark. See how to insert a picture watermark.

Document Properties

You can insert a ReqView content control also in Word document properties. For example, to set the current user company name in Company property, open the DOCX template, click File, click Info, click Properties, then choose Advanced Properties, and insert ReqView.user.company text in the Company text field:

Editing template fields: Title, Author, and Company

Section Headings

You can customize the standard paragraph styles for section headings Heading 1, Heading 2, ..., Heading 6. For example, enable automatic numbering of section headings, adjust spaces before section headings, and insert a page break before each Heading 1 paragraph.

Paragraph Styles

You can customize the following application specific paragraph styles:

  • rv-attachment — attachment including images (paragraph)
  • rv-attribute — custom attribute name (paragraph)
  • rv-attribute-value — custom attribute value (paragraph)
  • rv-column — template column name (paragraph)
  • rv-column-value — template column value (paragraph)
  • rv-comment — comment text (paragraph)
  • rv-id — object identifier (character)
  • rv-label — custom attribute or template column label (character)
  • rv-link — traceability link (character)
  • rv-link-group — group of traceability links (paragraph)
  • rv-text — text description of a document object (paragraph)
  • rv-text-deleted — text description of a deleted document object (paragraph)

For example, set the font of document object identifiers using rv-id character style to bold and set the font of custom attribute labels using rv-label character style to italic.

Updated for version 2.14.0