Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#57590] 14.5 Documentation: Store revisions of WYSIWYG content in lo… #16636

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
26 changes: 16 additions & 10 deletions docs/user-guide/wiki/create-edit-wiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ In OpenProject you can create and edit wiki pages together with your team to doc

To create a new wiki page in a project, navigate to the wiki module in your project menu and click on the green **+ Wiki page** button in the toolbar on the right hand side.

![create-wiki-page](1568198706474.png)
![Create a new wiki page in OpenProject](openproject_user_guide_create_wiki_page_button.png)

> **Note**: If you do not see the wiki module in your project menu, you first have to [activate the module in your project settings](../../projects).
> [!TIP]
>
> If you do not see the wiki module in your project menu, you first have to [activate the module in your project settings](../../projects).

The editor window will open, allowing you to enter title and content of the new page.

Expand All @@ -34,18 +36,24 @@ The editor window will open, allowing you to enter title and content of the new
5. Comment which changes you have made to a wiki page.
6. Save (or cancel) your changes to the page.

![create-wiki](create-wiki-1568199670933.png)
![Form to create a new wiki page in OpenProject](openproject_user_guide_create_wiki_page_form.png)

## Edit a wiki page

To edit a wiki page, click the **Edit** button on the wiki page details on the top right.

![edit-wiki-page](edit-wiki-page.png)
![Edit wiki page in OpenProject](openproject_user_guide_edit_wiki_page_button.png)

The text editor will be opened to make changes to the wiki page, as described above, how to [create a new wiki page](#create-a-new-wiki-page).

Do not forget to **Save** your changes after you finished editing the page.

> [!TIP]
>
> Changes you made are saved locally. If you navigated away from page or could not save your changes due to a technical difficulty, you can access latest changes via the editor toolbar.

![Restore local backups in text editor in OpenProject](openproject_user_guide_wiki_autosave_icon.png)

### Change the wiki page title

To rename a wiki page, simply select the wiki page you want to change, and click the **Edit** button on the top right of the page. Click in the title and just enter the new name of the page.
Expand All @@ -54,26 +62,24 @@ Do not forget to **Save** your changes by pressing the button at the bottom of t

## Create a wiki page structure

If you want to create a wiki structure with different pages and sub-pages, you can enter a parent page for a wiki page which then will be displayed automatically in the wiki page menu.

![wiki-page-structure](1568209656591.png)
If you want to create a wiki structure with different pages and sub-pages, you can enter a parent page for a wiki page which then will be displayed automatically in the wiki page menu on the left.

If you are on an existing wiki page and click the green **+ Wiki page** button on top of the page to [create a new wiki page](#create-a-new-wiki-page), the wiki page will already be pre-selected as a **parent page**.

![wiki-parent-page](1568209633619.png)
![Wiki page structure example with page parent](openproject_user_guide_wiki_child_page_example.png)

You can change the parent page afterwards to change the wiki page structure by clicking on the **Edit** button of an existing wiki page and select the new parent page at the bottom of the form.

If you select **-- No parent page --** the wiki page will be displayed at first level of the wiki navigation in the project menu.

The pages are ordered alphabetically in the wiki menu.

![wiki-page-structure](1568210445539.png)
![Wiki page structure example with no parent](openproject_user_guide_wiki_noparent_page_example.png)

## Watch a wiki page

If you want to keep updated about any changes to a wiki page, you can make use of the **Watch** option. Browse to the wiki page you want to watch and click on the **Watch** button in the top right corner. You can undo this choice at any time.

![watch-wiki](watch-wiki.png)
![Watch a wiki page in OpenProject](openproject_user_guide_watch_wiki_page_button.png)

With this function being activated, you will receive an e-mail notification (according to your email preferences) after every page update, including a link to the respective changes.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/user-guide/wiki/create-edit-wiki/watch-wiki.png
Binary file not shown.
Binary file modified docs/user-guide/wiki/openproject_user_guide_wiki.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/wiki/openproject_user_guide_wiki_emoji.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/user-guide/work-packages/edit-work-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ The green message on top of the work package indicates a successful update.

![Successful update message in OpenProject work package](openproject_user_guide_wp_update_message.png)

> [!TIP]
>
> Changes you made are saved locally. If you navigated away from page or could not save your changes due to a technical difficulty, you can access latest changes via the editor toolbar.

![Restore local backups in text editor in OpenProject](openproject_user_guide_wp_autosave_icon.png)

All changes of a work package are documented in the work package tab [Activity](../../../getting-started/work-packages-introduction/#activity-of-work-packages).

> [!NOTE]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.