Skip to content

Fixes #586 - Add missing link types and video embedding to knowledge base #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ralf401 merged 2 commits into from
Jul 7, 2026
Merged

Fixes #586 - Add missing link types and video embedding to knowledge base #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ee7843
Added missing link types and video
ralf401 Jul 7, 2026
4549fa6
Tweaks
ralf401 Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions extras/knowledge-base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,16 @@ talk to your administrator about enabling the function.
to.

.. figure:: /images/extras/knowledge-base/knowledge-base-internal-rss-function.png
:alt: Screenshot showing the modal for of the RSS button
:width: 99%
:alt: Screenshot shows the modal for of the RSS button
:align: center

.. warning::

Keep in mind that internal RSS links contain **personal access tokens**.
Never share these URLs with anyone else!

If you want to revoke the access and renew your token, you can do so
in the RSS modal.
in the RSS dialog.

.. figure:: /images/extras/knowledge-base/knowledge-base-reset-rss-access-token.png
:alt: Screenshot showing the access token reset link on the lower
Expand Down Expand Up @@ -146,8 +146,8 @@ If you're unsure, please ask your administrator to configure the
:admin-docs:`role permissions </manage/roles/agent-permissions.html>`
accordingly.

.. figure:: /images/extras/knowledge-base/knowledge-base-granular-category-permissions.gif
:alt: Screencast showing the visibility option for categories for granular access permissions
.. figure:: /images/extras/knowledge-base/knowledge-base-granular-category-permissions.png
:alt: Screenshot shows the granular category permissions for knowledge base
:align: center

In general, permissions of a parent category are inherited! If you want to
Expand Down Expand Up @@ -177,23 +177,40 @@ The knowledge base editor comes equipped with the same
**rich text editing capabilities** available in the Zammad ticket composer.
That means you can use the same
:doc:`keyboard shortcuts </advanced/keyboard-shortcuts>` to insert formatted
text, bullet lists, and more. You can even add file attachments and links!
text, bullet lists and more. You can even add file attachments and links!

Different link types
**Web link**
URLs pointing to other websites.
Web link
URLs pointing to other websites.

**Link Answer**
Link Answer
Internal references to other knowledge base answers (will not break if
destination URL changes).

**Linked Tickets**
Image
Include an image from your computer in the answer. Unlike file
attachments, these images are embedded directly in the answer.

Video
Include a video to embed in the answer. By default, you can embed videos
from Vimeo and YouTube. Depending on your Zammad settings, MediaCMS and
PeerTube instances can be enabled by your admin as well. A list of
supported video services is displayed in the video dialog below the URL
field.

Linked Tickets
Internal references to Zammad tickets (visible only in preview and edit
mode).

**Tags**
Can help to categorize or label answers for better search results. Please note
that tags are visible publicly and can be the same like those in your tickets.
Attachments
Add any file as an attachment to your answer. Such an attachment isn't
embedded in the body of the answer. Readers can download it by clicking
on it in the attachment section.

Tags
Can help to categorize or label answers for better search results. Please
note that tags are visible publicly and can be the same as those in your
tickets.

Visibility
Set the visibility of an answer to control who can see an article,
Expand Down
Binary file modified images/extras/knowledge-base/knowledge-base-edit-answer.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/extras/knowledge-base/knowledge-base-granular-category-permissions.gif
View file
Open in desktop
Binary file not shown.
Binary file added images/extras/knowledge-base/knowledge-base-granular-category-permissions.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 44 additions & 23 deletions locale/user-docs.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Zammad User Documentation pre-release\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-07-02 08:47+0200\n"
"POT-Creation-Date: 2026-07-07 14:22+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -1229,7 +1229,7 @@ msgstr ""
#: ../snippets/ticket-state-type-circles.rst:8
#: ../snippets/ticket-state-type-circles.rst:8
#: ../snippets/ticket-state-type-circles.rst:8
#: ../extras/knowledge-base.rst:204
#: ../extras/knowledge-base.rst:221
#: ../snippets/ticket-state-type-circles.rst:8
msgid "|grn|"
msgstr ""
Expand Down Expand Up @@ -2023,6 +2023,7 @@ msgstr ""

#: ../basics/ticket-basics.rst:117
#: ../basics/zammad-glossary.rst:706
#: ../extras/knowledge-base.rst:213
msgid "Tags"
msgstr ""

Expand Down Expand Up @@ -4425,15 +4426,15 @@ msgid "Pressing the RSS button will provide up to two RSS feeds to subscribe to.
msgstr ""

#: ../extras/knowledge-base.rst:0
msgid "Screenshot showing the modal for of the RSS button"
msgid "Screenshot shows the modal for of the RSS button"
msgstr ""

#: ../extras/knowledge-base.rst:107
msgid "Keep in mind that internal RSS links contain **personal access tokens**. Never share these URLs with anyone else!"
msgstr ""

#: ../extras/knowledge-base.rst:110
msgid "If you want to revoke the access and renew your token, you can do so in the RSS modal."
msgid "If you want to revoke the access and renew your token, you can do so in the RSS dialog."
msgstr ""

#: ../extras/knowledge-base.rst:0
Expand Down Expand Up @@ -4474,7 +4475,7 @@ msgid "The roles require ``knowledge_base.reader`` permission. Your administrato
msgstr ""

