SoftwareRoad Knowledge Base Shortcode Reference

SoftwareRoad Knowledge Base uses a simple WordPress shortcode to display the main knowledge base homepage.

The shortcode is:

[srkb_knowledge_base]

Add this shortcode to a published WordPress page to display your knowledge base search, categories, homepage highlights, popular articles and other enabled sections.

What does the shortcode display?

The shortcode creates the main public-facing SoftwareRoad Knowledge Base page.

Depending on your settings, it can display:

• Knowledge base title and tagline
• Main search box
• Popular searches
• Homepage highlights
• Knowledge base categories
• Popular Articles
• Recently Updated Articles
• Sidebar content
• Support help box

The shortcode uses the settings saved under:

Knowledge Base > Settings

You do not need to add separate shortcodes for each homepage section.

The SoftwareRoad Knowledge Base shortcode

Use the following shortcode exactly as shown:

[srkb_knowledge_base]

The shortcode does not require any extra attributes or settings inside the brackets.

For example, you do not need to add:

[srkb_knowledge_base layout="grid"]

or:

[srkb_knowledge_base categories="yes"]

Homepage layout and feature options are controlled through the plugin settings instead.

Add the shortcode to a WordPress page

To create the main knowledge base page:

1. Sign in to your WordPress dashboard.
2. Open Pages > Add New Page.
3. Enter a page title such as Knowledge Base, Help Centre or Documentation.
4. Add a Shortcode block.
5. Paste:

[srkb_knowledge_base]

6. Publish the page.
7. Open the page publicly and check that the knowledge base appears.

The page can use any suitable title, although Knowledge Base is normally the clearest choice.

Add the shortcode using the Block Editor

When using the standard WordPress Block Editor:

1. Select the Add Block button.
2. Search for Shortcode.
3. Add the Shortcode block.
4. Enter:

[srkb_knowledge_base]

5. Update or publish the page.

Using a dedicated Shortcode block helps prevent WordPress from changing the shortcode formatting.

Add the shortcode using the Classic Editor

When using the WordPress Classic Editor, paste the shortcode into the main content area:

[srkb_knowledge_base]

Use the Text view if another editor changes or formats the shortcode unexpectedly.

Do not place the shortcode inside quotation marks.

Add the shortcode using a page builder

Most WordPress page builders include a shortcode, text or HTML widget.

Add the shortcode to the builder element designed for WordPress shortcodes:

[srkb_knowledge_base]

Avoid placing it inside a heading, button, code example or decorative text element.

After saving the page, check the public version while signed out of WordPress.

The shortcode can be placed on any WordPress page

The shortcode can be added to any normal published WordPress page.

For example:

example.com/knowledge-base/

example.com/help-centre/

example.com/documentation/

The page does not need to use a particular name or slug.

However, the page should be publicly accessible if visitors need to use the WordPress knowledge base without signing in.

Choose a clear page address

A short, descriptive page slug makes the knowledge base easier to recognise and share.

Suitable examples include:

• knowledge-base
• help
• help-centre
• documentation
• support

For example:

https://example.com/knowledge-base

Avoid using unclear page addresses such as:

https://example.com/page-184

The page title and URL should make it obvious that visitors are opening your help documentation.

Only one main knowledge base page should normally be used

Although the shortcode can technically be placed on more than one WordPress page, you should normally choose one main knowledge base homepage.

Using several pages with the same shortcode can cause confusion.

For example, you could end up with:

• Duplicate knowledge base homepages
• Several pages showing the same categories
• Different links pointing to different versions
• Search engines finding repeated content
• Breadcrumbs linking to the wrong page
• Back links returning to an old test page

Choose one page as the main knowledge base and remove the shortcode from unused test pages.

Why duplicate knowledge base pages should be avoided

Two pages containing the same knowledge base can make the website harder to manage.

For example:

example.com/knowledge-base/

and:

example.com/help/

may both display identical content.

Visitors may bookmark different pages, and search engines may need to decide which version should be indexed.

A single main WordPress knowledge base page creates a clearer structure.

Select the main Knowledge Base Page

After publishing the page:

1. Open Knowledge Base > Settings.
2. Select the General tab.
3. Find the Knowledge Base Page setting.
4. Select the page containing:

[srkb_knowledge_base]

5. Select Save Changes.

The plugin uses this selected page for navigation features such as:

• Back to Knowledge Base links
• Breadcrumbs
• Homepage links
• Category navigation
• Article navigation

Selecting the correct page helps keep the entire knowledge base connected.

Automatic shortcode page detection

SoftwareRoad Knowledge Base can look for the WordPress page containing its shortcode.

