Skip to main content
insightsoftware Docs insightsoftware Docs
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

Help Text Editor

To open the help text editor

  1. In the navigation pane , click Help Texts to enter Help Texts navigation mode.

  2. Either select a help text to edit, or create a new help text. The help text details are displayed in the details pane. The help text editor is located on the right, below the language selector and the short and long name.

The help text editor is a simple WYSIWYG editor that is powered by Markdown. If you create a new help text, the editor is filled with a template based on the help text type that you selected.

Mandatory Elements

The help text template consists of one or more building blocks that have the following structure:

  • Section title - do not change this title.
  • Mandatory/optional indicator
  • Expected content - suggestions of what kind of content is expected.

If a section is mandatory, replace the mandatory/optional indicator and the expected content with your own content.

If a section is optional, you are free to choose whether to include it. If you decide to include it, replace the mandatory/optional indicator and the expected content with your own content. If you decide to leave it out, remove the section title, optional indicator and expected content for that section.

Editor Options

The Markdown editor supports the following elements:

Icon

Function

Keyboard shortcut

b

Make the selected text bold.

Ctrl + B

i

Make the selected text italic.

Ctrl + I

u

Underline the selected text.

Ctrl + U

WB_icon_undo

Undo the last action.

Ctrl + Z

WB_icon_redo

Redo your previous action.

Ctrl + Y

WB_button_headings

Insert a paragraph or a heading. A heading with a lower number is larger on the screen.

 

WB_icon_orderedlist

Insert an ordered list. It is numbered automatically.

 

WB_icon_itemizedlist

Insert an itemized list.

 

WB_icon_addtable

Insert a table with the selected number of rows and columns.

 

WB_icon_deletetable

Delete the table.

 

WB_icon_addimage

Insert an image. Make sure that the location of the image is accessible from the Web Client.

 

WB_icon_hyperlink

Select some text in the editor and click here to convert it into a hyperlink. You can use an alternative text to make the link more readable.

 

WB_icon_insertglossaryitem

Insert a glossary term. You can select a glossary term to use in the body of the help text. We recommend always using the long name, because the short name might contain abbreviations.

 

Published:

Help Text Editor

To open the help text editor

  1. In the navigation pane , click Help Texts to enter Help Texts navigation mode.

  2. Either select a help text to edit, or create a new help text. The help text details are displayed in the details pane. The help text editor is located on the right, below the language selector and the short and long name.

The help text editor is a simple WYSIWYG editor that is powered by Markdown. If you create a new help text, the editor is filled with a template based on the help text type that you selected.

Mandatory Elements

The help text template consists of one or more building blocks that have the following structure:

  • Section title - do not change this title.
  • Mandatory/optional indicator
  • Expected content - suggestions of what kind of content is expected.

If a section is mandatory, replace the mandatory/optional indicator and the expected content with your own content.

If a section is optional, you are free to choose whether to include it. If you decide to include it, replace the mandatory/optional indicator and the expected content with your own content. If you decide to leave it out, remove the section title, optional indicator and expected content for that section.

Editor Options

The Markdown editor supports the following elements:

Icon

Function

Keyboard shortcut

b

Make the selected text bold.

Ctrl + B

i

Make the selected text italic.

Ctrl + I

u

Underline the selected text.

Ctrl + U

WB_icon_undo

Undo the last action.

Ctrl + Z

WB_icon_redo

Redo your previous action.

Ctrl + Y

WB_button_headings

Insert a paragraph or a heading. A heading with a lower number is larger on the screen.

 

WB_icon_orderedlist

Insert an ordered list. It is numbered automatically.

 

WB_icon_itemizedlist

Insert an itemized list.

 

WB_icon_addtable

Insert a table with the selected number of rows and columns.

 

WB_icon_deletetable

Delete the table.

 

WB_icon_addimage

Insert an image. Make sure that the location of the image is accessible from the Web Client.

 

WB_icon_hyperlink

Select some text in the editor and click here to convert it into a hyperlink. You can use an alternative text to make the link more readable.

 

WB_icon_insertglossaryitem

Insert a glossary term. You can select a glossary term to use in the body of the help text. We recommend always using the long name, because the short name might contain abbreviations.

 

For an optimal Community experience, Please view on Desktop
Powered by Zendesk