Contributing to the Knowledge Base

Body

Proceed only if you are already familiar with TeamDynamix and have completed the Training for TDNext Users.

 

Accessing the Knowledge Base aka KB

Since you're reading this article, you probably already know how to access the KB, but if not, then go to TDClient and click on Knowledge Base from the menu.

 

Brand Colors

You MUST follow the University Brand Colors that are listed here.
 

Categories

Every category should have a suitable icon with the hex color code #002554.
 

Articles

There are some predefined templates for certain types of articles. It is recommended to use these to maintain a constant theme throughout the KB. If you would like more templates, please contact your admin.

Try to restrict articles to two levels of headings - Heading 2 and Heading 3. Only if you really need a third level of heading, you can use Heading 4 and just use the color black.

Heading 2 should use the hex color code #002554.

Heading 3 should use the hex color code #B3A369.
 

Shortcuts

You can create shortcuts for both articles as well as categories.
 

Ordering

If you want to alphabetically order categories or articles, you can set all of them to the same order number and it will automatically sort them.
 

Editor vs Source

TDX provides an editor but there is only so much that can be done with it. If you want to implement fancier stuff, then you will need to go into the source which is located at the top left corner of the editor.

 

Working with the Source

To edit the source, you will need to work with HTML and in-line CSS. There are some templates that you can use to make things easier.

Note: TDX has permanently restricted certain elements and attributes, and certain others need to be manually enabled by an administrator. Go here for more info about TDX's HTML content allowlist.
 

Font Awesome

You can access Font Awesome in the editor.



You can add these icons to your article but the icons should use the hex color code #002554.

When linking to certain items, add the following icons:

  • linking to our own KB article - 
  • linking to a file -  icon should resemble file type. e.g. pdf would use 
     

Using Article Templates

You can apply a template to an article by accessing them from the editor.

 

View Available Article Templates

Under the menu in the Knowledge Base, click on Templates.

 

Adding Screenshots/Images to Articles

  1. Click on the Image icon.

     
  2. An Image Properties window will pop up:

     
    1. Move to the Upload tab.
       
    2. Click on Choose File and select your desired picture.
       
    3. Then click on Send it to the Server.
       
    4. You will be taken to the Image Info tab where you can specify the Width and Height.
      Tip: If you type a number in either Width or Height, it will automatically suggest a suitable dimension for the second field that will ensure that the image is not distorted.

       
    5. Click OK when done.

      Note: If you want to highlight anything on the images or screenshots, then please refrain from freehand drawing as it does not look professional. You could use MS Paint or any other preferred app to draw shapes to highlight important content. This ensures that our content has a professional and clean look.

 

Details

Details

Article ID: 156
Created
Wed 4/12/23 10:47 AM
Modified
Mon 1/26/26 11:40 AM