Plans supporting the use of WYSIWYG editor
Professional | Business | Enterprise |
---|---|---|
The WYSIWYG (What You See Is What You Get) editor, also known as the HTML editor, is one of three editing options in Document360. It allows users to view content as it will appear on published articles or category pages within the Knowledge base site.
NOTE
You cannot switch from the WYSIWYG editor to the Markdown editor. Once articles are converted from Markdown to WYSIWYG, they cannot be reverted. However, switching from Markdown to WYSIWYG is possible.
WYSIWYG toolbar
The WYSIWYG toolbar offers various options to edit and format your text including the option to insert media files as well. The different toolbar sections and their uses are shown and elaborated below.
1. Heading options
The below heading options are available:
Normal
Heading 2
Heading 3
Heading 4
2. Text formatting
The below text styling options are available:
Bold: To Bold the text
Italic: To Italicize the text
Underline: To Underline the text
Strikethrough: To Strikethrough the textMore text: Provides options to update font size, font family, text color, background color, subscript, superscript, and clear formatting.
3. Paragraph formatting
The below paragraph formatting options are available:
Unordered list: Make a list denoted with the following symbols: •, ○, ◘. Disc and Default symbols are the same.
Ordered list: Make a list denoted with numbering for each item. You can use numbers, alphabets, Roman numerals, and Greek numerals. Default refers to numbers.
More paragraph: To update alignment, line height of paragraphs, indentations, and quote text.
4. Insert options
Insert link: Add a hyperlink from a provided URL or Knowledge base article to the selected text. This is useful for referencing additional information.
Insert codeblock: Add a codeblock to your article, such as a JavaScript snippet.
Insert image: Insert an image from the URL, local storage, or Drive. For example, you can add a screenshot of the user interface. You can also use (Ctrl+p) to perform this action.
Insert file: Add a {{glossary.File}} from the Drive, such as a Word or PDF file.
Insert callouts: Add editable info boxes in blue, yellow, and red for additional, important, and essential information, respectively.
Private notes: Insert an editable internal comment box visible only to logged-in team members for internal feedback.
Insert LaTeX: Add mathematical expressions and equations using LaTeX syntax.
To add, click the Insert LaTeX option and an Insert latex expression window appears. Type in your desired LaTeX syntax and click Insert. For more information, read this article.
To edit, click the Edit (Pencil) icon on the expression. An Insert latex expression window appears. Make the required changes in the syntax and click Update.
To delete, click the Remove (Trashbin) icon.
Find & replace: Search for and replace text within your article, useful in long articles.
Content reuse: Reuse content across the project with:
Variable: For text content.
Snippet: For text, images, tables, code blocks, etc.
Glossary: Maintain a list of terms and their definitions within the Knowledge base.
5. More rich
Insert video: Embed videos from platforms like YouTube, Wistia, Streams, or Vimeo.
Insert table: Add a table by selecting the desired number of rows and columns.
Insert horizontal line: Add a line in the article.
Emoticons: Insert emoticons to enhance the article's engagement.
6. Other options
Additional features include:
Code view: Switch to HTML syntax editor.
Undo: Undo the previous action.
Redo: Repeat the previous action.
7. Editor switch
The switch editor toggle comes in use if you want to convert your article to the Advanced WYSIWYG editor.
Click the toggle and click Switch to New Editor and the article will be converted to Advanced WYSIWYG editor.
For steps and guidance on using the Advanced WYSIWYG editor, refer to the article on Advanced WYSIWYG editor.
Additional formatting options
1. Image
Once an image is added to an article, you can access the below options by clicking on the image:
a. Replace: To replace the image.
b. Align: Add an image caption to align the image.
c. Image caption. This will appear at the bottom of the image.
d. Remove: To remove the image.
e. Insert link: To add a link to the image. After adding the link, you can open, remove, and edit the link.
f. Display: To change the display of the image. You can use Inline or Break Text options.
g. Style: To change the border style of the image. You can use Rounded, Bordered, and Shadow options.
h. Alternative text: To add alternative text for the image. If the image file cannot be loaded, the alternative text will appear in a blank box where the image will appear.
i. Change size: Adjust the width and height of the image as pixels. Click update to confirm.
j. Advanced edit: To edit your image, use advanced tools such as Crop for resizing, Text options to adjust bold, italic, underline, color, and size, and Rotate to adjust orientation. You can also Zoom in or Zoom out for detailed editing, use the Hand tool for navigation, and access History for previous states. Use Undo and Redo to reverse or repeat actions, Reset to return to the original image, Delete to remove specific edits, or Delete all to clear everything. When finished, click Save to apply and store your changes.
2. Video
Once you embed a video in an article, you can access the below options by clicking on the left or right of the video in the editor pane:
a. Replace: To replace the video.
b. Remove: To remove the video.
c. Display: To change the display of the video. You can use Inline or Break Text options.
d. Align: To align the video.
e. Change size: To change the size of the video.
f. Autoplay: To turn the autoplay option on or off.
3. PDF
Once a PDF file is added to an article, you can access the below options by clicking on the left or right side near the PDF file in the editor pane:
a. Remove: To remove the PDF file.
b. Change size: To change the size of the PDF file.
4. Word file
Once a Word file is added to an article, you can access the below options by clicking on the Word file:
a. Open link: Download the word file to the local system drive.
b. Remove: To remove the Word file.
5. Table
Once a table is added to an article, you can access the below options by clicking on the table:
a. Table header: Turn the table header on or off. Click on this button, and the top row appears on the table.
b. Remove table: To remove the table. Click on this button, and the table and the content will be deleted. If you have accidentally clicked on the remove, you can always use the Undo action (Ctrl + Z) to restore the table.
c. Row: Place the cursor in any cell of the intended row and click 'Insert row above' or 'Insert row below' to add rows to the table. Click on the 'Delete row' to remove the current row.
d. Column: Place the cursor in any cell of the intended column and click 'Insert column above' or 'Insert column below' to add columns to the table. Click on the 'Delete column' to remove the current column.
e. Table style: To change the table style. You can use Dashed Borders and Alternate Rows options. The alternate rows option would distinguish the row color.
f. Cell: Click on this button and select the action to merge or split cells. You can split a cell vertically or horizontally any number of times. The merge option would be enabled only when you select more than one cell horizontally or vertically.
g. Cell background: To change the cell's background color. You can select from the color palette available or enter the HEX code.
h. Vertical align: To change the vertical alignment of the content in the cell. You can do this for a single cell or multiple selections of cells. If the cell height is bigger than the content fit, then you can choose to align the content at the top, middle, or bottom of the cell.
i. Horizontal align: To change the horizontal alignment of the content in the cell. You can do this for a single cell or multiple selections of cells. If the cell width is bigger than the content fit, you can align the content at the left, center, right, or justified style.
j. Cell style: To change the type of the cell border. You can use the options Highlighted (changes the cell border color) and Thick (increases the cell border thickness) of the selected cell.
When, Where, and Why to Use the WYSIWYG Editor
Who can use the WYSIWYG editor?
Document360 users who are comfortable with HTML editors
Is the WYSIWYG editor easy to use?
Using the WYSIWYG editor will feel similar to using a word-processing application
For example, Microsoft Word, Google Docs, etc.
You can copy and paste content directly from a Word document or any other source. No special syntax is required.
Why use the WYSIWYG editor?
Unlike the Markdown editor, the WYSIWYG editor uses a single editing pane since the written content is already in preview mode.
WYSIWYG editor provides a unique feature to paste large tables from a third-party site or another Knowledge base.