Skip to content

Commit d28cbb2

Browse files
committed
[IMP] knowledge/management: update Articles management
task-4444311 closes #12909 X-original-commit: 671237d Signed-off-by: Xavier Platteau (xpl) <[email protected]>
1 parent 0f4e708 commit d28cbb2

File tree

6 files changed

+195
-88
lines changed

6 files changed

+195
-88
lines changed

Diff for: content/applications/essentials/export_import_data.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ modification. This document covers the export and import of data into and out of
1313
can occur with large exports, or in cases where the import file is too large. To circumvent this
1414
limitation surrounding the size of the records, process exports or imports in smaller batches.
1515

16-
.. _export-data:
16+
.. _essentials/export_import_data/export-data:
1717

1818
Export data from Odoo
1919
=====================
@@ -66,7 +66,7 @@ several options for the data to export:
6666
in the export user interface is equal to *parent_id* (external identifier). This is helpful
6767
because then, the only data exported is what should be modified and re-imported.
6868

69-
.. _import-data:
69+
.. _essentials/export_import_data/import-data:
7070

7171
Import data into Odoo
7272
=====================
@@ -534,14 +534,15 @@ that are able to be imported.
534534
unless it is manually added, but it is still included in the export. However, if the :guilabel:`I
535535
want to update data (import-compatible export)` checkbox is ticked, it is included in the export.
536536

537-
Select the required fields to be included in the export using the :ref:`options <export-data>` on
538-
the pop-up window, then click :guilabel:`Export`.
537+
Select the required fields to be included in the export using the :ref:`options
538+
<essentials/export_import_data/export-data>` on the pop-up window, then click :guilabel:`Export`.
539539

540540
Import updated data
541541
-------------------
542542

543543
After exporting, make any necessary changes to the data file. When the file is ready, it can be
544-
:ref:`imported <import-data>` by following the same process as a normal data import.
544+
:ref:`imported <essentials/export_import_data/import-data>` by following the same process as a
545+
normal data import.
545546

546547
.. danger::
547548
When updating data, it is extremely important that the *External ID* remain consistent, as

Diff for: content/applications/essentials/html_editor.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ toolbar and apply any of the following formatting options:
5151
the tone by clicking buttons such as :guilabel:`Correct, Shorten, Lengthen, Friendly,
5252
Professional`, and :guilabel:`Persuasive`.
5353

54-
.. image:: text_editor/style-and-colors.png
54+
.. image:: html_editor/style-and-colors.png
5555
:alt: Text editor's toolbox
5656

5757

Diff for: content/applications/productivity/knowledge/articles_editing.rst

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Article creation and editing
33
============================
44

5+
.. _knowledge/articles_editing/create-article:
6+
57
Article creation
68
================
79

@@ -118,6 +120,8 @@ To add a title emoji to the article's name and header:
118120
- Alternatively, click the :icon:`fa-file-text-o` :guilabel:`(page)` icon next to the article's
119121
name in the sidebar or the top bar and select the preferred emoji.
120122

123+
.. _knowledge/articles_editing/views:
124+
121125
Views and links from other apps
122126
-------------------------------
123127

+181-79
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,216 @@
1-
===================
2-
Articles management
3-
===================
1+
==================
2+
Article management
3+
==================
44

5-
Managing articles effectively is key to maximizing the value of your knowledge resources, whether
6-
working on a research project, studying for an exam, or building a knowledge database for your
7-
business. Knowledge allows you to fully manage your articles, from
8-
:ref:`creation <management/create>` to :ref:`removal <management/remove>`, through :ref:`sharing
9-
<management/share>` and :ref:`structure <management/structure>`.
5+
Knowledge allows for managing articles, which consists of :ref:`structuring
6+
<knowledge/management/structure>`, :ref:`sharing <knowledge/management/share>`, :ref:`removing
7+
<knowledge/management/remove>`, and :ref:`retrieving <knowledge/management/retrieve>` them.
108

11-
You can find most tools to manage articles by clicking the vertical ellipsis button (:guilabel:``)
12-
at the right side of the top bar. From there, you can move, lock, delete, or duplicate an article.
9+
Basic management
10+
================
1311

14-
.. image:: management/toolbox.png
15-
:alt: Menu with tools for the management of articles
12+
Click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon and select one of the following actions
13+
for basic article management:
1614