#: ../extras/knowledge-base.rst:None
msgid "Screencast showing the visibility option for categories for granular access permissions"
msgid "Screenshot shows the granular category permissions for knowledge base"
msgstr ""

#: ../extras/knowledge-base.rst:153
Expand All @@ -4498,78 +4499,98 @@ msgid "Edit answer"
msgstr ""

#: ../extras/knowledge-base.rst:176
msgid "The knowledge base editor comes equipped with the same **rich text editing capabilities** available in the Zammad ticket composer. That means you can use the same :doc:`keyboard shortcuts </advanced/keyboard-shortcuts>` to insert formatted text, bullet lists, and more. You can even add file attachments and links!"
msgid "The knowledge base editor comes equipped with the same **rich text editing capabilities** available in the Zammad ticket composer. That means you can use the same :doc:`keyboard shortcuts </advanced/keyboard-shortcuts>` to insert formatted text, bullet lists and more. You can even add file attachments and links!"
msgstr ""

#: ../extras/knowledge-base.rst:196
#: ../extras/knowledge-base.rst:213
msgid "Different link types"
msgstr ""

#: ../extras/knowledge-base.rst:184
msgid "**Web link**"
msgid "Web link"
msgstr ""

#: ../extras/knowledge-base.rst:184
msgid "URLs pointing to other websites."
msgstr ""

#: ../extras/knowledge-base.rst:188
msgid "**Link Answer**"
msgid "Link Answer"
msgstr ""

#: ../extras/knowledge-base.rst:187
msgid "Internal references to other knowledge base answers (will not break if destination URL changes)."
msgstr ""

#: ../extras/knowledge-base.rst:192
msgid "**Linked Tickets**"
msgid "Image"
msgstr ""

#: ../extras/knowledge-base.rst:191
msgid "Internal references to Zammad tickets (visible only in preview and edit mode)."
msgid "Include an image from your computer in the answer. Unlike file attachments, these images are embedded directly in the answer."
msgstr ""

#: ../extras/knowledge-base.rst:196
msgid "**Tags**"
#: ../extras/knowledge-base.rst:199
msgid "Video"
msgstr ""

#: ../extras/knowledge-base.rst:195
msgid "Can help to categorize or label answers for better search results. Please note that tags are visible publicly and can be the same like those in your tickets."
msgid "Include a video to embed in the answer. By default, you can embed videos from Vimeo and YouTube. Depending on your Zammad settings, MediaCMS and PeerTube instances can be enabled by your admin as well. A list of supported video services is displayed in the video dialog below the URL field."
msgstr ""

#: ../extras/knowledge-base.rst:221
#: ../extras/knowledge-base.rst:203
msgid "Linked Tickets"
msgstr ""

#: ../extras/knowledge-base.rst:202
msgid "Internal references to Zammad tickets (visible only in preview and edit mode)."
msgstr ""

#: ../extras/knowledge-base.rst:208
msgid "Attachments"
msgstr ""

#: ../extras/knowledge-base.rst:206
msgid "Add any file as an attachment to your answer. Such an attachment isn't embedded in the body of the answer. Readers can download it by clicking on it in the attachment section."
msgstr ""

#: ../extras/knowledge-base.rst:211
msgid "Can help to categorize or label answers for better search results. Please note that tags are visible publicly and can be the same as those in your tickets."
msgstr ""

#: ../extras/knowledge-base.rst:238
msgid "Visibility"
msgstr ""

#: ../extras/knowledge-base.rst:199
#: ../extras/knowledge-base.rst:216
msgid "Set the visibility of an answer to control who can see an article, or schedule it to be published at a later date. Articles are color-coded according to their visibility:"
msgstr ""

#: ../extras/knowledge-base.rst:204
#: ../extras/knowledge-base.rst:221
msgid "**Public** (visible to everyone)"
msgstr ""

#: ../extras/knowledge-base.rst:206
#: ../extras/knowledge-base.rst:223
msgid "|blu|"
msgstr ""

#: ../extras/knowledge-base.rst:206
#: ../extras/knowledge-base.rst:223
msgid "**Internal** (visible to agents & editors only)"
msgstr ""

#: ../extras/knowledge-base.rst:208
#: ../extras/knowledge-base.rst:225
msgid "|gry|"
msgstr ""

#: ../extras/knowledge-base.rst:208
#: ../extras/knowledge-base.rst:225
msgid "**Draft/Scheduled/Archived** (visible to editors only)"
msgstr ""

#: ../extras/knowledge-base.rst:224
#: ../extras/knowledge-base.rst:241
msgid "Using Answers In Ticket Articles"
msgstr ""

#: ../extras/knowledge-base.rst:226
#: ../extras/knowledge-base.rst:243
msgid "As soon as the knowledge base contains one or more answers, you can use these just like text modules. Instead of :kbd:`:`:kbd:`:` just use :kbd:`?`:kbd:`?` to open the search modal. The search is done full text on both answer body and title in all languages available. If you've found what you've been looking for, simply press :kbd:`Enter` to load the answer into the ticket article. The inserted content does not replace the article's content but is inserted at the cursor's position."
msgstr ""

Expand Down
Loading