[IMP] Knowledge: update Knowledge and HTML editor docs #15079
Conversation
|
|
emmi-odoo
force-pushed
the
19.0-knowledge-homepage-emmi
branch
from
f59012a to
adbc285
Compare
There was a problem hiding this comment.
Great update @emmi-odoo - throughout and well-structured pages :)
Just a few suggestions as usual :)
| - **Font style**: Define the font style using various options, such as :guilabel:`Header 1 to 6, | ||
| Normal, Paragraph, Code`, and :guilabel:`Quote`. | ||
| - **Font family**: Use the :guilabel:`Default system font` or select a preferred font family for | ||
| the text. |
There was a problem hiding this comment.
You need to expand the toolbar first to see that option.
I would either
Present the standard options first
then mention the additional ones
Or mention in the paragraph above that you need to
click the :icon:`oi-ellipsis-v` (:guilabel:`Expand toolbar`) button to access all options.| - :guilabel:`B`: Put the text in bold. | ||
| - :guilabel:`I`: Put the text in italics. | ||
| - :guilabel:`U`: Underline the text. |
There was a problem hiding this comment.
You could add the icons there while you are at it!
B: fa-bold
I: fa-italic
S: fa-underline
A: fa-font
For the colors, you can also mention that you can remove all colors by:
clicking the :icon:`fa-trash` (:guilabel:`Reset`) button.| - :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. |
There was a problem hiding this comment.
I would nest those 3 items under a new item:
Something like, to access the different list options
click the :icon`fa-list-ul` (:guilabel:`Toggle List`) button and select:| - :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:`Add a link`): Insert or edit a URL link to a selected text, and |
There was a problem hiding this comment.
You could add the different alignment options in a similar fashion.
(just adding the icon's labels so you don't have to look ;))
- click fa-align-left and select
- fa-align-left
- fa-align-center
- fa-align-right
- fa-align-justify
| - :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:`Add a link`): Insert or edit a URL link to a selected text, and | ||
| optionally upload an image using its file URL. |
There was a problem hiding this comment.
Maybe add some info about the different types of links? Link, and buttons.
I would definitely mention the link options (fa-gear "Advanced mode")
You can also add that info, as a tip? Not sure what it would look like, given the list is getting long.
remove a link by clicking the :icon:`fa-unlink` (:guilabel:`Remove Link`) button.|
|
||
| .. _essentials/html_editor/commands: | ||
|
|
||
| Powerbox commands |
There was a problem hiding this comment.
An empty line is required on line 61; otherwise, the first line of the tip appears in bold
| - :guilabel:`Upload a document`: Upload a document from a local drive. | ||
|
|
||
| - :guilabel:`Icons`: Search an icon from the selection in the database. | ||
| - :guilabel:`Icons`: Search for an icon in the database selection. |
There was a problem hiding this comment.
| - :guilabel:`Icons`: Search for an icon in the database selection. | |
| - :guilabel:`Icons`: Search and select one of the available icons. |
| - :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-search-plus` (:guilabel:`Preview`): Preview the image, zoom in or out, rotate it, print |
There was a problem hiding this comment.
| - :icon:`fa-search-plus` (:guilabel:`Preview`): Preview the image, zoom in or out, rotate it, print | |
| - :icon:`fa-search-plus` (:guilabel:`Preview image`): Preview the image, zoom in or out, rotate it, print |
If you use the tooltip as the icon's descriptor, it's best to write it as it. Could you check the other descriptors? (Nitpicking, I know, I can't help it :D)
|
|
||
| Default access rights | ||
| ********************* | ||
| General Access |
There was a problem hiding this comment.
| General Access | |
| General access |
| icon, then :guilabel:`Send to Trash`. Alternatively, click and hold the article, then drag it to the | ||
| :guilabel:`Drop here to delete this article` at the bottom left corner. The article is moved to the |
There was a problem hiding this comment.
| icon, then :guilabel:`Send to Trash`. Alternatively, click and hold the article, then drag it to the | |
| :guilabel:`Drop here to delete this article` at the bottom left corner. The article is moved to the | |
| icon, then :guilabel:`Send to Trash`. Alternatively, drag and drop the article under :icon:`fa-trash` | |
| :guilabel:`Drop here to delete this article` at the bottom left corner. The article is moved to the |
task-5173838