# 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)

* Begin of the insertion[x]End of the insertion Begin of the deletion [ ]End of the deletion Feedback from devs
* [ ] Polish the formattings

# Acceptance criteria

## Structure of the pdf

The exported pdf consists of two Begin of the insertioncomponentsEnd of the insertion Begin of the deletion parts:End of the deletion

Begin of the insertion1. End of the insertion Begin of the deletion * End of the deletion Index table
Begin of the insertion2. Detail sections (one detail section for each exported work package)End of the insertion Begin of the deletion * Main partEnd of the deletion

### 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) Begin of the insertion
* Only the first four columns are shown (this value might change in the future).End of the insertion

### Begin of the insertionDetail sectionsEnd of the insertion Begin of the deletion Main partEnd of the deletion

* For each work package there is heading based on the work package subject
* Below each work package heading there is Begin of the insertion`detail table`End of the insertion Begin of the deletion tableEnd of the deletion 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 Begin of the insertiontheEnd of the insertion Begin of the deletion aEnd of the deletion corresponding label (bold)
* The text fields are ordered by their order in the Begin of the insertioncustom field administration (not type form configuration).End of the insertion Begin of the deletion web view.End of the deletion
* Description
* Long text custom field 1
* Long text custom field 2
* ....
* Begin of the insertionPage breaks
* End of the insertion The Begin of the insertionheaders are not separated from their detail tables.
* The longEnd of the insertion text field labels are not separated from their text. Begin of the insertion
*


End of the insertion Begin of the deletion

End of the deletion ### Footer/Header

* Document title (query name)
* Logo Begin of the insertion
* Community edition: OpenProject logo from the header
* Enterprise edition: Custom logo added to "Administration" -> "Design"End of the insertion
* 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
* Begin of the insertionHeadings: All headings used in the long text fields are "degraded" to be "smaller" than the long text field lables. This requires additional research.End of the insertion Begin of the deletion HeadingsEnd of the deletion
* 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 Begin of the insertionattachments~~  (deprecated feature/removed)End of the insertion Begin of the deletion attachments~~End of the deletion
4. ~~PDF  with  attachments~~ Begin of the insertion(deprecated feature/removed)End of the insertion

Begin of the deletion ###

End of the deletion # Open

Begin of the deletion * Do we add a logo?
* Should we restrict the number of columns in the overview table?
* Do we take the first 4 columns?
* Should we allow row breaks in long subjects
End of the deletion * 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 to remove "Backlogs for each sprint".