Topics Map > Documents Tab

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.

Core Plugins

TinyMCE, the newest KB editor, has several plugins that provide key functionality while editing KB documents. These plugins can be accessed via the menu bar or throughout the tool bar.

The current plugins available are as follows:

KB Link Doc Icon of a link over a document

The KB Link Doc plugin is found next to the Link button in the toolbar, or under the Insert menu. It 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 - Using the KB Link Doc Feature  

KB Include Doc Icon of a plus sign over a document

The KB Include Doc plugin is found next to the KB Link Doc button in the toolbar, or under the Insert menu. It allows you to insert sections of other KB documents, news items, or external webpages 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:

Custom include doc plugin dialog window

  • Type - The document type to be included; Doc, News, or External page
  • Style - 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

To edit an existing IncludeDoc tag, click within the tag element, and edit the text as needed. Additionally, the KB include doc button will be highlighted in the editor toolbar. Clicking the button will let you edit additional IncludeDoc properties.

Content Restriction Icon of a padlock

The Content Restriction plug-in is found next to the KB Include Doc button in the toolbar, or under the Tools menu. It is 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  

Note: If you are nesting content restriction tags, the interior restriction should typically be applied as an "Inline SPAN" in order to prevent formatting issues.

KB Attachments Icon of a folder with an image on the front

The KB Attachments plugin is found next to the Image button in the toolbar, or under the Insert menu. It 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 an attachment file dropdown, as displayed in the image below:

KB attachment popup window

From this drop down you will be able to select files from the shared attachment folder. If the document has an attachment folder, you will also be able to select files from that location.

Select the desired attachment. Depending on the file type, there are specific options:

  • Image files:
    • General options:
      dialog window showing general image options
      • Alternative description: enter alt text for the image. If the image is purely decorative, select the 'Image is decorative' checkbox, and the alt text field will be left blank. 
      • Width and Height Fields
    • Advanced options:
      Dialog window showing advanced image options
      • Vertical and Horizontal space: set the image's white space padding
      • Border width and Border style: add an optional border style and set the border's width
      • Border radius and Border color: set the border's corner curve and the border's color
  • JavaScript/CSS files:
    • Place as drop down: add as additional resource in JavaScript/CSS field, hyperlink to the file, import the file in the body content
    • Link display text if hyperlinking file
  • PDF files:
    • Place as drop down: hyperlink to the file, embed PDF content in iframe
    • Link display text if hyperlinking file
    • Width and Height Fields if embedding in iframe
  • Video (mp4, webm, ogg) and Audio Files (mp3)
    • Place as drop down: video/audio in a media player, hyperlink to the file
    • Link display text if hyperlinking file
  • Other files: 
    • Link display text 

Click the Place button to insert your attachment into the document. 

Clicking Draft folder or Shared folder buttons will respectively open either the document attachment folder or the shared attachment folder. 

Collapsible Panel Icon of a plus and minus sign

This plugin is found next to the Table button in the toolbar, or under the Insert menu. It 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.

Button Icon of a rectangular button with three dots inside

This plugin is found next to the Collapsible Panel button in the toolbar, or under the Insert menu. It allows you to insert links styled as buttons into the body of a KB document. Clicking the Button plugin will open a dialog window with the following options:

popup window displaying options to customize the kb custom buttons

  • Color - Red or blue (colors match UW–Madison’s Colors for Web style guide)
  • Size - Default or large
  • Style
    • Default: Solid color with white text
    • Reversed: Colored outline and text on a white background
  • Open link in - Current window or new window/tab
  • Text - The text to be displayed on the button
  • URL - The link to navigate to when the button is clicked

As options are changed, the window will display a button preview that dynamically updates. Click Insert to add the button to your document. 

To edit an existing button, click within button, and edit the text as needed. Additionally, the custom Custom KB buttons icon and the Insert/edit link icon will be highlighted in the editor toolbar. Clicking the plugin icon will allow you to update any options for the existing button. Clicking the link icon will allow you to edit the button's link properties. 

Additional Plugins

Several other plugins are available under the menu bar.

'To the Top' Link Icon of a circle with an arrow inside pointing upward

The 'To The Top' Link plugin is found under the Insert menu. It 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.

Feedback Form Icon of a set of form fields

The Feedback Form plugin is found under the Insert menu. It 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. For more information, please see KB User's Guide - Documents Tab - Embed a Basic Form into a KB Document

  • Important: Forms in the KB should not be used to collect sensitive or restricted data, such as social security numbers or Protected Health Information (PHI).

Import from URL Icon of an arrow pointing to a document

The Import from URL plugin is found under the Insert menu. It 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.

Content Restore Icon of a page with a counter-clockwise arrow inside

The Content Restore plugin is found under the Tools menu. It 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
After selecting the fields to restore, and the version to restore to, click the Restore button to revert those fields.

Keywordseditor new editor tiny tinymce plugins custom attachments include link restore inline content restrictions doc includedoc linkdoc expanding collapsing panels   Doc ID114240
OwnerLeah S.GroupKB User's Guide
Created2021-10-12 10:39:23Updated2023-10-16 12:42:02
SitesKB User's Guide
Feedback  0   0