17-
Creation, sharing, and removal of articles
18-
==========================================
15+
- :guilabel:`Move To`: Select the article to move under a category or another article, then click
16+
:guilabel:`Move Article`.
17+
- :guilabel:`Lock Content`: Lock the article to stop edits. Click :guilabel:`Unlock` to edit again.
18+
- :guilabel:`Create a Copy`: Copy the article under the :guilabel:`Private` section.
19+
- :guilabel:`Open Version History`: View the current and previous versions of the article.
20+
- :guilabel:`Export`: Open the browser's print function.
21+
- :guilabel:`Add to Templates`: Add the article to the list of templates.
22+
- :guilabel:`Send to Trash`: Move the article to the trash.
1923

20-
.. _management/create:
24+
.. note::
25+
The following actions only apply to nested articles and :ref:`article items
26+
<knowledge/articles_editing/commands>`:
2127

22-
Creation
23-
--------
24-
25-
To create articles, click the :guilabel:`+ New` button on the right side of the top bar or the
26-
:guilabel:`+` button next to a category or another article.
28+
- :guilabel:`Convert into Article Item`: Convert the nested article into an article item.
29+
- :guilabel:`Convert into Article`: Convert the article item into a nested article.
2730

2831
.. tip::
29-
Create private articles quickly with the Alt/Option + C keyboard shortcut.
32+
- Move an article directly from the sidebar tree by dragging and dropping it under another
33+
article or category.
34+
- Press `CTRL` / `CMD` + `K` to open the command palette, then type `?` to search for visible
35+
articles or `$` for :ref:`hidden articles <knowledge/management/visibility>`. Alternatively,
36+
hover over the :guilabel:`Workspace` category and click the :icon:`fa-eye` (:guilabel:`eye`)
37+
icon to find hidden articles.
38+
39+
.. _knowledge/management/structure:
40+
41+
Structuring
42+
===========
43+
44+
The article structure follows a hierarchy with parent and nested articles organized within the
45+
following categories:
3046

31-
.. _management/share:
47+
- :guilabel:`Favorites` displays all articles marked as favorites.
48+
- :guilabel:`Workspace` displays articles accessible to all internal users.
49+
- :guilabel:`Shared` displays articles shared with specific users.
50+
- :guilabel:`Private` displays personal articles.
51+
52+
.. note::
53+
- To mark an article as a favorite and display the :guilabel:`Favorites` category, click the
54+
:icon:`fa-star-o` (:guilabel:`star`) icon in the top-right menu.
55+
- Nested articles inherit the access rights of their parent article.
56+
57+
.. _knowledge/management/share:
3258

3359
Sharing
34-
-------
60+
=======
61+
62+
Sharing an article involves configuring :ref:`access rights <knowledge/management/rights>`,
63+
inviting :ref:`users <knowledge/management/invite>`, providing :ref:`online access
64+
<knowledge/management/share-online>`, and determining its visibility in the :ref:`sidebar tree
65+
<knowledge/management/structure>`.
66+
67+
Articles listed under a category in the sidebar tree are visible. Articles that certain users must
68+
search for through the command palette due to restricted access rights are hidden.
69+
70+
.. _knowledge/management/rights:
71+
72+
Configure access rights
73+
-----------------------
74+
75+
Click :guilabel:`Share` in the top-right menu to configure access rights.
76+
77+
Default access rights
78+
~~~~~~~~~~~~~~~~~~~~~
79+
80+
.. tabs::
3581

36-
You can share articles with internal or external users. To do so, open the share menu by clicking
37-
:guilabel:`Share` in the top-right menu of articles.
82+
.. list-table::
83+
:widths: 20 80
84+
:header-rows: 1
85+
:stub-columns: 1
3886

39-
Invite users
40-
~~~~~~~~~~~~
87+
* - Setting
88+
- Use
89+
* - :guilabel:`Can edit`
90+
- Allow all internal users to edit the article.
91+
* - :guilabel:`Can read`
92+
- Allow all internal users to read the article only.
93+
* - :guilabel:`No access`
94+
- Prevent all users from accessing the article in the sidebar tree or searching in the
95+
command palette.
4196

42-
To share articles with specific users (internal or external, such as a partner or a customer), click
43-
:guilabel:`Invite`. This opens a pop-up window in which you can choose the :guilabel:`Permission`
44-
:ref:`(i.e, access rights) <management/categories>` and enter the :guilabel:`Recipients`' name or
45-
email.
97+
.. _knowledge/management/visibility:
4698

