Creating a Knowledge Base Category

70 Aufrufe Markdown

Create the section that groups your help articles, and give it a name, an icon and an address in every site language.

Opening the Screen

Go to {admin}/knowledgebase/categories and click the Create Category button. The form opens at {admin}/knowledgebase/categories/add.

You reach that list from the knowledge base page with the Categories button. To change a category, open the row menu at the end of its line and choose Edit; the edit form carries the same fields.

What Is on the Screen

A language tab strip runs across the top of the form. Title, link structure, subtitle, content and the SEO fields belong to the language you picked. Switch tabs to fill in the next language.

Between them sit the shared settings: icon, parent category, status, sort order and an optional background image. The last card is Search Engine Optimization (SEO). The Create button at the bottom saves the whole form at once, for all languages.

Fields

Language Fields

TitleThe name of the category. Required in every language.

Link StructureThe web address of the category page. Leave it alone and it comes from the title; the pencil button, Change the URL, opens it for editing.

SubtitleShort description under the category title. Optional.

ContentLonger introduction for the category page, written in the rich text editor. It is saved, but the stock themes do not show it on the category page: that page prints only the title, the subtitle and the icon. Optional.

Shared Settings

IconBootstrap or Font Awesome icon class, for example bi bi-book. It appears next to the category name on the website.

Parent CategoryWhere the category sits in the tree. Default: None (Top Level). Deeper levels carry a dash in front of the name.

StatusThe category page opens on the website while this box is ticked. Default: ticked.

Sort OrderPosition among the other categories. Smaller numbers come first. Optional.

Background ImageHeader image of the category page. 1920 x 400px, up to 2MB, JPG, PNG, SVG or WebP. Optional.

SEO Card

Enable SEOWhile it is off, the two fields below are not saved and anything you entered before stays as it is. On a new category the default values apply.

Page TitleThe headline search engines show. One per language.

Meta DescriptionThe short summary under the headline in search results. One per language.

Tasks

Create a category

Fill in Title for the language shown in the tab strip, and a Subtitle if you want one.
Pick a Parent Category, set the Sort Order and check Status.
Click the Create button at the bottom of the form.

The category is saved and you land back on the category list.

Give it an icon

Type an icon class into the Icon field, such as bi bi-book.
Watch the preview to the left of the box; it follows what you type.
Click Create, or Save while editing.

The icon now sits next to the category name on your website.

Fill in another language

Click the language you want in the tab strip at the top of the form.
Fill in Title, and the subtitle and content if you use them. Icon, parent and status stay shared.
Click Create, or Save while editing.

Every language you filled in is saved in one go.

Things to Watch

A title is needed in every language

Nothing is saved while one language tab has an empty title. The warning shows the language code, so switch to that tab and fill it in.

Two categories cannot share an address

If another knowledge base category already uses that link structure in that language, the form refuses to save. Pick a different address.

Status closes the category page

With the box unticked, the category page answers with a not found page on your website. Untick it while you prepare the content.

Required Privileges

Creating, editing and saving a category needs KNOWLEDGEBASE_OPERATION. Without it the screen answers with an access warning.

War das hilfreich?

Vielen Dank für Ihre Rückmeldung!

Brauchen Sie weitere Hilfe?

Unser Support-Team ist rund um die Uhr für Sie da, wenn Sie oben nicht fündig werden.

Kontakt aufnehmen Ticket eröffnen