Creating a Knowledge Base Article

100 Aufrufe Markdown

Write a help article in every site language and publish it on your website from a single form.

Opening the Screen

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

To change an article you already have, open the same list, then open the row menu at the end of its line and choose Edit. The edit form carries the same fields. The address in the URL column opens the public page in a new tab instead. If the menu entry is missing, turn on Knowledge Base under Settings, General, Advanced.

What Is on the Screen

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

Under those fields you decide where the article is filed and who sees it: category, sort order, two visibility switches, status 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 article. Required in every language.
Link StructureThe web address of the article. Leave it alone and it comes from the title.
ContentThe body of the article. The editor handles headings, lists, links, tables and images.
TagsHelps the article turn up in the knowledge base search on your website. That search covers the title, content and tags. Optional.

Publishing Options

CategoryThe category the article belongs to. Default: None. Subcategories carry a dash in front of the name.
Sort OrderPosition of the article in the list. Smaller numbers come first. Optional.
Registered Clients OnlyWhen ticked, the article stays out of the website lists, the search results and the article page. The help text on the screen says only registered clients can see it. In fact nobody sees it, registered clients included. The box takes the article off the website altogether. Default: off.
Hide SidebarHides the sidebar and gives the article the full page width. Default: off.
StatusAn article appears on the website while this box is ticked. Default: ticked.
Background ImageHeader image of the article page. 1920 x 400px, up to 2MB, JPG, PNG, SVG or WebP. Optional.

SEO Card

Enable SEOSwitch for the two search engine fields below. Its position is not stored on this screen, so the form opens with it on every time.
Page TitleThe headline search engines show. One per language.
Meta DescriptionThe short summary under the headline in search results. One per language.

Tasks

Write an article

  1. Fill in Title and Content for the language shown in the tab strip.
  2. Pick a Category, then check Status and Registered Clients Only.
  3. Click the Create button at the bottom of the form.

The article is saved and you land back on the knowledge base list.

Fill in another language

  1. Click the language you want in the tab strip at the top of the form.
  2. Fill in Title and Content again. The other fields stay shared.
  3. Click Create (or Save while editing).

Every language you filled in is saved in one go.

Change the web address

  1. In the Link Structure field, click the pencil button, Change the URL.
  2. Type the new address and click the same button again; it now carries a check mark. Enter saves it too.
  3. Click Create (or Save while editing) to save the article itself.

The article answers at the new address. Repeat this for each language tab.

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 articles cannot share an address

If the link structure is already taken in that language, the form refuses to save. Pick a different address.

Changing the address breaks old links

Visitors and search engines keep the old address. After you change it, the previous address answers with a not found page.

Do not save with the SEO switch off

Saving while Enable SEO is off writes an empty Page Title and Meta Description. The values you entered before are lost.

Required Privileges

Writing, editing and saving an article 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

Wir verwenden Cookies, um Sie angemeldet zu halten, Ihre Sprache und Währung zu merken und die Website zu verbessern. Cookie-Richtlinie