|
| 1 | +.. _text-editor: |
| 2 | + |
| 3 | +===================== |
| 4 | +Odoo rich-text editor |
| 5 | +===================== |
| 6 | + |
| 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 :doc:`Knowledge |
| 9 | +articles </applications/productivity/knowledge/articles_editing>` 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. |
| 13 | + |
| 14 | +.. tip:: |
| 15 | + Hover over any element in the text (header, table, clipboard, etc.) to reveal the |
| 16 | + :icon:`fa-sort` :guilabel:`(drag)` icon. Click and hold the icon to drag and drop the element |
| 17 | + elsewhere in the text. |
| 18 | + |
| 19 | +.. _essentials/html_editor/toolbar: |
| 20 | + |
| 21 | +Text editor toolbar |
| 22 | +=================== |
| 23 | + |
| 24 | +To 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: |
| 26 | + |
| 27 | +- **Font style**: Change the style using various options, such as :guilabel:`Header 1 to 6, |
| 28 | + 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: |
| 35 | + |
| 36 | + - :guilabel:`Solid`: Select the preferred color from the predefined palette. |
| 37 | + - :guilabel:`Custom`: Customize the color palette using the wheel or by configuring the |
| 38 | + :guilabel:`hex` code and :guilabel:`RGBA` values. |
| 39 | + - :guilabel:`Gradient`: Select a predefined gradient or customize it by choosing |
| 40 | + between :guilabel:`Linear` or :guilabel:`Radial` and adjusting the wheel. |
| 41 | + |
| 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`. |
| 53 | + |
| 54 | +.. image:: text_editor/style-and-colors.png |
| 55 | + :alt: Text editor's toolbox |
| 56 | + |
| 57 | + |
| 58 | +.. 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. |
| 64 | + |
| 65 | +.. _essentials/html_editor/commands: |
| 66 | + |
| 67 | +Powerbox commands |
| 68 | +================= |
| 69 | + |
| 70 | +To use a command, type `/` to open the powerbox, then enter the command's name or select from |
| 71 | +multiple features to insert tables, images, banners, etc. |
| 72 | + |
| 73 | +.. tip:: |
| 74 | + Starting a new paragraph displays a tooltip with command shortcut icons. Click an icon to add |
| 75 | + the command, or click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon to open the |
| 76 | + powerbox for all commands. |
| 77 | + |
| 78 | +.. note:: |
| 79 | + Commands specific to particular apps are excluded from this description. |
| 80 | + |
| 81 | +.. tabs:: |
| 82 | + .. tab:: Structure |
| 83 | + |
| 84 | + .. list-table:: |
| 85 | + :widths: 20 80 |
| 86 | + :header-rows: 1 |
| 87 | + :stub-columns: 1 |
| 88 | + |
| 89 | + * - Command |
| 90 | + - Use |
| 91 | + * - :guilabel:`Separator` |
| 92 | + - Insert a horizontal rule separator. |
| 93 | + * - :guilabel:`2 columns` |
| 94 | + - Convert into 2 columns. |
| 95 | + * - :guilabel:`3 columns` |
| 96 | + - Convert into 3 columns. |
| 97 | + * - :guilabel:`4 columns` |
| 98 | + - Convert into 4 columns. |
| 99 | + * - :guilabel:`Table` |
| 100 | + - Insert a table. |
| 101 | + * - :guilabel:`Bulleted list` |
| 102 | + - Create a bulleted list. |
| 103 | + * - :guilabel:`Numbered list` |
| 104 | + - Create a numbered list. |
| 105 | + * - :guilabel:`Checklist` |
| 106 | + - Create a checklist. |
| 107 | + * - :guilabel:`Quote` |
| 108 | + - Add a blockquote section. |
| 109 | + * - :guilabel:`Code` |
| 110 | + - Add a code section. |
| 111 | + |
| 112 | + .. note:: |
| 113 | + To organize a table, hover over a column or row to reveal the table menu. Click the |
| 114 | + :icon:`fa-ellipsis-h` :guilabel:`(ellipsis)` icon to move, insert, or delete a column or |
| 115 | + row. |
| 116 | + |
| 117 | + .. tab:: Banner |
| 118 | + |
| 119 | + .. list-table:: |
| 120 | + :widths: 20 80 |
| 121 | + :header-rows: 1 |
| 122 | + :stub-columns: 1 |
| 123 | + |
| 124 | + * - Command |
| 125 | + - Use |
| 126 | + * - :guilabel:`Banner Info` |
| 127 | + - Insert an info banner. |
| 128 | + * - :guilabel:`Banner Success` |
| 129 | + - Insert a success banner. |
| 130 | + * - :guilabel:`Banner Warning` |
| 131 | + - Insert a warning banner. |
| 132 | + * - :guilabel:`Banner Danger` |
| 133 | + - Insert a danger banner. |
| 134 | + |
| 135 | + .. tab:: Format |
| 136 | + |
| 137 | + .. list-table:: |
| 138 | + :widths: 20 80 |
| 139 | + :header-rows: 1 |
| 140 | + :stub-columns: 1 |
| 141 | + |
| 142 | + * - Command |
| 143 | + - Use |
| 144 | + * - :guilabel:`Heading 1` |
| 145 | + - Big section heading. |
| 146 | + * - :guilabel:`Heading 2` |
| 147 | + - Medium section heading. |
| 148 | + * - :guilabel:`Heading 3` |
| 149 | + - Small section heading. |
| 150 | + * - :guilabel:`Text` |
| 151 | + - Paragraph block: Insert a paragraph. |
| 152 | + * - :guilabel:`Switch direction` |
| 153 | + - Switch the text's direction. |
| 154 | + |
| 155 | + .. tab:: Media |
| 156 | + |
| 157 | + .. list-table:: |
| 158 | + :widths: 20 80 |
| 159 | + :header-rows: 1 |
| 160 | + :stub-columns: 1 |
| 161 | + |
| 162 | + * - Command |
| 163 | + - Use |
| 164 | + * - :guilabel:`Media` |
| 165 | + - :ref:`Insert an image <insert-media>` or icon: :doc:`Search the Unsplash database |
| 166 | + </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` |
| 170 | + - Add a download box: share images, recordings, or documents that internal users can |
| 171 | + download. |
| 172 | + |
| 173 | + .. tab:: Navigation |
| 174 | + |
| 175 | + .. list-table:: |
| 176 | + :widths: 20 80 |
| 177 | + :header-rows: 1 |
| 178 | + :stub-columns: 1 |
| 179 | + |
| 180 | + * - Command |
| 181 | + - Use |
| 182 | + * - :guilabel:`Link` |
| 183 | + - Add a link: Type the label and enter a URL or upload a file, then click |
| 184 | + :guilabel:`Apply`. |
| 185 | + * - :guilabel:`Button` |
| 186 | + - Add a button: Type the label, enter a URL or upload a file, select the button style, |
| 187 | + 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` |
| 194 | + - 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). |
| 197 | + |
| 198 | + .. tab:: Widget |
| 199 | + |
| 200 | + .. list-table:: |
| 201 | + :widths: 20 80 |
| 202 | + :header-rows: 1 |
| 203 | + :stub-columns: 1 |
| 204 | + |
| 205 | + * - Command |
| 206 | + - Use |
| 207 | + * - :guilabel:`Emoji` |
| 208 | + - Add an emoji: search for the desired emoji. |
| 209 | + * - :guilabel:`3 Stars` |
| 210 | + - Insert a rating of up to 3 stars. |
| 211 | + * - :guilabel:`5 Stars` |
| 212 | + - Insert a rating of up to 5 stars. |
| 213 | + |
| 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 | + |
| 238 | +.. _insert-media: |
| 239 | + |
| 240 | +Insert media |
| 241 | +------------ |
| 242 | + |
| 243 | +To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(image)` icon in the |
| 244 | +tooltip, then choose from the following tabs: |
| 245 | + |
| 246 | +- :guilabel:`Images` |
| 247 | + |
| 248 | + - Search the :doc:`Unsplash </applications/general/integrations/unsplash>` database to find a |
| 249 | + suitable image. |
| 250 | + - :guilabel:`Add URL`: Copy-paste the **image address**. |
| 251 | + - :guilabel:`Upload an image`: Upload an image into the library. |
| 252 | + |
| 253 | +- :guilabel:`Documents` |
| 254 | + |
| 255 | + - Search for a document in the database. |
| 256 | + - :guilabel:`Add URL`: Copy-paste a valid URL. |
| 257 | + - :guilabel:`Upload a document`: Upload a document from a local drive. |
| 258 | + |
| 259 | +- :guilabel:`Icons`: Search an icon from the selection in the database. |
| 260 | + |
| 261 | +Media editor toolbar |
| 262 | +~~~~~~~~~~~~~~~~~~~~ |
| 263 | + |
| 264 | +After :ref:`inserting an image <insert-media>`, click it to display the media editor toolbar, and |
| 265 | +apply any of the following formatting options: |
| 266 | + |
| 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. |
| 281 | +- :icon:`fa-object-ungroup` (:guilabel:`object`): Resize and rotate the image. Click the |
| 282 | + :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: |
| 284 | + |
| 285 | + - Choose from the `Flexible`, `16:9`, `4:3`, `1:1`, or `2:3` aspect ratios. |
| 286 | + - Zoom in or out. |
| 287 | + - Rotate left or right. |
| 288 | + - Flip horizontally or vertically. |
| 289 | + - Reset the image. |
| 290 | + |
| 291 | +- :guilabel:`Replace`: Replace the image by searching in the :doc:`Unsplash |
| 292 | + </applications/general/integrations/unsplash>` database, adding a URL, or uploading a different |
| 293 | + 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. |
0 commit comments