OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/user-guide/calendar/README.md

81 lines
4.3 KiB

---
5 years ago
sidebar_navigation:
5 years ago
title: Calendar
5 years ago
priority: 840
5 years ago
description: Create a calendar in OpenProject.
robots: index, follow
keywords: calendar
---
# Calendar
The calendar shows all of the project's work packages in calendar form.
| Topic | Content |
5 years ago
| ------------------------------------------------------------ | ----------------------------------------------------- |
| [Calendar overview](#calendar-overview) | How to use the calendar in OpenProject. |
| [Filters in calendar](#filters-in-calendar) | How to filter in the calendar view. |
| [Zen mode](#zen-mode) | How to work distraction free in a calendar view. |
| [Project overarching calendar](#project-overarching-calendar) | How to display more than one project in the calendar. |
5 years ago
## Calendar overview
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
To display a calendar in a project, the module **calendar** needs to be activated in the [project settings](../projects/#project-settings).
5 years ago
When you open the calendar, all work packages within the current project are displayed on the calendar, displaying the title of the work package. The colors represent the different [work package types](../../system-admin-guide/manage-work-packages/work-package-types).
5 years ago
The current month is automatically selected. You can change the date range between month or week and navigate through the views with the arrows on the left. The **today** button brings you back to the current date.
Hovering over one item displays more information to a work package, such as the type, status, start and finish date, assignee and priority, as well as the project to which the work package belongs.
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
Click on any item to open the work package details or to edit an item.
5 years ago
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
![Calendar overview](calendar-overview.png)
The numbers in the instruction below correspond to the numbers in the image above:
1. Edit/change the name of your calendar or add additional calendars. Each calendar can be customized to display work packages from specific project(s). You can further fine-tune the information displayed using the filters.
2. Change your calendar to be private to you or public to your organization: Select the **[⋮] button** -> **Visibility settings**
a. Check the **Public** box to make the calendar visible to your entire organization.
b. Check the **Favored** box to save the calendar to your favorites.
3. Any calendar that has the **Favored** box checked in the "Visibility settings" will be displayed under the **Favorite Views** heading in the menu bar to the left.
4. Any calendar that has the **Public** box checked in the "Visibility settings" will be displayed under the **Public Views** heading in the menu bar to the left.
5. Any calendar that has the **Public** box unchecked in the **Visibility settings** will be considered **Private**, and hence displayed under the **Private Views** heading in the menu bar to the left.
5 years ago
## Filters in calendar
You can filter the work packages in the calendar view by adding any number of filters, e.g. *Author*, *Due Date*, *Priority*, *Assignee*, etc.
Click the **Filter** button on the top right above the calendar to open the filter details.
To add another filter criteria, select the drop down next to **+ Add filter** and choose a filter criteria.
The number of different filter criteria is displayed on the filter button.
![filter-calendar](filter-calendar.png)
5 years ago
You can also display the calendar on the dashboard in the [project overview](../project-overview/#calendar-widget).
5 years ago
## Zen mode
You can display the calendar in a full screen view to eliminate header and project menu and work distraction free.
Click the **Activate zen mode** button on the top of the calendar.
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
Click Escape (**Esc**) to leave the Zen mode.
5 years ago
![zen-calendar](zen-calendar.png)
5 years ago
## Project overarching calendar
It is possible to display the work packages from more than one project in the calendar. To include, or exclude such work packages, use the **Include projects** dialog, where you can select/unselect the appropriate projects and sub-projects. To automatically include all subprojects for each project you chose to select, check the **Include all sub-projects** box at the bottom of the dialog.
5 years ago
![Select projects](select-projects.png)