From b96f4c76225a0a5b7667a9456982662e1b85308e Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Fri, 14 Feb 2025 13:09:43 +0100 Subject: [PATCH 1/7] Interactive demos added in the user documentation --- docs/ai_actions/work_with_ai_actions.md | 2 ++ docs/content_management/create_edit_content_items.md | 7 +++++-- docs/content_management/create_edit_pages.md | 8 ++++++-- docs/content_management/preview_content_items.md | 3 +++ docs/content_management/schedule_publishing.md | 2 ++ docs/content_management/work_with_forms.md | 8 ++++++++ .../workflow_management/editorial_workflow.md | 4 +++- .../workflow_management/work_with_versions.md | 3 +++ docs/getting_started/dashboard/dashboard.md | 6 +++++- docs/getting_started/discover_ui.md | 2 ++ docs/getting_started/get_started.md | 6 +++++- docs/image_management/upload_images.md | 2 ++ 12 files changed, 46 insertions(+), 7 deletions(-) diff --git a/docs/ai_actions/work_with_ai_actions.md b/docs/ai_actions/work_with_ai_actions.md index 38242590..406b43ad 100644 --- a/docs/ai_actions/work_with_ai_actions.md +++ b/docs/ai_actions/work_with_ai_actions.md @@ -7,6 +7,8 @@ description: Create new AI actions or modify existing ones to work faster and in AI actions define what results are available to editors in AI-enabled areas, such as, for example, the AI Assistant. If the AI Actions LTS update has been installed and configured in your application, and you have the required [permissions]([[= developer_doc =]]/permissions/policies/#ai-actions), including `Action configuration/Edit` and `Action configuration/Create`, you can reconfigure the existing AI actions, and create new ones. +
+ ## View AI actions With the right permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting **AI actions**. diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md index ec168a6e..ec19582f 100644 --- a/docs/content_management/create_edit_content_items.md +++ b/docs/content_management/create_edit_content_items.md @@ -54,6 +54,9 @@ description: Create content for your website with different fields, rich text, t For more information, see [Publish content](publish_content.md). +
+ + !!! note "Versioning and autosave" Whenever you edit a content item, a [new version](content_versions.md) is created in the repository. @@ -99,7 +102,7 @@ Its options appear when you click inside the field box. ![Online editor menu](img/online_editor_menu.png "Online editor menu") -You can chooose from available options to edit and customize Rich Text field, for example, move up or down its elements, select heading style, add text elements, like superscript, block quote, or anchor. +You can choose from available options to edit and customize Rich Text field, for example, move up or down its elements, select heading style, add text elements, like superscript, block quote, or anchor. You can also add new elements to the field. To do it, choose one of the available elements: @@ -118,7 +121,7 @@ To do it, choose one of the available elements: Each of these elements can have its own settings, such as text formatting. The option bar also lets you reorder or remove any elements in the Rich Text field. - +
#### Edit embedded content items diff --git a/docs/content_management/create_edit_pages.md b/docs/content_management/create_edit_pages.md index 1f97977c..e41227a9 100644 --- a/docs/content_management/create_edit_pages.md +++ b/docs/content_management/create_edit_pages.md @@ -38,18 +38,22 @@ You can now navigate away from the Page by clicking the **Close** button. !!! note "Autosave" - To help you preserve your work, [[= product_name =]] saves drafts of content items automatically. + To help you preserve your work, [[= product_name =]] saśves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave). ## Edit page To edit an existing page, in the back office, from the content tree, choose the page that you want to edit, and click the **Edit** button. +
+ ### Page Builder interface Page Builder has a plain and intuitive interface. You can create pages without having advanced technical skills. +
+ ![Page Builder interface](img/page_builder_interface.png) Page Builder user interface consists of: @@ -249,4 +253,4 @@ There are several options for saving work on the page: |Save draft|Save the page draft*.| |Delete draft|Delete the page draft.| -* To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/master/content_management/content_versions/#autosave). +* To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/master/content_management/content_versions/#autosave). \ No newline at end of file diff --git a/docs/content_management/preview_content_items.md b/docs/content_management/preview_content_items.md index f4727e79..369f350c 100644 --- a/docs/content_management/preview_content_items.md +++ b/docs/content_management/preview_content_items.md @@ -30,3 +30,6 @@ Additionally, if you select a specific SiteAccess from the **Site context** drop - when you hover over content items in the content tree, miniature previews appear - in Focus mode, when you browse content items in content tree, their full screen preview is displayed - if you [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode) or click **Exit full view**, the **View** tab appears in the content item's details view, where you can quickly preview the content item + +
\ No newline at end of file diff --git a/docs/content_management/schedule_publishing.md b/docs/content_management/schedule_publishing.md index 42c2140f..0909c5e9 100644 --- a/docs/content_management/schedule_publishing.md +++ b/docs/content_management/schedule_publishing.md @@ -46,6 +46,8 @@ Use it to remove the previously selected publication date. ![Discard publish later button in the menu](img/discard_publish_date.png "Discard publish later button in the menu") +
+ You can also [reschedule or cancel planned publications](#reschedule-or-cancel-publication). To browse all the future events, use the [Calendar widget](#calendar-widget). diff --git a/docs/content_management/work_with_forms.md b/docs/content_management/work_with_forms.md index 9fa2cf26..5b87e74a 100644 --- a/docs/content_management/work_with_forms.md +++ b/docs/content_management/work_with_forms.md @@ -10,6 +10,10 @@ You can then review the results gathered from website users, for example, to imp For more information about building and styling forms, see [Developer Documentation]([[= developer_doc =]]/content_management/forms/forms). +You can create a form with a visual drag-and-drop editor, the Form Builder. + +
+ ## Create forms Editors can use the created form anywhere on the website. @@ -65,6 +69,10 @@ You can choose one of a few options of what is shown to the user after filling i For more information, see [Publish content](publish_content.md). +**Check out the interactive demo below:** + +
+ ## View results Once you publish a form and users start filling it in, you can preview the results in the **Submissions** tab in the content item view. diff --git a/docs/content_management/workflow_management/editorial_workflow.md b/docs/content_management/workflow_management/editorial_workflow.md index 0be4e2f0..791bb52e 100644 --- a/docs/content_management/workflow_management/editorial_workflow.md +++ b/docs/content_management/workflow_management/editorial_workflow.md @@ -27,4 +27,6 @@ If your installation is [configured to support draft locking]([[= developer_doc In the Review queue table, you can access the draft for editing, review its history, unlock the draft, or request that a lock is released. -For more information, see [Work with versions](work_with_versions.md). \ No newline at end of file +For more information, see [Work with versions](work_with_versions.md). + +
\ No newline at end of file diff --git a/docs/content_management/workflow_management/work_with_versions.md b/docs/content_management/workflow_management/work_with_versions.md index 4d4cc55f..cbcd6542 100644 --- a/docs/content_management/workflow_management/work_with_versions.md +++ b/docs/content_management/workflow_management/work_with_versions.md @@ -26,6 +26,7 @@ You can also do it in **My dashboard**, the **Review queue** table, by clicking If you're not assigned to the draft, depending on the permissions set for your role, in the **Review queue** table, you can either release the lock by clicking the **Unlock** icon, or request that the lock is released by the reviewer by clicking the **Request access** icon. ## Compare versions + You can compare two versions of the same content item. To do it, [disable the Focus mode](../../getting_started/discover_ui.md#disable-focus-mode). @@ -50,6 +51,8 @@ When you compare two versions, the system highlights the changes: ![Version comparison in Split view](img/split_view.png "Version comparison in Split view") +
+ You can also compare media field types such as images. ![Image comparison](img/image_comparison.png "Image comparison") diff --git a/docs/getting_started/dashboard/dashboard.md b/docs/getting_started/dashboard/dashboard.md index 162e142c..929df006 100644 --- a/docs/getting_started/dashboard/dashboard.md +++ b/docs/getting_started/dashboard/dashboard.md @@ -40,4 +40,8 @@ By default, dashboard in [[= product_name_exp =]] and [[= product_name_com =]] c ![Dashboard - Experience and Commerce edition](dashboard.png "Default dashboard in Experience and Commerce edition") -For more information, see [Work with dashboard](work_with_dashboard.md). \ No newline at end of file +For more information, see [Work with dashboard](work_with_dashboard.md). + +**Check out the interactive demo below:** + +
\ No newline at end of file diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index 7cb5707d..b179986c 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -104,6 +104,8 @@ Focus mode helps editors focus on information that is only relevant to their lin It's enabled by default, after you log in. If you need access to certain settings or technical details, you can [disable the focus mode](#disable-focus-mode) at any time. +
+ - **Dark theme for content tree** : In areas where the content tree is displayed, for example, in **Content structure**, the tree is displayed on a dark background. diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md index 97b2283f..e587f1e2 100644 --- a/docs/getting_started/get_started.md +++ b/docs/getting_started/get_started.md @@ -141,4 +141,8 @@ Then, click **Change password**. Fill in all the required fields and click **Save and close** to save changes. Click **Discard** to reject your changes and return to the previous screen. -![Editing password](img/editing_password.png "Editing password") \ No newline at end of file +![Editing password](img/editing_password.png "Editing password") + +**Check out the interactive demo below:** + +
\ No newline at end of file diff --git a/docs/image_management/upload_images.md b/docs/image_management/upload_images.md index 026002a5..ac41094c 100644 --- a/docs/image_management/upload_images.md +++ b/docs/image_management/upload_images.md @@ -50,6 +50,8 @@ Tagging image assets helps keep the media library organized and enables searchin The maximum file size and file extension limitations may differ depending on your configuration. +
+ ## Edit image assets and images After you upload the image to create an image asset, you can adjust it according to your needs. From ba3e3424634440a31c97a19060a2142dfd2a55de Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Fri, 14 Feb 2025 13:38:17 +0100 Subject: [PATCH 2/7] Interactive demo for copy block section added --- docs/content_management/create_edit_content_items.md | 1 - docs/content_management/create_edit_pages.md | 2 ++ 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md index ec19582f..9e6d557c 100644 --- a/docs/content_management/create_edit_content_items.md +++ b/docs/content_management/create_edit_content_items.md @@ -56,7 +56,6 @@ description: Create content for your website with different fields, rich text, t
- !!! note "Versioning and autosave" Whenever you edit a content item, a [new version](content_versions.md) is created in the repository. diff --git a/docs/content_management/create_edit_pages.md b/docs/content_management/create_edit_pages.md index fe6cbee5..5ea1ee43 100644 --- a/docs/content_management/create_edit_pages.md +++ b/docs/content_management/create_edit_pages.md @@ -182,6 +182,8 @@ Content of the clipboard is visible only to you, and preserves switching into a ![The clipboard section containing a Code block](img/page_builder_page_blocks_clipboard.png "The clipboard section containing a Code block") +
+ #### Configure block settings Each kind of block has its special settings. From 5ba19df2162f4333c1cc7b875955db499e7fb279 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Fri, 14 Feb 2025 13:46:00 +0100 Subject: [PATCH 3/7] typo fix --- docs/content_management/create_edit_pages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content_management/create_edit_pages.md b/docs/content_management/create_edit_pages.md index 5ea1ee43..b347207f 100644 --- a/docs/content_management/create_edit_pages.md +++ b/docs/content_management/create_edit_pages.md @@ -38,7 +38,7 @@ You can now navigate away from the Page by clicking the **Close** button. !!! note "Autosave" - To help you preserve your work, [[= product_name =]] saśves drafts of content items automatically. + To help you preserve your work, [[= product_name =]] saves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave). ## Edit page From d7f892e9de07cb3d42e75cd0db3e23cf051d5688 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Fri, 14 Feb 2025 13:47:27 +0100 Subject: [PATCH 4/7] title fix --- docs/image_management/upload_images.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/image_management/upload_images.md b/docs/image_management/upload_images.md index ac41094c..fd2a371e 100644 --- a/docs/image_management/upload_images.md +++ b/docs/image_management/upload_images.md @@ -50,7 +50,7 @@ Tagging image assets helps keep the media library organized and enables searchin The maximum file size and file extension limitations may differ depending on your configuration. -
+
## Edit image assets and images From 90f7c55aab3e20debe9fb3f388ba053486d3d05d Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Mon, 17 Feb 2025 08:36:24 +0100 Subject: [PATCH 5/7] fixes --- docs/getting_started/discover_ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index b179986c..45122d12 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -61,7 +61,7 @@ Depending on the product edition and your [permissions](../permission_management - **Content**, which gives you access to the content repository. It lets you navigate the content tree, and, for example, create, edit, move, copy, or delete content. -- [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] **Site management**, which enables you to create and edit block-based Pages and manage multiple websites. +- [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] **Site management**, which enables you to create and edit block-based pages and manage multiple websites. - **PIM**, which enables you to handle products presented on the website, including their specifications and pricing. - **Admin**, which is the administration panel where you can manage, for example, Users, Sections, or permissions. From edbd7defc454117c5a6d0eefdea2fedf0a9300a8 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Mon, 17 Feb 2025 08:41:43 +0100 Subject: [PATCH 6/7] demo moved in dashboard section --- docs/getting_started/dashboard/dashboard.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/getting_started/dashboard/dashboard.md b/docs/getting_started/dashboard/dashboard.md index 929df006..c1230a7a 100644 --- a/docs/getting_started/dashboard/dashboard.md +++ b/docs/getting_started/dashboard/dashboard.md @@ -7,6 +7,8 @@ description: Get to know about dashboard. Dashboard is the first screen that you see after you log into [[= product_name =]]. It provides users a quick overview about specific content to make better business decisions based on data and work more efficiently with a clear and effortless access to important information. +
+ Default dashboard in [[= product_name_headless =]] contains the following blocks: - [Review queue](dashboard_block_reference.md#review-queue-block) @@ -41,7 +43,3 @@ By default, dashboard in [[= product_name_exp =]] and [[= product_name_com =]] c ![Dashboard - Experience and Commerce edition](dashboard.png "Default dashboard in Experience and Commerce edition") For more information, see [Work with dashboard](work_with_dashboard.md). - -**Check out the interactive demo below:** - -
\ No newline at end of file From 911e7ab6511ac499bf780c0b369ead2c41da47ee Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Tue, 18 Feb 2025 09:33:35 +0100 Subject: [PATCH 7/7] Fixes after review --- docs/ai_actions/work_with_ai_actions.md | 2 -- docs/content_management/create_edit_content_items.md | 1 + docs/content_management/work_with_forms.md | 2 -- docs/getting_started/get_started.md | 2 -- 4 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/ai_actions/work_with_ai_actions.md b/docs/ai_actions/work_with_ai_actions.md index 406b43ad..38242590 100644 --- a/docs/ai_actions/work_with_ai_actions.md +++ b/docs/ai_actions/work_with_ai_actions.md @@ -7,8 +7,6 @@ description: Create new AI actions or modify existing ones to work faster and in AI actions define what results are available to editors in AI-enabled areas, such as, for example, the AI Assistant. If the AI Actions LTS update has been installed and configured in your application, and you have the required [permissions]([[= developer_doc =]]/permissions/policies/#ai-actions), including `Action configuration/Edit` and `Action configuration/Create`, you can reconfigure the existing AI actions, and create new ones. -
- ## View AI actions With the right permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting **AI actions**. diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md index 9e6d557c..515c1446 100644 --- a/docs/content_management/create_edit_content_items.md +++ b/docs/content_management/create_edit_content_items.md @@ -220,6 +220,7 @@ When response is displayed on the screen, depending on whether you are satisfied Depending on the length of the source text and the complexity of request, processing may take a while. You may cancel the processing if it takes too long by clicking **Stop**. +
### SeenThis! streaming diff --git a/docs/content_management/work_with_forms.md b/docs/content_management/work_with_forms.md index 5b87e74a..6c768841 100644 --- a/docs/content_management/work_with_forms.md +++ b/docs/content_management/work_with_forms.md @@ -69,8 +69,6 @@ You can choose one of a few options of what is shown to the user after filling i For more information, see [Publish content](publish_content.md). -**Check out the interactive demo below:** -
## View results diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md index e587f1e2..2ce513c8 100644 --- a/docs/getting_started/get_started.md +++ b/docs/getting_started/get_started.md @@ -143,6 +143,4 @@ Click **Discard** to reject your changes and return to the previous screen. ![Editing password](img/editing_password.png "Editing password") -**Check out the interactive demo below:** -
\ No newline at end of file