This helps the plugin identify the main knowledge base page during setup.

The plugin searches for:

[srkb_knowledge_base]

If it finds a suitable page, it can use that page for knowledge base navigation.

When automatic detection may choose the wrong page

Automatic detection can become less reliable when the shortcode appears on several pages.

For example, you may have:

• A live knowledge base page
• An old test page
• A private preview page
• A duplicated page created by a page builder
• A staging page copied into the live website

In this situation, select the correct page manually under the General settings.

The page must be published

Visitors cannot normally access the knowledge base from a page that is still saved as a draft.

Check that the WordPress page status is Published.

A page may fail to appear publicly when it is:

• Draft
• Pending Review
• Private
• Password protected
• In the Trash

Use a normal published page unless you deliberately want to restrict access.

The shortcode requires an active licence

The SoftwareRoad Knowledge Base shortcode requires an active Monthly or Yearly licence.

When the licence is active, the shortcode can load the public knowledge base normally.

If the licence becomes inactive, expired or cannot be verified, the shortcode may display an unavailable message instead of the normal knowledge base content.

Check the licence status

To check your licence:

1. Open Knowledge Base > Licence.
2. Review the licence status.
3. Confirm that your purchase email is correct.
4. Confirm that the product key is correct.
5. Reactivate the licence if required.

The licence details must match an active SoftwareRoad Knowledge Base Monthly or Yearly subscription.

What happens when the licence is inactive?

When the licence is inactive, the shortcode will not display the full knowledge base.

This may happen when:

• The subscription has expired
• The subscription has been cancelled
• Licence details were removed
• The purchase email is incorrect
• The product key is incorrect
• The website cannot contact the licence service
• A temporary verification error occurs

The plugin may show that the knowledge base is temporarily unavailable.

Your articles, categories and saved settings are not deleted simply because the licence becomes inactive.

The shortcode does not create articles

The shortcode displays the knowledge base structure, but it does not automatically create documentation.

You still need to create:

• Knowledge base categories
• Knowledge base articles
• Article excerpts
• Category descriptions
• Homepage wording
• Search settings

Once published, this content will appear through the knowledge base page and individual article or category URLs.

The shortcode does not need to be added to article pages

Do not add srkb_knowledge_base inside individual knowledge base articles.

SoftwareRoad Knowledge Base automatically creates the public layout for articles and category pages.

The shortcode is only needed for the main knowledge base homepage.

Adding it inside an article could display the full knowledge base homepage within the article content, which would make the page confusing and unnecessarily long.

The shortcode does not need to be added to category pages

Knowledge base category pages are generated automatically by WordPress and SoftwareRoad Knowledge Base.

You do not need to create a normal WordPress page for each category.

Create and manage categories under:

Knowledge Base > Categories

The plugin generates the category URL and article listing for you.

Add normal content around the shortcode

You can add normal WordPress content above or below the shortcode, although it is usually best to keep the main page simple.

You could add:

• A short introduction
• An important support notice
• A maintenance message
• A link to customer support
• A temporary announcement

Be careful not to repeat content already provided by the knowledge base title, tagline or help box.

Avoid wrapping the shortcode in code formatting

The shortcode must be added as an active WordPress shortcode.

Do not place it inside:

• A Code block
• A Preformatted block
• Inline code formatting
• Quotation marks
• An image caption

If visitors can see the text srkb_knowledge_base publicly, WordPress is displaying it as plain text rather than processing it.

Correct shortcode spelling

The shortcode must be written exactly as:

[srkb_knowledge_base]

Common mistakes include:

[srkb-knowledge-base]

[software_road_knowledge_base]

[srkbknowledgebase]

srkb_knowledge_base

[srkb_knowledgebase]

Make sure both square brackets are present.

The shortcode text appears on the page

If visitors see the shortcode itself instead of the knowledge base:

1. Check that SoftwareRoad Knowledge Base is installed.
2. Check that the plugin is activated.
3. Confirm the shortcode spelling.
4. Check that the shortcode is inside a Shortcode block.
5. Confirm the licence is active.
6. Update the page.
7. Clear the website cache.

This normally means WordPress is not recognising or processing the shortcode.

The page is blank

If the page loads but does not display the knowledge base, check that:

• The plugin is active
• The Monthly or Yearly licence is active
• The shortcode is correct
• The page is published
• The correct page template is being used
• The page builder has not hidden the shortcode block
• The website cache has been cleared
• JavaScript is not being blocked

Open the browser developer console if you suspect a script error.

The wrong page opens from breadcrumbs

Open:

Knowledge Base > Settings > General

Check that the correct Knowledge Base Page has been selected.