47-
You can also restrict a specific user from accessing the article by selecting :guilabel:`No access`
48-
permission.
99+
Visibility
100+
~~~~~~~~~~
49101

50-
.. image:: management/invite.png
51-
:alt: pop-up window to invite users to access a Knowledge article
102+
.. tabs::
52103

53-
Share online
54-
~~~~~~~~~~~~
104+
.. list-table::
105+
:widths: 20 80
106+
:header-rows: 1
107+
:stub-columns: 1
55108

56-
To share articles **online**, activate the :guilabel:`Share to web` button. Doing so generates a URL
57-
link anyone can use to view the article.
109+
* - Setting
110+
- Use
111+
* - :guilabel:`Everyone`
112+
- The article is visible in the sidebar tree to all internal users.
113+
* - :guilabel:`Members`
114+
- The article is only visible in the sidebar tree to :ref:`invited users
115+
<knowledge/management/invite>`, while other users can find it using the hidden article
116+
search by pressing `CTRL` / `CMD` + `K` and typing `$`.
58117

59-
Additionally, the share menu displays the default permission for internal members along with all the
60-
users who have been granted specific permission.
118+
.. note::
119+
- The :guilabel:`Default Access Rights` apply to all internal users except invited users;
120+
specific access rights override default access rights.
121+
- Selecting `Can edit` or `Can read` in the :guilabel:`Default Access Rights` moves the article
122+
to the :guilabel:`Workspace` category, while selecting `No access` moves it to the
123+
:guilabel:`Private` category if it is not shared with anyone.
124+
- The :guilabel:`Visibility` setting only applies to :guilabel:`Workspace` articles.
61125

62-
.. image:: management/share-menu.png
63-
:alt: Sharing menu with URL for online sharing and the list of members.
126+
.. _knowledge/management/invite:
64127

65-
.. _management/remove:
128+
Invite specific users
129+
---------------------
130+
131+
To grant specific internal or portal users access to a private article or to share a
132+
:guilabel:`Workspace` article with a portal user, follow these steps:
133+
134+
#. Click :guilabel:`Share` in the top-right menu.
135+
#. Click :guilabel:`Invite`.
136+
#. Select the preferred :guilabel:`Permission` and add users in the :guilabel:`Recipients` field.
137+
#. Click :guilabel:`Invite`.
138+
139+
.. _knowledge/management/share-online:
140+
141+
Generate article URL
142+
--------------------
143+
144+
Click :guilabel:`Share` and activate the :guilabel:`Share to web` toggle to generate a URL.
145+
Click the :icon:`fa-clone` (:guilabel:`copy`) icon to copy the article's URL.
146+
147+
.. note::
148+
- If an article contains :ref:`inserted views <knowledge/articles_editing/views>`, users with
149+
the URL do not see them unless they can access the inserted content.
150+
- Having the Website app is necessary to share an article's URL.
151+
152+
.. _knowledge/management/remove:
66153

