Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Article Editor

The options provided under the Article Editor settings give control over the toolbar options that are available on the article editor to all of the knowledge contributors.

Having a standard set of formatting options across all articles ensures that there is a consistent look and feel to articles. The selection of options can be done to match or help conform to a style guide. An example of this might be to keep the Font Family turned off to make sure that all documents use the same font.

Article Editor Toolbar Options

Removing unused options can also help simplify the toolbar, making it easier for people to work with the article formatting.

Before you begin.

How to access

  1. Select the Configuration cog icon located at the bottom of the left hand vertical menu.
  2. Select Service Manager.
  3. Locate the section titled Knowledge Base.
  4. Select Article Editor

Editor options

Editor Options

  • Undo. Undo recent changes that have not yet been saved.
  • Redo. Reapply changes that were removed using the Undo option.
  • Hot Keys. Displays a list of hotkeys that the user can use while editing.
  • Fullscreen. Opens the editor in a full screen. This is particularly useful when working with a small screen.

Font options

Font options

  • Font Color. Allow the user to change the color of the font.
  • Font Family. Allow the user to change the font family. Available font families include Arial, Helvetica, Georgia, Times New Roman,and Monospace.
  • Font Size. Allow the user to change the size of the font.

Formatting options

Format options

  • HTML. Allows the user to toggle between the editor view and HTML. When viewing as HTML, the user can see all HTML tags that make up the article. This is useful for advanced contributors who have a good knowledge of HTML.
  • Format. Apply options such as heading levels, lists, and quotes to a new section.
  • Bold. Set the selected text as bold.
  • Italic. Set the selected text as italic.
  • Deleted. Puts a line through the selected text.
  • Underline. Add an underline to the selected text.
  • Alignment. Changes the orientation of the selected text. Left, right, center, or justify.

List options

List options

  • Ordered List. Also known as a numbered list.
  • Unordered List. Also known as a bulleted list.
  • Table. Add a table to the article. A 2x2 table is added when clicked on. The user can then add additional rows and columns using the table configuration options.

Media options

Media options

  • Link. Allows for an embedded link to be added to selected text. While adding the URL, the user also has the option to open the link in a new tab.
  • Image. An image can be provided through a URL or uploaded directly into the article. After an image has been added, the contributor can resize, position, add a link, and include a caption.
  • Video. Embed a YouTube or Vimeo video into an article. This can also include other types of embeddable content.

Other options

Other article options Word and Character Count

  • Special Characters. Provides a list of commonly used special characters that are not always available on the keyboard.
  • Emoji. Provides a selection of commonly used emojis.
  • Counter. Adds a counter to the bottom of the article that shows the number of words and characters in the article.
  • Limiter. Limits the number of characters that can be used in an article. When enabled, a field is displayed below the switch that lets you set the maximum number of characters. The number of characters used vs the maximum number will be displayed at the bottom of the article. When a contributor reaches the maximum they will not be able to type anymore. If there are existing articles that are longer than the defined number of characters, the full article will still be available, however when edited, the contributor can only remove characters until they are below the maximum number.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document