If the plugin detected an old test page, choose the live page manually and save the settings.

Clear the website cache afterwards.

The Back to Knowledge Base link opens the wrong page

The back link uses the selected main knowledge base page.

To correct it:

1. Open the General settings.
2. Select the live page containing the shortcode.
3. Save the settings.
4. Clear the website cache.
5. Test the link from a published article.

You do not need to edit every article individually.

The shortcode works in the editor but not publicly

This may be caused by:

• Page caching
• An inactive licence
• A page builder display condition
• The page being private
• A theme template problem
• JavaScript optimisation
• A plugin conflict

Test the page in a private browser window while signed out of WordPress.

The page builder changes the shortcode

Some page builders may convert or wrap shortcode text incorrectly.

Try using the builder’s dedicated Shortcode widget rather than a normal text element.

If the problem continues:

1. Create a standard WordPress page.
2. Add a normal Shortcode block.
3. Paste srkb_knowledge_base.
4. Publish the page.
5. Test it without the page builder layout.

This helps confirm whether the builder is causing the problem.

The page uses an unsuitable template

A narrow page template or theme sidebar can make the knowledge base feel cramped.

Use a wide or full-width page template where available.

Avoid showing the theme’s normal blog sidebar alongside the SoftwareRoad Knowledge Base sidebar.

Check the page settings provided by your WordPress theme.

Caching after adding the shortcode

If the shortcode page was recently created or changed, clear:

• WordPress page cache
• Hosting or server cache
• Content delivery network cache
• Browser cache

Then open the page in a private browser window.

Cached HTML may continue showing an old blank page or previous shortcode setup.

Moving the shortcode to another page

To move the knowledge base homepage:

1. Create or edit the new WordPress page.
2. Add srkb_knowledge_base.
3. Publish the new page.
4. Open Knowledge Base > Settings > General.
5. Select the new Knowledge Base Page.
6. Save the settings.
7. Remove the shortcode from the old page if it is no longer needed.
8. Redirect the old page URL where appropriate.

Test breadcrumbs and back links after moving it.

Redirect the old knowledge base page

If the old page has already been shared or indexed, create a redirect to the new page.

For example:

Old page:

example.com/help/

New page:

example.com/knowledge-base/

A redirect prevents visitors from reaching a deleted or empty page.

It can also help preserve links from search engines, emails and bookmarks.

Changing the page title

You can change the normal WordPress page title without changing the shortcode.

For example:

• Knowledge Base
• Help Centre
• Product Documentation
• Support Guides

The visible SoftwareRoad Knowledge Base title shown inside the search area is controlled separately through the plugin settings.

This means the WordPress page title and the internal knowledge base title can be different.

Changing the page slug

Changing the WordPress page slug changes the main knowledge base homepage address.

For example:

Old address:

example.com/help/

New address:

example.com/knowledge-base/

After changing it:

• Test the main page
• Check the selected Knowledge Base Page
• Test article back links
• Check breadcrumbs
• Update menus
• Add a redirect from the old page
• Clear the website cache

Shortcode and knowledge base SEO

Use one clear main page for the shortcode to avoid duplicate WordPress knowledge base content.

A well-organised main knowledge base page can help visitors and search engines understand the structure of your documentation.

Use a clear page title, page slug and knowledge base description.

Suitable phrases may include:

• WordPress knowledge base
• WordPress knowledge base plugin
• Product documentation
• Help centre
• Support articles
• Knowledge base for WordPress

Use these phrases naturally rather than repeating them unnecessarily.

Shortcode reference summary

Shortcode

[srkb_knowledge_base]

Used on

A normal published WordPress page.

Recommended number of pages

One main knowledge base page.

Page detection

SoftwareRoad Knowledge Base can detect a page containing the shortcode.

Manual page selection

Available under Knowledge Base > Settings > General.

Licence requirement

An active SoftwareRoad Knowledge Base Monthly or Yearly licence.

Shortcode attributes

No additional shortcode attributes are required.

Articles and categories

Generated separately and do not need the shortcode added to them.

Shortcode setup checklist

Before finishing, check that:

• The shortcode is written correctly
• It is inside a WordPress Shortcode block
• The page is published
• Only one main knowledge base page is being used
• The correct Knowledge Base Page is selected
• The plugin is installed and active
• The Monthly or Yearly licence is active
• Breadcrumbs link to the correct page
• Back links return to the correct page
• The page uses a suitable wide layout
• Old test pages have been removed or redirected
• The public page works while signed out
• WordPress and server caches have been cleared

The SoftwareRoad Knowledge Base shortcode is now ready to display your main WordPress knowledge base homepage.