Export Documents to DOCX

Documentation / Export

You can export documents to a MS Word DOCX file for sharing, printing or conversion to PDF.

Export DOCX Files

To export a DOCX file, click File, mouseover Export and click DOCX File. In the Export DOCX dialog, choose a Word template, layout and style and other options. After confirmation of the dialog, select a destination for storing the exported DOCX file.

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

Export Options

Word Template:

  • Default MS Word template — export the current document using the default title page, table of contents, headers, footers and paragraph styles in the output DOCX file.
  • Custom MS Word template — select a MS Word Template file to customize selection of exported documents, title page, headers, footers and paragraph styles in the output DOCX file.

Layout:

  • 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

Options:

  • Export displayed custom attributes in a single column — if set then columns displaying custom attributes will be compacted into a single column (for Table and Custom layouts)
  • 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 do not include links from / to document objects which are not visible in the exported file (for Book and Table layouts)

Example: Export a Software Requirements Specification (SRS) document into a Word file using the Book layout. For each SW requirement output its ID, text description, verification method, and upstream traceability links to user needs.

Export a *Software Requirements Specification (SRS)* into a Word file using the Book layout from ReqView

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

The default MS Word template outputs the current document only and defines a title page, table of contents, page headers, footers and paragraph styles. You can create custom MS Word templates to export DOCX documents according to your company standards.

Content Controls

If you choose a custom MS Word template, then ReqView parses the selected DOCX/DOTX file and replaces Word content controls with data from the exported project.

You can insert Word content controls into a custom MS Word 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.exportSection[<sectionId>] — export the section sectionId of the current document, see Export Sections
    • ReqView.document[<docId>] — export data from the document docId, for instance ReqView.document[SRS]
    • ReqView.document[<docId>].name — export the name of the document docId
    • ReqView.document[<docId>].exportSection[<sectionId>] — export the sectionId of the document docId, see Export Sections
  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 Word 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 instance, 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.

Example: Download the default MS Word template used by the application.

Default DOCX template for export from ReqView

Document Sections

You can insert in the DOCX template content controls ReqView.document.exportSection[<sectionId>] or ReqView.document[<docId>].exportSection[<sectionId>] to output ReqView document sections selected in a custom HTML template using exportOption helper with "exportSection" parameter.

Example: Export document Software Requirements Specification (SRS) into a DOCX file, which contains document section Introduction using book layout and portrait page orientation and document section Requirements using table layout and landscape orientation.

  1. In Word, open a DOCX template and insert content control ReqView.document.exportSection[Intro] at a new page after the title page and table of contents having the portrait page orientation.

  2. In Word, click on Breaks on the Layout tab and select Next Page to insert a section break and start a new section on the next page. Then insert content control ReqView.document.exportSection[Reqs] at the new page and set its orientation to landscape.

    Custom DOCX template for exporting introduction and requirements as separate sections from ReqView
  3. In ReqView, open the exported document SRS. Then define custom enumeration attribute exportSection:

    {
    "exportSection": {
    "type": "enum",
    "name": "Export Section",
    "values": [
    { "key": "Intro", "label": "Introduction" },
    { "key": "Reqs", "label": "Requirements" }
    ]
    }
    }
  4. In ReqView, set values of attribute exportSection for each top level document section:

    Set custom attribute storing export sections in ReqView document exported to DOCX
  5. Create a custom HTML template exporting different content for both sections "Intro" and "Reqs". See also Custom Export Using Templates.

    <!DOCTYPE html>
    <html lang="en-US">
    <head>
    <meta charset="utf-8">
    <title>{{docName}}</title>
    </head>
    <body>
    {{!-- Export section Introduction --}}
    {{#if (eval (exportOption "exportSection") "==" "Intro")}}
    {{#eachDocumentObject}}
    {{#if (eval (attributeValue "exportSection" format="string" inherit=true) "==" "Introduction")}}
    {{#if heading}}{{#section numbering=false}}{{{heading}}}{{/section}}{{/if}}
    {{text}}
    {{/if}}
    {{/eachDocumentObject}}
    {{/if}}
    {{!-- Export section Requirements --}}
    {{#if (eval (exportOption "exportSection") "==" "Reqs")}}
    <table>
    <thead>
    <tr>
    <th>ID</th>
    <th>Description</th>
    <th>Rationale</th>
    <th>Source</th>
    </tr>
    </thead>
    <tbody>
    {{#eachDocumentObject}}
    {{#if (eval (attributeValue "exportSection" format="string" inherit=true) "==" "Requirements")}}
    <tr>
    <td>{{docObjId}}</td>
    <td>
    {{#if heading}}{{#section numbering=false}}{{{heading}}}{{/section}}{{/if}}
    {{{text}}}
    </td>
    <td>{{{rationale}}}</td>
    <td>{{{source}}}</td>
    </tr>
    {{/if}}
    {{/eachDocumentObject}}
    </tbody>
    </table>
    </body>
  6. In ReqView, export the document SRS to DOCX. In the Export DOCX dialog choose Custom MS Word Template and select the DOCX template created in steps 1-2, and then choose Custom layout and select the HTML template created in step 5.

Updated for version 2.15.0