Merge codes

Merge codes act as placeholders for content. KnowledgeOwl replaces the merge code with the appropriate content when it builds the page. They are mainly used when creating custom layouts, look and feel. They can also allow you to create dynamic content.

Example one: creating custom layouts

When creating a custom article layout, adding the [article("title")] merge code results in KnowledgeOwl displaying the article title at that point in the document.

Example two: adding pieces of functionality

There are also merge codes that add larger pieces of functionality. For example, [template("up-articles")] causes KnowledgeOwl to display a list of recently updated articles.

Using this HTML:

<h1>This is a title</h1>
<p>And this is your article content.</p>
<p>Now, imagine you want a list of recently updated articles at the end of this page . . . </p>
[template("up-articles")]

Results in this:

Here are the available template merge codes in the KB merge codes list, which you can use in any of the Settings > Style, Custom HTML templates. Many can also be used directly within individual articles, categories, and subcategories.

Template Merge Code	Description	Example
[template("article-tags")]	Creates a Tags: [hyperlinked tags] list for an article or category wherever it's used. The "Tags:" test is controlled by a setting in the Customize Text tool.	Tags: search subscription
[template("article-tag-names")]	Creates a comma-separated list of the article tag names associated with a given article or category.	tag1,tag2,tag3,search,subscription
[template("project-logo")]	Inserts the knowledge base logo set in Settings > Style. Used in the Default Top Navigation HTML
[template("project-name")]	Inserts the knowledge base's name, as set in Settings > Basic. Used in the Default Top Navigation HTML.	KnowledgeOwl Support
[template("contact")]	Adds the link to Contact Form. Should be added somewhere in your knowledge base if you're using the Contact Form.	Contact Us
[template("glossary")]	Creates a link to the Glossary page.	Glossary

Here are the available template merge codes for use in Settings > Style, Custom HTML > Article. Many can also be used directly within individual articles, categories, and subcategories.

Template Merge Code	Description	Example
[article("body")]	The "body" merge code will display the contents of the current category or article.	This merge code only works in Custom HTML > Article. It does not work inside articles. If it did, it would create an infinite loop of loading content inside of content. It might be fun to see, but it would break KnowledgeOwl horribly.
[article("title")]	The "title" merge code will display the category or article title.	Article Merge Codes
[article("toc_title")]	The "toc_title" merge code will display the Table of Contents Title (if set).	Article
[article("pdf_download_tool")]	The "pdf_download_tool" merge code will display a PDF icon that will download the contents of the current category or article when clicked.
[article("date_created")]	The "date_created" merge code will display the date and time the current category or article was created.	07/12/2015 2:24 pm EDT
[article("date_modified")]	The "date_modified" merge code will display the date and time the current category or article was last modified.	12/28/2022 12:25 pm EST
[article["thumbnail"]]	The "thumbnail" merge code displays a thumbnail image, if one is set in the article editor.	[article["thumbnail"]]
[article["banner"]]	The "banner" merge codes displays a banner image, if one is set in the article editor.	[article["banner"]]
[template["rating"]]	The "rating" merge code displays the rating text and controls as set up in Settings > Article Ratings.
[template["comments"]]	The "comments" merge code displays the leave a comment options as set up in Settings > Comments.

Here are the available template merge codes for use in Settings > Style > Custom HTML > Home Page. These merge codes will only work in the knowledge base home page; they will not work inside categories or articles.

Here are the available template merge codes for use in any of the following locations:

• Settings > Style
• Knowledge Base > Home Page
• Knowledge Base > Articles
• Knowledge Base > Contact Form

Here are the available template merge codes for use in Settings > Style > Custom HTML > Body. All merge codes except "contents" will also work inside articles.

Template Merge Code	Description	Example
[template("project-logo")]	The "project-logo" merge code will display whatever image you have uploaded under Settings > Style > Logo. You can change the logo there or by replacing the original file in your library.
[template("project-name")]	The "project-name" merge code will display the knowledge base name from Settings > Basic.	KnowledgeOwl Support
[template("contact")]	The "contact" merge code will display a "Contact Us" link to your contact form if you have this feature enabled. You can enable your contact form under Knowledge Base > Contact Form. You can also customize your contact form link or add it to the table of contents.	Contact Us
[template("searchbar")]	The "searchbar" merge code will display a search bar with the text "Search for articles".
[template("contents")]	The "contents" merge code will display the contents of the current page whether that is the home page, the contact form, or an article.	This merge code does not work inside articles. If it did, it would create an infinite loop of loading content inside of content. It might be fun to see, but it would break KnowledgeOwl horribly.
[template("is-editor-check")]	Checks if the current viewer is an author. Returns a "true" value if the viewer is an author and a "false" value if they are not.	true

These merge codes can be used in Custom content categories to display subcategories.

These merge codes can be used in Custom HTML but also in individual articles, categories, etc. See usage notes: