[IMP] productivity/knowledge: Articles editing updated

task-4444310
This commit is contained in:
emmi-odoo 2025-01-15 13:09:13 +01:00
parent d4841aee90
commit 35d5560a5f
9 changed files with 322 additions and 225 deletions

View File

@ -7,6 +7,7 @@ Odoo essentials
essentials/activities essentials/activities
essentials/reporting essentials/reporting
essentials/search essentials/search
essentials/text_editor
essentials/contacts essentials/contacts
essentials/export_import_data essentials/export_import_data
essentials/in_app_purchase essentials/in_app_purchase

View File

@ -0,0 +1,224 @@
.. _text-editor:
========================
Text editor and commands
========================
Odoo allows you to write content in various areas across different apps. Whether it is in the
:guilabel:`Internal Notes` field in :guilabel:`Sales` or in the :guilabel:`Description` field in
:guilabel:`Project`, adding a text requires using the text editor and the commands.
Text editor
===========
To edit a word, a sentence, or a paragraph, select it or double-click on it to display the text
editor, and apply any of the following editing options:
- :guilabel:`Normal`: Change the style with multiple options, including :guilabel:`Normal, Code,
Header 1 to 6`, and :guilabel:`Quote`.
- :guilabel:`B`: Put the text in bold.
- :guilabel:`I`: Put the text in italics.
- :guilabel:`U`: Underline the text.
- :guilabel:`S`: Apply a strikethrough effect to the text.
- :guilabel:`A` for the font or the :icon:`fa-paint-brush` :guilabel:`(paintbrush)` icon for the
background to customize colors:
- :guilabel:`Solid`: Select your preferred color from the predefined palette.
- :guilabel:`Custom`: Customize your color palette using the wheel or by configuring the
:guilabel:`hex` code and :guilabel:`RGBA` values.
- :guilabel:`Gradient`: Choose a predefined gradient or personalize it by selecting
between a :guilabel:`Linear` or :guilabel:`Radial` type, and adjusting the wheel.
- **Size number**: Adjust the size of the text.
- :icon:`fa-list-ul`: Turn the text into a bulleted list.
- :icon:`fa-list-ol`: Turn the text into a numbered list.
- :icon:`fa-check-square-o`: Turn the text into a checklist.
- :icon:`fa-link`: Insert or edit a URL link.
- :guilabel:`Translate`: Translate the content in your
:doc:`installed languages </applications/general/users/language>`.
- :icon:`fa-magic` :guilabel:`AI`: Get AI-generated suggestions and adjust the tone.
- :icon:`fa-commenting` :guilabel:`Comment`: Add a comment to the selected text.
.. image:: text_editor/style-and-colors.png
:alt: Text editor's toolbox
Commands
========
To use a command, type `/` and open the **powerbox**. Type the command's name or select from
multiple features to insert tables, images, banners, etc.
List of commands
----------------
Commands are divided into multiple categories depending on their use. The :guilabel:`Knowledge`
category and its commands are only available in the app of the same name.
.. tabs::
.. tab:: Structure
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Separator`
- Insert a horizontal rule separator.
* - :guilabel:`2 columns`
- Convert into 2 columns.
* - :guilabel:`3 columns`
- Convert into 3 columns.
* - :guilabel:`4 columns`
- Convert into 4 columns.
* - :guilabel:`Table`
- Insert a table.
* - :guilabel:`Bulleted list`
- Create a bulleted list.
* - :guilabel:`Numbered list`
- Create a list with numbering.
* - :guilabel:`Checklist`
- Track tasks with a checklist.
* - :guilabel:`Quote`
- Add a blockquote section.
* - :guilabel:`Code`
- Add a code section.
.. tab:: Banner
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Banner Info`
- Insert an info banner.
* - :guilabel:`Banner Success`
- Insert a success banner.
* - :guilabel:`Banner Warning`
- Insert a warning banner.
* - :guilabel:`Banner Danger`
- Insert a danger banner.
.. tab:: Knowledge
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Index`
- Show nested articles.
* - :guilabel:`Item Kanban`
- Insert a Kanban view of article items.
* - :guilabel:`Item Cards`
- Insert a Card view of article items.
* - :guilabel:`Item List`
- Insert a List view of article items.
* - :guilabel:`Item Calendar`
- Insert a Calendar view of article items.
.. tab:: Format
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Heading 1`
- Big section heading.
* - :guilabel:`Heading 2`
- Medium section heading.
* - :guilabel:`Heading 3`
- Small section heading.
* - :guilabel:`Text`
- Paragraph block.
* - :guilabel:`Switch direction`
- Switch the text's direction.
.. tab:: Media
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Media`
- Insert image or icon.
* - :guilabel:`Clipboard`
- Add a clipboard section.
* - :guilabel:`Upload a file`
- Add a download box..
.. tab:: Navigation
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Link`
- Add a link.
* - :guilabel:`Button`
- Add a button.
* - :guilabel:`Article`
- Insert an Article shortcut.
* - :guilabel:`Appointment`
- Add a specific appointment.
* - :guilabel:`Drawing Board`
- Insert an Excalidraw Board.
* - :guilabel:`Table Of Content`
- Highlight the structure (headings).
* - :guilabel:`Viedo Link`
- Insert a Video.
.. tab:: Widget
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Emoji`
- Add an emoji.
* - :guilabel:`3 Stars`
- Insert a rating over 3 stars.
* - :guilabel:`5 Stars`
- Insert a rating over 5 stars.
.. tab:: AI Tools
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`ChatGPT`
- Generate or transform content with AI.
.. tab:: Basic Bloc
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Signature`
- Insert your signature.

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View File

