44Odoo rich-text editor
55=====================
66
7- The Odoo rich-text editor allows creating and editing rich-text content in HTML fields, such as the
8- :guilabel: `Internal Notes ` and :guilabel: `Description ` fields, as well as in the :ref: `Knowledge
9- articles <knowledge/articles_editing/edit-article>` and the :ref: `Studio report
10- editor <studio/pdf-reports/report-editor>`, among others. Start typing or use the
11- :ref: ` toolbar <essentials/html_editor/toolbar >` or :ref: `powerbox
12- <essentials/html_editor/commands>` for formatting and structuring text.
7+ The Odoo rich-text editor allows for creating and editing rich-text content in HTML fields, such as
8+ the :guilabel: `Internal Notes ` and :guilabel: `Description ` fields, as well as in the :ref: `Knowledge
9+ articles <knowledge/articles_editing/edit-article>` and the :ref: `Studio report editor
10+ <studio/pdf-reports/report-editor>`, among others. Start typing or use the :ref: ` toolbar
11+ <essentials/html_editor/toolbar>` or :ref: `powerbox < essentials/html_editor/commands >` for
12+ formatting and structuring text.
1313
1414.. tip ::
1515 Hover over any element in the text (header, table, clipboard, etc.) to reveal the
@@ -22,51 +22,75 @@ Text editor toolbar
2222===================
2323
2424To edit a word, sentence, or paragraph, select or double-click it to display the text editor
25- toolbar and apply any of the following formatting options:
25+ toolbar and apply any of the following standard formatting options:
2626
27- - **Font style **: Change the style using various options, such as :guilabel: `Header 1 to 6,
27+ - **Font style **: Define the font style using various options, such as :guilabel: `Header 1 to 6,
2828 Normal, Paragraph, Code `, and :guilabel: `Quote `.
29- - :guilabel: `B `: Put the text in bold.
30- - :guilabel: `I `: Put the text in italics.
31- - :guilabel: `U `: Underline the text.
32- - :guilabel: `S `: Strike through the text.
33- - :guilabel: `A ` and :icon: `fa-paint-brush ` :guilabel: `(paintbrush) ` to customize the font and
34- background colors, respectively:
29+ - **Font size **: Select the preferred font size.
30+ - :icon: `fa-bold ` (:guilabel: `Toggle bold `): Put the text in bold.
31+ - :icon: `fa-italic ` (:guilabel: `Toggle italic `): Put the text in italics.
32+ - :icon: `fa-underline ` (:guilabel: `Toggle underline `): Underline the text.
33+ - :icon: `fa-font ` (:guilabel: `Apply Font Color `): Customize the font colors:
3534
3635 - :guilabel: `Solid `: Select the preferred color from the predefined palette.
3736 - :guilabel: `Custom `: Customize the color palette using the wheel or by configuring the
3837 :guilabel: `hex ` code and :guilabel: `RGBA ` values.
3938 - :guilabel: `Gradient `: Select a predefined gradient or customize it by choosing
4039 between :guilabel: `Linear ` or :guilabel: `Radial ` and adjusting the wheel.
40+ - :icon: `fa-trash ` (:guilabel: `Reset `): Restore the original font/background color.
4141
42- - **Font size **: Adjust the size of the text.
43- - :icon: `fa-list-ul ` (:guilabel: `bulleted list `): Turn the text into a bulleted list.
44- - :icon: `fa-list-ol ` (:guilabel: `numbered list `): Turn the text into a numbered list.
45- - :icon: `fa-check-square-o ` (:guilabel: `checklist `): Turn the text into a checklist.
46- - :icon: `fa-link ` (:guilabel: `link `): Insert or edit a URL link to a selected text, and optionally
47- upload an image using its file URL.
48- - :guilabel: `Translate `: Translate the content in the :doc: `installed languages
49- </applications/general/users/language>`.
50- - :icon: `fa-magic ` :guilabel: `AI ` (:guilabel: `ChatGPT `): Get AI-generated suggestions and adjust
51- the tone by clicking buttons such as :guilabel: `Correct, Shorten, Lengthen, Friendly,
52- Professional `, and :guilabel: `Persuasive `.
42+ - :icon: `fa-link ` (:guilabel: `Add a link `): Insert or edit a URL link to a selected text, and
43+ optionally upload an image using its file URL.
44+ - :guilabel: `Odoo AI `: Write a prompt and get AI-generated content. Optionally, click the
45+ AI suggestions instead of writing a prompt.
46+
47+ Click the :icon: `fa-ellipsis-v ` (:guilabel: `Expand toolbar `) icon to display additional formatting
48+ options:
49+
50+ - **Font family **: Use the :guilabel: `Default system font ` or select a preferred font family for
51+ the text.
52+ - :icon: `fa-strikethrough ` (:guilabel: `Toggle strikethrough `): Strike through the text.
53+ - :icon: `fa-paint-brush ` :guilabel: `(Apply Background Color) `: Customize the background colors.
54+ - :icon: `fa-eraser ` (:guilabel: `Remove Format `): Remove all formatting applied to a selected text.
55+ - :icon: `fa-list-ul ` (:guilabel: `Toggle List `): Select the following list options:
56+
57+ - :icon: `fa-list-ul ` (:guilabel: `Bulleted list `): Turn the text into a bulleted list.
58+ - :icon: `fa-list-ol ` (:guilabel: `Numbered list `): Turn the text into a numbered list.
59+ - :icon: `fa-check-square-o ` (:guilabel: `Checklist `): Turn the text into a checklist.
60+
61+ - :icon: `fa-align-left ` (:guilabel: `Align text `): Select the following text alignments:
62+
63+ - :icon: `fa-align-left ` (:guilabel: `align left `): Align the text on the left.
64+ - :icon: `fa-align-center ` (:guilabel: `align center `): Align the text in the center.
65+ - :icon: `fa-align-right ` (:guilabel: `align right `): Align the text on the right.
66+ - :icon: `fa-align-justify ` (:guilabel: `justify `): Apply straight edges to both text margins.
67+
68+ - :guilabel: `Translate with AI `: Translate the content in the :doc: `installed languages
69+ </applications/general/users/language>` with AI.
5370
5471.. image :: html_editor/style-and-colors.png
5572 :alt: Text editor's toolbox
5673
57-
5874.. tip ::
59- Use the following keyboard shortcuts to apply formatting:
60- - **Emphasis **: Press `CTRL `/`CMD ` + `B `, `CTRL `/`CMD ` + `I `, or `CTRL `/`CMD ` + `U ` to apply
61- the bold, italics, or underlined effect.
62- - **Numbered list **: Type `1. `, `1) `, `A. `, or `A) ` to start a numbered list.
63- - **Bulleted list **: Type `* ` or `- ` to start a bulleted list.
75+ - Use the following keyboard shortcuts to apply formatting:
76+
77+ - **Emphasis **: Press `CTRL `/`CMD ` + `B `, `CTRL `/`CMD ` + `I `, or `CTRL `/`CMD ` + `U ` to apply
78+ the bold, italics, or underlined effect.
79+ - **Numbered list **: Type `1. `, `1) `, `A. `, or `A) ` to start a numbered list.
80+ - **Bulleted list **: Type `* ` or `- ` to start a bulleted list.
81+
82+ - Click a hyperlinked text and perform one of the following actions: :icon: `fa-clipboard `
83+ (:guilabel: `Copy Link `), :icon: `fa-pencil-square-o ` (:guilabel: `Edit Link `), or
84+ :icon: `fa-chain-broken ` (:guilabel: `Remove Link `).
6485
6586.. _essentials/html_editor/commands :
6687
6788Powerbox commands
6889=================
6990
91+ Commands enable editing and managing various types of features within the text editor, such as
92+ tables, banners, headers, and more.
93+
7094To use a command, type `/ ` to open the powerbox, then enter the command's name or select from
7195multiple features to insert tables, images, banners, etc.
7296
@@ -88,26 +112,24 @@ multiple features to insert tables, images, banners, etc.
88112
89113 * - Command
90114 - Use
91- * - :guilabel: `Separator `
115+ * - :icon: ` fa-minus ` : guilabel: `Separator `
92116 - Insert a horizontal rule separator.
93- * - :guilabel: `2 columns `
117+ * - :icon: ` fa-columns ` : guilabel: `2 columns `
94118 - Convert into 2 columns.
95- * - :guilabel: `3 columns `
119+ * - :icon: ` fa-columns ` : guilabel: `3 columns `
96120 - Convert into 3 columns.
97- * - :guilabel: `4 columns `
121+ * - :icon: ` fa-columns ` : guilabel: `4 columns `
98122 - Convert into 4 columns.
99- * - :guilabel: `Table `
123+ * - :icon: ` fa-table ` : guilabel: `Table `
100124 - Insert a table.
101- * - :guilabel: `Bulleted list `
125+ * - :icon: ` fa-list-ul ` : guilabel: `Bulleted list `
102126 - Create a bulleted list.
103- * - :guilabel: `Numbered list `
127+ * - :icon: ` fa-list-ol ` : guilabel: `Numbered list `
104128 - Create a numbered list.
105- * - :guilabel: `Checklist `
129+ * - :icon: ` fa-check-square-o ` : guilabel: `Checklist `
106130 - Create a checklist.
107- * - :guilabel: `Quote `
108- - Add a blockquote section.
109- * - :guilabel: `Code `
110- - Add a code section.
131+ * - :icon: `fa-caret-square-o-right ` :guilabel: `Toggle list `
132+ - Hide a group of text under a foldable toggle.
111133
112134 .. note ::
113135 To organize a table, hover over a column or row to reveal the table menu. Click the
@@ -117,40 +139,44 @@ multiple features to insert tables, images, banners, etc.
117139 .. tab :: Banner
118140
119141 .. list-table ::
120- :widths: 20 80
142+ :widths: 30 70
121143 :header-rows: 1
122144 :stub-columns: 1
123145
124146 * - Command
125147 - Use
126- * - :guilabel: `Banner Info `
148+ * - :icon: ` fa-info-circle ` : guilabel: `Banner Info `
127149 - Insert an info banner.
128- * - :guilabel: `Banner Success `
150+ * - :icon: ` fa-check-circle ` : guilabel: `Banner Success `
129151 - Insert a success banner.
130- * - :guilabel: `Banner Warning `
152+ * - :icon: ` fa-exclamation-triangle ` : guilabel: `Banner Warning `
131153 - Insert a warning banner.
132- * - :guilabel: `Banner Danger `
154+ * - :icon: ` fa-exclamation-circle ` : guilabel: `Banner Danger `
133155 - Insert a danger banner.
134156
135157 .. tab :: Format
136158
137159 .. list-table ::
138- :widths: 20 80
160+ :widths: 30 70
139161 :header-rows: 1
140162 :stub-columns: 1
141163
142164 * - Command
143165 - Use
144- * - :guilabel: `Heading 1 `
166+ * - :icon: ` fa-header ` : guilabel: `Heading 1 `
145167 - Big section heading.
146- * - :guilabel: `Heading 2 `
168+ * - :icon: ` fa-header ` : guilabel: `Heading 2 `
147169 - Medium section heading.
148- * - :guilabel: `Heading 3 `
170+ * - :icon: ` fa-header ` : guilabel: `Heading 3 `
149171 - Small section heading.
150- * - :guilabel: `Text `
172+ * - :icon: ` fa-paragraph ` : guilabel: `Text `
151173 - Paragraph block: Insert a paragraph.
152- * - :guilabel: `Switch direction `
174+ * - :icon: ` fa-exchange ` : guilabel: `Switch direction `
153175 - Switch the text's direction.
176+ * - :icon: `fa-quote-right ` :guilabel: `Quote `
177+ - Add a blockquote section.
178+ * - :icon: `fa-code ` :guilabel: `Code `
179+ - Add a code section.
154180
155181 .. tab :: Media
156182
@@ -161,39 +187,30 @@ multiple features to insert tables, images, banners, etc.
161187
162188 * - Command
163189 - Use
164- * - :guilabel: `Media `
190+ * - :icon: ` fa-file-image-o ` : guilabel: `Media `
165191 - :ref: `Insert an image <insert-media >` or icon: :doc: `Search the Unsplash database
166192 </applications/general/integrations/unsplash>` or upload images, documents, or icons.
167- * - :guilabel: `Clipboard `
168- - Add a clipboard section to store content and reuse it in other apps.
169- * - :guilabel: `Upload a file `
193+ * - :icon: `fa-upload ` :guilabel: `Upload a file `
170194 - Add a download box: share images, recordings, or documents that internal users can
171195 download.
172196
173197 .. tab :: Navigation
174198
175199 .. list-table ::
176- :widths: 20 80
200+ :widths: 30 70
177201 :header-rows: 1
178202 :stub-columns: 1
179203
180204 * - Command
181205 - Use
182- * - :guilabel: `Link `
206+ * - :icon: ` fa-link ` : guilabel: `Link `
183207 - Add a link: Type the label and enter a URL or upload a file, then click
184208 :guilabel: `Apply `.
185- * - :guilabel: `Button `
209+ * - :icon: ` fa-link ` : guilabel: `Button `
186210 - Add a button: Type the label, enter a URL or upload a file, select the button style,
187211 type, and size, then click :guilabel: `Apply `.
188- * - :guilabel: `Article `
189- - Insert a shortcut to a :doc: `Knowledge article </applications/productivity/knowledge >`.
190- * - :guilabel: `Appointment `
191- - Add a specific appointment: Select one or several appointment type(s) to assign to
192- relevant users, then click :guilabel: `Insert a link `.
193- * - :guilabel: `Table Of Content `
212+ * - :icon: `fa-bookmark ` :guilabel: `Table Of Contents `
194213 - Highlight the structure (headings): Create a table of content based on the headings.
195- * - :guilabel: `Video Link `
196- - Insert a video: Copy-paste the video URL (Youtube, Vimeo, Dailymotion, and Youku only).
197214
198215 .. tab :: Widget
199216
@@ -204,43 +221,19 @@ multiple features to insert tables, images, banners, etc.
204221
205222 * - Command
206223 - Use
207- * - :guilabel: `Emoji `
224+ * - :icon: ` fa-smile-o ` : guilabel: `Emoji `
208225 - Add an emoji: search for the desired emoji.
209- * - :guilabel: `3 Stars `
226+ * - :icon: ` fa-star-o ` : guilabel: `3 Stars `
210227 - Insert a rating of up to 3 stars.
211- * - :guilabel: `5 Stars `
228+ * - :icon: ` fa-star ` : guilabel: `5 Stars `
212229 - Insert a rating of up to 5 stars.
213230
214- .. tab :: AI Tools
215-
216- .. list-table ::
217- :widths: 20 80
218- :header-rows: 1
219- :stub-columns: 1
220-
221- * - Command
222- - Use
223- * - :guilabel: `ChatGPT `
224- - Generate content with AI.
225-
226- .. tab :: Basic Block
227-
228- .. list-table ::
229- :widths: 20 80
230- :header-rows: 1
231- :stub-columns: 1
232-
233- * - Command
234- - Use
235- * - :guilabel: `Signature `
236- - Insert your signature.
237-
238231.. _insert-media :
239232
240233Insert media
241234------------
242235
243- To insert media, type `/Media ` or click the :icon: `fa-file-image-o ` :guilabel: `(image ) ` icon in the
236+ To insert media, type `/Media ` or click the :icon: `fa-file-image-o ` :guilabel: `(media ) ` icon in the
244237tooltip, then choose from the following tabs:
245238
246239- :guilabel: `Images `
@@ -256,41 +249,58 @@ tooltip, then choose from the following tabs:
256249 - :guilabel: `Add URL `: Copy-paste a valid URL.
257250 - :guilabel: `Upload a document `: Upload a document from a local drive.
258251
259- - :guilabel: `Icons `: Search an icon from the selection in the database.
252+ - :guilabel: `Icons `: Search for and select one of the available icons.
253+ - :guilabel: `Videos `: Paste a video URL of the following sources: YouTube, Vimeo, Dailymotion, and
254+ Youku. Alternatively, type code to embed a video.
255+
256+ .. note ::
257+ When adding a video, use the toggles to enable autoplay or looping, hide player controls or the
258+ fullscreen button, or set a start time.
260259
261260Media editor toolbar
262261~~~~~~~~~~~~~~~~~~~~
263262
264263After :ref: `inserting an image <insert-media >`, click it to display the media editor toolbar, and
265264apply any of the following formatting options:
266265
267- - :icon: `fa-search-plus ` (:guilabel: `preview `): Preview the image, zoom in or out, print it or
268- download it. Exit the preview by clicking the :icon: `fa-times ` :guilabel: `(close) ` icon in the
269- top right corner.
270- - :guilabel: `Description `: Edit the image description and tooltip, then click :guilabel: `Save `.
271- - :icon: `fa-square ` (:guilabel: `rounded `): Apply a rounded shape to the corners of the image.
272- - :icon: `fa-circle-o ` (:guilabel: `circle `): Apply a circular shape to the image.
273- - :icon: `fa-sun-o ` (:guilabel: `shadow `): Apply a shadow effect to the image.
274- - :icon: `fa-picture-o ` (:guilabel: `image `): Apply a border to the image.
275- - :icon: `fa-plus-square-o ` (:guilabel: `padding `): Add an image padding and choose from small,
276- medium, large, or extra large sizes.
277- - :guilabel: `Default `: Restore the image to its default size.
278- - :guilabel: `100% `: Set the image to full size.
279- - :guilabel: `50% `: Set the image to half its size.
280- - :guilabel: `25% `: Set the image to a quarter of its size.
266+ - :icon: `fa-search-plus ` (:guilabel: `Preview image `): Preview the image, zoom in or out, rotate it,
267+ print it, or download it. Exit the preview by clicking the :icon: `fa-times ` :guilabel: `(close) `
268+ icon in the top right corner.
269+ - :guilabel: `Description `: Edit the image description and tooltip, then click :guilabel: `Apply `.
270+ - :guilabel: `Caption `: Write a caption under 100 characters below the image.
271+ - :icon: `fa-square ` (:guilabel: `Rounded `): Apply a rounded shape to the corners of the image.
272+ - :icon: `fa-circle-o ` (:guilabel: `Circle `): Apply a circular shape to the image.
273+ - :icon: `fa-sun-o ` (:guilabel: `Shadow `): Apply a shadow effect to the image.
274+ - :icon: `fa-picture-o ` (:guilabel: `Thumbnail `): Apply a border to the image.
275+ - :icon: `fa-plus-square-o ` (:guilabel: `Padding `): Add an image padding and choose from
276+ :guilabel: `Small `, :guilabel: `Medium `, :guilabel: `Large `, or :guilabel: `XL ` sizes.
277+ - :guilabel: `Resize `: Restore the image to its default size or set its size to :guilabel: `25% `,
278+ :guilabel: `50% `, or :guilabel: `100% `.
281279- :icon: `fa-object-ungroup ` (:guilabel: `object `): Resize and rotate the image. Click the
282280 :icon: `fa-object-ungroup ` :guilabel: `(object) ` icon a second time to reset the transformation.
283- - :icon: `fa-crop ` (:guilabel: `crop `): Crop the image manually or apply the following options:
281+ - :icon: `fa-crop ` (:guilabel: `Crop image `): Crop the image manually or apply the following options:
284282
285283 - Choose from the `Flexible `, `16:9 `, `4:3 `, `1:1 `, or `2:3 ` aspect ratios.
286284 - Zoom in or out.
287285 - Rotate left or right.
288286 - Flip horizontally or vertically.
289287 - Reset the image.
290288
291- - :guilabel: `Replace `: Replace the image by searching in the :doc: `Unsplash
289+ - :icon: `fa-link ` (:guilabel: `Add a link `): Add a link to the image, type the URL, then click
290+ :guilabel: `Apply `. To remove the link, click :icon: `fa-unlink ` (:guilabel: `Remove Link `).
291+ - :icon: `fa-exchange ` (:guilabel: `Replace `): Replace the image by searching in the :doc: `Unsplash
292292 </applications/general/integrations/unsplash>` database, adding a URL, or uploading a different
293293 one.
294- - :icon: `fa-link ` (:guilabel: `link `): Insert a link to the image, type the URL, then click
295- :guilabel: `Apply `. To remove the link, click the :icon: `fa-chain-broken ` :guilabel: `(unlink) ` icon.
296- - :icon: `fa-trash ` (:guilabel: `trash `): Remove the image.
294+ - :icon: `fa-trash ` (:guilabel: `Delete `): Delete the image.
295+
296+ Icon editor toolbar
297+ ~~~~~~~~~~~~~~~~~~~
298+
299+ After :ref: `inserting an icon <insert-media >`, click it to display the icon editor toolbar, and
300+ apply any of the following formatting options:
301+
302+ - :icon: `fa-font ` (:guilabel: `Select Font Color `): Customize the font color.
303+ - :icon: `fa-paint-brush ` (:guilabel: `Select Background Color `): Customize the background color.
304+ - :guilabel: `Resize icon `: From :guilabel: `1x ` to :guilabel: `5x `.
305+ - :icon: `fa-play ` (:guilabel: `Toggle icon spin `): Activate the spin animation.
306+ - :guilabel: `Replace `: Select a different icon.
0 commit comments