diff --git a/content/applications/productivity.rst b/content/applications/productivity.rst index 1b54d9910..415752c84 100644 --- a/content/applications/productivity.rst +++ b/content/applications/productivity.rst @@ -8,6 +8,7 @@ Productivity .. toctree:: productivity/discuss + productivity/knowledge productivity/iot productivity/mail_plugins productivity/studio diff --git a/content/applications/productivity/knowledge.rst b/content/applications/productivity/knowledge.rst new file mode 100644 index 000000000..075f4ad59 --- /dev/null +++ b/content/applications/productivity/knowledge.rst @@ -0,0 +1,23 @@ +:show-content: +:hide-page-toc: +:show-toc: + +========= +Knowledge +========= + +**Odoo Knowledge** is a multipurpose productivity app that allows internal users to enrich their +business knowledge base and provide individually or collaboratively gathered information. + +The pages on which they gather content are called *articles*. They are mainly composed of a title +and a body. The latter is an HTML field containing text, images, links to other articles, records +from other models, templates, etc. + +.. seealso:: + - `Knowledge product page `_ + +.. toctree:: + :titlesonly: + + knowledge/articles_editing + knowledge/properties diff --git a/content/applications/productivity/knowledge/articles_editing.rst b/content/applications/productivity/knowledge/articles_editing.rst new file mode 100644 index 000000000..82605579b --- /dev/null +++ b/content/applications/productivity/knowledge/articles_editing.rst @@ -0,0 +1,257 @@ +================ +Articles editing +================ + +Add and style content +===================== + +To start adding content, click anywhere on the page. Your cursor is automatically set to write the +article's first-level header. Once you are done writing the title, press **enter** on your keyboard +to move to the next line. + +.. image:: articles_editing/ui.png + :align: center + :alt: knowledge's user interface + +.. tip:: + Click :guilabel:`Untitled` on the left side of the top bar to automatically match your :dfn:`h1 + (First-level header)` title and the article's name. To change the name of your article later, you + must do it manually. To do so, click the name on the top bar and proceed to the modification. + +Text editor +----------- + +To stylize the text using the text editor, select the text to format. + +Then, you can: + +- 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*. + +Add a cover +----------- + +You can customize your article by adding a cover picture and an icon. Hover above the h1 title and +click :guilabel:`Add Cover`. A pop-up window opens to set a cover picture. + +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. +- Enter a picture's **URL**. +- **Upload** an image from a computer. + +To remove the cover, hover over it to make the buttons appear and click :guilabel:`Remove Cover`. + +.. note:: + - To associate Unsplash with your database, please refer to + :doc:`../../websites/website/optimize/unsplash`. + - The articles are responsive, and so are the cover pictures. As a result, the images cannot + be repositioned manually to fit a particular screen, as they automatically resize + depending on the device. + +Add an icon +----------- + +To add an icon, hover above the h1 title and click :guilabel:`Add Icon`. Doing this sets a random +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`. + +.. note:: + - The emoji is also displayed before the corresponding article in the side panel hierarchic tree. + - Click the emoji on the side panel to change it without opening the related article. + +Commands +======== + +To use a command, type `/` and open the **powerbox**. Type the command's name or select from +multiple features to insert blocks, images, files, etc. Some of them, such as `/Image` or `/Article` +are common to all the apps, but others are inherent to the knowledge app and cannot be found or used +in any other application. + +List of commands +---------------- + +Commands are divided into multiple categories depending on their use. + +.. tabs:: + .. tab:: Structure + + .. list-table:: + :widths: 20 80 + :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 app +====================== + +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:: + To retrieve the view below, we created it by going to :menuselection:`Sales --> Graph icon --> + Pie Chart icon` and inserted it by clicking :menuselection:`Favorite --> Insert view in article` + and selecting the *Sales Playbook* article. + + .. image:: articles_editing/inserted-view.png + :align: center + :alt: article view from the Sales app + +.. important:: + 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. diff --git a/content/applications/productivity/knowledge/articles_editing/inserted-view.png b/content/applications/productivity/knowledge/articles_editing/inserted-view.png new file mode 100644 index 000000000..f50cc424f Binary files /dev/null and b/content/applications/productivity/knowledge/articles_editing/inserted-view.png differ diff --git a/content/applications/productivity/knowledge/articles_editing/style-and-colors.png b/content/applications/productivity/knowledge/articles_editing/style-and-colors.png new file mode 100644 index 000000000..d8103e9c1 Binary files /dev/null and b/content/applications/productivity/knowledge/articles_editing/style-and-colors.png differ diff --git a/content/applications/productivity/knowledge/articles_editing/text-editor.png b/content/applications/productivity/knowledge/articles_editing/text-editor.png new file mode 100644 index 000000000..d7161efab Binary files /dev/null and b/content/applications/productivity/knowledge/articles_editing/text-editor.png differ diff --git a/content/applications/productivity/knowledge/articles_editing/ui.png b/content/applications/productivity/knowledge/articles_editing/ui.png new file mode 100644 index 000000000..9054dcf80 Binary files /dev/null and b/content/applications/productivity/knowledge/articles_editing/ui.png differ diff --git a/content/applications/productivity/knowledge/properties.rst b/content/applications/productivity/knowledge/properties.rst new file mode 100644 index 000000000..3bdd0fa67 --- /dev/null +++ b/content/applications/productivity/knowledge/properties.rst @@ -0,0 +1,102 @@ +========== +Properties +========== + +Properties are fields containing data and that can be added to articles by any user with **write** +access. These fields are shared between all the child articles and article items under the same +parent. + +.. note:: + To be able to add properties, an article must be either a **child article** or an **article + item**. + +Add property fields +=================== + +Hover above the first-level header to make the buttons appear. Click :menuselection:`⚙ Add +Properties --> Field Type`, select the type and add a default value if needed. To make the fields +appear in **kanban views**, check :guilabel:`View in Kanban` as well. To validate and close the +property creation window, click anywhere. + +.. image:: properties/fields.png + :align: center + :alt: Dropdown of property fields types + +The different types assess what the field content can be: + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + :stub-columns: 1 + + * - Types + - Uses + * - :guilabel:`Text` + - Allows adding any content with no restriction. + * - :guilabel:`Checkbox` + - Add a checkbox. + * - :guilabel:`Integer` + - Allows adding integer numbers. + * - :guilabel:`Decimal` + - Allows adding any number. + * - :guilabel:`Date` + - Allows selecting a date. + * - :guilabel:`Date & Time` + - Allows selecting a date and time. + +Some **field types** need to be configured: + +.. image:: properties/manyone.png + :align: center + :alt: property configuration form + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + :stub-columns: 1 + + * - Types + - Uses + * - :guilabel:`Selection` + - Add a drop-down selection menu with restricted values that have been set at the property + creation. + + To set it up, click :guilabel:`Add a Value` next to the :guilabel:`Values` field. Enter + predetermined values and press **enter** to validate; you can enter as many values as needed. + Click anywhere to close the property creation window. + * - :guilabel:`Tags` + - Allows creating and applying as many tags as needed. + + To set it up, enter your `new_tag` in the :guilabel:`Tags` field, and press **enter** or + click :guilabel:`Create "new_tag"`. Click anywhere to close the window. Then, add the tags + into the property field. To do so, click the property field and choose from the created tags; + enter the tags' name and press **enter**; enter a new tag's name and create a new one on the + spot. + * - :guilabel:`Many2one` + - Choose from a list of records that result from a model's domain. You can only select one + result. + + To set it up, click :guilabel:`Search a Model` in the :guilabel:`Model` field, select the + model. Match all records by clicking :guilabel:`## Record(s)`, or filter the results by + clicking :guilabel:`+ Add Filter` and show the records by clicking :guilabel:`## Record(s)`. + * - :guilabel:`Many2many` + - Choose from a list of records that result from a model's domain. You can select as many + results as needed. + + To set it up, click :guilabel:`Search a Model` in the :guilabel:`Model` field, select the + model. Match all records by clicking :guilabel:`## Record(s)`, or filter the results by + clicking :guilabel:`+ Add Filter` and show the records by clicking :guilabel:`## Record(s)`. + +Delete property fields +====================== + +To remove a property, click the **pencil** icon next to the targeted property, then click +:menuselection:`Delete --> Delete`. + +.. warning:: + Once a property field is deleted, you cannot retrieve it. + +Hide the property panel +======================= + +To hide the property sidebar panel, click the gear :guilabel:`(⚙)` button. diff --git a/content/applications/productivity/knowledge/properties/fields.png b/content/applications/productivity/knowledge/properties/fields.png new file mode 100644 index 000000000..3718a800b Binary files /dev/null and b/content/applications/productivity/knowledge/properties/fields.png differ diff --git a/content/applications/productivity/knowledge/properties/manyone.png b/content/applications/productivity/knowledge/properties/manyone.png new file mode 100644 index 000000000..8a3766dfb Binary files /dev/null and b/content/applications/productivity/knowledge/properties/manyone.png differ