Content
View differences
Updated by Jens Ulferts about 3 years ago
# User story
**As** a project member
**I want to** create professionally styled work plan documents (pdf)
**so that** I don't have to create them manually in a text editor.
Link to the document template that shows the structure of the pdf export (draft): [https://nextcloud.openproject.org/s/qRsCyZDTaaALwAB](https://nextcloud.openproject.org/s/qRsCyZDTaaALwAB)
* [x] Feedback from devs
* [ ] Polish the formattings
# Acceptance criteria
## Structure of the pdf
The exported pdf consists of two components
1. Index table
2. Detail sections (one detail section for each exported work package)
### Index table
* Table view that shows the columns from the query
* The table shows the hierarchy by indention (similar to web view but without the fold/unfold icons)
* Column header similar to the column header in the web view (bold and capitalized)
* Only the first four columns are shown (this value might change in the future).
* If only the index table is exported: PDF is in landscape format
### Detail sections
* For each work package there is heading based on the work package subject
* Below each work package heading there is `detail table` that shows the selected attributes
* The work package headings have level based on the level of the correspondig work package
* Work packages on root level: h2
* Work packages on the second level: h3
* Work packages on the third level: h4
* ....
* The main text contains all long text field with the corresponding label (bold)
* The text fields are ordered by their order in the custom field administration (not type form configuration).
* Description
* Long text custom field 1
* Long text custom field 2
* ....
* Page breaks
* The headers are not separated from their detail tables.
* The long text field labels are not separated from their text.
*
### Footer/Header
* Document title (query name)
* Logo
* Community edition: OpenProject logo from the header
* Enterprise edition: Custom logo added to "Administration" -> "Design"
* Export date
* Name of the exporting person (first name and last name)
* URL of the exported query
## Text formatting
* All text formatting supported by our text editors
* Headings: All headings used in the long text fields are "degraded" to be "smaller" than the long text field lables. This requires additional research.
* Bold
* Italic
* Strikethrough
* Code
* Links
* Embedded pictures
## Export modal
### PDF export options
1. PDF -> PDF: table
2. PDF with descriptions -> PDF: table and details
3. ~~PDF with description and attachments~~ (removed) (deprecated feature/removed)
4. ~~PDF with attachments~~ (removed) (deprecated feature/removed)
# Open
* Do we need a limit of exported work packages, e.g. 500
* How do we handle parent work packages that are filtered out?
* "Paper format" Page size in PDF (A4 vs EXECUTIVE)?
# **Out of Scope**
## Attribute selection
* Selecting the long text fields to be exported (we export all long text fields that are active for the type and the project)
* Select the attributes for the index table and the details section
## Formatting configuration
* Having a frontend to configure the pdf
* Borders
* Icons
* Font sizes
* Colors
### "Export" tab in modal "Work package table configuration"
* In the PDF tab the long text fields can be selected
* Description
* Long text custom field 1
* Long text custom field 2
* ....
* All long test fields are selected by default.
* There is an option to add the "Overview table"
* There is an option to add the "Work package details sections"
* We remove the option export "PDF with attachments and descriptions": If a user needs to export pictures they need to be embedded in the text.
* We remove the option "Export" from the drop down menu of to remove "Backlogs for each backlog in the backlogs view. sprint".
**As** a project member
**I want to** create professionally styled work plan documents (pdf)
**so that** I don't have to create them manually in a text editor.
Link to the document template that shows the structure of the pdf export (draft): [https://nextcloud.openproject.org/s/qRsCyZDTaaALwAB](https://nextcloud.openproject.org/s/qRsCyZDTaaALwAB)
* [x] Feedback from devs
* [ ] Polish the formattings
# Acceptance criteria
## Structure of the pdf
The exported pdf consists of two components
1. Index table
2. Detail sections (one detail section for each exported work package)
### Index table
* Table view that shows the columns from the query
* The table shows the hierarchy by indention (similar to web view but without the fold/unfold icons)
* Column header similar to the column header in the web view (bold and capitalized)
* Only the first four columns are shown (this value might change in the future).
* If only the index table is exported: PDF is in landscape format
### Detail sections
* For each work package there is heading based on the work package subject
* Below each work package heading there is `detail table` that shows the selected attributes
* The work package headings have level based on the level of the correspondig work package
* Work packages on root level: h2
* Work packages on the second level: h3
* Work packages on the third level: h4
* ....
* The main text contains all long text field with the corresponding label (bold)
* The text fields are ordered by their order in the custom field administration (not type form configuration).
* Description
* Long text custom field 1
* Long text custom field 2
* ....
* Page breaks
* The headers are not separated from their detail tables.
* The long text field labels are not separated from their text.
*
### Footer/Header
* Document title (query name)
* Logo
* Community edition: OpenProject logo from the header
* Enterprise edition: Custom logo added to "Administration" -> "Design"
* Export date
* Name of the exporting person (first name and last name)
* URL of the exported query
## Text formatting
* All text formatting supported by our text editors
* Headings: All headings used in the long text fields are "degraded" to be "smaller" than the long text field lables. This requires additional research.
* Bold
* Italic
* Strikethrough
* Code
* Links
* Embedded pictures
## Export modal
### PDF export options
1. PDF -> PDF: table
2. PDF with descriptions -> PDF: table and details
3. ~~PDF with description and attachments~~ (removed)
4. ~~PDF with attachments~~ (removed)
# Open
* Do we need a limit of exported work packages, e.g. 500
* How do we handle parent work packages that are filtered out?
* "Paper format" Page size in PDF (A4 vs EXECUTIVE)?
# **Out of Scope**
## Attribute selection
* Selecting the long text fields to be exported (we export all long text fields that are active for the type and the project)
* Select the attributes for the index table and the details section
## Formatting configuration
* Having a frontend to configure the pdf
* Borders
* Icons
* Font sizes
* Colors
### "Export" tab in modal "Work package table configuration"
* In the PDF tab the long text fields can be selected
* Description
* Long text custom field 1
* Long text custom field 2
* ....
* All long test fields are selected by default.
* There is an option to add the "Overview table"
* There is an option to add the "Work package details sections"
* We remove the option export "PDF with attachments and descriptions": If a user needs to export pictures they need to be embedded in the text.
* We remove the option "Export" from the drop down menu of