[IMP] knowledge/properties: update Properties
task-4444312
X-original-commit: a9127727df
@@ -12,3 +12,4 @@ Odoo essentials
|
||||
essentials/export_import_data
|
||||
essentials/in_app_purchase
|
||||
essentials/keyboard_shortcuts
|
||||
essentials/property_fields
|
||||
|
||||
@@ -5,8 +5,8 @@ Odoo rich-text editor
|
||||
=====================
|
||||
|
||||
The Odoo rich-text editor allows creating and editing rich-text content in HTML fields, such as the
|
||||
:guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in :doc:`Knowledge
|
||||
articles </applications/productivity/knowledge/articles_editing>` and the :ref:`Studio report
|
||||
: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
|
||||
editor <studio/pdf-reports/report-editor>`, among others. Start typing or use the
|
||||
:ref:`toolbar <essentials/html_editor/toolbar>` or :ref:`powerbox
|
||||
<essentials/html_editor/commands>` for formatting and structuring text.
|
||||
|
||||
202
content/applications/essentials/property_fields.rst
Normal file
@@ -0,0 +1,202 @@
|
||||
===============
|
||||
Property fields
|
||||
===============
|
||||
|
||||
Property fields, or properties, enable the customization of a :ref:`form
|
||||
<studio/views/general/form>` view by adding various :ref:`field types <property_field/add>`. These
|
||||
fields allow information storage and management by adding values.
|
||||
|
||||
.. admonition:: Property vs. regular fields
|
||||
|
||||
Properties act as pseudo-fields; they behave like regular fields but are not saved as columns in
|
||||
the database. They also rely on a defined :ref:`parent record <property-fields/properties-apps>`.
|
||||
|
||||
.. example::
|
||||
Adding a property to a *task* inserts a field in *all tasks* within the *same
|
||||
project* while other projects' tasks remain unaffected.
|
||||
|
||||
.. _property_field/add:
|
||||
|
||||
Add property fields
|
||||
-------------------
|
||||
|
||||
To add a first property field to a :ref:`form view <studio/views/general/form>`, click the
|
||||
:icon:`fa-cog` (:guilabel:`Actions`) icon, then select :icon:`fa-cogs` :guilabel:`Edit Properties`.
|
||||
|
||||
In the popover, enter the property's :guilabel:`Label`, choose a :guilabel:`Field Type`, and then
|
||||
configure the field based on the selected type:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 15 30 55
|
||||
|
||||
* - Field type
|
||||
- Use
|
||||
- Options
|
||||
* - :ref:`Text <studio/fields/simple-fields-text>`
|
||||
- Short text on a single line
|
||||
- Enter a :guilabel:`Default Value` if desired.
|
||||
* - :guilabel:`Multiline Text`
|
||||
- Full text on multiple lines
|
||||
- Enter a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`HTML <text-editor>`
|
||||
- HTML field
|
||||
- Enter a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Checkbox <studio/fields/simple-fields-checkbox>`
|
||||
- Checked or unchecked status
|
||||
- Choose the :guilabel:`Default State`.
|
||||
* - :ref:`Integer <studio/fields/simple-fields-integer>`
|
||||
- Integer numbers (:dfn:`positive, negative, or zero, without a decimal`)
|
||||
- Enter a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Decimal <studio/fields/simple-fields-decimal>`
|
||||
- Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`)
|
||||
- Enter a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Date <studio/fields/simple-fields-date>`
|
||||
- Selection of a date on a calendar
|
||||
- Select a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Date & Time <studio/fields/simple-fields-date-time>`
|
||||
- Selection of a date on a calendar and a time on a clock
|
||||
- Select a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Selection <studio/fields/simple-fields-selection>`
|
||||
- Selection of a value from a group of predefined values
|
||||
- Add a selectable option by clicking :icon:`fa-plus` :guilabel:`Add a Value` and entering the
|
||||
:guilabel:`Option Name`.
|
||||
|
||||
If desired, set an option as default by clicking the :icon:`fa-star-o`
|
||||
(:guilabel:`Select Default`) button.
|
||||
|
||||
Reorder the options by dragging and dropping them using the :icon:`oi-draggable`
|
||||
(:guilabel:`drag handle`) button.
|
||||
|
||||
Delete an option by clicking the :icon:`fa-trash-o` (:guilabel:`Remove Property`) button.
|
||||
* - :ref:`Tags <studio/fields/relational-fields-tags>`
|
||||
- Selection of multiple values in the form of tags
|
||||
- Enter a :guilabel:`Tag` name and press `Enter` to save it.
|
||||
|
||||
Change a tag's color by clicking it and selecting another one.
|
||||
* - :ref:`Many2one <studio/fields/relational-fields-many2one>`
|
||||
- Selection of a single record from another model
|
||||
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
|
||||
filter records if needed.
|
||||
|
||||
Select a :guilabel:`Default Value` if desired.
|
||||
* - :ref:`Many2many <studio/fields/relational-fields-many2many>`
|
||||
- Selection of multiple records from another model
|
||||
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
|
||||
filter records if needed.
|
||||
|
||||
Select a :guilabel:`Default Value` if desired.
|
||||
* - :guilabel:`Separator`
|
||||
- Group several properties under a foldable label
|
||||
-
|
||||
|
||||
Click outside the popover to save the added property.
|
||||
|
||||
.. note::
|
||||
- Select whether to display the property in the Kanban, List, or Calendar views cards for every
|
||||
field with the :guilabel:`Display in Cards` option.
|
||||
- To add another property, click :icon:`fa-plus` :guilabel:`Add a Property` at the bottom of the
|
||||
form while.
|
||||
|
||||
.. tip::
|
||||
To edit an existing property, hover the cursor over the property:
|
||||
|
||||
- Click the :icon:`fa-pencil` (:guilabel:`pencil`) button to open a popover and modify the
|
||||
property. In the popover, click the :icon:`fa-chevron-up` (up) or :icon:`fa-chevron-down`
|
||||
(down) chevron to move a property upwards or downwards.
|
||||
- Click :icon:`fa-trash` :guilabel:`Delete`, then :guilabel:`Delete` to delete it. Deleting
|
||||
a property is permanent.
|
||||
- Use the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to drag and drop the property to
|
||||
reorder or regroup.
|
||||
|
||||
.. _property-fields/properties-apps:
|
||||
|
||||
Properties across apps
|
||||
----------------------
|
||||
|
||||
Property fields can be defined in the :ref:`form view <studio/views/general/form>` of multiple
|
||||
models. Once set, the property is shared by all records that are linked to the same *parent*.
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 40 40
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - App
|
||||
- Model
|
||||
- Parent
|
||||
* - :guilabel:`Accounting`
|
||||
- :ref:`Asset/Revenue Recognition <create-assets-entry>`
|
||||
|
||||
:doc:`Loan </applications/finance/accounting/bank/loans>`
|
||||
- :ref:`Asset model <assets/asset-model>`
|
||||
|
||||
:ref:`Journal <cheat_sheet/journals>`
|
||||
* - :guilabel:`Appraisals`
|
||||
- :ref:`Employee Appraisal <appraisals/manual>`
|
||||
- :ref:`Department <employee/create-departments>`
|
||||
* - :guilabel:`Approvals`
|
||||
- Approval Request
|
||||
- Category
|
||||
* - :guilabel:`CRM`
|
||||
- :doc:`Lead/Opportunity </applications/sales/crm/acquire_leads/email_manual>`
|
||||
- :ref:`Sales team <crm/sales-team-dashboard>`
|
||||
* - :guilabel:`Employees`
|
||||
- :ref:`Employee <employees/general-info>`
|
||||
- :ref:`Company <employees/general-info>`
|
||||
* - :guilabel:`Events`
|
||||
- :doc:`Event Registration </applications/marketing/events/registration_desk>`
|
||||
- :ref:`Event <events/new-event>`
|
||||
* - :guilabel:`Fleet`
|
||||
- :doc:`Vehicle </applications/hr/fleet/new_vehicle>`
|
||||
- :ref:`Vehicle model <fleet/add-model>`
|
||||
* - :guilabel:`Frontdesk`
|
||||
- :ref:`Frontdesk Visitors <frontdesk/list>`
|
||||
- :ref:`Station <frontdesk/stations>`
|
||||
* - :guilabel:`Helpdesk`
|
||||
- :ref:`Ticket <helpdesk/follow>`
|
||||
- :ref:`Helpdesk team <helpdesk/create-team>`
|
||||
* - :guilabel:`Inventory`
|
||||
- :ref:`Lot/Serial <inventory/product_management/edit-lot>`
|
||||
|
||||
:doc:`Transfer
|
||||
</applications/inventory_and_mrp/inventory/shipping_receiving/picking_methods/wave>`
|
||||
|
||||
:ref:`Batch Transfer <inventory/misc/batch_picking>`
|
||||
- :ref:`Product variant <product-variants/add-product-variants>`
|
||||
|
||||
:ref:`Operation type <inventory/product_management/operation-type-setting>`
|
||||
|
||||
:ref:`Operation type <inventory/product_management/operation-type-setting>`
|
||||
* - :guilabel:`Knowledge`
|
||||
- :ref:`Knowledge Article <knowledge/articles_editing/create-article>`
|
||||
- :ref:`Parent article <knowledge/articles_editing/create-article>`
|
||||
* - :guilabel:`Maintenance`
|
||||
- :ref:`Maintenance Equipment <maintenance/equipment_management/add_new_equipment>`
|
||||
- :ref:`Equipment category <maintenance/equipment_management/add_new_equipment>`
|
||||
* - :guilabel:`Meeting Rooms`
|
||||
- Room
|
||||
- Office
|
||||
* - :guilabel:`Planning`
|
||||
- :ref:`Shift <planning/roles>`
|
||||
- :ref:`Role <planning/roles>`
|
||||
* - :guilabel:`Project` / :guilabel:`Field Service`
|
||||
- :ref:`Task <task_creation/task-configuration>`
|
||||
- :ref:`Project <project_management/configuration>`
|
||||
* - :guilabel:`Recruitment`
|
||||
- :ref:`Applicant <recruitment/quick-add-applicant>`
|
||||
|
||||
:ref:`Job Position <recruitment/new_job_position/edit>`
|
||||
|
||||
Candidate
|
||||
- :ref:`Job position <job-position/create-job-position>`
|
||||
|
||||
:ref:`Company <companies/manage>`
|
||||
|
||||
:ref:`Company <companies/manage>`
|
||||
* - :guilabel:`Repairs`
|
||||
- :ref:`Repair order <repairs/repair_orders/repair>`
|
||||
- :ref:`Company <companies/manage>`
|
||||
* - :guilabel:`Sales` / etc.
|
||||
- Product
|
||||
- Category
|
||||
@@ -199,6 +199,8 @@ time of the sale and the amount it is sold for.
|
||||
To record the sale of an asset, you must first post the related Customer Invoice so you can link
|
||||
the sale of the asset with it.
|
||||
|
||||
.. _assets/asset-model:
|
||||
|
||||
Assets Models
|
||||
=============
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@ Departments
|
||||
|
||||
All employees in the **Employees** app fall under specific departments within a company.
|
||||
|
||||
.. _employee/create-departments:
|
||||
|
||||
Create new departments
|
||||
======================
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ Configuration
|
||||
The first item to configure with the **Frontdesk** application is the station, followed by any drink
|
||||
selections that might optionally be offered.
|
||||
|
||||
.. _frontdesk/stations:
|
||||
|
||||
Stations
|
||||
--------
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ View submitted applications by clicking anywhere on a job position card.
|
||||
.. image:: new_job/jobs.png
|
||||
:alt: Main dashboard view of Recruitment app showing all job positions.
|
||||
|
||||
.. _job-position/create-job-position:
|
||||
|
||||
Create a new job position
|
||||
=========================
|
||||
|
||||
|
||||
@@ -259,7 +259,7 @@ on a lot number form:
|
||||
:icon:`fa-cogs` :guilabel:`Add Properties` from the drop-down menu.
|
||||
#. Click the :icon:`fa-plus` :guilabel:`Add a Property` button, located below the existing fields.
|
||||
|
||||
Name and :doc:`configure the new field <../../../../productivity/knowledge/properties>`. Once
|
||||
Name and :doc:`configure the new field </applications/essentials/property_fields>`. Once
|
||||
finished, enter the property value in the new field.
|
||||
|
||||
.. example::
|
||||
@@ -270,7 +270,7 @@ finished, enter the property value in the new field.
|
||||
:alt: Show the "Add Properties" button on a lot number form.
|
||||
|
||||
.. seealso::
|
||||
:doc:`Configuring custom properties <../../../../productivity/knowledge/properties>`
|
||||
:doc:`Configuring custom properties </applications/essentials/property_fields>`
|
||||
|
||||
.. _inventory/product_management/create-new-lot:
|
||||
|
||||
|
||||
@@ -54,6 +54,8 @@ drop-down menu. Then, select the desired options next to the :guilabel:`Display
|
||||
Once all desired :guilabel:`Values` have been added, click :guilabel:`Save` to save the new
|
||||
attribute.
|
||||
|
||||
.. _product-variants/add-product-variants:
|
||||
|
||||
Add product variants on the product form
|
||||
========================================
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ Events can be manually created from scratch or built off of pre-made templates.
|
||||
registration of the event for attendees, the *Sales* app for the purchasing ability of paid tickets,
|
||||
as well the *CRM* application through customizable lead generation rules.
|
||||
|
||||
.. _events/new-event:
|
||||
|
||||
New event
|
||||
=========
|
||||
|
||||
|
||||
@@ -1,24 +1,440 @@
|
||||
: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.
|
||||
business knowledge base by providing information gathered individually or collaboratively.
|
||||
|
||||
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.
|
||||
and a body. The latter is an HTML field containing text, images, links, records from other models,
|
||||
templates, etc.
|
||||
|
||||
.. seealso::
|
||||
- `Knowledge product page <https://www.odoo.com/app/knowledge>`_
|
||||
`Knowledge product page <https://www.odoo.com/app/knowledge>`_
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
.. _knowledge/articles_editing/create-article:
|
||||
|
||||
knowledge/articles_editing
|
||||
knowledge/management
|
||||
knowledge/properties
|
||||
Article creation
|
||||
================
|
||||
|
||||
Knowledge articles can be created from scratch or a pre-configured template. When an article
|
||||
is created under another, the original one is the **parent article**, while the new one is called a
|
||||
**child** or **nested article**, indicating its subordinate position. This structure helps organize
|
||||
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`
|
||||
:guilabel:`(plus)` icon.
|
||||
|
||||
From scratch
|
||||
------------
|
||||
|
||||
To create an article from scratch, click :icon:`fa-plus` :guilabel:`New Article` in the top-left
|
||||
corner or hover over the :guilabel:`Private` or :guilabel:`Workspace` category in the sidebar tree,
|
||||
then click the :icon:`fa-plus` :guilabel:`(plus)` icon. Start typing text or select one of the
|
||||
suggested options:
|
||||
|
||||
- :guilabel:`Load a Template`: Select a preconfigured template and click :guilabel:`Load Template`.
|
||||
- :guilabel:`Build an Item Kanban`: Create items to visualize and manage them in a Kanban view.
|
||||
- :guilabel:`Build an Item List`: Create a structured list of items to centralize them in a single
|
||||
article.
|
||||
- :guilabel:`Build an Item Calendar`: Create a calendar view to manage and track items by date.
|
||||
- :guilabel:`Generate an Article with AI`: Generate content based on a prompt.
|
||||
|
||||
.. tip::
|
||||
After writing the header, click or hover over :guilabel:`Untitled` in the top bar to
|
||||
automatically name the article after the header. This action does not apply if the article is
|
||||
already titled.
|
||||
|
||||
From a template
|
||||
---------------
|
||||
|
||||
To create an article from a template, follow these steps:
|
||||
|
||||
#. Click :icon:`fa-paint-brush` :guilabel:`Browse Templates` at the bottom of the sidebar tree.
|
||||
#. Select a preferred template.
|
||||
#. Click :guilabel:`Load Template`.
|
||||
|
||||
.. _knowledge/articles_editing/edit-article:
|
||||
|
||||
Article editing
|
||||
===============
|
||||
|
||||
To edit an article, select it in the sidebar tree, then edit its content and format it using the
|
||||
:ref:`text editor toolbar <knowledge/articles_editing/text-editor>`, typing :ref:`powerbox
|
||||
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/text-editor:
|
||||
|
||||
Text editor toolbar
|
||||
-------------------
|
||||
|
||||
To edit a word, sentence, or paragraph, select or double-click it to display the text editor
|
||||
toolbar and apply the desired :doc:`formatting options </applications/essentials/html_editor>`.
|
||||
|
||||
.. tip::
|
||||
Click :icon:`fa-commenting-o` :guilabel:`Comment` to add a comment to the selected text.
|
||||
|
||||
.. _knowledge/articles_editing/commands:
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
Type `/` to open the :ref:`powerbox <essentials/html_editor/commands>` and use a command. The
|
||||
following commands are exclusive to the Knowledge app:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`Index`
|
||||
- Show :ref:`nested articles <knowledge/articles_editing/create-article>`: Display the
|
||||
child pages of the parent article.
|
||||
* - :guilabel:`Item Kanban`
|
||||
- Insert a Kanban view and create :ref:`article items
|
||||
<knowledge/articles_editing/items>`.
|
||||
* - :guilabel:`Item Cards`
|
||||
- Insert a Card view and create :ref:`article items <knowledge/articles_editing/items>`.
|
||||
* - :guilabel:`Item List`
|
||||
- Insert a List view and create :ref:`article items <knowledge/articles_editing/items>`.
|
||||
* - :guilabel:`Item Calendar`
|
||||
- Insert a Calendar view and create :ref:`article items
|
||||
<knowledge/articles_editing/items>`.
|
||||
|
||||
.. _knowledge/articles_editing/items:
|
||||
|
||||
Article items
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Article items are active building blocks within an article, allowing the addition, management, and
|
||||
viewing of various organized content and data.
|
||||
|
||||
Article items within a parent article can contain :ref:`properties
|
||||
<knowledge/articles_editing/properties>`, which are shared data fields from the parent, ensuring
|
||||
consistent information across related items and articles.
|
||||
|
||||
.. _knowledge/articles_editing/cover:
|
||||
|
||||
Cover pictures
|
||||
--------------
|
||||
|
||||
To add a cover picture, click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon, then
|
||||
:guilabel:`Add Cover`. The following options enable selecting and inserting pictures from different
|
||||
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:
|
||||
|
||||
- :guilabel:`Replace Cover` and search from the database or library, or add a different URL.
|
||||
|
||||
- :guilabel:`Reposition` and adjust the picture before clicking :guilabel:`Save Position`.
|
||||
|
||||
- :guilabel:`Remove`.
|
||||
|
||||
.. _knowledge/articles_editing/emoji:
|
||||
|
||||
Title emoji
|
||||
-----------
|
||||
|
||||
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
|
||||
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
|
||||
name in the sidebar or the top bar and select the preferred emoji.
|
||||
|
||||
.. _knowledge/articles_editing/views:
|
||||
|
||||
Views and links from other apps
|
||||
-------------------------------
|
||||
|
||||
To insert a view or a view link into an article, follow these steps:
|
||||
|
||||
#. Go to the desired app and select the preferred view.
|
||||
#. Click the :icon:`fa-cog` :guilabel:`(cog)` icon, then select :menuselection:`Knowledge -->
|
||||
Insert view in article` or :guilabel:`Insert link in article`.
|
||||
#. Choose the article to insert the view or link to.
|
||||
|
||||
.. note::
|
||||
Once the view or link is inserted:
|
||||
|
||||
- Users without access to the view cannot see it in Knowledge, even if they can access the
|
||||
article.
|
||||
- Clicking the inserted link opens a pop-up with the view's name next to the
|
||||
:icon:`fa-clipboard` (:guilabel:`Copy Link`), :icon:`fa-pencil-square-o` (:guilabel:`Edit
|
||||
Link`), and :icon:`fa-chain-broken` (:guilabel:`Remove Link`) icons. Click the name inside the
|
||||
pop-up to open the linked view.
|
||||
|
||||
Article management
|
||||
==================
|
||||
|
||||
Knowledge allows for managing articles, which consists of :ref:`structuring
|
||||
<knowledge/articles_editing/structure>`, :ref:`sharing <knowledge/articles_editing/share>`,
|
||||
:ref:`removing <knowledge/articles_editing/remove>`, and :ref:`retrieving
|
||||
<knowledge/articles_editing/retrieve>` them.
|
||||
|
||||
Basic management
|
||||
----------------
|
||||
|
||||
Click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon and select one of the following actions
|
||||
for basic article management:
|
||||
|
||||
- :guilabel:`Move To`: Select the article to move under a category or another article, then click
|
||||
:guilabel:`Move Article`.
|
||||
- :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:`Open Version History`: Restore a previous version of the article.
|
||||
- :guilabel:`Export`: Open the browser's print function.
|
||||
- :guilabel:`Add to Templates`: Add the article to the list of templates.
|
||||
- :guilabel:`Send to Trash`: Move the article to the trash.
|
||||
|
||||
.. note::
|
||||
The following actions only apply to :ref:`nested articles
|
||||
<knowledge/articles_editing/create-article>` and :ref:`article items
|
||||
<knowledge/articles_editing/items>`:
|
||||
|
||||
- :guilabel:`Convert into Article Item`: Convert the nested article into an :ref:`article item
|
||||
<knowledge/articles_editing/items>`.
|
||||
- :guilabel:`Convert into Article`: Convert the article item into a :ref:`nested article
|
||||
<knowledge/articles_editing/create-article>`.
|
||||
|
||||
.. tip::
|
||||
- Move an article directly from the sidebar tree by dragging and dropping it under another
|
||||
article or category.
|
||||
- Click the :icon:`fa-search` (:guilabel:`serch`) icon in the top-left corner or press `CTRL` /
|
||||
`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
|
||||
the :guilabel:`Workspace` category and click the :icon:`fa-eye` (:guilabel:`eye`) icon to find
|
||||
hidden articles.
|
||||
|
||||
.. _knowledge/articles_editing/structure:
|
||||
|
||||
Structuring
|
||||
-----------
|
||||
|
||||
Sidebar structure
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
The sidebar structure follows a hierarchy with parent and nested articles organized within the
|
||||
following categories:
|
||||
|
||||
- The :guilabel:`Favorites` category displays all articles marked as favorites.
|
||||
- The :guilabel:`Workspace` category displays articles accessible to all internal users.
|
||||
- The :guilabel:`Shared` category displays articles shared with specific users.
|
||||
- The :guilabel:`Private` category displays personal articles.
|
||||
|
||||
.. note::
|
||||
- To mark an article as a favorite and display the :guilabel:`Favorites` category, click the
|
||||
:icon:`fa-star-o` (:guilabel:`star`) icon in the top-right menu.
|
||||
|
||||
Article structure
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Nested articles inherit their parent's :ref:`access rights <knowledge/articles_editing/rights>`, and
|
||||
:ref:`properties <knowledge/articles_editing/properties>` are applied to a group of nested articles
|
||||
under the same parent.
|
||||
|
||||
.. _knowledge/articles_editing/share:
|
||||
|
||||
Sharing
|
||||
-------
|
||||
|
||||
Sharing an article involves configuring :ref:`access rights <knowledge/articles_editing/rights>`,
|
||||
inviting :ref:`users <knowledge/articles_editing/invite>`, providing :ref:`online access
|
||||
<knowledge/articles_editing/share-online>`, and determining its visibility in the :ref:`sidebar tree
|
||||
<knowledge/articles_editing/structure>`.
|
||||
|
||||
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**.
|
||||
|
||||
.. _knowledge/articles_editing/rights:
|
||||
|
||||
Configure access rights
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Click :guilabel:`Share` in the top-right menu to configure access rights.
|
||||
|
||||
Default access rights
|
||||
*********************
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Setting
|
||||
- Use
|
||||
* - :guilabel:`Can edit`
|
||||
- Allow all internal users to edit the article.
|
||||
* - :guilabel:`Can read`
|
||||
- Allow all internal users to read the article only.
|
||||
* - :guilabel:`No access`
|
||||
- Prevent all users from accessing the article in the sidebar tree or searching in the
|
||||
command palette.
|
||||
|
||||
.. _knowledge/articles_editing/visibility:
|
||||
|
||||
Visibility
|
||||
**********
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Setting
|
||||
- Use
|
||||
* - :guilabel:`Everyone`
|
||||
- The article is visible in the sidebar tree to all internal users.
|
||||
* - :guilabel:`Members`
|
||||
- The article is only visible in the sidebar tree to :ref:`invited users
|
||||
<knowledge/articles_editing/invite>`, while other users can find it using the hidden
|
||||
article search by pressing `CTRL` / `CMD` + `K` and typing `$`.
|
||||
|
||||
.. note::
|
||||
- The :guilabel:`Default Access Rights` apply to all internal users except invited users;
|
||||
specific access rights override default access rights.
|
||||
- Selecting `Can edit` or `Can read` in the :guilabel:`Default Access Rights` moves the article
|
||||
to the :guilabel:`Workspace` category while selecting `No access` moves it to the
|
||||
:guilabel:`Private` category if it is not shared with an invited user.
|
||||
- The :guilabel:`Visibility` setting only applies to :guilabel:`Workspace` articles.
|
||||
|
||||
.. _knowledge/articles_editing/invite:
|
||||
|
||||
Invite specific users
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To grant specific internal or portal users access to a private article or to share a
|
||||
:guilabel:`Workspace` article with a portal user, follow these steps:
|
||||
|
||||
#. Click :guilabel:`Share` in the top-right menu.
|
||||
#. Click :guilabel:`Invite`.
|
||||
#. Select the preferred :guilabel:`Permission` and add users in the :guilabel:`Recipients` field.
|
||||
#. Click :guilabel:`Invite`.
|
||||
|
||||
.. _knowledge/articles_editing/share-online:
|
||||
|
||||
Generate article URL
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Click :guilabel:`Share` and activate the :guilabel:`Share to web` toggle to generate a URL. Click
|
||||
:guilabel:`Copy Link` to copy the article's URL.
|
||||
|
||||
.. note::
|
||||
- If an article contains :ref:`inserted views <knowledge/articles_editing/views>`, users with
|
||||
the URL do not see them unless they can access the inserted content.
|
||||
- Having the Website app is necessary to share an article's URL.
|
||||
|
||||
.. _knowledge/articles_editing/remove:
|
||||
|
||||
Removal
|
||||
-------
|
||||
|
||||
Removing an article involves deleting or archiving it.
|
||||
|
||||
Delete an article
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Select an article in the sidebar tree and click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`)
|
||||
icon, then :guilabel:`Send to Trash`. Alternatively, hold click the article and drag it 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.
|
||||
|
||||
To permanently delete an article, click :guilabel:`Articles` in the top-left menu, select an article,
|
||||
and click :menuselection:`Actions --> Delete --> Delete`.
|
||||
|
||||
.. note::
|
||||
To restore a trashed article, click :guilabel:`Open the Trash` at the bottom of the sidebar
|
||||
tree, select an article, and click :guilabel:`Restore`. Alternatively, click :guilabel:`Articles`
|
||||
in the top-left menu. In the search bar, click :menuselection:`Filters --> Trashed`. Click the
|
||||
article, then :guilabel:`Restore`.
|
||||
|
||||
Archive an article
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Click :guilabel:`Articles`, select an article, and click :menuselection:`Actions --> Archive -->
|
||||
Archive`.
|
||||
|
||||
.. note::
|
||||
To restore an archived article, click :guilabel:`Articles`. In the search bar, click
|
||||
:menuselection:`Filters --> Archived`. Select the article and go to :menuselection:`Actions -->
|
||||
Unarchive`.
|
||||
|
||||
.. _knowledge/articles_editing/retrieve:
|
||||
|
||||
Retrieval
|
||||
---------
|
||||
|
||||
Retrieving Knowledge articles consists of accessing them from various Odoo apps or restoring
|
||||
previous versions.
|
||||
|
||||
Access articles from various apps
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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
|
||||
the command palette, then choose one of the following search methods:
|
||||
|
||||
- :guilabel:`Search for an article`: start typing the text to execute a semantic search that
|
||||
identifies relevant article information.
|
||||
- :guilabel:`Advanced Search`: after typing the text in the search bar, click :guilabel:`Advanced
|
||||
Search` to perform a parametric search with options to filter, group, or save articles.
|
||||
|
||||
Version history
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
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 to open the version history. Select a version and click :guilabel:`Restore history`.
|
||||
|
||||
.. note::
|
||||
In the version history, the :guilabel:`Content` tab shows the selected version, while the
|
||||
:guilabel:`Comparison` tab displays the differences between the article's previous and current
|
||||
versions.
|
||||
|
||||
.. _knowledge/articles_editing/properties:
|
||||
|
||||
Properties
|
||||
==========
|
||||
|
||||
Properties are custom fields for storing and managing information that users with `Can edit`
|
||||
:ref:`access rights <knowledge/articles_editing/rights>` can add to :ref:`nested articles
|
||||
<knowledge/articles_editing/create-article>` or :ref:`article items
|
||||
<knowledge/articles_editing/items>`.
|
||||
|
||||
To add a property, click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon, then
|
||||
:menuselection:`Add Properties --> Add a Property`, enter a :guilabel:`Label`, and select a
|
||||
:guilabel:`Field Type`.
|
||||
|
||||
To learn more about properties and field types, go to :doc:`Property fields
|
||||
</applications/essentials/property_fields>`.
|
||||
|
||||
.. note::
|
||||
- Click outside the property field window to save a property.
|
||||
- To remove a property, hover over its name, click the :icon:`fa-pencil` (:guilabel:`pencil`)
|
||||
icon, then click :menuselection:`Delete --> Delete`. Deleting a property is permanent, and
|
||||
deleting all properties removes the property sidebar panel.
|
||||
|
||||
.. tip::
|
||||
- Hover over the property name and click the :icon:`fa-pencil` (:guilabel:`pencil`) icon to edit
|
||||
it or the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to move it above or below another
|
||||
property.
|
||||
- Tick :guilabel:`Display in Cards` to show the properties in an :ref:`article item's view
|
||||
<knowledge/articles_editing/items>` that is visible from a parent article.
|
||||
- Click the :icon:`fa-cogs` (:guilabel:`cogs`) icon to hide the property sidebar panel. Exiting
|
||||
and returning to the article causes the panel to reappear.
|
||||
|
||||
@@ -1,143 +0,0 @@
|
||||
============================
|
||||
Article creation and editing
|
||||
============================
|
||||
|
||||
.. _knowledge/articles_editing/create-article:
|
||||
|
||||
Article creation
|
||||
================
|
||||
|
||||
Knowledge articles can be created from scratch or from a preconfigured template.
|
||||
|
||||
From scratch
|
||||
------------
|
||||
|
||||
To create an article from scratch, click :guilabel:`New` in the top right corner or hover over the
|
||||
:guilabel:`Private` or :guilabel:`Workspace` category in the sidebar tree, then click the
|
||||
:icon:`fa-plus` :guilabel:`(plus)` icon. Start typing text or select one of the suggested options:
|
||||
|
||||
- :guilabel:`Load a Template`: Select a preconfigured template and click :guilabel:`Load Template`.
|
||||
- :guilabel:`Build an Item Kanban`: Create items to visualize and manage them in a Kanban view.
|
||||
- :guilabel:`Build an Item List`: Create a structured list of items to centralize them in a single
|
||||
article.
|
||||
- :guilabel:`Build an Item Calendar`: Create a calendar view to manage and track items by date.
|
||||
- :guilabel:`Generate an Article with AI`: Generate content based on a prompt.
|
||||
|
||||
.. tip::
|
||||
After writing the header, click or hover over :guilabel:`Untitled` in the top bar to
|
||||
automatically name the article after the header. This does not apply if the article is already
|
||||
titled.
|
||||
|
||||
From a template
|
||||
---------------
|
||||
|
||||
To create an article from a template, follow these steps:
|
||||
|
||||
#. Click :icon:`fa-paint-brush` :guilabel:`Browse Templates` at the bottom of the sidebar tree.
|
||||
#. Select a preferred template.
|
||||
#. Click :guilabel:`Load Template`.
|
||||
|
||||
Article editing
|
||||
===============
|
||||
|
||||
To edit an article, select it in the sidebar tree, then edit its content and format it using the
|
||||
:ref:`text editor toolbar <knowledge/articles_editing/text-editor>`, by typing :ref:`powerbox
|
||||
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/text-editor:
|
||||
|
||||
Text editor toolbar
|
||||
-------------------
|
||||
|
||||
To edit a word, sentence, or paragraph, select or double-click it to display the text editor
|
||||
toolbar and apply the desired :doc:`formatting options </applications/essentials/html_editor>`.
|
||||
|
||||
.. tip::
|
||||
Click :icon:`fa-commenting` :guilabel:`Comment` to add a comment to the selected text.
|
||||
|
||||
.. _knowledge/articles_editing/commands:
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
Type `/` to open the :ref:`powerbox <essentials/html_editor/commands>` and use a command. The
|
||||
following commands are exclusive to the Knowledge app:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`Index`
|
||||
- Show nested articles: Display the child pages of the parent article.
|
||||
* - :guilabel:`Item Kanban`
|
||||
- Insert a Kanban view and create items.
|
||||
* - :guilabel:`Item Cards`
|
||||
- Insert a Card view and create items.
|
||||
* - :guilabel:`Item List`
|
||||
- Insert a List view and create items.
|
||||
* - :guilabel:`Item Calendar`
|
||||
- Insert a Calendar view and create items.
|
||||
|
||||
.. _knowledge/articles_editing/cover:
|
||||
|
||||
Cover pictures
|
||||
--------------
|
||||
|
||||
To add a cover picture, click the :icon:`fa-ellipsis-v` :guilabel:`(ellipsis)` icon, then
|
||||
:guilabel:`Add Cover`. The following options enable selecting and inserting pictures from different
|
||||
sources:
|
||||
|
||||
- Search the :doc:`Unsplash </applications/general/integrations/unsplash>` database to find a
|
||||
suitable picture. If your database and your **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:
|
||||
|
||||
- :guilabel:`Replace Cover` and search from the database or library, or add a different URL.
|
||||
|
||||
- :guilabel:`Reposition` and adjust the picture before clicking :guilabel:`Save Position`.
|
||||
|
||||
- :guilabel:`Remove Cover`.
|
||||
|
||||
.. _knowledge/articles_editing/emoji:
|
||||
|
||||
Title emoji
|
||||
-----------
|
||||
|
||||
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
|
||||
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
|
||||
name in the sidebar or the top bar and select the preferred emoji.
|
||||
|
||||
.. _knowledge/articles_editing/views:
|
||||
|
||||
Views and links from other apps
|
||||
-------------------------------
|
||||
|
||||
To insert a view or a view link into an article, follow these steps:
|
||||
|
||||
#. Go to the desired app and select the preferred view.
|
||||
#. Click the :icon:`fa-cog` :guilabel:`(cog)` icon, then select :menuselection:`Knowledge -->
|
||||
Insert view in article` or :guilabel:`Insert link in article`.
|
||||
#. Choose the article to insert the view or link to.
|
||||
|
||||
.. note::
|
||||
Once the view or link is inserted:
|
||||
|
||||
- Users without access to the view cannot see it in Knowledge, even if they can access the
|
||||
article containing it.
|
||||
- Clicking the inserted link opens a pop-up with the view's name next to the
|
||||
:icon:`fa-clipboard` (:guilabel:`copy`), :icon:`fa-pencil-square-o` (:guilabel:`edit`), and
|
||||
:icon:`fa-chain-broken` (:guilabel:`remove`) icons. Click the name inside the pop-up to open
|
||||
the linked view.
|
||||
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 20 KiB |
@@ -1,216 +0,0 @@
|
||||
==================
|
||||
Article management
|
||||
==================
|
||||
|
||||
Knowledge allows for managing articles, which consists of :ref:`structuring
|
||||
<knowledge/management/structure>`, :ref:`sharing <knowledge/management/share>`, :ref:`removing
|
||||
<knowledge/management/remove>`, and :ref:`retrieving <knowledge/management/retrieve>` them.
|
||||
|
||||
Basic management
|
||||
================
|
||||
|
||||
Click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon and select one of the following actions
|
||||
for basic article management:
|
||||
|
||||
- :guilabel:`Move To`: Select the article to move under a category or another article, then click
|
||||
:guilabel:`Move Article`.
|
||||
- :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:`Open Version History`: View the current and previous versions of the article.
|
||||
- :guilabel:`Export`: Open the browser's print function.
|
||||
- :guilabel:`Add to Templates`: Add the article to the list of templates.
|
||||
- :guilabel:`Send to Trash`: Move the article to the trash.
|
||||
|
||||
.. note::
|
||||
The following actions only apply to nested articles and :ref:`article items
|
||||
<knowledge/articles_editing/commands>`:
|
||||
|
||||
- :guilabel:`Convert into Article Item`: Convert the nested article into an article item.
|
||||
- :guilabel:`Convert into Article`: Convert the article item into a nested article.
|
||||
|
||||
.. tip::
|
||||
- Move an article directly from the sidebar tree by dragging and dropping it under another
|
||||
article or category.
|
||||
- Press `CTRL` / `CMD` + `K` to open the command palette, then type `?` to search for visible
|
||||
articles or `$` for :ref:`hidden articles <knowledge/management/visibility>`. Alternatively,
|
||||
hover over the :guilabel:`Workspace` category and click the :icon:`fa-eye` (:guilabel:`eye`)
|
||||
icon to find hidden articles.
|
||||
|
||||
.. _knowledge/management/structure:
|
||||
|
||||
Structuring
|
||||
===========
|
||||
|
||||
The article structure follows a hierarchy with parent and nested articles organized within the
|
||||
following categories:
|
||||
|
||||
- :guilabel:`Favorites` displays all articles marked as favorites.
|
||||
- :guilabel:`Workspace` displays articles accessible to all internal users.
|
||||
- :guilabel:`Shared` displays articles shared with specific users.
|
||||
- :guilabel:`Private` displays personal articles.
|
||||
|
||||
.. note::
|
||||
- To mark an article as a favorite and display the :guilabel:`Favorites` category, click the
|
||||
:icon:`fa-star-o` (:guilabel:`star`) icon in the top-right menu.
|
||||
- Nested articles inherit the access rights of their parent article.
|
||||
|
||||
.. _knowledge/management/share:
|
||||
|
||||
Sharing
|
||||
=======
|
||||
|
||||
Sharing an article involves configuring :ref:`access rights <knowledge/management/rights>`,
|
||||
inviting :ref:`users <knowledge/management/invite>`, providing :ref:`online access
|
||||
<knowledge/management/share-online>`, and determining its visibility in the :ref:`sidebar tree
|
||||
<knowledge/management/structure>`.
|
||||
|
||||
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.
|
||||
|
||||
.. _knowledge/management/rights:
|
||||
|
||||
Configure access rights
|
||||
-----------------------
|
||||
|
||||
Click :guilabel:`Share` in the top-right menu to configure access rights.
|
||||
|
||||
Default access rights
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Setting
|
||||
- Use
|
||||
* - :guilabel:`Can edit`
|
||||
- Allow all internal users to edit the article.
|
||||
* - :guilabel:`Can read`
|
||||
- Allow all internal users to read the article only.
|
||||
* - :guilabel:`No access`
|
||||
- Prevent all users from accessing the article in the sidebar tree or searching in the
|
||||
command palette.
|
||||
|
||||
.. _knowledge/management/visibility:
|
||||
|
||||
Visibility
|
||||
~~~~~~~~~~
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Setting
|
||||
- Use
|
||||
* - :guilabel:`Everyone`
|
||||
- The article is visible in the sidebar tree to all internal users.
|
||||
* - :guilabel:`Members`
|
||||
- The article is only visible in the sidebar tree to :ref:`invited users
|
||||
<knowledge/management/invite>`, while other users can find it using the hidden article
|
||||
search by pressing `CTRL` / `CMD` + `K` and typing `$`.
|
||||
|
||||
.. note::
|
||||
- The :guilabel:`Default Access Rights` apply to all internal users except invited users;
|
||||
specific access rights override default access rights.
|
||||
- Selecting `Can edit` or `Can read` in the :guilabel:`Default Access Rights` moves the article
|
||||
to the :guilabel:`Workspace` category, while selecting `No access` moves it to the
|
||||
:guilabel:`Private` category if it is not shared with anyone.
|
||||
- The :guilabel:`Visibility` setting only applies to :guilabel:`Workspace` articles.
|
||||
|
||||
.. _knowledge/management/invite:
|
||||
|
||||
Invite specific users
|
||||
---------------------
|
||||
|
||||
To grant specific internal or portal users access to a private article or to share a
|
||||
:guilabel:`Workspace` article with a portal user, follow these steps:
|
||||
|
||||
#. Click :guilabel:`Share` in the top-right menu.
|
||||
#. Click :guilabel:`Invite`.
|
||||
#. Select the preferred :guilabel:`Permission` and add users in the :guilabel:`Recipients` field.
|
||||
#. Click :guilabel:`Invite`.
|
||||
|
||||
.. _knowledge/management/share-online:
|
||||
|
||||
Generate article URL
|
||||
--------------------
|
||||
|
||||
Click :guilabel:`Share` and activate the :guilabel:`Share to web` toggle to generate a URL.
|
||||
Click the :icon:`fa-clone` (:guilabel:`copy`) icon to copy the article's URL.
|
||||
|
||||
.. note::
|
||||
- If an article contains :ref:`inserted views <knowledge/articles_editing/views>`, users with
|
||||
the URL do not see them unless they can access the inserted content.
|
||||
- Having the Website app is necessary to share an article's URL.
|
||||
|
||||
.. _knowledge/management/remove:
|
||||
|
||||
Removal
|
||||
=======
|
||||
|
||||
Removing an article involves deleting or archiving it.
|
||||
|
||||
Delete an article
|
||||
-----------------
|
||||
|
||||
Select an article in the sidebar tree and click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`)
|
||||
icon, then :guilabel:`Send to Trash`. The article is moved to the trash for 30 days before being
|
||||
permanently deleted.
|
||||
|
||||
To delete an article directly, click :guilabel:`Articles` in the top-left menu, select an article,
|
||||
and click :menuselection:`Actions --> Delete --> Delete` to remove the article permanently.
|
||||
|
||||
.. note::
|
||||
To restore a trashed article, click :guilabel:`Open the Trash` at the bottom of the sidebar
|
||||
tree, select an article, and click :guilabel:`Restore`. Alternatively, click :guilabel:`Articles`
|
||||
in the top-left menu. In the search bar, click :menuselection:`Filters --> Trashed`. Click the
|
||||
article, then :guilabel:`Restore`.
|
||||
|
||||
Archive an article
|
||||
------------------
|
||||
|
||||
Click :guilabel:`Articles`, select an article, and click :menuselection:`Actions --> Archive -->
|
||||
Archive`.
|
||||
|
||||
.. note::
|
||||
To restore an archived article, click :guilabel:`Articles`. In the search bar, click
|
||||
:menuselection:`Filters --> Archived`. Select the article and go to :menuselection:`Actions -->
|
||||
Unarchive`.
|
||||
|
||||
.. _knowledge/management/retrieve:
|
||||
|
||||
Retrieval
|
||||
=========
|
||||
|
||||
Retrieving Knowledge articles consists of accessing them from various Odoo apps or restoring
|
||||
previous versions.
|
||||
|
||||
Access articles from various apps
|
||||
---------------------------------
|
||||
|
||||
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
|
||||
the command palette, then choose one of the following search methods:
|
||||
|
||||
- :guilabel:`Search for an article`: start typing the text to execute a semantic search that
|
||||
identifies relevant article information.
|
||||
- :guilabel:`Advanced Search`: after typing the text in the search bar, click :guilabel:`Advanced
|
||||
Search` to perform a parametric search with options to filter, group, or save articles.
|
||||
|
||||
Version history
|
||||
---------------
|
||||
|
||||
To retrieve a previous version of an article, click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`)
|
||||
icon and select :guilabel:`Open Version History`. Select a version and click :guilabel:`Restore
|
||||
history`.
|
||||
|
||||
.. note::
|
||||
In the version history, the :guilabel:`Content` tab shows the selected version, while the
|
||||
:guilabel:`Comparison` tab displays the differences between the article's previous and current
|
||||
versions.
|
||||
|
Before Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 7.5 KiB |
|
Before Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 5.0 KiB |
@@ -1,102 +0,0 @@
|
||||
==========
|
||||
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.
|
||||
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 6.3 KiB |
@@ -10,6 +10,8 @@ and managed in one dashboard, each with their own pipeline for tickets submitted
|
||||
Pipelines are organized in customizable stages that enable teams to track, prioritize, and solve
|
||||
customer issues efficiently.
|
||||
|
||||
.. _helpdesk/create-team:
|
||||
|
||||
Create a Helpdesk team
|
||||
======================
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ Once an article has been created and assigned to a **Helpdesk** team, content ca
|
||||
organized through the **Knowledge** app.
|
||||
|
||||
.. seealso::
|
||||
:doc:`Editing Knowledge articles <../../../productivity/knowledge/articles_editing>`
|
||||
:ref:`Editing Knowledge articles <knowledge/articles_editing/edit-article>`
|
||||
|
||||
Search articles from a Helpdesk ticket
|
||||
--------------------------------------
|
||||
@@ -143,8 +143,8 @@ Add clipboard boxes to articles
|
||||
To create a clipboard box, go to :menuselection:`Knowledge app --> Help`. Click on an existing
|
||||
nested article or create a new one by clicking the |plus| next to *Help*.
|
||||
|
||||
Type :kbd:`/` to open the *powerbox*, and view a drop-down list of :doc:`commands
|
||||
<../../../productivity/knowledge/articles_editing>`. Select or type :kbd:`clipboard`. A gray block
|
||||
Type :kbd:`/` to open the *powerbox*, and view a drop-down list of :ref:`commands
|
||||
<knowledge/articles_editing/commands>`. Select or type :kbd:`clipboard`. A gray block
|
||||
is then added to the page. Add any necessary content to this block.
|
||||
|
||||
.. image:: help_center/help-center-knowledge-clipboard-options.png
|
||||
|
||||
@@ -54,7 +54,7 @@ Planning includes the possibility of adding property fields linked to roles to s
|
||||
To create a property field, switch to the list view from any schedule. From there, click
|
||||
:guilabel:`View` on the shift that you wish to edit. If the :guilabel:`Role` field is empty, fill it
|
||||
in with the desired role, then click the cog icon and select :guilabel:`Add Properties`.
|
||||
:doc:`Configure <../productivity/knowledge/properties>` the new field according to your needs.
|
||||
:doc:`Configure </applications/essentials/property_fields>` the new field according to your needs.
|
||||
|
||||
.. image:: planning/add-properties.png
|
||||
:alt: Creating a new property field in Planning.
|
||||
|
||||
@@ -15,6 +15,11 @@ content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet.r
|
||||
|
||||
applications/inventory_and_mrp/purchase/products/uom.rst applications/inventory_and_mrp/inventory/product_management/configure/uom.rst
|
||||
|
||||
# applications/productivity/knowledge
|
||||
|
||||
applications/productivity/knowledge/articles_editing.rst applications/productivity/knowledge.rst
|
||||
applications/productivity/knowledge/management.rst applications/productivity/knowledge.rst
|
||||
|
||||
# applications/sales
|
||||
|
||||
applications/sales/sales/send_quotations.rst applications/sales/sales/sales_quotations.rst # sales/send_quotations --> sales/sales_quotations
|
||||
|
||||