KB User's Guide - Documents Tab - TinyMCE Custom Plugins Guide
This document explains how to access custom KB plugins, such as LinkDoc, IncludeDoc, content restriction, and revision restoration in the TinyMCE editor.
TinyMCE, the newest KB editor, has several plugins that provide key functionality while editing KB documents. These plugins can be accessed via the Custom menu in the menu bar, or on the far right side of the tool bar (note that they may be collapsed under the three dot menu depending on the width of your screen).
The current plugins available are as follows:
The Attachment plugin gives the ability to easily upload and place files from the group and doc attachment folders into your document. In order to place attachments from the folders into documents, click the KB Attachments plugin. You will be presented with several options, as displayed in the image below:
- Draft attachments - If the document has an attachment folder you can select an attachment from it
- Shared attachments - This dropdown is always present and allows you to select files from the shared attachment folder
After selecting the desired attachment from either the draft or shared attachment folder, click the Place button to insert your attachment into the document. If the attachment is an image, right-click the image and select the 'image' option to add alt text.
The Link Doc plugin allows you to place links to other KB docs inside your content easily. This feature is explained in detail in this document: KB User's Guide - Documents Tab - Link Doc
The IncludeDoc plugin allows you to insert sections of other KB documents into your document. The general function of this tag is described in this doc: KB User's Guide - Documents Tab - IncludeDoc and Dynamic Web Page Content
In TinyMCE, when the IncludeDoc option is clicked, you will be presented with three options:
- Types - The document type to be included; Doc, News, or External page
- Styles - Type of include as HTML - Block DIV or Inline SPAN
- Doc ID or URL - ID number of the document or news item, or URL of the external page being included
The content restriction tags are used to hide content when viewed on either the live internal or external sites. For example, you can choose to only display sensitive content on the internal site, or display information not relevant to internal audiences on the external site. More information on how to use the content restriction tags can be found here: KB Users Guide - Documents Tab - Content Restriction Tags
The KB Restore plugin is a way to easily recover document versions that have been changed. Instead of having to completely roll back to a previous version of a document, you have the option to only roll back a single document field to a previous version. When rolling back, there are several fields to choose from:
- Revision - the revision to roll back to
- Restore title
- Restore keywords
- Restore summary
- Restore body
- Restore internal Notes
Several other plugins are available under the Custom menu, which provide additional useful tools.
This plugin allows you to create expanding and collapsing panels to help organize your content within a KB document. Enter a heading size, panel title, and optional ID for anchor reference. Alternatively choose the Add "Expand All" and "Collapse All" buttons only option to add buttons that control the visability of all panels within a document.
The KB Form plugin allows you to insert a custom form into a KB document. The recipient email address, along with the form labels, can all be customized as desired. The number of fields is fixed to allow for proper validation.
This plugin allows you to insert a link anywhere in the document that will allow the reader of the document to jump back to the top of the page. This is particularly useful for long documents that include a table of contents.
The HTML import plugin allows you to import the full HTML of a page hosted outside of the KB. You will be prompted to enter the URL to import, after which point the page's HTML will be added to the document body. This is handy for cases where you may be migrating content from a previous storage location into the KB.
Please note that because the full page is imported, unwanted elements, such as page headers and footers, may need to be removed.