Customizing the Microsoft Word Output
You can customize both the content and the formatting of the document that is generated from a requirements tracker.
The output document is in MHTML format.
The content is generated by rendering two Velocity
templates.
templates.In order to customize the output, modify the following templates:
• <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-body.vm
• <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-headerfooter.vm
The following objects are available in the Velocity context and can be used in templates:
Key | Class | Description |
|---|---|---|
request | HttpServletRequest | |
user | UserDto | |
currentDate | Date | |
project | ProjectDto | |
requirementTracker | TrackerDto | |
requirements | SortedMap<ReleaseId, TrackerItemDto> | ReleaseId class provides indexing and sorting for requirements.Use ReleaseId.getRelease() |
baseline | Baseline | Only available when exporting a baselined set of issues. When exporting the HEAD (the latest revision), it is not available. |
wikiMarkupProcessor | WikiMarkupProcessor | |
incomingReferencesByIssue | Map<Integer, Map<String, List<TrackerItemDto>>> | Keyed first by the item ID, then by the field name. Maps to a list of tracker items. |
outgoingReferencesByIssue | Map<Integer, Map<String, List<TrackerItemDto>>> | Keyed first by the item ID, then by the field name. Maps to a list of tracker items. |