67154
Removal
68-
-------
155+
=======
156+
157+
Removing an article involves deleting or archiving it.
158+
159+
Delete an article
160+
-----------------
161+
162+
Select an article in the sidebar tree and click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`)
163+
icon, then :guilabel:`Send to Trash`. The article is moved to the trash for 30 days before being
164+
permanently deleted.
165+
166+
To delete an article directly, click :guilabel:`Articles` in the top-left menu, select an article,
167+
and click :menuselection:`Actions --> Delete --> Delete` to remove the article permanently.
168+
169+
.. note::
170+
To restore a trashed article, click :guilabel:`Open the Trash` at the bottom of the sidebar
171+
tree, select an article, and click :guilabel:`Restore`. Alternatively, click :guilabel:`Articles`
172+
in the top-left menu. In the search bar, click :menuselection:`Filters --> Trashed`. Click the
173+
article, then :guilabel:`Restore`.
69174

70-
To remove an article, you can either **delete** it or **archive** it.
175+
Archive an article
176+
------------------
71177

72-
To delete an article, open it and click the vertical ellipsis button :menuselection:`(⋮) -->
73-
Delete`. The article is moved to the trash for 30 days before being permanently deleted. To restore
74-
it, click :guilabel:`Open the Trash`, select the article, and click :guilabel:`Restore`.
178+
Click :guilabel:`Articles`, select an article, and click :menuselection:`Actions --> Archive -->
179+
Archive`.
75180

76-
To archive articles, click :guilabel:`Search`, select the article(s), and click
77-
:menuselection:`Action --> Archive --> Archive`. Archived articles are hidden from the search menu.
78-
To retrieve an archived article, add a custom filter to display them (:menuselection:`Search -->
79-
Filters --> Add Custom Filter`, and set :guilabel:`Active` as :guilabel:`is No`). Then, select the
80-
article(s) and go to :menuselection:`Action --> Unarchive`.
181+
.. note::
182+
To restore an archived article, click :guilabel:`Articles`. In the search bar, click
183+
:menuselection:`Filters --> Archived`. Select the article and go to :menuselection:`Actions -->
184+
Unarchive`.
81185

82-
.. _management/structure:
186+
.. _knowledge/management/retrieve:
83187

84-
Structure of articles
85-
=====================
188+
Retrieval
189+
=========
86190

87-
Articles are organized into a hierarchical structure wherein the article on top is a parent article,
88-
and those underneath are called nested articles. This structure allows the grouping of related
89-
articles.
191+
Retrieving Knowledge articles consists of accessing them from various Odoo apps or restoring
192+
previous versions.
90193

91-
To establish this hierarchy, create new articles by clicking the :guilabel:`+` button next to the
92-
parent-to-be article, or move existing articles by either dragging and dropping them under the
93-
parent-to-be or by clicking the vertical ellipsis button (:guilabel:``), clicking :guilabel:`Move
94-
To` on the toolbox and selecting the article to use as a parent.
194+
Access articles from various apps
195+
---------------------------------
95196

96-
.. _management/categories:
197+
Knowledge articles are accessible from the :ref:`form view <studio/views/general/form>` of various
198+
apps. Click the :icon:`fa-bookmark` :guilabel:`(Knowledge)` icon in the top right corner to open
199+
the command palette, then choose one of the following search methods:
97200

98-
Categories
99-
----------
201+
- :guilabel:`Search for an article`: start typing the text to execute a semantic search that
202+
identifies relevant article information.
203+
- :guilabel:`Advanced Search`: after typing the text in the search bar, click :guilabel:`Advanced
204+
Search` to perform a parametric search with options to filter, group, or save articles.
100205

101-
Additionally, articles are divided into four categories that can be found on the left sidebar. These
102-
categories give articles default **access rights**.
206+
Version history
207+
---------------
103208

104-
- :guilabel:`Favorites`: You can set any article you can access as a favorite. To do so, click the
105-
star-shaped icon (:guilabel:``) in the top-right menu of articles. Marking articles as
106-
**favorites** is user-specific and does not affect other users.
107-
- :guilabel:`Workspace`: Articles displayed in that category are available to all internal users.
108-
These users have the right to read, modify or share these articles.
109-
- :guilabel:`Shared`: Articles displayed in that category are those you shared with internal users,
110-
external users, or shared with you.
111-
- :guilabel:`Private`: Articles displayed in that category are only available to you.
209+
To retrieve a previous version of an article, click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`)
210+
icon and select :guilabel:`Open Version History`. Select a version and click :guilabel:`Restore
211+
history`.
112212

113-
.. image:: management/left-sidebar-cat.png
114-
:alt: Categories displayed in the left sidebar of Odoo Knowledge
213+
.. note::
214+
In the version history, the :guilabel:`Content` tab shows the selected version, while the
215+
:guilabel:`Comparison` tab displays the differences between the article's previous and current
216+
versions.

Diff for: content/applications/websites/ecommerce/products.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ page. When you :guilabel:`Save`, the product page is automatically published.
4545
Import products
4646
---------------
4747

48-
To :ref:`import product data <import-data>` using XLSX or CSV files, go to
49-
:menuselection:`Website --> eCommerce --> Products`, click the :icon:`fa-cog` (:guilabel:`gear`)
50-
icon, then :ref:`Import records <import-data>`.
48+
To :ref:`import product data <essentials/export_import_data/import-data>` using XLSX or CSV files,
49+
go to :menuselection:`Website --> eCommerce --> Products`, click the :icon:`fa-cog`
50+
(:guilabel:`gear`) icon, then :ref:`Import records <essentials/export_import_data/import-data>`.
5151

5252
.. tip::
5353
To publish **large batches** of products, follow these steps:

0 commit comments

Comments
 (0)