mirror of
https://github.com/odoo/documentation.git
synced 2026-01-04 10:46:04 +07:00
[IMP] productivity/knowledge: Articles editing updated
task-4444310
closes odoo/documentation#12417
X-original-commit: 8b3c17613c
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
This commit is contained in:
emmi-odoo
@@ -7,6 +7,7 @@ Odoo essentials
|
||||
essentials/activities
|
||||
essentials/reporting
|
||||
essentials/search
|
||||
essentials/html_editor
|
||||
essentials/contacts
|
||||
essentials/export_import_data
|
||||
essentials/in_app_purchase
|
||||
|
||||
296
content/applications/essentials/html_editor.rst
Normal file
296
content/applications/essentials/html_editor.rst
Normal file
@@ -0,0 +1,296 @@
|
||||
.. _text-editor:
|
||||
|
||||
=====================
|
||||
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
|
||||
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.
|
||||
|
||||
.. tip::
|
||||
Hover over any element in the text (header, table, clipboard, etc.) to reveal the
|
||||
:icon:`fa-sort` :guilabel:`(drag)` icon. Click and hold the icon to drag and drop the element
|
||||
elsewhere in the text.
|
||||
|
||||
.. _essentials/html_editor/toolbar:
|
||||
|
||||
Text editor toolbar
|
||||
===================
|
||||
|
||||
To edit a word, sentence, or paragraph, select or double-click it to display the text editor
|
||||
toolbar and apply any of the following formatting options:
|
||||
|
||||
- **Font style**: Change the style using various options, such as :guilabel:`Header 1 to 6,
|
||||
Normal, Paragraph, Code`, and :guilabel:`Quote`.
|
||||
- :guilabel:`B`: Put the text in bold.
|
||||
- :guilabel:`I`: Put the text in italics.
|
||||
- :guilabel:`U`: Underline the text.
|
||||
- :guilabel:`S`: Strike through the text.
|
||||
- :guilabel:`A` and :icon:`fa-paint-brush` :guilabel:`(paintbrush)` to customize the font and
|
||||
background colors, respectively:
|
||||
|
||||
- :guilabel:`Solid`: Select the preferred color from the predefined palette.
|
||||
- :guilabel:`Custom`: Customize the color palette using the wheel or by configuring the
|
||||
:guilabel:`hex` code and :guilabel:`RGBA` values.
|
||||
- :guilabel:`Gradient`: Select a predefined gradient or customize it by choosing
|
||||
between :guilabel:`Linear` or :guilabel:`Radial` and adjusting the wheel.
|
||||
|
||||
- **Font size**: Adjust the size of the text.
|
||||
- :icon:`fa-list-ul` (:guilabel:`bulleted list`): Turn the text into a bulleted list.
|
||||
- :icon:`fa-list-ol` (:guilabel:`numbered list`): Turn the text into a numbered list.
|
||||
- :icon:`fa-check-square-o` (:guilabel:`checklist`): Turn the text into a checklist.
|
||||
- :icon:`fa-link` (:guilabel:`link`): Insert or edit a URL link to a selected text, and optionally
|
||||
upload an image using its file URL.
|
||||
- :guilabel:`Translate`: Translate the content in the :doc:`installed languages
|
||||
</applications/general/users/language>`.
|
||||
- :icon:`fa-magic` :guilabel:`AI` (:guilabel:`ChatGPT`): Get AI-generated suggestions and adjust
|
||||
the tone by clicking buttons such as :guilabel:`Correct, Shorten, Lengthen, Friendly,
|
||||
Professional`, and :guilabel:`Persuasive`.
|
||||
|
||||
.. image:: text_editor/style-and-colors.png
|
||||
:alt: Text editor's toolbox
|
||||
|
||||
|
||||
.. tip::
|
||||
Use the following keyboard shortcuts to apply formatting:
|
||||
- **Emphasis**: Press `CTRL`/`CMD` + `B`, `CTRL`/`CMD` + `I`, or `CTRL`/`CMD` + `U` to apply
|
||||
the bold, italics, or underlined effect.
|
||||
- **Numbered list**: Type `1.`, `1)`, `A.`, or `A)` to start a numbered list.
|
||||
- **Bulleted list**: Type `*` or `-` to start a bulleted list.
|
||||
|
||||
.. _essentials/html_editor/commands:
|
||||
|
||||
Powerbox commands
|
||||
=================
|
||||
|
||||
To use a command, type `/` to open the powerbox, then enter the command's name or select from
|
||||
multiple features to insert tables, images, banners, etc.
|
||||
|
||||
.. tip::
|
||||
Starting a new paragraph displays a tooltip with command shortcut icons. Click an icon to add
|
||||
the command, or click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon to open the
|
||||
powerbox for all commands.
|
||||
|
||||
.. note::
|
||||
Commands specific to particular apps are excluded from this description.
|
||||
|
||||
.. 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 numbered list.
|
||||
* - :guilabel:`Checklist`
|
||||
- Create a checklist.
|
||||
* - :guilabel:`Quote`
|
||||
- Add a blockquote section.
|
||||
* - :guilabel:`Code`
|
||||
- Add a code section.
|
||||
|
||||
.. note::
|
||||
To organize a table, hover over a column or row to reveal the table menu. Click the
|
||||
:icon:`fa-ellipsis-h` :guilabel:`(ellipsis)` icon to move, insert, or delete a column or
|
||||
row.
|
||||
|
||||
.. 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:: 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: Insert a paragraph.
|
||||
* - :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`
|
||||
- :ref:`Insert an image <insert-media>` or icon: :doc:`Search the Unsplash database
|
||||
</applications/general/integrations/unsplash>` or upload images, documents, or icons.
|
||||
* - :guilabel:`Clipboard`
|
||||
- Add a clipboard section to store content and reuse it in other apps.
|
||||
* - :guilabel:`Upload a file`
|
||||
- Add a download box: share images, recordings, or documents that internal users can
|
||||
download.
|
||||
|
||||
.. tab:: Navigation
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`Link`
|
||||
- Add a link: Type the label and enter a URL or upload a file, then click
|
||||
:guilabel:`Apply`.
|
||||
* - :guilabel:`Button`
|
||||
- Add a button: Type the label, enter a URL or upload a file, select the button style,
|
||||
type, and size, then click :guilabel:`Apply`.
|
||||
* - :guilabel:`Article`
|
||||
- Insert a shortcut to a :doc:`Knowledge article </applications/productivity/knowledge>`.
|
||||
* - :guilabel:`Appointment`
|
||||
- Add a specific appointment: Select one or several appointment type(s) to assign to
|
||||
relevant users, then click :guilabel:`Insert a link`.
|
||||
* - :guilabel:`Table Of Content`
|
||||
- Highlight the structure (headings): Create a table of content based on the headings.
|
||||
* - :guilabel:`Video Link`
|
||||
- Insert a video: Copy-paste the video URL (Youtube, Vimeo, Dailymotion, and Youku only).
|
||||
|
||||
.. tab:: Widget
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`Emoji`
|
||||
- Add an emoji: search for the desired emoji.
|
||||
* - :guilabel:`3 Stars`
|
||||
- Insert a rating of up to 3 stars.
|
||||
* - :guilabel:`5 Stars`
|
||||
- Insert a rating of up to 5 stars.
|
||||
|
||||
.. tab:: AI Tools
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`ChatGPT`
|
||||
- Generate content with AI.
|
||||
|
||||
.. tab:: Basic Block
|
||||
|
||||
.. list-table::
|
||||
:widths: 20 80
|
||||
:header-rows: 1
|
||||
:stub-columns: 1
|
||||
|
||||
* - Command
|
||||
- Use
|
||||
* - :guilabel:`Signature`
|
||||
- Insert your signature.
|
||||
|
||||
.. _insert-media:
|
||||
|
||||
Insert media
|
||||
------------
|
||||
|
||||
To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(image)` icon in the
|
||||
tooltip, then choose from the following tabs:
|
||||
|
||||
- :guilabel:`Images`
|
||||
|
||||
- Search the :doc:`Unsplash </applications/general/integrations/unsplash>` database to find a
|
||||
suitable image.
|
||||
- :guilabel:`Add URL`: Copy-paste the **image address**.
|
||||
- :guilabel:`Upload an image`: Upload an image into the library.
|
||||
|
||||
- :guilabel:`Documents`
|
||||
|
||||
- Search for a document in the database.
|
||||
- :guilabel:`Add URL`: Copy-paste a valid URL.
|
||||
- :guilabel:`Upload a document`: Upload a document from a local drive.
|
||||
|
||||
- :guilabel:`Icons`: Search an icon from the selection in the database.
|
||||
|
||||
Media editor toolbar
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
After :ref:`inserting an image <insert-media>`, click it to display the media editor toolbar, and
|
||||
apply any of the following formatting options:
|
||||
|
||||
- :icon:`fa-search-plus` (:guilabel:`preview`): Preview the image, zoom in or out, print it or
|
||||
download it. Exit the preview by clicking the :icon:`fa-times` :guilabel:`(close)` icon in the
|
||||
top right corner.
|
||||
- :guilabel:`Description`: Edit the image description and tooltip, then click :guilabel:`Save`.
|
||||
- :icon:`fa-square` (:guilabel:`rounded`): Apply a rounded shape to the corners of the image.
|
||||
- :icon:`fa-circle-o` (:guilabel:`circle`): Apply a circular shape to the image.
|
||||
- :icon:`fa-sun-o` (:guilabel:`shadow`): Apply a shadow effect to the image.
|
||||
- :icon:`fa-picture-o` (:guilabel:`image`): Apply a border to the image.
|
||||
- :icon:`fa-plus-square-o` (:guilabel:`padding`): Add an image padding and choose from small,
|
||||
medium, large, or extra large sizes.
|
||||
- :guilabel:`Default`: Restore the image to its default size.
|
||||
- :guilabel:`100%`: Set the image to full size.
|
||||
- :guilabel:`50%`: Set the image to half its size.
|
||||
- :guilabel:`25%`: Set the image to a quarter of its size.
|
||||
- :icon:`fa-object-ungroup` (:guilabel:`object`): Resize and rotate the image. Click the
|
||||
:icon:`fa-object-ungroup` :guilabel:`(object)` icon a second time to reset the transformation.
|
||||
- :icon:`fa-crop` (:guilabel:`crop`): Crop the image manually or apply the following options:
|
||||
|
||||
- Choose from the `Flexible`, `16:9`, `4:3`, `1:1`, or `2:3` aspect ratios.
|
||||
- Zoom in or out.
|
||||
- Rotate left or right.
|
||||
- Flip horizontally or vertically.
|
||||
- Reset the image.
|
||||
|
||||
- :guilabel:`Replace`: Replace the image by searching in the :doc:`Unsplash
|
||||
</applications/general/integrations/unsplash>` database, adding a URL, or uploading a different
|
||||
one.
|
||||
- :icon:`fa-link` (:guilabel:`link`): Insert a link to the image, type the URL, then click
|
||||
:guilabel:`Apply`. To remove the link, click the :icon:`fa-chain-broken` :guilabel:`(unlink)` icon.
|
||||
- :icon:`fa-trash` (:guilabel:`trash`): Remove the image.
|
||||
BIN
content/applications/essentials/text_editor/style-and-colors.png
Normal file
BIN
content/applications/essentials/text_editor/style-and-colors.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
@@ -1,262 +1,139 @@
|
||||
================
|
||||
Articles editing
|
||||
============================
|
||||
Article creation and editing
|
||||
============================
|
||||
|
||||
Article creation
|
||||
================
|
||||
|
||||
Add and style content
|
||||
=====================
|
||||
Knowledge articles can be created from scratch or from a preconfigured template.
|
||||
|
||||
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.
|
||||
From scratch
|
||||
------------
|
||||
|
||||
.. image:: articles_editing/ui.png
|
||||
:align: center
|
||||
:alt: knowledge's user interface
|
||||
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::
|
||||
Click :guilabel:`Untitled` on the left side of the top bar to automatically match your h1
|
||||
:dfn:`(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.
|
||||
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.
|
||||
|
||||
.. _knowledge/text-editor:
|
||||
From a template
|
||||
---------------
|
||||
|
||||
Text editor
|
||||
-----------
|
||||
To create an article from a template, follow these steps:
|
||||
|
||||
To stylize the text using the text editor, select the text to format.
|
||||
#. Click :icon:`fa-paint-brush` :guilabel:`Browse Templates` at the bottom of the sidebar tree.
|
||||
#. Select a preferred template.
|
||||
#. Click :guilabel:`Load Template`.
|
||||
|
||||
Then, you can:
|
||||
Article editing
|
||||
===============
|
||||
|
||||
- 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 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>`.
|
||||
|
||||
- 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.
|
||||
.. _knowledge/articles_editing/text-editor:
|
||||
|
||||
- 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.
|
||||
Text editor toolbar
|
||||
-------------------
|
||||
|
||||
.. image:: articles_editing/style-and-colors.png
|
||||
:align: center
|
||||
:alt: Text editor's toolbox
|
||||
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>`.
|
||||
|
||||
To format a whole paragraph, type `/` anywhere in the text. Doing so opens the **powerbox**, which
|
||||
allows:
|
||||
.. tip::
|
||||
Click :icon:`fa-commenting` :guilabel:`Comment` to add a comment to the selected text.
|
||||
|
||||
- Changing a paragraph into lists (unordered, ordered, checklists).
|
||||
- Changing a paragraph into a header (1 → 6), normal text, `code`, or *quotes*.
|
||||
.. _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
|
||||
--------------
|
||||
|
||||
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.
|
||||
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:
|
||||
|
||||
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.
|
||||
- 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.
|
||||
|
||||
Retrieve images from different sources:
|
||||
To manage the cover picture, hover the mouse over it and select the preferred option:
|
||||
|
||||
- Search the **Unsplash** database.
|
||||
- Enter a picture's **URL**.
|
||||
- **Upload** an image from a computer.
|
||||
- :guilabel:`Replace Cover` and search from the database or library, or add a different URL.
|
||||
|
||||
To remove the cover, hover over it to make the buttons appear and click :guilabel:`Remove Cover`.
|
||||
- :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.
|
||||
|
||||
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::
|
||||
- To associate Unsplash with your database, please refer to
|
||||
:doc:`/applications/general/integrations/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.
|
||||
Once the view or link is inserted:
|
||||
|
||||
Icons
|
||||
-----
|
||||
|
||||
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.
|
||||
|
||||
.. _knowledge/powerbox:
|
||||
|
||||
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 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::
|
||||
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.
|
||||
- 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.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 20 KiB |
@@ -205,6 +205,8 @@ to:
|
||||
version.
|
||||
- :guilabel:`Print preview`: to generate and download a report preview.
|
||||
|
||||
.. _studio/pdf-reports/report-editor:
|
||||
|
||||
Report editor
|
||||
-------------
|
||||
|
||||
@@ -252,8 +254,8 @@ There are two types of text content in reports:
|
||||
the quotation date.
|
||||
|
||||
You can add content (e.g., fields, lists, tables, images, banners, etc.) to the report using
|
||||
commands. Type `/` to open the :ref:`powerbox <knowledge/powerbox>`, then type the command's
|
||||
name or select it from the list.
|
||||
commands. Type `/` to open the :ref:`powerbox <essentials/html_editor/commands>`, then type the
|
||||
command's name or select it from the list.
|
||||
|
||||
To add static text to the report, type the text where you want it.
|
||||
|
||||
@@ -354,7 +356,7 @@ Formatting
|
||||
**********
|
||||
|
||||
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/html_editor>`.
|
||||
|
||||
.. image:: pdf_reports/text-editor.png
|
||||
:alt: Format text using the text editor.
|
||||
|
||||
Reference in New Issue
Block a user