@ -1,262 +1,134 @@
================ ====================================
Articles editing Article creation and content editing
================ ====================================
Add and style content Start writing
===================== =============
To start adding content, click anywhere on the page. Your cursor is automatically set to write the Use the :guilabel:`Private` or :guilabel:`Workspace` section of the sidebar tree to start creating
article's first-level header. Once you are done writing the title, press **enter** on your keyboard an article. The former is for drafting ideas, and the latter is for sharing with internal users.
to move to the next line. Hover above your preferred section, then click the :icon:`fa-plus` :guilabel:`(plus)` icon. An
:guilabel:`Untitled` page appears and offers you the option to start writing your content or do the
following:
.. image:: articles_editing/ui.png - :guilabel:`Load a Template`: Load preconfigured templates.
:align: center - :guilabel:`Build an Item Kanban`: Visualize tasks or items in a Kanban view.
:alt: knowledge's user interface - :guilabel:`Build an Item List`: Build a structured list of items.
- :guilabel:`Build an Item Calendar`: Create a calendar view to track items by date.
- :guilabel:`Generate an Article with AI`: Generate content based on your prompt.
.. tip:: .. tip::
Click :guilabel:`Untitled` on the left side of the top bar to automatically match your h1 After writing the title, click :guilabel:`Untitled` on the top bar to automatically match your
:dfn:`(First-level header)` title and the article's name. To change the name of your article h1 :dfn:`(First-level header)` title to the name of the article. To change the name of the
later, you must do it manually. To do so, click the name on the top bar and proceed to the article later, you must do it manually: click the name on the top bar and proceed to the
modification. modification.
Edit and customize
==================
Edit and customize your content by using the text editor, adding a cover picture with an emoji, and
typing commands.
.. _knowledge/text-editor: .. _knowledge/text-editor:
Text editor Text editor
----------- -----------
To stylize the text using the text editor, select the text to format. To edit a word, a sentence, or a paragraph, select it or double-click on it to display the text
editor, and apply the desired editing options. To know more about the editing options, please refer
Then, you can: to :doc:`../../../applications/essentials/text_editor`.
- Change the style by clicking :guilabel:`Normal`. Doing so opens a dropdown menu with multiple
styles to choose from (:guilabel:`Normal, Code, Header 1 → Header 6, Quote`);
- Format the text. Click :guilabel:`B` to put it in bold, :guilabel:`I` to put it in italic,
:guilabel:`U` to underline, and :guilabel:`S` to strikethrough;
- Change the font color by clicking :guilabel:`A` or the background color by clicking the **pencil**
icon:
- To choose from a predefined theme color, click :guilabel:`Theme` and select the desired color.
- To customize, click :guilabel:`Solid` and define a color using the wheel, by typing its hex
code, or its RGBA values.
- To use a gradient, click :guilabel:`Gradient`, choose a predefined gradient or click
:guilabel:`Custom` to create a personalized gradient.
- To change the text's size, click the **size number** and select the desired size;
- Click the **lists** icons to turn the paragraph into an unordered list, an ordered list, or a
checklist;
- Click the **chain** icon to insert or edit an URL link.
.. image:: articles_editing/style-and-colors.png
:align: center
:alt: Text editor's toolbox
To format a whole paragraph, type `/` anywhere in the text. Doing so opens the **powerbox**, which
allows:
- Changing a paragraph into lists (unordered, ordered, checklists).
- Changing a paragraph into a header (1 → 6), normal text, `code`, or *quotes*.
Cover pictures Cover pictures
-------------- --------------
You can customize your article by adding a cover picture and an icon. Hover above the h1 title and To add a cover picture, click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon, then
click :guilabel:`Add Cover`. A pop-up window opens to set a cover picture. :guilabel:`Add Cover`. The following options allow you to select and insert pictures from different
sources:
If your database and your Unsplash account are associated, the cover picture is automatically
selected based on the article's name. To modify it, hover over the picture to make the buttons
appear, click :guilabel:`Change Cover`, and select another image.
Retrieve images from different sources:
- Search the **Unsplash** database. - Search the **Unsplash** database.
- Enter a picture's **URL**. - Enter a picture's **URL**.
- **Upload** an image from a computer. - Click :guilabel:`Upload an image`.
To remove the cover, hover over it to make the buttons appear and click :guilabel:`Remove Cover`. To replace the cover picture, hover above it, click :guilabel:`Replace Cover`, and choose a new one
from the selection.
To reposition the cover picture, hover above it and click :guilabel:`Reposition`. Adjust the
picture, then click :guilabel:`Save Position`.
To remove the cover picture, hover above it and click :guilabel:`Remove Cover`.
.. note:: .. note::
- To associate Unsplash with your database, please refer to If your database and your **Unsplash** account are associated, the cover picture is
:doc:`/applications/general/integrations/unsplash`. automatically selected based on the title of the article. To associate **Unsplash** with your
- The articles are responsive, and so are the cover pictures. As a result, the images cannot database, please refer to :doc:`/applications/general/integrations/unsplash`.
be repositioned manually to fit a particular screen, as they automatically resize
depending on the device.
Icons Emojis
----- ------
To add an icon, hover above the h1 title and click :guilabel:`Add Icon`. Doing this sets a random There are two possibilities to add an emoji to your article:
emoji automatically. To change it, click it and select one from the emoji window. To remove it,
proceed equally and click the red-circled :guilabel:`x`. - Through the ellipsis icon:
#. Click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon.
#. Click :guilabel:`Add Icon` to generate a random emoji that appears near the title of the article.
#. To change the emoji, click :guilabel:`Remove Icon`, then :guilabel:`Add Icon` again.
- Through the emoji search bar:
#. Click the :icon:`fa-file-text-o` :guilabel:`(page)` icon next to the title of the article to
open the emoji search bar.
#. Use the search bar or scroll down to find the desired emoji.
#. Select the desired emoji, which will appear close to the title of the article.
#. (Optional) Click the selected emoji to open the emoji search bar, and select a different
one.
.. note:: .. note::
- The emoji is also displayed before the corresponding article in the side panel hierarchic tree. - Adding an emoji through the ellipsis icon requires repeating the operation as many times as
- Click the emoji on the side panel to change it without opening the related article. needed to find the suitable emoji for the article. However, after clicking
:guilabel:`Add Icon`, click on the generated emoji to open the emoji search bar and proceed as
in the second option.
- The system also displays the emoji before the corresponding article in the sidebar tree.
- Click on the emoji in the sidebar tree to change it without opening the related article.
.. _knowledge/powerbox: .. _knowledge/powerbox:
Commands Commands
======== --------
To use a command, type `/` and open the **powerbox**. Type the command's name or select from Type `/` to use a command and open the **powerbox**. Some commands, such as `/Media` or
multiple features to insert blocks, images, files, etc. Some of them, such as `/Image` or `/Article` `/Article`, are common to all apps, but others are specific to the :guilabel:`Knowledge` app and
are common to all the apps, but others are inherent to the knowledge app and cannot be found or used cannot be found or used in any other app. To know more about the list of commands, please refer to
in any other application. :doc:`../../../applications/essentials/text_editor`.
List of commands Knowledge integration
---------------- =====================
Commands are divided into multiple categories depending on their use. :guilabel:`Knowledge` articles and their content can be retrieved from certain apps. Similarly,
content views from some apps can be embedded into Knowledge articles.
.. tabs:: Retrieve Knowledge articles
.. tab:: Structure ---------------------------
.. list-table:: Depending on the app, the :icon:`fa-bookmark` :guilabel:`(Knowledge)` icon is visible at the top
:widths: 20 80 right corner of the interface. Click the icon to search for an article.
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Bulleted list`
- Create a bulleted list.
* - :guilabel:`Numbered list`
- Create a list with numbering.
* - :guilabel:`Checklist`
- Track tasks with a checklist.
* - :guilabel:`Table`
- Insert a table.
* - :guilabel:`Separator`
- Insert an horizontal rule separator.
* - :guilabel:`Quote`
- Add a blockquote section.
* - :guilabel:`Code`
- Add a code section.
* - :guilabel:`2 columns`
- Convert into 2 columns.
* - :guilabel:`3 columns`
- Convert into 3 columns.
* - :guilabel:`4 columns`
- Convert into 4 columns.
.. tab:: Format
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Heading 1`
- Big section heading.
* - :guilabel:`Heading 2`
- Medium section heading.
* - :guilabel:`Heading 3`
- Small section heading.
* - :guilabel:`Switch direction`
- Switch the text's direction.
* - :guilabel:`Text`
- Paragraph block.
.. tab:: Media
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Image`
- Insert an image.
* - :guilabel:`Article`
- Link an article.
.. tab:: Navigation
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Link`
- Add a link.
* - :guilabel:`Button`
- Add a button.
* - :guilabel:`Appointment`
- Add a specific appointment.
* - :guilabel:`Calendar`
- Schedule an appointment.
.. tab:: Widget
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`3 Stars`
- Insert a rating over 3 stars.
* - :guilabel:`5 Stars`
- Insert a rating over 5 stars.
.. tab:: Knowledge
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Table of Content`
- Add a table of content with the article's headings.
* - :guilabel:`Index`
- Show the first level of nested articles.
* - :guilabel:`Outline`
- Show all nested articles.
* - :guilabel:`Item Kanban`
- Insert a kanban view of article items.
* - :guilabel:`Item List`
- Insert a list view of article items.
* - :guilabel:`File`
- Embed a file that can be downloaded.
* - :guilabel:`Template`
- Add a template section that can be inserted in messages, terms & conditions, or
description in other applications.
.. tab:: Basic Blocks
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Signature`
- Insert your signature.
Content from other apps
=======================
Knowledge allows to retrieve content views from other applications. To do so, go to the targeted app
and create the desired view. Then, click :menuselection:`Favorite --> Insert view in article` and
select an article. The view is inserted at the bottom of the selected article.
.. example:: .. example::
To retrieve the view below, we created it by going to :menuselection:`Sales --> Graph icon --> After receiving an opportunity in :guilabel:`CRM` through the contact form of the website, the
Pie Chart icon` and inserted it by clicking :menuselection:`Favorite --> Insert view in article` message automatically appears in the :guilabel:`Internal Notes` of the opportunity. Click the
and selecting the *Sales Playbook* article. :icon:`fa-bookmark` :guilabel:`(Knowledge)` icon to open the Knowledge search view. Type the
name of the article before clicking on it to display it in :guilabel:`CRM`.
.. image:: articles_editing/inserted-view.png Embed content views
:align: center -------------------
:alt: article view from the Sales app
.. important:: To embed content views from other apps, go to the desired app and do the following:
Users who do **not** have access to the view will **not** be able to access it in **Knowledge**
even though they have access to the article containing the view. #. Select the preferred view.
#. Click the :icon:`fa-cog` :guilabel:`(cog)` icon at the top left corner.
#. Click :menuselection:`Knowledge --> Insert view in article`.
#. Select the article in which you want to embed the view.
.. note::
- Users who do not have access to the view will not be able to access it in
:guilabel:`Knowledge` even though they have access to the article containing the view.
- In some apps, certain views are not available.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -265,7 +265,7 @@ Formatting
********** **********
To format text in the report, select it, then format it using the options in the To format text in the report, select it, then format it using the options in the
:ref:`knowledge/text-editor`. :doc:`text editor <../../../applications/essentials/text_editor>`.
.. image:: pdf_reports/text-editor.png .. image:: pdf_reports/text-editor.png
:alt: Format text using the text editor. :alt: Format text using the text editor.

View File

@ -2375,7 +2375,7 @@ msgstr "التنسيق "
#: ../../content/applications/studio/pdf_reports.rst:267 #: ../../content/applications/studio/pdf_reports.rst:267
msgid "" msgid ""
"To format text in the report, select it, then format it using the options in" "To format text in the report, select it, then format it using the options in"
" the :ref:`knowledge/text-editor`." " the :ref:`text-editor`."
msgstr "" msgstr ""
#: ../../content/applications/studio/pdf_reports.rst:0 #: ../../content/applications/studio/pdf_reports.rst:0