diff --git a/docs/user-guide/work-packages/README.md b/docs/user-guide/work-packages/README.md index 42e67fabea..42a5595047 100644 --- a/docs/user-guide/work-packages/README.md +++ b/docs/user-guide/work-packages/README.md @@ -16,7 +16,6 @@ keywords: work packages Work packages have a **type**, an **ID**, a **subject** and may have various additional attributes, such as **status**, **assignee**, **priority**, **due date**.
**Work package ID** is defined as a unique integer assigned to a newly created work package. Work package IDs cannot be changed and are numbered across all projects of an OpenProject instance (therefore, the numbering within a project may not be sequential).
-
**Types** are the different items a work package can represent, such as task, feature, bug, phase, milestone. The work package types can be configured in the system administration.
@@ -32,6 +31,7 @@ Work packages can be displayed in a projects timeline, e.g. as a milestone or a | [Edit work package](edit-work-package) | How to edit a work package in OpenProject? | | [Copy, move, delete](copy-move-delete) | How to copy, move, delete a work package? | | [Work package table configuration](work-package-table-configuration) | How to configure the work package table (columns, filters, group by, etc.)? | +| [Exporting](exporting) | How to export work packages for other tools such as Microsoft Excel? | | [Work package relations and hierarchies](work-package-relations-hierarchies) | How to create work package relations and hierarchies? | diff --git a/docs/user-guide/work-packages/edit-work-package/1567413583391.png b/docs/user-guide/work-packages/edit-work-package/1567413583391.png deleted file mode 100644 index c2791a98f5..0000000000 Binary files a/docs/user-guide/work-packages/edit-work-package/1567413583391.png and /dev/null differ diff --git a/docs/user-guide/work-packages/edit-work-package/README.md b/docs/user-guide/work-packages/edit-work-package/README.md index cb799fa352..6b9b98d49a 100644 --- a/docs/user-guide/work-packages/edit-work-package/README.md +++ b/docs/user-guide/work-packages/edit-work-package/README.md @@ -85,8 +85,4 @@ To remove watchers, navigate to the work package [details view](#work-package-fu To export the work packages, choose **Export ...** in the settings menu on the top right of the work package list (or Gantt chart) view. - ![export-gantt-chart](export-gantt-chart.png) - -You can choose between several export possibilities: - -![work-package-export](1567413583391.png) +Please see [this separate guide](../exporting) for more information on exporting work packages. \ No newline at end of file diff --git a/docs/user-guide/work-packages/exporting/README.md b/docs/user-guide/work-packages/exporting/README.md new file mode 100644 index 0000000000..f29f9e8cbb --- /dev/null +++ b/docs/user-guide/work-packages/exporting/README.md @@ -0,0 +1,96 @@ +--- +sidebar_navigation: + title: Exporting + priority: 600 +description: How to export work packages for other tools, such as Microsoft Excel +robots: index, follow +keywords: work package exports, CSV, Excel, XLS, PDF +--- + +# Exporting work packages + +You can export work packages from your OpenProject instance to other formats using the export functionality. + + + +## How to trigger an export + +To export a work packages list or card view to another format, visit the *work packages* module or a saved view and click on the settings icon in the top right. Trigger the *Export* dialog from the dropdown menu that opens. + +![Exporting from the table](export-gantt-chart.png) + +This will open a dialog similar to the following screenshot, where you can select the desired format. Below, we will detail how to control the data being exported as well as the various formats. + + + +![The export dialog](dialog.png) + + + +## Changing what will be exported + +From the work packages module, all work packages that are included in the filter list will be exported. Up to a total of 500 work packages can be exported at once. + + + +**Columns** + +The exported file will follow the columns that you activated for the work packages table. With it, you can control the columns that will be contained in various formats. + +Some formats such as PDF will limit the number of columns available due to limitations of the PDF rendering engine to avoid overflowing the available space. + + + +## PDF export + +OpenProject has multiple options of exporting the results to PDF: + + + +- **PDF** export of the work package list as rows +- **PDF with descriptions** same as above with work package descriptions output. Note that this does not include a fully rendered markdown description, but a stripped version of it due to technical limitations of the PDF rendering engine. +- **PDF with attachments** of work packages with their attachments inlined to fit as best as possible +- **PDF with descriptions and attachments** The above options combined to create a PDF export with work package descriptions and their attachments + + + +## Excel (XLS) export + +OpenProject can export the table for Microsoft Excel with the following options: + +- **XLS** a plain sheet that matches the OpenProject work packages table with its columns and work packages as rows matching the selected filter(s). +- **XLS with descriptions** same as above, but with an additional column for work package descriptions, which cannot be selected in the table +- **XLS with relations** Same as XLS, but with additional columns to list each work package relation in a separate row with the relation target and its ID and relation type included in the export + + + + + +## CSV export + +OpenProject can export the table into a comma-separated CSV. This file will be UTF-8 encoded. + + + + + + + +## Atom (XML) export + +OpenProject can export the table into a XML-based atom format. This file will be UTF-8 encoded. + + + diff --git a/docs/user-guide/work-packages/exporting/dialog.png b/docs/user-guide/work-packages/exporting/dialog.png new file mode 100644 index 0000000000..208481388c Binary files /dev/null and b/docs/user-guide/work-packages/exporting/dialog.png differ diff --git a/docs/user-guide/work-packages/edit-work-package/export-gantt-chart.png b/docs/user-guide/work-packages/exporting/export-gantt-chart.png similarity index 100% rename from docs/user-guide/work-packages/edit-work-package/export-gantt-chart.png rename to docs/user-guide/work-packages/exporting/export-gantt-chart.png