# 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

* [x] Index table
* [x] Detail sections (one detail section for each exported work package)

### Index table

* [x] Table view that shows the columns from the query
* [x] The table shows the hierarchy by indention  (if query is in hierarchy view)
* [x] Column header similar to the column header in the web view (bold and capitalized)
* [x] Only the first four columns are shown (this value might change in the future).
* [x] If only the index table is exported: PDF is in landscape format

### Detail sections

* [x] For each work package there is heading based on the work package subject
* [x] 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
* [ ] ....
* [x] 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).
* [x] Description
* [x] Long text custom field 1
* [x] Long text custom field 2
* [x] ....
* [x] Page breaks
* [x] The headers are not separated from their detail tables.
* [x] The long text field labels are not separated from their text.

### Footer/Header

* [x] Document title (query name)
* [x] Logo
* [x] Community edition: OpenProject logo from the header
* [x] Enterprise edition: Custom logo added to "Administration" -> "Design"
* [x] Export date
* [x] 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
* [x] Headings: All headings used in the long text fields are "degraded" to be "smaller" than the long text field lables. This requires additional research.
* [x] Bold
* [x] Italic
* [x] Strikethrough
* [x] Code
* [x] Codeblock
* [x] Links
* [x] Embedded pictures
* [x] Tables
* [x] Ordered list
* [x] Unordered list
* [x] Task list

## Export modal

### PDF export options

1. PDF -> PDF: table
2. PDF with descriptions -> PDF: table and details (with / without embedded images)
3. ~~PDF with description and attachments~~  (removed)
4. ~~PDF  with  attachments~~ (removed)

# Open

* Begin of the insertion~~DoEnd of the insertion Begin of the deletion DoEnd of the deletion we need a limit of exported work packages, e.g. Begin of the insertion500~~ NoEnd of the insertion Begin of the deletion 500End of the deletion
* 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 each backlog in the backlogs view.