Overview
This story put in place the whole technical mecanism for document generation out of a tracker report. Regarding the artifacts, only the basic fields are taken into account to limit as much as possible the difficulties related to the conversion from Tuleap format to OpenDocument (docx).
Document
Covered fields
- Artifact ID
- Per tracker ID
- String
- Date
- Last update date
- Submitted on
- Float
- Integer
- Computed value
- Rank
Fields are covered for both "Report" and "Artifacts" section below
Structure
The generated document will have the following structure:
-
- Title: Platform name - Project name - Tracker name - Report name
- Date of the export
- Who did the export
- URL of the report
-
- Table of contents
-
- Artifacts
- 4.1 <tracker_shortname> #<artifact_id_1> <artifact_title_1>
| Field |
Value |
| field 1 |
value 1 |
| field 2 |
value 2 |
| ... |
... |
Pseudo example with Request tracker in markdown to understand the structure:
(note: tables for field list/values are not rendered here so it's "mockup" with lists)
# 1. Tuleap - Tuleap - Requests - Default
* Export date: 2021-07-08
* Exported by: Manuel Vacelet (@vaceletm)
* Tracker URL: https://tuleap.net/plugins/tracker/?tracker=140
## 1.1 Table of contents
1. Tuleap - Tuleap - Requests - Default
1.1 Table of contents
1.2 Artifacts
1.2.1 request #22209 Introduce a basic HEALTHCHECK directive in production Docker images
1.2.2 request #22208 document, lock update is not up to date when user lock/unlock item
## 1.2 Artifacts
### 1.2.1 request #22209 Introduce a basic HEALTHCHECK directive in production Docker images
| Field | Value |
| ---------------- | ------------------------------------------------------------------- |
| Artifact ID | 22209 |
| Last Modified On | 2021-07-08 17:27 |
| Submitted on | 2021-07-08 09:26 |
| Rank | 23374 |
| Summary | Introduce a basic HEALTHCHECK directive in production Docker images |
| Disclosure date | |
| Close date | 2021-07-08 |
### 1.2.2 request #22208 document, lock update is not up to date when user lock/unlock item
...
Document properties
- Artifacts are one after another (no page break)
- There is a table of contents
- Pages are numbered
- Titles have numbers
- Basic header/footer formatting (to be defined)
- Basic cover page