|
1 |
| -=================== |
2 |
| -Articles management |
3 |
| -=================== |
| 1 | +================== |
| 2 | +Article management |
| 3 | +================== |
4 | 4 |
|
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. |
10 | 8 |
|
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 | +================ |
13 | 11 |
|
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: |
16 | 14 |
|
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. |
19 | 23 |
|
20 |
| -.. _management/create: |
| 24 | +.. note:: |
| 25 | + The following actions only apply to nested articles and :ref:`article items |
| 26 | + <knowledge/articles_editing/commands>`: |
21 | 27 |
|
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. |
27 | 30 |
|
28 | 31 | .. 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: |
30 | 46 |
|
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: |
32 | 58 |
|
33 | 59 | 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:: |
35 | 81 |
|
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 |
38 | 86 |
|
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. |
41 | 96 |
|
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: |
46 | 98 |
|
47 |
| -You can also restrict a specific user from accessing the article by selecting :guilabel:`No access` |
48 |
| -permission. |
| 99 | +Visibility |
| 100 | +~~~~~~~~~~ |
49 | 101 |
|
50 |
| -.. image:: management/invite.png |
51 |
| - :alt: pop-up window to invite users to access a Knowledge article |
| 102 | +.. tabs:: |
52 | 103 |
|
53 |
| -Share online |
54 |
| -~~~~~~~~~~~~ |
| 104 | + .. list-table:: |
| 105 | + :widths: 20 80 |
| 106 | + :header-rows: 1 |
| 107 | + :stub-columns: 1 |
55 | 108 |
|
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 `$`. |
58 | 117 |
|
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. |
61 | 125 |
|
62 |
| -.. image:: management/share-menu.png |
63 |
| - :alt: Sharing menu with URL for online sharing and the list of members. |
| 126 | +.. _knowledge/management/invite: |
64 | 127 |
|
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: |
66 | 153 |
|
67 | 154 | 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`. |
69 | 174 |
|
70 |
| -To remove an article, you can either **delete** it or **archive** it. |
| 175 | +Archive an article |
| 176 | +------------------ |
71 | 177 |
|
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`. |
75 | 180 |
|
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`. |
81 | 185 |
|
82 |
| -.. _management/structure: |
| 186 | +.. _knowledge/management/retrieve: |
83 | 187 |
|
84 |
| -Structure of articles |
85 |
| -===================== |
| 188 | +Retrieval |
| 189 | +========= |
86 | 190 |
|
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. |
90 | 193 |
|
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 | +--------------------------------- |
95 | 196 |
|
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: |
97 | 200 |
|
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. |
100 | 205 |
|
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 | +--------------- |
103 | 208 |
|
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`. |
112 | 212 |
|
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. |
0 commit comments