diff --git a/extras/knowledge-base.rst b/extras/knowledge-base.rst index d4018a48..5ebebd31 100644 --- a/extras/knowledge-base.rst +++ b/extras/knowledge-base.rst @@ -99,8 +99,8 @@ 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:: @@ -108,7 +108,7 @@ talk to your administrator about enabling the function. 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 @@ -146,8 +146,8 @@ If you're unsure, please ask your administrator to configure the :admin-docs:`role permissions ` 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 @@ -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 ` 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, diff --git a/images/extras/knowledge-base/knowledge-base-edit-answer.png b/images/extras/knowledge-base/knowledge-base-edit-answer.png index a234e94c..992a2205 100644 Binary files a/images/extras/knowledge-base/knowledge-base-edit-answer.png and b/images/extras/knowledge-base/knowledge-base-edit-answer.png differ diff --git a/images/extras/knowledge-base/knowledge-base-granular-category-permissions.gif b/images/extras/knowledge-base/knowledge-base-granular-category-permissions.gif deleted file mode 100644 index 21d7c4f6..00000000 Binary files a/images/extras/knowledge-base/knowledge-base-granular-category-permissions.gif and /dev/null differ diff --git a/images/extras/knowledge-base/knowledge-base-granular-category-permissions.png b/images/extras/knowledge-base/knowledge-base-granular-category-permissions.png new file mode 100644 index 00000000..3cd8dbc1 Binary files /dev/null and b/images/extras/knowledge-base/knowledge-base-granular-category-permissions.png differ diff --git a/locale/user-docs.pot b/locale/user-docs.pot index c21412df..21bd93fe 100644 --- a/locale/user-docs.pot +++ b/locale/user-docs.pot @@ -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 \n" "Language-Team: LANGUAGE \n" @@ -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 "" @@ -2023,6 +2023,7 @@ msgstr "" #: ../basics/ticket-basics.rst:117 #: ../basics/zammad-glossary.rst:706 +#: ../extras/knowledge-base.rst:213 msgid "Tags" msgstr "" @@ -4425,7 +4426,7 @@ 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 @@ -4433,7 +4434,7 @@ msgid "Keep in mind that internal RSS links contain **personal access tokens**. 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 @@ -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 @@ -4498,15 +4499,15 @@ 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 ` 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 ` 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 @@ -4514,7 +4515,7 @@ msgid "URLs pointing to other websites." msgstr "" #: ../extras/knowledge-base.rst:188 -msgid "**Link Answer**" +msgid "Link Answer" msgstr "" #: ../extras/knowledge-base.rst:187 @@ -4522,54 +4523,74 @@ msgid "Internal references to other knowledge base answers (will not break if de 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 ""