Knowledge Base Example Article

Tags TDX

Introduction

This is an example article to showcase how an article should look when following standards for consistency. This will not include everything that you can do within an article, but it will highlight some ideas.

Steps

This article contains a number of steps on how to Change Header Styles, Use HTML Templates, and Add Images below.

Changing Header Styles

You can change Header styles for section titles by doing the following:

  1. While creating or editing your article, highlight the text of the title you want to edit.
  2. At the top of the editor ribbon, you will see a drop-down button that says "Normal". Click that button and select the appropriate Heading level for your title.Uploaded Image (Thumbnail)
  3. Remember that top level headings will start with Heading 2, sub-headings will use Heading 3, next level > Heading 4, and so-on.

Using HTML Templates

There are a handful of HTML Templates set up for quick use on articles. You can view the HTML templates by clicking Templates on the editor and scrolling down to the HTML Components section. Here are some examples from the list.

Alerts

Information Alert! PUT YOUR MESSAGE Here.
Success! Indicates a positive or successful action.
Danger! Indicates a dangerous or potentially negative action.
Warning! Indicates a warning that might need attention.

Button Link

You can edit the name of the text and also right click > edit link to set the destination.

Type the Target Text Here

Other HTML

TeamDynamix uses Bootstrap HTML on the client portal and you can edit the HTML of articles. To do so, click Source in the editor ribbon. You may have uses to where you want to edit the html of the article, but please remember to make sure your edits are still following the guidance for standards.

Images

When adding images to articles, you can do so by either adding a thumbnail version that will expand when clicked on or you can add images inline.

Thumbnail

To add an image with the thumbnail method, just copy and paste your image into the text editor where you want the image to reside. It should add it as a thumbnail by default.

Uploaded Image (Thumbnail)

Inline Image

To insert the full image on the page, follow these steps:

  1. Click the Image button on the editor ribbon
  2. Unless you have a hosted image already, you will need to go to the Upload tab to upload the image.
  3. Browse and Send it to the Server.
  4. Click OK to insert. You can resize as necessary.

Additional Information

If you have any questions, please reach out to Chris Middleton.

Print Article