Menu

Search

InstantASP Support

Help & Support


Creating Custom Tabs


Tabs

By default InstantKB is provided with four tabs within the main navigation after installation. These tabs are Knowledgebase, Troubleshooter, Downloads, & Submit Ticket.

These tabs represent the standard tab types supported by InstantKB. You can easily extend InstantKB and add your own unique Knowledgebase, Troubleshooter, Downloads or Ticketing tab or remote any of these tabs if they are not relevant to you.

Why Create Your Own Tabs

To help illustrate why you would want to create your own unique tabs we've highlighted a few examples below...

Private / Internal Knowledge Base

You could create a new "Knowledge Base" tab called "Internal Knowledge Base" and associate this only with your support agent or staff user group within InstantKB.

Capture Unique Issues

You could create a new "Ticketing" tab called "Change Requests" that employees could use to submit change requests within your organization. In addition you could design a custom form for this tab to capture unique information about the change request.

Separate Access To Content For Agents Within the Agent CP

If you have several different departments within your organization publishing content to the knowledge base it's often a good idea to separate this content to ensure only the necessary support agents or staff members from each department can edit the content for that department. You can control the visbility of tabs within the Agent Control Panel based on the department the agent belongs to.

Creating a Custom Tab

To create your custom tab simply visit the InstantKB Admin Control Panel. Hover over the Tabs link on the left and select Add Tab...

Tab Options

When creating a custom tab the following options are available...

 Setting  Description
Icon
(Optional)
Allows you to select an icon that can be used to represent the tab within the front-end navigation and within the Agent Control Panel Navigation.

Tab Text
(Required)

This is the name of the tab that is shown within the navigation to users and support agents.

Example: "Product Documentation"

Tab Description
(Optional)

This is the description for the tab that is shown to end users within the root of the tab within your support center.

Example: "This tab contains installation & configurtation documentation for our products".

Tab Type
(Requested)

The type of type you would like to create.

Knowledgebase

This will create a tab that can contain multiple categories where each category can hold multiple support articles. Use this option if you wish to publish articles within a different tab within your support center.

Troubleshooter

A troubleshooter tab works similar to a Knowledgebase tab however you can define a series of questions or steps at the bottom of each article within a troubleshooter tab.

Downloads

The Downloads tab type works similar to the Knowledgebase tab type however the user interface is customized to be more focused around file downloads.

Ticketing

The Ticketing tab type allows you to create a form that can be presented to end users to allow them to submit questions or issues via your support center. For example you could use this option to create a tab to allow customers to Submit Product Suggestions or Bug Reports.

NOTE
When selecting the "Tab Type" from the drop down list if you select either the "Knowledgebase", "Troubleshooter" or "Downloads" tab type two additional options to further control how the tab behaves will appear below the tab type drop down list.

These options are...

Enable Tree

This options determines if the tree view control is displayed for navigating categories within your front-end Knowledgebase, Troubleshooter or Downloads tab. If disabled no tree view control will be displayed on the left when within a tab instead a directory style listing will be displaying showing child categories and the last 5 articles from each category. Disabling the tree view control and using the directory style navigation can assist if you need to ensure your support center is accessible on smaller screens.

Documentation Tab

To create a tab with the optimized documentation interface ensure this option is enabled. The "Enable Tree" option must be enabled for this option to appear. To create a regular knowledge base tab without the optimized documentation interface ensure this option is disabled.

Tab Content Type
(Optional)
Provide an optional content type to identify the type of content within this tab. Content types should be singular, for example Article, Bug, Feature, Task, Project, Issue, PDF, Work, Guide, Download etc.
Tab Redirect
(Optional)
If supplied the tab will simply redirect the user to the supplied URL when clicked within the InstantKB navigation.
User Groups
(Optional)
Select which user groups can view this tab. Users who don't belong to any of the selected groups will not see this tab and will not be able to access or search any content within this tab. Leave blank to automatically associate the tab with all available user groups.
Show In Main Navigation
(Optional)
If enabled the tab will be visible the to chosen user groups within the main navigation within your support center. If disabled the tab will not be shown within the main navigation however the tab will still be accessible via a direct link to the user groups who are allowed to access the tab.
Show In Side Navigation
(Optional)
If enabled the tab will be visible the to chosen user groups within the side navigation on the homepage within your support center. If disabled the tab will not be shown within the side navigation however the tab will still be accessible via a direct link to the user groups who are allowed to access the tab.

How Many Tabs Can I Create?

You can create as many tabs as you wish within InstantKB. For example if you offer several products you may wish to create several documentation or knowledgebase tabs for each products.

Display Tabs In Main Navigation or Side Navigation?

If you do create several tabs you may notice you run out of space to show the tabs horizontally within the main navigation within your support center. If you start to see your tabs wrapping onto two lines within the main navigation we would suggest displaying some of your lesser important tabs within the side navigation. You can use the "Show In Main Navigation" and "Show In Side Navigation" options to control the viability of tabs. The side navigation is displayed vertically allowing you to add as many tabs to this area as needed without the worry of the tabs being wrapped. We would only suggest displaying your most important tabs within the main navigation and showing all other tabs within the Side Navigation.

Should I Use Tab Or Categories To Organize Content

Creating Documentation Tabs

InstantKB 2015+

Documentation tabs provide a completely unique user interface designed to look and feel more like regular product documentation. You can see an example by taking a look at our own documentation here.

To create documentation tabs you will need to visit the Admin CP. Hover over the Tabs option on the left and select "Add Tab". Enter a name for your documentation tab. When selecting the "Tab Type" from the drop down list ensure you select either "Knowledgebase", "Troubleshooter" or "Downloads".

Selecting one of these tab types will present 2 additional options to further control how this tab behaves. These options are...

Enable Tree

This options determines if the tree view control is displayed for navigating categories within your front-end support center. If disabled no tree view control will be displayed instead a directory style listing will be showing displaying your categories and the last 5 articles from each category.

Documentation Tab

To create a tab with the optimized documentation interface ensure this option is enabled. To create a regular knowledge base tab ensure this option is left disabled.


Optionally provide private feedback to help us improve this article...

Thank you for your feedback!


Comments require login or registration.

Details

Product: InstantKB
Version: All Versions
Type: INFO
Article not rated yet.
Article has been viewed 5.9K times.
Last Modified: 2 Years Ago
Last Modified By: Ryan Healey

Options

Similar Articles


Tags