diff --git a/docs/user-guide/gantt-chart/README.md b/docs/user-guide/gantt-chart/README.md index 9c666e085b0d..c7ced56d5d77 100644 --- a/docs/user-guide/gantt-chart/README.md +++ b/docs/user-guide/gantt-chart/README.md @@ -9,7 +9,7 @@ keywords: gantt chart, timeline, project plan # Gantt charts
-The **Gantt charts** module in OpenProject displays the work packages in a timeline. You can collaboratively create and manage your project plan, have your project timelines available to all team members and share up-to-date information with stakeholders. You can add start and finish dates and adapt it via drag and drop directly in the Gantt chart. Also, you can add dependencies, predecessors or followers within the Gantt chart. +The **Gantt charts** module in OpenProject displays the work packages in a timeline. You can collaboratively create and manage your project plan, have your project timelines available to all team members, and share up-to-date information with stakeholders. You can add start and finish dates and adapt them via drag and drop directly in the Gantt chart. Also, you can add dependencies, predecessors, or followers within the Gantt chart.
| Topic | Content | @@ -27,7 +27,7 @@ The **Gantt charts** module in OpenProject displays the work packages in a timel ## Activate the Gantt chart -A Gantt chart view can be activated either for a specific project, or on the project overarching level if you need to view the timeline for multiple projects. +A Gantt chart view can be activated either for a specific project or on the project overarching level if you need to view the timeline for multiple projects. For a specific project, select the **Gantt charts** module from the project module menu on the left side. @@ -39,22 +39,22 @@ To view multiple projects in a single timeline, select **Gantt charts** from the Alternatively, you can also use the **Include projects** filter. -## Gantt charts views +## Gantt chart views -Once you opened the Gantt charts module, the default view will show all open work packages. You can search for a specific Gantt chart using the search bar on the left. You can adjust the view using the filters or select one the following view options: +Once you open the Gantt charts module, the default view will show all open work packages. You can search for a specific Gantt chart using the search bar on the left. You can adjust the view using the filters or select one of the following view options: ![View options in OpenProject Gantt charts](openproject-user-guide-gantt-charts-views.png) -**Favorite**: lists all saved Gantt charts view that are marked as favorite +**Favorite**: lists all saved Gantt chart views that are marked as favorite -**Default**: lists pre-defined Gantt charts views and includes the following: +**Default**: lists pre-defined Gantt chart views and includes the following: - **All open**: shows all work packages with the status open - **Milestones**: shows all work packages with the work package type Milestones (or other types that are set to be recognized as milestones) -**Public**: lists all Gantt charts views set to be public +**Public**: lists all Gantt chart views set to be public -**Private**: lists all your personal saved Gantt charts views +**Private**: lists all your personal saved Gantt chart views ## Quick context menu in Gantt chart view @@ -72,11 +72,11 @@ You can use any of the following options. - **Copy link to clipboard** - copies a short link to the selected work package to your clipboard. - **Change project** - allows moving the selected work package to a different project. - **Delete** - deletes a work package. You will need to confirm the deletion. -- **Indent hierarchy** - creates a child-parent relationship with the work package directly above. The work package you selected become the child work package. The work package directly above becomes the parent work package. +- **Indent hierarchy** - creates a child-parent relationship with the work package directly above. The work package you selected becomes the child work package. The work package directly above becomes the parent work package. - **Add predecessor** - adds a predecessor (it will prompt you to select a work package in Gantt view). - **Add follower** - adds a follower (it will prompt you to select a work package in Gantt view). -- **Show relations** - open the details view of a work package and displays the **Relations** tab. -- **Create new child** - opens a new work package on the right side of the screen. This new work package already has a child relationship to the work package you selected. **This option will not be available if the work package type is a milestone**. +- **Show relations** - opens the details view of a work package and displays the **Relations** tab. +- **Create new child** - opens a new work package on the right side of the screen. This new work package already has a child relationship to the work package you selected. **This option will not be available if the work package type is a milestone**. ## Create a new element in the Gantt chart @@ -84,20 +84,20 @@ To add a work package (e.g. phase, milestone or task) to a Gantt chart, click th You can add a subject and make changes to type, status or more fields. -In the **Gantt chart** you can schedule the work package with drag and drop and change the duration. +In the **Gantt chart**, you can schedule the work package with drag and drop and change the duration. -To **change the order of an item** in the Gantt chart, click the **drag and drop** icon (6 dots) at the left hand side of the work package row. Drag the item to the new position. The blue horizontal line indicates the new position to drop the element. +To **change the order of an item** in the Gantt chart, click the **drag and drop** icon (6 dots) on the left-hand side of the work package row. Drag the item to the new position. The blue horizontal line indicates the new position to drop the element. ![create-new-element-gantt-chart](create-new-element-gantt-chart.gif) ### How to change the duration of an element in the Gantt chart -To change the duration of a work package in the Gantt chart view, hover over the work package in the Gantt chart and use the little arrows on its ends to adjust the start date or finish date. This will shorten or prolong its duration. To move a work package on the time line just click on it and drag and drop it to the desired point of time. This will change its start and finish date. +To change the duration of a work package in the Gantt chart view, hover over the work package in the Gantt chart and use the little arrows on its ends to adjust the start date or finish date. This will shorten or prolong its duration. To move a work package on the timeline, just click on it and drag and drop it to the desired point in time. This will change its start and finish date. > [!NOTE] > The Gantt chart will highlight non-working days with a darker background color when you are zoomed in to a level that shows individual days. By default, a work package cannot be dragged or resized such that it begins or ends on these days unless the "Working days only" switch is turned off for that work package. To learn how to do this, refer to the documentation on [Working days and duration](../work-packages/set-change-dates/#working-days-and-duration). > -> Work packages can also expand and retract in width depending on how many non-working days are spanned (for example, a 3-day task starting on Thursday and ending on Monday will spread across 5 calendar days; dragging that same work package so that it starts on a Tuesday and ends on a Thursday means that it will spread across 3 calendar days. In both cases, the duration remains 3 days. +> Work packages can also expand and retract in width depending on how many non-working days are spanned (for example, a 3-day task starting on Thursday and ending on Monday will spread across 5 calendar days; dragging that same work package so that it starts on a Tuesday and ends on a Thursday means that it will spread across 3 calendar days. In both cases, the duration remains 3 days). ## Relations in the Gantt chart @@ -109,26 +109,26 @@ In the menu, choose **Add predecessor** or **Add follower**. Select the item to which you want to create a dependency. The precede and follow relation is marked with a small blue line in the Gantt chart. -The quickest way to remove a relation is to select **Show relations** from the quick context menu and removing the relation in the work package details view. +The quickest way to remove a relation is to select **Show relations** from the quick context menu and remove the relation in the work package details view. ![dependencies-gantt-chart](gantt-chart.gif) When work packages have a precedes/follows relationship: -- A follower cannot be moved to start earlier the finish date of its predecessor. -- Moving a predecessor past the start date of the the follower will automatically push the follower into the future (such that it starts the next working day). -- If there is a gap between the predecessor and the follower, either one can be moved forwards or backwards without affecting the other as long as long as the dates do not overlap. +- A follower cannot be moved to start earlier than the finish date of its predecessor. +- Moving a predecessor past the start date of the follower will automatically push the follower into the future (such that it starts the next working day). +- If there is a gap between the predecessor and the follower, either one can be moved forward or backward without affecting the other as long as the dates do not overlap. Scheduling modes can also affect work package relations. Read about [automatic and manual scheduling](scheduling) to find out more. -> [!NOTE] +> [!NOTE] > Relations other than predecessor/follower and parent/child (such as related to, blocked by, includes, duplicates) are not displayed in the Gantt chart. To find out more, read our guide on [work package relations](../work-packages/work-package-relations-hierarchies). ## Understanding the colors and lines in the Gantt chart -- A **blue line** connects two work packages, they are predecessor and follower. +- A **blue line** connects two work packages; they are predecessor and follower. - The **vertical red dotted line** indicates today's date. -- A **black clamp** indicates the duration from the start date of a work packages earliest starting child until the finish date of a work packages latest ending child. +- A **black clamp** indicates the duration from the start date of a work package's earliest starting child until the finish date of a work package's latest ending child. - A **red clamp** indicates the same as the black clamp, with an important difference: The clamp turns red if the dates derived from the children are before or after the manually scheduled dates (of this parent work package). The clamps are black in case the derived dates are within the set dates (of this parent). - A **diamond symbol** stands for a milestone. @@ -139,7 +139,7 @@ Scheduling modes can also affect work package relations. Read about [automatic a To open the Gantt chart configuration, please open the **settings** icon with the three dots on the upper right of the work package module. Choose **Configure view ...** and select the tab **Gantt chart**. -Here you can **adapt the Zoom level**, or choose Auto zoom which will select a Zoom level which best fits to your browser size to have optimal results on a page. +Here you can **adapt the Zoom level**, or choose Auto zoom which will select a Zoom level that best fits your browser size to have optimal results on a page. Also, you have **Label Configuration** for your Gantt chart. You can add up to three additional labels within the chart: On the left, on the right and on the far right. Just select which additional information you would need to have in the Gantt chart. This can be especially relevant if you want to print your Gantt chart. @@ -149,10 +149,10 @@ Click the **Apply** button to save your changes. ### How to export data from a Gantt diagram -To export the data from your Gantt chart there are several possibilities: +To export the data from your Gantt chart, there are several possibilities: * [Export via the work package view](../work-packages/edit-work-package/#export-work-packages) -* [Print (e.g. to PDF)](#how-to-print-a-gantt-chart) +* [Print (e.g., to PDF)](#how-to-print-a-gantt-chart) * [Synchronize data from OpenProject to Excel](../../system-admin-guide/integrations/excel-synchronization/) ←→ MS Project ### How to print a Gantt chart @@ -177,26 +177,27 @@ Press the **Print** button. For other browsers, please simply follow the browser's printing instruction to optimize results. -To synchronize your work package data between OpenProject and Excel (two-way synchronization) please have a look at [this instruction](../../system-admin-guide/integrations/excel-synchronization/). +To synchronize your work package data between OpenProject and Excel (two-way synchronization), please have a look at [this instruction](../../system-admin-guide/integrations/excel-synchronization/). ### Gantt chart PDF Export (Enterprise add-on) > [!NOTE] > Gantt chart PDF export is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide). An upgrade from the free Community edition is easy and helps support OpenProject. -To export a Gantt chart in a PDF format click the **More** (three dots) icon in the top right corner and select *Export*. +To export a Gantt chart in a PDF format, click the **More** (three dots) icon in the top right corner and select *Export*. ![Export Gantt chart option in OptionProject](openproject-user-guide-gantt-charts-export.png) -Then select the **PDF Gantt** option. +Then select the **PDF Gantt** option under PDF export type. Configure the parameters of the PDF export, such as zoom level for the dates, column width and paper size. Then click the green **Export** button. -![Gantt chart export options in OpenProject](openproject-user-guide-gantt-pdf-gantt-icon.png) +![Gantt chart export options in OpenProject](openproject-user-guide-export-gantt-chart.png) Configure the parameters of the PDF export, such as zoom level for the dates, column width and paper size. Then click the green **Export** button. -![Configure PDF Gantt export in OpenProject](openproject-user-guide-gantt-pdf-gantt-options.png) +You can then save the Gantt chart in PDF form to share with your project stakeholders or print it directly. -You can now save the Gantt chart in PDF form to share with your project stakeholders or print it directly. +> [!TIP] +> You can also export Gantt charts in PDF format from the [work packages module](../work-packages/exporting/#gantt-chart-pdf). ## Gantt chart views @@ -210,21 +211,21 @@ To zoom in and zoom out in the Gantt chart view, click on the button with the ** Select the **auto zoom button** on top of the Gantt chart to have the best view of your Gantt chart. -Please note that the **auto zoom button** may not be selectable if it has been pre-selected in the [Gantt charts configuration](#gantt-chart-configuration) +Please note that the **auto zoom button** may not be selectable if it has been pre-selected in the [Gantt charts configuration](#gantt-chart-configuration). ![auto-zoom-Gantt](openproject-user-guide-gantt-charts-auto-zoom.png) ### Zen mode -The zen mode gives you more space to focus on the tasks at hand. It's almost like activating the full screen view in your browser. To exit press the *Esc* key or click on the **zen mode** symbol again. +The zen mode gives you more space to focus on the tasks at hand. It's almost like activating the full screen view in your browser. To exit, press the *Esc* key or click on the **zen mode** symbol again. ![zen-mode-Gantt-chart](openproject-user-guide-gantt-charts-zen-mode.png) ## Multi project views -With the Gantt charts in OpenProject you can create project overarching timelines. +With the Gantt charts in OpenProject, you can create project overarching timelines. -Create multi project timelines and display all activities, phases and milestones within your project and sub-projects. Also, you can create project overarching timelines by filtering and including respective projects in one joint plan. +Create multi-project timelines and display all activities, phases and milestones within your project and sub-projects. Also, you can create project overarching timelines by filtering and including respective projects in one joint plan. To include sub-projects: within the parent project, click on the Filter button and select the subproject(s) you want to have included in your project plan. You can also choose an [aggregation by project](#aggregation-by-project). @@ -236,22 +237,24 @@ If you want to adjust your work package table and filter, sort or order your wor ## Aggregation by project -You can get a **quick overview of multiple projects** in the Gantt chart. To accomplish this navigate to the Gantt charts module of a project or the [project overarching Gantt charts module](../projects/project-lists/#project-overarching-reports). +You can get a **quick overview of multiple projects** in the Gantt chart. To accomplish this, navigate to the Gantt charts module of a project or the [project overarching Gantt charts module](../projects/project-lists/#project-overarching-reports). **Group the work packages** by project by using the [work packages table configuration](../work-packages/work-package-table-configuration/#flat-list-hierarchy-mode-and-group-by) (accessible in the upper right corner) or by clicking on the small triangle next to "Project" in the table header. - ![group-by-project](image-20201211020614221.png) + +![group-by-project](image-20201211020614221.png) Use the minus next to the project's name or the **collapse button** in the upper right corner to collapse some or all projects. ![collapse-button](openproject-user-guide-gantt-charts-collapse-all.png) -This will give you an **aggregated view of the projects' work packages**. You can further adjust this view by using the Filter functionality, for example display work package type Bugs. +This will give you an **aggregated view of the projects' work packages**. You can further adjust this view by using the Filter functionality, for example, display work package type Bugs. ![Filtering project aggregated projects Gantt chart view in OpenProject](openproject-user-guide-gantt-charts-filters.png) > [!TIP] -> If you want the work packages to be displayed when the projects are folded, it is necessary to set the selected work package type to be recognized as a milestone under [work package type settings](../../system-admin-guide/manage-work-packages/work-package-types/). Otherwise you will need to unfold the projects to view all of the work packages. +> If you want the work packages to be displayed when the projects are folded, it is necessary to set the selected work package type to be recognized as a milestone under [work package type settings](../../system-admin-guide/manage-work-packages/work-package-types/). Otherwise, you will need to unfold the projects to view all of the work packages. + +Apart from the set filters, the list of displayed projects depends on your [permissions](../../system-admin-guide/users-permissions/roles-permissions/). You can only see private projects that you are a member of and public projects. +In some cases (many work packages per project), you will have to increase the objects per page in the bottom right corner to display multiple projects. Change the available options in the [system settings](../../system-admin-guide/system-settings/general-settings/) if necessary. -Apart from the set filters the list of displayed projects depends on your [permissions](../../system-admin-guide/users-permissions/roles-permissions/). You can only see private projects that you are a member of and public projects. -In some cases (many work packages per project) you will have to increase the objects per page in bottom right corner to display multiple projects. Change the available options in the [system settings](../../system-admin-guide/system-settings/general-settings/) if necessary. - ![image-20201211131803961](image-20201211131803961.png) +![image-20201211131803961](image-20201211131803961.png) diff --git a/docs/user-guide/gantt-chart/openproject-user-guide-export-gantt-chart.png b/docs/user-guide/gantt-chart/openproject-user-guide-export-gantt-chart.png new file mode 100644 index 000000000000..880c409b500d Binary files /dev/null and b/docs/user-guide/gantt-chart/openproject-user-guide-export-gantt-chart.png differ diff --git a/docs/user-guide/gantt-chart/openproject-user-guide-gantt-charts-export.png b/docs/user-guide/gantt-chart/openproject-user-guide-gantt-charts-export.png index 561c371afddb..82725afaaced 100644 Binary files a/docs/user-guide/gantt-chart/openproject-user-guide-gantt-charts-export.png and b/docs/user-guide/gantt-chart/openproject-user-guide-gantt-charts-export.png differ diff --git a/docs/user-guide/work-packages/exporting/README.md b/docs/user-guide/work-packages/exporting/README.md index f98188319c95..2c090f36ab51 100644 --- a/docs/user-guide/work-packages/exporting/README.md +++ b/docs/user-guide/work-packages/exporting/README.md @@ -8,130 +8,157 @@ keywords: work package exports, CSV, Excel, XLS, PDF # Export work packages -You can export work packages from your OpenProject instance in various formats using the export functionality. +You can export [a single work package](#export-single-work-package) in PDF/Atom format or [multiple work packages](#export-multiple-work-packages) in PDF/XLS/CSV formats. -## How to trigger an export +## Export multiple work packages -To export work packages to another format, visit the **Work packages** module and select a default or saved work package view (table or card view) that you want to export. Click on the settings icon in the top right corner. Trigger the **Export** dialog from the dropdown menu. +### How to trigger an export + +To export work packages to another format, visit the **Work packages** module and select a default or saved work package view (table or card view) you want to export. Click on the settings icon in the top right corner. Trigger the **Export** dialog from the dropdown menu. ![Exporting from the table](openproject_export_wp.png) This will open a dialog where you can select the desired format. Click on one of the possible formats to start the export. Below, we will detail how to adjust which data should be exported as well as what the various formats contain. -![The export dialog](openproject_wp_export_options.png) - -## Export contents +### Export options -All work packages that are included in the work package table in the currently selected view will be exported, unless a certain export limit has been defined by the instance administrator. The limit can be changed in the [work package settings](../../../system-admin-guide/system-settings/general-settings/#general-system-settings) in the system administration. Newly created instances have a maximum of 500 work packages set as a limit by default. +All work packages included in the work package table in the currently selected view will be exported, unless a certain export limit has been defined by the instance administrator. The limit can be changed in the [work package settings](../../../system-admin-guide/system-settings/general-settings/#general-system-settings) in the system administration. Newly created instances have a maximum of 500 work packages set as a limit by default. -> **Note**: PDF export options includes all of the work packages in the selected work package table, regardless of the limit. The possible export limit is relevant for XLS, CSV and Atom export options. +> [!NOTE] +> PDF export options include all of the work packages in the selected work package table, regardless of the limit. The possible export limit is relevant for XLS, CSV and Atom export options. **Columns** -The exported file will display the columns that are activated for the work package table. By adding or removing specific columns you can control the columns that will be included into the exported file. Please make sure to [save the work package view](../work-package-table-configuration/#save-work-package-views) you configured for the changes to be included into the report. +You can choose which columns will be displayed in the table (excluding long text fields) and change their order. The pre-selected columns are the ones in the work package table query. Learn how to [save the work package view](../work-package-table-configuration/#save-work-package-views). 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. -## Export format options +### Export format options -OpenProject has multiple options of exporting work packages, including PDF, XLS, CSV and Atom. See below what each format entails. +OpenProject has multiple file format options for exporting work packages, including PDF, XLS and CSV. See below what each format entails. -## PDF export +### PDF export -OpenProject has multiple options of exporting work packages in PDF format. +OpenProject has multiple options for exporting work packages in PDF format. These include table, report and Gantt chart. -### PDF Table +#### PDF Table -PDF Table exports the work package table displaying work packages as single rows with the selected columns for the work package table. Work packages IDs are linked to the respective work packages. Clicking on a work package ID will lead you directly to the work package in OpenProject. +PDF Table exports the work package table displaying work packages as single rows with the selected columns for the work package table. Work package IDs are linked to the respective work packages. Clicking on a work package ID will lead you directly to the work package in OpenProject. ![OpenProject PDF Table export](openproject_pdf_table_export.png) -### PDF Report +> [!TIP] +> +> If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included at the bottom of the exported work package table. + +#### PDF Report + +With PDF Reports, you can export detailed up-to-date work plans for your project in a clean and practical format. It includes a title page, a table of contents (listing all of the work packages), followed by the description of single work packages in a block form. The table of contents is clickable and is linked to the respective pages within the report, making navigation much easier. -With PDF Reports you can export detailed up to date work plans for your project in a clean and practical format. It includes a title page, a table of contents (listing all of the work packages), followed by the description of single work packages in a block form. Table of contents is clickable and is linked to the respective pages within the report, making navigation much easier. +![Define a PDF report for OpenProject work packages export](openproject_pdf_export_report_options.png) -For each work package a table of attributes is included, where attributes correspond to the columns in the work package table. For a single work package export, attributes are displayed according to the work package form configuration. +For each work package, a table of attributes is included, where attributes correspond to the columns you specified for the export. For a [single work package export](#export-single-work-package), attributes are displayed according to the work package form configuration. -Table of attributes is followed by the work package description and if necessary custom long text fields, which support [embedded work package and project attributes](../../wysiwyg/#attributes). +The table of attributes is followed by the work package description and, if necessary, custom long text fields, which support [embedded work package and project attributes](../../wysiwyg/#attributes). -> **Note**: Embedding of rich text, e.g. descriptions of other work package, is currently not supported. +> [!NOTE] +> Embedding of rich text, e.g. descriptions of other work packages, is currently not supported. ![OpenProject_pdf_report_export](openproject-pdf-export-work-plans.png) -> **Note**: If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included between table of contents and work packages description in an Overview section. +> [!TIP] +> If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included between the table of contents and work packages description in an Overview section. ![OpenProject_work_package_table_sum](openproject_wp_table_total_sum.png) ![OpenProject_pdf_report_sum](openproject_wp_report_total_sum.png) -### PDF Report with images +#### PDF Report with images -PDF Report with images is the same as PDF Report, but also includes the images from the work package description. +If you select the **Include images** option, your PDF Report will include the images from the work package description. -> **Note**: Images attached or linked in the work package Files section or in the Activity comments are not included into the PDF Report with images. +![Include images in OpenProject work packages export](openproject_wp_report_include_images_checked.png) + +> [!NOTE] +> Images attached or linked in the work package Files section or in the Activity comments are not included in the PDF Report with images. ![OpenProject_work_package_export](openproject_pdf_report_images.png) -> **Note**: if you need to export work packages in a Gantt chart form, please refer to the [Gantt chart PDF Export guide](../../gantt-chart/#gantt-chart-pdf-export-enterprise-add-on). +#### Gantt chart PDF -## Excel (XLS) export +> [!NOTE] +> Gantt chart PDF export is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). An upgrade from the free Community edition is easy and helps support OpenProject. -> **Note**: To open XLS exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows. +You can export Gantt charts directly from the work packages module by selecting the respective option, or from the Gantt charts module by doing the same. -OpenProject can export the table for Microsoft Excel with the following options: +![Gantt chart PDF export in OpenProject](openproject_pdf_export_report_gantt_chart_options.png) + +For more information on using the Gantt chart module and Gantt exports, please refer to the [Gantt chart PDF Export guide](../../gantt-chart/#gantt-chart-pdf-export-enterprise-add-on). -### XLS +### XLS export (Excel) **XLS** is a plain sheet that matches the OpenProject work packages table with its columns and work packages as rows matching the selected filter(s). +> [!TIP] +> To open XLS exported files in Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with the wrong encoding under Microsoft Windows. + +OpenProject can export the table for Microsoft Excel with the following options: + +![Work package export in Excel form in OpenProject](openproject_pdf_export_report_excel_options.png) + +In **XLS** format export, you can manage and reorder columns that should be included, as well as decide if relations and descriptions should be included in the report. + ![OpenProject_work_package_export_excel](openproject_export_excel.png) -### XLS with descriptions +#### XLS with descriptions -**XLS with descriptions** is same as above, but with an additional column for work package descriptions, which cannot be selected in the table. +If you activate the **Include descriptions** option, an additional column will be included in the report, showing work package descriptions. -![OpenProject_work_package_export_excel_description](openproject_pdf_table_export_description.png) +![OpenProject_work_package_export_excel_description](openproject_export_excel_with_descriptions.png) -### XLS with relations +#### XLS with relations -**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. +If you activate the **Include relations** option, additional columns to list each work package relation in a separate row will be included in the report. It will include the relation target and its ID and relation type. -![OpenProject_work_package_export_excel_relations](openproject_pdf_table_export_relations.png) +![OpenProject_work_package_export_excel_relations](openproject_export_excel_with_relations.png) -### Limitations +#### Limitations -The OpenProject XLS export currently does not respect all options in the work package view being exported form: +The OpenProject XLS export currently does not respect all options in the work package view being exported from: -- The order of work packages in a manually sorted query is not respected. This is known limitation ([Ticket](https://community.openproject.org/projects/openproject/work_packages/34971/activity)). +- The order of work packages in a manually sorted query is not respected. This is a known limitation ([Ticket](https://community.openproject.org/projects/openproject/work_packages/34971/activity)). - The hierarchy of work packages as displayed in the work package view. The exported XLS is always in "flat" mode. +- The description is exported in 'raw' format, so it may contain HTML tags. -## CSV export +### CSV export OpenProject can export the table into a comma-separated CSV. This file will be UTF-8 encoded. -> **Note**: To open CSV exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows. +![Export work packages in CSV format in OpenProject](openproject_pdf_report_csv_options.png) -![OpenProject_work_package_export_csv](openproject_export_csv.png) +> [!TIP] +> To open CSV exported files in Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with the wrong encoding under Microsoft Windows. -### Limitations +![OpenProject work package CSV export](openproject_export_csv.png) -The OpenProject CSV export currently does not respect all options in the work package view being exported form: +If you select the **Include descriptions** option, the work package description field will be included in the export. -- The order of work packages in a manually sorted query is not respected. This is known limitation ([Ticket](https://community.openproject.org/projects/openproject/work_packages/34971/activity)). -- The hierarchy of work packages as displayed in the work package view. The exported CSV is always in "flat" mode. +![OpenProject work package CSV export with descriptions](openproject_export_csv_with_descriptions.png) -## Atom (XML) export +#### Limitations -OpenProject can export the table into a XML-based atom format. This file will be UTF-8 encoded. +The OpenProject CSV export currently does not respect all options in the work package view being exported from: -![OpenProject_work_package_export_atom](openproject_export_atom.png) +- The order of work packages in a manually sorted query is not respected. This is a known limitation ([Ticket](https://community.openproject.org/projects/openproject/work_packages/34971/activity)). +- The hierarchy of work packages as displayed in the work package view. The exported CSV is always in "flat" mode. +- The description is exported in 'raw' format, so it may contain HTML tags. -## Export single work packages +## Export single work package -It is also possible to export single work packages in PDF and Atom format. To do that click on the settings icon in the top right corner and select the preferred format from the dropdown menu. +It is also possible to export single work packages in PDF and Atom format. To do that, click on the settings icon in the top right corner and select the preferred format from the dropdown menu. ![OpenProject_single_work_package_export_options](openProject_single_work_package_export_options.png) -An exported PDF file will include all the work package fields that are [configured in the work package form](../../../system-admin-guide/manage-work-packages/work-package-types/#work-package-form-configuration-enterprise-add-on), regardless whether they are filled out or not. +An exported PDF file will include all the work package fields that are [configured in the work package form](../../../system-admin-guide/manage-work-packages/work-package-types/#work-package-form-configuration-enterprise-add-on), regardless of whether they are filled out or not. Atom Export includes a work package Title, Author, a link to the work package and work package activities. diff --git a/docs/user-guide/work-packages/exporting/openproject-pdf-export-work-plans.png b/docs/user-guide/work-packages/exporting/openproject-pdf-export-work-plans.png index 4892e2db8569..7c815acf71f0 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject-pdf-export-work-plans.png and b/docs/user-guide/work-packages/exporting/openproject-pdf-export-work-plans.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_csv.png b/docs/user-guide/work-packages/exporting/openproject_export_csv.png index 2a735b9a80af..943c2320742f 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_export_csv.png and b/docs/user-guide/work-packages/exporting/openproject_export_csv.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_csv_with_descriptions.png b/docs/user-guide/work-packages/exporting/openproject_export_csv_with_descriptions.png new file mode 100644 index 000000000000..8d370ac53a68 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_export_csv_with_descriptions.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_excel.png b/docs/user-guide/work-packages/exporting/openproject_export_excel.png index 7be7ed1edef8..72d1e14fac73 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_export_excel.png and b/docs/user-guide/work-packages/exporting/openproject_export_excel.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_excel_with_descriptions.png b/docs/user-guide/work-packages/exporting/openproject_export_excel_with_descriptions.png new file mode 100644 index 000000000000..f362476270a0 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_export_excel_with_descriptions.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_excel_with_relations.png b/docs/user-guide/work-packages/exporting/openproject_export_excel_with_relations.png new file mode 100644 index 000000000000..3585d179ca75 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_export_excel_with_relations.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_export_wp.png b/docs/user-guide/work-packages/exporting/openproject_export_wp.png index c0c9ae7d6d0a..b166b3885d0a 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_export_wp.png and b/docs/user-guide/work-packages/exporting/openproject_export_wp.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_excel_options.png b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_excel_options.png new file mode 100644 index 000000000000..31b2f2a36f52 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_excel_options.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_gantt_chart_options.png b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_gantt_chart_options.png new file mode 100644 index 000000000000..51a8a3163de0 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_gantt_chart_options.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_options.png b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_options.png new file mode 100644 index 000000000000..98dbbb807f3e Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_pdf_export_report_options.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_pdf_report_csv_options.png b/docs/user-guide/work-packages/exporting/openproject_pdf_report_csv_options.png new file mode 100644 index 000000000000..175101dfbc59 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_pdf_report_csv_options.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_pdf_table_export.png b/docs/user-guide/work-packages/exporting/openproject_pdf_table_export.png index 302b80005960..c2a7fff76bc3 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_pdf_table_export.png and b/docs/user-guide/work-packages/exporting/openproject_pdf_table_export.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_wp_export_options.png b/docs/user-guide/work-packages/exporting/openproject_wp_export_options.png index 82619fcb446b..8403fb703837 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_wp_export_options.png and b/docs/user-guide/work-packages/exporting/openproject_wp_export_options.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_wp_report_include_images_checked.png b/docs/user-guide/work-packages/exporting/openproject_wp_report_include_images_checked.png new file mode 100644 index 000000000000..00f04db8d7a2 Binary files /dev/null and b/docs/user-guide/work-packages/exporting/openproject_wp_report_include_images_checked.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_wp_report_total_sum.png b/docs/user-guide/work-packages/exporting/openproject_wp_report_total_sum.png index a890b900db23..ff7f8b78fbf4 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_wp_report_total_sum.png and b/docs/user-guide/work-packages/exporting/openproject_wp_report_total_sum.png differ diff --git a/docs/user-guide/work-packages/exporting/openproject_wp_table_total_sum.png b/docs/user-guide/work-packages/exporting/openproject_wp_table_total_sum.png index caa160264e68..fe4ed3adcc0e 100644 Binary files a/docs/user-guide/work-packages/exporting/openproject_wp_table_total_sum.png and b/docs/user-guide/work-packages/exporting/openproject_wp_table_total_sum.png differ