khanh.pndc/odoo-docs
1
0
Fork 0
mirror of https://github.com/odoo/documentation.git synced 2025-12-12 07:29:27 +07:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] knowledge/commands: update Knowledge and HTML editor docs

Browse Source 
task-5173838

closes odoo/documentation#15079

Signed-off-by: Emmanuel Minga (EMMI) <emmi@odoo.com>
This commit is contained in:
emmi-odoo
2025-10-31 15:47:09 +01:00
parent b71ddf9276
commit c740037982
3 changed files with 191 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
content/applications/essentials/html_editor.rst
View File

@@ -4,12 +4,12 @@
Odoo rich-text editor Odoo rich-text editor
===================== =====================
The Odoo rich-text editor allows creating and editing rich-text content in HTML fields, such as the The Odoo rich-text editor allows for creating and editing rich-text content in HTML fields, such as
:guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in the :ref:`Knowledge the :guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in the :ref:`Knowledge
articles <knowledge/articles_editing/edit-article>` and the :ref:`Studio report articles <knowledge/articles_editing/edit-article>` and the :ref:`Studio report editor
editor <studio/pdf-reports/report-editor>`, among others. Start typing or use the <studio/pdf-reports/report-editor>`, among others. Start typing or use the :ref:`toolbar
:ref:`toolbar <essentials/html_editor/toolbar>` or :ref:`powerbox <essentials/html_editor/toolbar>` or :ref:`powerbox <essentials/html_editor/commands>` for
<essentials/html_editor/commands>` for formatting and structuring text. formatting and structuring text.
.. tip:: .. tip::
Hover over any element in the text (header, table, clipboard, etc.) to reveal the Hover over any element in the text (header, table, clipboard, etc.) to reveal the
@@ -22,51 +22,75 @@ Text editor toolbar
=================== ===================
To edit a word, sentence, or paragraph, select or double-click it to display the text editor To edit a word, sentence, or paragraph, select or double-click it to display the text editor
toolbar and apply any of the following formatting options: toolbar and apply any of the following standard formatting options:
- **Font style**: Change the style using various options, such as :guilabel:`Header 1 to 6, - **Font style**: Define the font style using various options, such as :guilabel:`Header 1 to 6,
Normal, Paragraph, Code`, and :guilabel:`Quote`. Normal, Paragraph, Code`, and :guilabel:`Quote`.
- :guilabel:`B`: Put the text in bold. - **Font size**: Select the preferred font size.
- :guilabel:`I`: Put the text in italics. - :icon:`fa-bold` (:guilabel:`Toggle bold`): Put the text in bold.
- :guilabel:`U`: Underline the text. - :icon:`fa-italic` (:guilabel:`Toggle italic`): Put the text in italics.
- :guilabel:`S`: Strike through the text. - :icon:`fa-underline` (:guilabel:`Toggle underline`): Underline the text.
- :guilabel:`A` and :icon:`fa-paint-brush` :guilabel:`(paintbrush)` to customize the font and - :icon:`fa-font` (:guilabel:`Apply Font Color`): Customize the font colors:
background colors, respectively:
- :guilabel:`Solid`: Select the preferred color from the predefined palette. - :guilabel:`Solid`: Select the preferred color from the predefined palette.
- :guilabel:`Custom`: Customize the color palette using the wheel or by configuring the - :guilabel:`Custom`: Customize the color palette using the wheel or by configuring the
:guilabel:`hex` code and :guilabel:`RGBA` values. :guilabel:`hex` code and :guilabel:`RGBA` values.
- :guilabel:`Gradient`: Select a predefined gradient or customize it by choosing - :guilabel:`Gradient`: Select a predefined gradient or customize it by choosing
between :guilabel:`Linear` or :guilabel:`Radial` and adjusting the wheel. between :guilabel:`Linear` or :guilabel:`Radial` and adjusting the wheel.
- :icon:`fa-trash` (:guilabel:`Reset`): Restore the original font/background color.
- **Font size**: Adjust the size of the text. - :icon:`fa-link` (:guilabel:`Add a link`): Insert or edit a URL link to a selected text, and
- :icon:`fa-list-ul` (:guilabel:`bulleted list`): Turn the text into a bulleted list. optionally upload an image using its file URL.
- :icon:`fa-list-ol` (:guilabel:`numbered list`): Turn the text into a numbered list. - :guilabel:`Odoo AI`: Write a prompt and get AI-generated content. Optionally, click the
- :icon:`fa-check-square-o` (:guilabel:`checklist`): Turn the text into a checklist. AI suggestions instead of writing a prompt.
- :icon:`fa-link` (:guilabel:`link`): Insert or edit a URL link to a selected text, and optionally
upload an image using its file URL. Click the :icon:`fa-ellipsis-v` (:guilabel:`Expand toolbar`) icon to display additional formatting
- :guilabel:`Translate`: Translate the content in the :doc:`installed languages options:
</applications/general/users/language>`.
- :icon:`fa-magic` :guilabel:`AI` (:guilabel:`ChatGPT`): Get AI-generated suggestions and adjust - **Font family**: Use the :guilabel:`Default system font` or select a preferred font family for
the tone by clicking buttons such as :guilabel:`Correct, Shorten, Lengthen, Friendly, the text.
Professional`, and :guilabel:`Persuasive`. - :icon:`fa-strikethrough` (:guilabel:`Toggle strikethrough`): Strike through the text.
- :icon:`fa-paint-brush` :guilabel:`(Apply Background Color)`: Customize the background colors.
- :icon:`fa-eraser` (:guilabel:`Remove Format`): Remove all formatting applied to a selected text.
- :icon:`fa-list-ul` (:guilabel:`Toggle List`): Select the following list options:
- :icon:`fa-list-ul` (:guilabel:`Bulleted list`): Turn the text into a bulleted list.
- :icon:`fa-list-ol` (:guilabel:`Numbered list`): Turn the text into a numbered list.
- :icon:`fa-check-square-o` (:guilabel:`Checklist`): Turn the text into a checklist.
- :icon:`fa-align-left` (:guilabel:`Align text`): Select the following text alignments:
- :icon:`fa-align-left` (:guilabel:`align left`): Align the text on the left.
- :icon:`fa-align-center` (:guilabel:`align center`): Align the text in the center.
- :icon:`fa-align-right` (:guilabel:`align right`): Align the text on the right.
- :icon:`fa-align-justify` (:guilabel:`justify`): Apply straight edges to both text margins.
- :guilabel:`Translate with AI`: Translate the content in the :doc:`installed languages
</applications/general/users/language>` with AI.
.. image:: html_editor/style-and-colors.png .. image:: html_editor/style-and-colors.png
:alt: Text editor's toolbox :alt: Text editor's toolbox
.. tip:: .. tip::
Use the following keyboard shortcuts to apply formatting: - Use the following keyboard shortcuts to apply formatting:
- **Emphasis**: Press `CTRL`/`CMD` + `B`, `CTRL`/`CMD` + `I`, or `CTRL`/`CMD` + `U` to apply
the bold, italics, or underlined effect. - **Emphasis**: Press `CTRL`/`CMD` + `B`, `CTRL`/`CMD` + `I`, or `CTRL`/`CMD` + `U` to apply
- **Numbered list**: Type `1.`, `1)`, `A.`, or `A)` to start a numbered list. the bold, italics, or underlined effect.
- **Bulleted list**: Type `*` or `-` to start a bulleted list. - **Numbered list**: Type `1.`, `1)`, `A.`, or `A)` to start a numbered list.
- **Bulleted list**: Type `*` or `-` to start a bulleted list.
- Click a hyperlinked text and perform one of the following actions: :icon:`fa-clipboard`
(:guilabel:`Copy Link`), :icon:`fa-pencil-square-o` (:guilabel:`Edit Link`), or
:icon:`fa-chain-broken` (:guilabel:`Remove Link`).
.. _essentials/html_editor/commands: .. _essentials/html_editor/commands:
Powerbox commands Powerbox commands
================= =================
Commands enable editing and managing various types of features within the text editor, such as
tables, banners, headers, and more.
To use a command, type `/` to open the powerbox, then enter the command's name or select from To use a command, type `/` to open the powerbox, then enter the command's name or select from
multiple features to insert tables, images, banners, etc. multiple features to insert tables, images, banners, etc.
@@ -88,26 +112,24 @@ multiple features to insert tables, images, banners, etc.
* - Command * - Command
- Use - Use
* - :guilabel:`Separator` * - :icon:`fa-minus` :guilabel:`Separator`
- Insert a horizontal rule separator. - Insert a horizontal rule separator.
* - :guilabel:`2 columns` * - :icon:`fa-columns` :guilabel:`2 columns`
- Convert into 2 columns. - Convert into 2 columns.
* - :guilabel:`3 columns` * - :icon:`fa-columns` :guilabel:`3 columns`
- Convert into 3 columns. - Convert into 3 columns.
* - :guilabel:`4 columns` * - :icon:`fa-columns` :guilabel:`4 columns`
- Convert into 4 columns. - Convert into 4 columns.
* - :guilabel:`Table` * - :icon:`fa-table` :guilabel:`Table`
- Insert a table. - Insert a table.
* - :guilabel:`Bulleted list` * - :icon:`fa-list-ul` :guilabel:`Bulleted list`
- Create a bulleted list. - Create a bulleted list.
* - :guilabel:`Numbered list` * - :icon:`fa-list-ol` :guilabel:`Numbered list`
- Create a numbered list. - Create a numbered list.
* - :guilabel:`Checklist` * - :icon:`fa-check-square-o` :guilabel:`Checklist`
- Create a checklist. - Create a checklist.
* - :guilabel:`Quote` * - :icon:`fa-caret-square-o-right` :guilabel:`Toggle list`
- Add a blockquote section. - Hide a group of text under a foldable toggle.
* - :guilabel:`Code`
- Add a code section.
.. note:: .. note::
To organize a table, hover over a column or row to reveal the table menu. Click the To organize a table, hover over a column or row to reveal the table menu. Click the
@@ -117,40 +139,44 @@ multiple features to insert tables, images, banners, etc.
.. tab:: Banner .. tab:: Banner
.. list-table:: .. list-table::
:widths: 20 80 :widths: 30 70
:header-rows: 1 :header-rows: 1
:stub-columns: 1 :stub-columns: 1
* - Command * - Command
- Use - Use
* - :guilabel:`Banner Info` * - :icon:`fa-info-circle` :guilabel:`Banner Info`
- Insert an info banner. - Insert an info banner.
* - :guilabel:`Banner Success` * - :icon:`fa-check-circle` :guilabel:`Banner Success`
- Insert a success banner. - Insert a success banner.
* - :guilabel:`Banner Warning` * - :icon:`fa-exclamation-triangle` :guilabel:`Banner Warning`
- Insert a warning banner. - Insert a warning banner.
* - :guilabel:`Banner Danger` * - :icon:`fa-exclamation-circle` :guilabel:`Banner Danger`
- Insert a danger banner. - Insert a danger banner.
.. tab:: Format .. tab:: Format
.. list-table:: .. list-table::
:widths: 20 80 :widths: 30 70
:header-rows: 1 :header-rows: 1
:stub-columns: 1 :stub-columns: 1
* - Command * - Command
- Use - Use
* - :guilabel:`Heading 1` * - :icon:`fa-header` :guilabel:`Heading 1`
- Big section heading. - Big section heading.
* - :guilabel:`Heading 2` * - :icon:`fa-header` :guilabel:`Heading 2`
- Medium section heading. - Medium section heading.
* - :guilabel:`Heading 3` * - :icon:`fa-header` :guilabel:`Heading 3`
- Small section heading. - Small section heading.
* - :guilabel:`Text` * - :icon:`fa-paragraph` :guilabel:`Text`
- Paragraph block: Insert a paragraph. - Paragraph block: Insert a paragraph.
* - :guilabel:`Switch direction` * - :icon:`fa-exchange` :guilabel:`Switch direction`
- Switch the text's direction. - Switch the text's direction.
* - :icon:`fa-quote-right` :guilabel:`Quote`
- Add a blockquote section.
* - :icon:`fa-code` :guilabel:`Code`
- Add a code section.
.. tab:: Media .. tab:: Media
@@ -161,39 +187,30 @@ multiple features to insert tables, images, banners, etc.
* - Command * - Command
- Use - Use
* - :guilabel:`Media` * - :icon:`fa-file-image-o` :guilabel:`Media`
- :ref:`Insert an image <insert-media>` or icon: :doc:`Search the Unsplash database - :ref:`Insert an image <insert-media>` or icon: :doc:`Search the Unsplash database
</applications/general/integrations/unsplash>` or upload images, documents, or icons. </applications/general/integrations/unsplash>` or upload images, documents, or icons.
* - :guilabel:`Clipboard` * - :icon:`fa-upload` :guilabel:`Upload a file`
- Add a clipboard section to store content and reuse it in other apps.
* - :guilabel:`Upload a file`
- Add a download box: share images, recordings, or documents that internal users can - Add a download box: share images, recordings, or documents that internal users can
download. download.
.. tab:: Navigation .. tab:: Navigation
.. list-table:: .. list-table::
:widths: 20 80 :widths: 30 70
:header-rows: 1 :header-rows: 1
:stub-columns: 1 :stub-columns: 1
* - Command * - Command
- Use - Use
* - :guilabel:`Link` * - :icon:`fa-link` :guilabel:`Link`
- Add a link: Type the label and enter a URL or upload a file, then click - Add a link: Type the label and enter a URL or upload a file, then click
:guilabel:`Apply`. :guilabel:`Apply`.
* - :guilabel:`Button` * - :icon:`fa-link` :guilabel:`Button`
- Add a button: Type the label, enter a URL or upload a file, select the button style, - Add a button: Type the label, enter a URL or upload a file, select the button style,
type, and size, then click :guilabel:`Apply`. type, and size, then click :guilabel:`Apply`.
* - :guilabel:`Article` * - :icon:`fa-bookmark` :guilabel:`Table Of Contents`
- Insert a shortcut to a :doc:`Knowledge article </applications/productivity/knowledge>`.
* - :guilabel:`Appointment`
- Add a specific appointment: Select one or several appointment type(s) to assign to
relevant users, then click :guilabel:`Insert a link`.
* - :guilabel:`Table Of Content`
- Highlight the structure (headings): Create a table of content based on the headings. - Highlight the structure (headings): Create a table of content based on the headings.
* - :guilabel:`Video Link`
- Insert a video: Copy-paste the video URL (Youtube, Vimeo, Dailymotion, and Youku only).
.. tab:: Widget .. tab:: Widget
@@ -204,43 +221,19 @@ multiple features to insert tables, images, banners, etc.
* - Command * - Command
- Use - Use
* - :guilabel:`Emoji` * - :icon:`fa-smile-o` :guilabel:`Emoji`
- Add an emoji: search for the desired emoji. - Add an emoji: search for the desired emoji.
* - :guilabel:`3 Stars` * - :icon:`fa-star-o` :guilabel:`3 Stars`
- Insert a rating of up to 3 stars. - Insert a rating of up to 3 stars.
* - :guilabel:`5 Stars` * - :icon:`fa-star` :guilabel:`5 Stars`
- Insert a rating of up to 5 stars. - Insert a rating of up to 5 stars.
.. tab:: AI Tools
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`ChatGPT`
- Generate content with AI.
.. tab:: Basic Block
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Signature`
- Insert your signature.
.. _insert-media: .. _insert-media:
Insert media Insert media
------------ ------------
To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(image)` icon in the To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(media)` icon in the
tooltip, then choose from the following tabs: tooltip, then choose from the following tabs:
- :guilabel:`Images` - :guilabel:`Images`
@@ -256,7 +249,13 @@ tooltip, then choose from the following tabs:
- :guilabel:`Add URL`: Copy-paste a valid URL. - :guilabel:`Add URL`: Copy-paste a valid URL.
- :guilabel:`Upload a document`: Upload a document from a local drive. - :guilabel:`Upload a document`: Upload a document from a local drive.
- :guilabel:`Icons`: Search an icon from the selection in the database. - :guilabel:`Icons`: Search for and select one of the available icons.
- :guilabel:`Videos`: Paste a video URL of the following sources: YouTube, Vimeo, Dailymotion, and
Youku. Alternatively, type code to embed a video.
.. note::
When adding a video, use the toggles to enable autoplay or looping, hide player controls or the
fullscreen button, or set a start time.
Media editor toolbar Media editor toolbar
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@@ -264,23 +263,22 @@ Media editor toolbar
After :ref:`inserting an image <insert-media>`, click it to display the media editor toolbar, and After :ref:`inserting an image <insert-media>`, click it to display the media editor toolbar, and
apply any of the following formatting options: apply any of the following formatting options:
- :icon:`fa-search-plus` (:guilabel:`preview`): Preview the image, zoom in or out, print it or - :icon:`fa-search-plus` (:guilabel:`Preview image`): Preview the image, zoom in or out, rotate it,
download it. Exit the preview by clicking the :icon:`fa-times` :guilabel:`(close)` icon in the print it, or download it. Exit the preview by clicking the :icon:`fa-times` :guilabel:`(close)`
top right corner. icon in the top right corner.
- :guilabel:`Description`: Edit the image description and tooltip, then click :guilabel:`Save`. - :guilabel:`Description`: Edit the image description and tooltip, then click :guilabel:`Apply`.
- :icon:`fa-square` (:guilabel:`rounded`): Apply a rounded shape to the corners of the image. - :guilabel:`Caption`: Write a caption under 100 characters below the image.
- :icon:`fa-circle-o` (:guilabel:`circle`): Apply a circular shape to the image. - :icon:`fa-square` (:guilabel:`Rounded`): Apply a rounded shape to the corners of the image.
- :icon:`fa-sun-o` (:guilabel:`shadow`): Apply a shadow effect to the image. - :icon:`fa-circle-o` (:guilabel:`Circle`): Apply a circular shape to the image.
- :icon:`fa-picture-o` (:guilabel:`image`): Apply a border to the image. - :icon:`fa-sun-o` (:guilabel:`Shadow`): Apply a shadow effect to the image.
- :icon:`fa-plus-square-o` (:guilabel:`padding`): Add an image padding and choose from small, - :icon:`fa-picture-o` (:guilabel:`Thumbnail`): Apply a border to the image.
medium, large, or extra large sizes. - :icon:`fa-plus-square-o` (:guilabel:`Padding`): Add an image padding and choose from
- :guilabel:`Default`: Restore the image to its default size. :guilabel:`Small`, :guilabel:`Medium`, :guilabel:`Large`, or :guilabel:`XL` sizes.
- :guilabel:`100%`: Set the image to full size. - :guilabel:`Resize`: Restore the image to its default size or set its size to :guilabel:`25%`,
- :guilabel:`50%`: Set the image to half its size. :guilabel:`50%`, or :guilabel:`100%`.
- :guilabel:`25%`: Set the image to a quarter of its size.
- :icon:`fa-object-ungroup` (:guilabel:`object`): Resize and rotate the image. Click the - :icon:`fa-object-ungroup` (:guilabel:`object`): Resize and rotate the image. Click the
:icon:`fa-object-ungroup` :guilabel:`(object)` icon a second time to reset the transformation. :icon:`fa-object-ungroup` :guilabel:`(object)` icon a second time to reset the transformation.
- :icon:`fa-crop` (:guilabel:`crop`): Crop the image manually or apply the following options: - :icon:`fa-crop` (:guilabel:`Crop image`): Crop the image manually or apply the following options:
- Choose from the `Flexible`, `16:9`, `4:3`, `1:1`, or `2:3` aspect ratios. - Choose from the `Flexible`, `16:9`, `4:3`, `1:1`, or `2:3` aspect ratios.
- Zoom in or out. - Zoom in or out.
@@ -288,9 +286,21 @@ apply any of the following formatting options:
- Flip horizontally or vertically. - Flip horizontally or vertically.
- Reset the image. - Reset the image.
- :guilabel:`Replace`: Replace the image by searching in the :doc:`Unsplash - :icon:`fa-link` (:guilabel:`Add a link`): Add a link to the image, type the URL, then click
:guilabel:`Apply`. To remove the link, click :icon:`fa-unlink` (:guilabel:`Remove Link`).
- :icon:`fa-exchange` (:guilabel:`Replace`): Replace the image by searching in the :doc:`Unsplash
</applications/general/integrations/unsplash>` database, adding a URL, or uploading a different </applications/general/integrations/unsplash>` database, adding a URL, or uploading a different
one. one.
- :icon:`fa-link` (:guilabel:`link`): Insert a link to the image, type the URL, then click - :icon:`fa-trash` (:guilabel:`Delete`): Delete the image.
:guilabel:`Apply`. To remove the link, click the :icon:`fa-chain-broken` :guilabel:`(unlink)` icon.
- :icon:`fa-trash` (:guilabel:`trash`): Remove the image. Icon editor toolbar
~~~~~~~~~~~~~~~~~~~
After :ref:`inserting an icon <insert-media>`, click it to display the icon editor toolbar, and
apply any of the following formatting options:
- :icon:`fa-font` (:guilabel:`Select Font Color`): Customize the font color.
- :icon:`fa-paint-brush` (:guilabel:`Select Background Color`): Customize the background color.
- :guilabel:`Resize icon`: From :guilabel:`1x` to :guilabel:`5x`.
- :icon:`fa-play` (:guilabel:`Toggle icon spin`): Activate the spin animation.
- :guilabel:`Replace`: Select a different icon.

BIN
content/applications/essentials/html_editor/style-and-colors.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 11 KiB

113
content/applications/productivity/knowledge.rst
View File

@@ -22,8 +22,9 @@ is created under another, the original one is the **parent article**, while the
**child** or **nested article**, indicating its subordinate position. This structure helps organize **child** or **nested article**, indicating its subordinate position. This structure helps organize
content by establishing clear relationships between related articles. content by establishing clear relationships between related articles.
To create a nested article, hover over an article in the sidebar tree and click the :icon:`fa-plus` .. tip::
:guilabel:`(plus)` icon. To create a nested article, hover over an article in the sidebar tree and click the
:icon:`fa-plus` :guilabel:`(plus)` icon.
From scratch From scratch
------------ ------------
@@ -64,6 +65,10 @@ To edit an article, select it in the sidebar tree, then edit its content and for
commands <knowledge/articles_editing/commands>`, and adding a :ref:`cover picture commands <knowledge/articles_editing/commands>`, and adding a :ref:`cover picture
<knowledge/articles_editing/cover>` with a :ref:`title emoji <knowledge/articles_editing/emoji>`. <knowledge/articles_editing/cover>` with a :ref:`title emoji <knowledge/articles_editing/emoji>`.
.. tip::
To enlarge or reduce the article's width, click the :icon:`fa-ellipsis-v` (:guilabel:`More
actions`) icon, then toggle the :icon:`oi-arrows-h` :guilabel:`Full Width` on or off.
.. _knowledge/articles_editing/text-editor: .. _knowledge/articles_editing/text-editor:
Text editor toolbar Text editor toolbar
@@ -105,6 +110,12 @@ following commands are exclusive to the Knowledge app:
* - :guilabel:`Item Calendar` * - :guilabel:`Item Calendar`
- Insert a Calendar view and create :ref:`article items - Insert a Calendar view and create :ref:`article items
<knowledge/articles_editing/items>`. <knowledge/articles_editing/items>`.
* - :guilabel:`Clipboard`
- Add a clipboard section to store content and reuse it in other apps.
* - :guilabel:`Foldable Section`
- Hide the text inside a foldable section.
* - :guilabel:`Article`
- Insert a shortcut to an article.
.. _knowledge/articles_editing/items: .. _knowledge/articles_editing/items:
@@ -123,24 +134,25 @@ consistent information across related items and articles.
Cover pictures Cover pictures
-------------- --------------
To add a cover picture, click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon, then To add a cover picture, click the :icon:`fa-ellipsis-v` (:guilabel:`More actions`) icon, then
:guilabel:`Add Cover`. The following options enable selecting and inserting pictures from different :guilabel:`Add Cover`.
sources:
- Search the :doc:`Unsplash </applications/general/integrations/unsplash>` database to find a
suitable picture. If the database and **Unsplash** account are associated, the cover
picture is automatically selected based on the article's name.
- :guilabel:`Add URL`: Copy-paste the **image address**.
- :guilabel:`Upload an image`: Upload the file into the image library.
To manage the cover picture, hover the mouse over it and select the preferred option: To manage the cover picture, hover the mouse over it and select the preferred option:
- :guilabel:`Replace Cover` and search from the database or library, or add a different URL. - :guilabel:`Replace Cover`: Search from the :doc:`Unsplash
</applications/general/integrations/unsplash>` database library, click :guilabel:`Add URL` and
- :guilabel:`Reposition` and adjust the picture before clicking :guilabel:`Save Position`. paste the **image address**, or click :guilabel:`Upload an image` to upload a file into the image
library.
- :guilabel:`Reposition`: Adjust the picture, then click :guilabel:`Save Position` or
:guilabel:`Cancel`.
- :guilabel:`Remove`. - :guilabel:`Remove`.
.. note::
- After clicking :guilabel:`Add Cover`, a cover picture is automatically attributed to the
article based on the title.
- A removed cover picture can be retrieved in the database library. To delete it, hover the
mouse over it and click the :icon:`fa-trash` (:guilabel:`trash`) icon.
.. _knowledge/articles_editing/emoji: .. _knowledge/articles_editing/emoji:
Title emoji Title emoji
@@ -148,9 +160,8 @@ Title emoji
To add a title emoji to the article's name and header: To add a title emoji to the article's name and header:
- Click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon, then :guilabel:`Add Icon` to - Click the :icon:`fa-ellipsis-v` (:guilabel:`More actions`) icon, then :guilabel:`Add Icon` to
generate a random emoji. Click the emoji to select a different one. generate a random emoji. Click the emoji to select a different one.
- Alternatively, click the :icon:`fa-file-text-o` :guilabel:`(page)` icon next to the article's - Alternatively, click the :icon:`fa-file-text-o` :guilabel:`(page)` icon next to the article's
name in the sidebar or the top bar and select the preferred emoji. name in the sidebar or the top bar and select the preferred emoji.
@@ -187,15 +198,15 @@ Knowledge allows for managing articles, which consists of :ref:`structuring
Basic management Basic management
---------------- ----------------
Click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon and select one of the following actions Click the :icon:`fa-ellipsis-v` (:guilabel:`More actions`) icon and select one of the following
for basic article management: actions for basic article management:
- :guilabel:`Move To`: Select the article to move under a category or another article, then click - :guilabel:`Move To`: Select the article to move under a category or another article, then click
:guilabel:`Move Article`. :guilabel:`Move Article`.
- :guilabel:`Lock Content`: Lock the article to stop edits. Click :guilabel:`Unlock` to edit again. - :guilabel:`Lock Content`: Lock the article to stop edits. Click :guilabel:`Unlock` to edit again.
- :guilabel:`Create a Copy`: Copy the article under the :guilabel:`Private` section. - :guilabel:`Create a Copy`: Copy the article under the :guilabel:`Private` section.
- :guilabel:`Open Version History`: Restore a previous version of the article. - :guilabel:`Open Version History`: Restore a previous version of the article.
- :guilabel:`Export`: Open the browser's print function. - :guilabel:`Download PDF`: Open the browser's print function.
- :guilabel:`Add to Templates`: Add the article to the list of templates. - :guilabel:`Add to Templates`: Add the article to the list of templates.
- :guilabel:`Send to Trash`: Move the article to the trash. - :guilabel:`Send to Trash`: Move the article to the trash.
@@ -212,7 +223,7 @@ for basic article management:
.. tip:: .. tip::
- Move an article directly from the sidebar tree by dragging and dropping it under another - Move an article directly from the sidebar tree by dragging and dropping it under another
article or category. article or category.
- Click the :icon:`fa-search` (:guilabel:`serch`) icon in the top-left corner or press `CTRL` / - Click the :icon:`fa-search` (:guilabel:`search`) icon in the top-left corner or press `CTRL` /
`CMD` + `K` to open the command palette, then type `?` to search for visible articles or `$` `CMD` + `K` to open the command palette, then type `?` to search for visible articles or `$`
for :ref:`hidden articles <knowledge/articles_editing/visibility>`. Alternatively, hover over for :ref:`hidden articles <knowledge/articles_editing/visibility>`. Alternatively, hover over
the :guilabel:`Workspace` category and click the :icon:`fa-eye` (:guilabel:`eye`) icon to find the :guilabel:`Workspace` category and click the :icon:`fa-eye` (:guilabel:`eye`) icon to find
@@ -258,6 +269,11 @@ inviting :ref:`users <knowledge/articles_editing/invite>`, providing :ref:`onlin
Articles listed under a category in the sidebar tree are **visible**. Articles that certain users Articles listed under a category in the sidebar tree are **visible**. Articles that certain users
must search for through the command palette due to restricted access rights are **hidden**. must search for through the command palette due to restricted access rights are **hidden**.
.. tip::
To copy a specific section of an article, hover over the header (`H1`, `H2`, and `H3`), and click
the :icon:`fa-link` (:guilabel:`link`) icon. Clicking the shared link leads to the selected
section of the article.
.. _knowledge/articles_editing/rights: .. _knowledge/articles_editing/rights:
Configure access rights Configure access rights
@@ -265,8 +281,8 @@ Configure access rights
Click :guilabel:`Share` in the top-right menu to configure access rights. Click :guilabel:`Share` in the top-right menu to configure access rights.
Default access rights General access
********************* **************
.. tabs:: .. tabs::
@@ -277,18 +293,18 @@ Default access rights
* - Setting * - Setting
- Use - Use
* - :guilabel:`Can edit` * - :guilabel:`Can Edit`
- Allow all internal users to edit the article. - Allow all internal users to edit the article.
* - :guilabel:`Can read` * - :guilabel:`Can Read`
- Allow all internal users to read the article only. - Allow all internal users to read the article only.
* - :guilabel:`No access` * - :guilabel:`Members only`
- Prevent all users from accessing the article in the sidebar tree or searching in the - Allow only members to access the article from the sidebar tree or by searching for it in
command palette. the command palette.
.. _knowledge/articles_editing/visibility: .. _knowledge/articles_editing/visibility:
Visibility Show in workspace
********** *****************
.. tabs:: .. tabs::
@@ -301,8 +317,8 @@ Visibility
- Use - Use
* - :guilabel:`Everyone` * - :guilabel:`Everyone`
- The article is visible in the sidebar tree to all internal users. - The article is visible in the sidebar tree to all internal users.
* - :guilabel:`Members` * - :guilabel:`Members only`
- The article is only visible in the sidebar tree to :ref:`invited users - The article is only visible in the sidebar tree to :ref:`members
<knowledge/articles_editing/invite>`, while other users can find it using the hidden <knowledge/articles_editing/invite>`, while other users can find it using the hidden
article search by pressing `CTRL` / `CMD` + `K` and typing `$`. article search by pressing `CTRL` / `CMD` + `K` and typing `$`.
@@ -319,7 +335,7 @@ Visibility
Invite specific users Invite specific users
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
To grant specific internal or portal users access to a private article or to share a To grant specific internal or portal users access to a private nested article or to share a
:guilabel:`Workspace` article with a portal user, follow these steps: :guilabel:`Workspace` article with a portal user, follow these steps:
#. Click :guilabel:`Share` in the top-right menu. #. Click :guilabel:`Share` in the top-right menu.
@@ -332,8 +348,8 @@ To grant specific internal or portal users access to a private article or to sha
Generate article URL Generate article URL
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Click :guilabel:`Share` and activate the :guilabel:`Share to web` toggle to generate a URL. Click To generate a URL and share an article, click :guilabel:`Share` and activate the :guilabel:`Share to
:guilabel:`Copy Link` to copy the article's URL. web` toggle. Click :guilabel:`Copy Link` to copy the article's URL.
.. note:: .. note::
- If an article contains :ref:`inserted views <knowledge/articles_editing/views>`, users with - If an article contains :ref:`inserted views <knowledge/articles_editing/views>`, users with
@@ -350,8 +366,8 @@ Removing an article involves deleting or archiving it.
Delete an article Delete an article
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Select an article in the sidebar tree and click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) Select an article in the sidebar tree and click the :icon:`fa-ellipsis-v` (:guilabel:`More actions`)
icon, then :guilabel:`Send to Trash`. Alternatively, hold click the article and drag it to the icon, then :guilabel:`Send to Trash`. Alternatively, drag and drop the article under
:guilabel:`Drop here to delete this article` at the bottom left corner. The article is moved to the :guilabel:`Drop here to delete this article` at the bottom left corner. The article is moved to the
trash for 30 days before being permanently deleted. trash for 30 days before being permanently deleted.
@@ -380,11 +396,11 @@ Archive`.
Retrieval Retrieval
--------- ---------
Retrieving Knowledge articles consists of accessing them from various Odoo apps or restoring Retrieving Knowledge articles consists of accessing them from Odoo apps or restoring previous
previous versions. versions.
Access articles from various apps Access articles from Odoo apps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Knowledge articles are accessible from the :ref:`form view <studio/views/general/form>` of various Knowledge articles are accessible from the :ref:`form view <studio/views/general/form>` of various
apps. Click the :icon:`fa-bookmark` :guilabel:`(Knowledge)` icon in the top right corner to open apps. Click the :icon:`fa-bookmark` :guilabel:`(Knowledge)` icon in the top right corner to open
@@ -399,8 +415,8 @@ Version history
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
To retrieve a previous version of an article, select it in the sidebar tree and click the To retrieve a previous version of an article, select it in the sidebar tree and click the
:icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon, then the :icon:`fa-history` (:guilabel:`history`) :icon:`fa-ellipsis-v` (:guilabel:`More actions`) icon, then :guilabel:`Open Version History`.
icon to open the version history. Select a version and click :guilabel:`Restore history`. Select a version and click :guilabel:`Restore history`.
.. note:: .. note::
In the version history, the :guilabel:`Content` tab shows the selected version, while the In the version history, the :guilabel:`Content` tab shows the selected version, while the
@@ -412,17 +428,16 @@ icon to open the version history. Select a version and click :guilabel:`Restore
Properties Properties
========== ==========
Properties are custom fields for storing and managing information that users with `Can edit` Properties are custom fields for storing and managing information that members can add to
:ref:`access rights <knowledge/articles_editing/rights>` can add to :ref:`nested articles :ref:`nested articles <knowledge/articles_editing/create-article>` or :ref:`article items
<knowledge/articles_editing/create-article>` or :ref:`article items
<knowledge/articles_editing/items>`. <knowledge/articles_editing/items>`.
To add a property, click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon, then To add a property, click the :icon:`fa-ellipsis-v` (:guilabel:`More actions`) icon, then
:menuselection:`Add Properties --> Add a Property`, enter a :guilabel:`Label`, and select a :menuselection:`Add Properties --> Add a Property`, enter a :guilabel:`Label`, and select a
:guilabel:`Field Type`. :guilabel:`Field Type`.
To learn more about properties and field types, go to :doc:`Property fields .. seealso::
</applications/essentials/property_fields>`. :doc:`/applications/essentials/property_fields`
.. note:: .. note::
- Click outside the property field window to save a property. - Click outside the property field window to save a property.