Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions advanced/keyboard-shortcuts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,15 +132,15 @@ How

Before typing:

* Press :kbd:`ctrl` :kbd:`i` to enter *italics* mode,
* enter your desired text, and
* press :kbd:`ctrl` :kbd:`i` again to return to normal text mode.
- Press :kbd:`ctrl` :kbd:`i` to enter *italics* mode,
- enter your desired text, and
- press :kbd:`ctrl` :kbd:`i` again to return to normal text mode.

After typing:

* Enter your desired text,
* click-and-drag with the mouse to select it, and
* press :kbd:`ctrl` :kbd:`i` to set the text in *italics*.
- Enter your desired text,
- click-and-drag with the mouse to select it, and
- press :kbd:`ctrl` :kbd:`i` to set the text in *italics*.

Key Combinations
======================================== =================================================
Expand Down
56 changes: 28 additions & 28 deletions advanced/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,39 +69,39 @@ Below you can find the most important attributes sorted by ticket and article.
Ticket Attributes
^^^^^^^^^^^^^^^^^

* number: string
* title: string
* group: object (group.name, ...)
* priority: object (priority.name, ...)
* state: object (state.name, ...)
* organization: object (organization.name, ...)
* owner: object (owner.firstname, owner.lastname, owner.email, ...)
* customer: object
- number: string
- title: string
- group: object (group.name, ...)
- priority: object (priority.name, ...)
- state: object (state.name, ...)
- organization: object (organization.name, ...)
- owner: object (owner.firstname, owner.lastname, owner.email, ...)
- customer: object
(customer.firstname, customer.lastname, customer.email, ...)
* first_response_at: timestamp
* first_response_in_min: integer (business min till first response)
* close_at: timestamp
* close_in_min: integer (business min till close)
* last_contact_at: timestamp (last contact by customer or agent)
* last_contact_agent_at: timestamp (last contact by agent)
* last_contact_customer_at: timestamp (last contact by customer)
* create_article_type.name: string (email|phone|web|...)
* create_article_sender: string (Customer|Agent|System)
* article_count: integer
* escalation_at: timestamp
* pending_time: timestamp
- first_response_at: timestamp
- first_response_in_min: integer (business min till first response)
- close_at: timestamp
- close_in_min: integer (business min till close)
- last_contact_at: timestamp (last contact by customer or agent)
- last_contact_agent_at: timestamp (last contact by agent)
- last_contact_customer_at: timestamp (last contact by customer)
- create_article_type.name: string (email|phone|web|...)
- create_article_sender: string (Customer|Agent|System)
- article_count: integer
- escalation_at: timestamp
- pending_time: timestamp

Article Attributes
^^^^^^^^^^^^^^^^^^

* article.from: string
* article.to: string
* article.cc: string
* article.subject: string
* article.body: string
* article.attachment.title: string (filename of attachment)
* article.attachment.content: string (content of attachment)
* article.attachment.content_type: string (MIME type, e.g.
- article.from: string
- article.to: string
- article.cc: string
- article.subject: string
- article.body: string
- article.attachment.title: string (filename of attachment)
- article.attachment.content: string (content of attachment)
- article.attachment.content_type: string (MIME type, e.g.
``application\/vnd.oasis.opendocument.spreadsheet``; see hint)

.. hint::
Expand Down
12 changes: 6 additions & 6 deletions advanced/suggested-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Reassigning Tickets
^^^^^^^^^^^^^^^^^^^

.. figure:: /images/advanced/suggested-workflows/sharing-work.png
:alt: Reassigning tickets in the ticket pane
:alt: Reassigning tickets in the ticket sidebar
:align: center

Reassign a ticket (via the *Group* and *Owner* settings)
Expand Down Expand Up @@ -58,7 +58,7 @@ but maybe this is a really important contract,
and you want to make sure they have an A+ experience from start to finish.

To enable notifications for a ticket that doesn't belong to you,
simply click the **Subscribe** button at the bottom of the ticket pane:
simply click the ``Subscribe`` button at the bottom of the ticket sidebar:

.. figure:: /images/advanced/suggested-workflows/mention-subscribe-yourself-to-a-ticket.gif
:alt: Screencast of the Subscribe button feature
Expand Down Expand Up @@ -99,10 +99,10 @@ Quickly Assign in Ticket Listings
Within overviews and detailed searches you can run bulk operations on tickets.
This means you can adjust the following ticket information:

* group
* owner
* state (with pending time if applicable)
* priority
- group
- owner
- state (with pending time if applicable)
- priority

After pressing "Confirm", Zammad also allows you to provide an internal or
public note of why you adjusted the settings.
Expand Down
6 changes: 3 additions & 3 deletions advanced/tabs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ all unsaved changes are automatically backed up to the server.

.. tip:: **🖱️ UI Protip**

* :doc:`Ticket states </basics/ticket-basics>` are
- :doc:`Ticket states </basics/ticket-basics>` are
**color-coded:**

.. include:: /snippets/ticket-state-type-circles.rst

* A **pulsing dot** means that a ticket has new activity since you last
- A **pulsing dot** means that a ticket has new activity since you last
viewed it.
* Drag and drop tabs to rearrange them.
- Drag and drop tabs to rearrange them.

Tab Behavior in Ticket Zooms
----------------------------
Expand Down
2 changes: 1 addition & 1 deletion advanced/ticket-actions/merge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ What is merged where?
from there so it will be merged into the original ticket.

How to merge tickets?
To merge a ticket, access the **Ticket ▾** submenu in the ticket pane and
To merge a ticket, access the **Ticket ▾** submenu in the ticket sidebar and
choose **Merge**.

.. figure:: /images/advanced/ticket-actions/ticket-menu-merge.png
Expand Down
2 changes: 1 addition & 1 deletion advanced/ticket-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use **ticket templates** to fill them in with a single click next time.
:alt: Ticket template selection in new ticket dialog
:align: center

Use the ticket pane to load ticket templates.
Use the ticket sidebar to load ticket templates.

On any *new ticket* dialogue use the 🗒️ tab on the right to display the
*Templates* column. If Zammad has any templates for you to apply, you'll
Expand Down
4 changes: 2 additions & 2 deletions advanced/time-accounting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ grouped together.
Accounted Time in Ticket
------------------------

If a ticket already has accounted time(s), you can see it in the ticket pane
If a ticket already has accounted time(s), you can see it in the ticket sidebar
at the bottom. You can find the calculated sums of each activity type as well
as the total sum of accounted times for all activity types.

.. figure:: /images/advanced/time-accounting/ticket-pane-accounted-time.png
:alt: Screenshot showing accounted times in ticket pane
:alt: Screenshot showing accounted times in ticket sidebar
:align: center

Accounted times in the ticket view
4 changes: 2 additions & 2 deletions basics/create-tickets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Customer
Enter a name or email address of a customer to search for existing accounts.
You can even search for organizations and their members. Select an option from
the autocomplete menu or create a new customer by clicking the
**+ Create new Customer** button. This opens a dialog where you can provide
``+ Create new Customer`` button. This opens a dialog where you can provide
all relevant information of the customer. A ticket can only have one customer.

.. figure:: /images/basics/work-with-tickets/search-customer.png
Expand Down Expand Up @@ -82,6 +82,6 @@ it out to learn more.
-----

After you provided the relevant information, finally create the ticket with a
click on the **Create** button. Read on
click on the ``Create`` button. Read on
:doc:`how to find tickets <find-tickets>` and
:doc:`how to work with them <work-with-tickets>`.
2 changes: 1 addition & 1 deletion basics/find-tickets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you search for new tickets to work on, your first look should be in the
overview section. This section gives you a rough overview. More details are
covered in a separate overview page.

You can either open it by clicking the **Overviews** button
You can either open it by clicking the ``Overviews`` button
in the navigation bar or use the keyboard shortcut :kbd:`o`. You can think of
overviews as some kind of ticket lists.
By default, there are some built in overviews. For example, there is
Expand Down
2 changes: 1 addition & 1 deletion basics/ticket-basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ find them in the future. You find the tag section under the attribute fields.
:width: 70%
:align: center

To add a tag, click the **Add Tag** button. Depending on your Zammad's
To add a tag, click the ``Add Tag`` button. Depending on your Zammad's
configuration, you can create new tags by simply type and confirm them with
:kbd:`enter` or :kbd:`tab`. In any case, you can choose from already available
tags. Start typing and you see a list with matching suggestions. To remove it,
Expand Down
4 changes: 2 additions & 2 deletions basics/work-with-tickets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ problem to create a new ticket while editing an existing one. Simply switch back
to the other tab.

For the most changes (except tags or rename title, for example), an explicit
update of the ticket is needed. So make sure to click the **Update** button
update of the ticket is needed. So make sure to click the ``Update`` button
on the right side of the footer bar when you are happy with your changes.

Changing Ticket Attributes
Expand Down Expand Up @@ -68,7 +68,7 @@ an article (1). This opens additional meta information (2):

You might wonder how to delete articles. The answer is you can only delete
articles that you have created yourself and which are not older than 10 minutes.
To see the **delete** button in articles of a communication type (emails, calls),
To see the ``delete`` button in articles of a communication type (emails, calls),
their visibility has to be switched to internal first.

.. figure:: /images/basics/work-with-tickets/delete-article.png
Expand Down
16 changes: 8 additions & 8 deletions basics/zammad-glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ CTI

Here you can find the fitting documentation pages:

* :admin-docs:`generic CTI </system/integrations/cti/generic.html>`
* :admin-docs:`placetel CTI </system/integrations/cti/placetel.html>`
* :admin-docs:`sipgate CTI </system/integrations/cti/sipgate.html>`
- :admin-docs:`generic CTI </system/integrations/cti/generic.html>`
- :admin-docs:`placetel CTI </system/integrations/cti/placetel.html>`
- :admin-docs:`sipgate CTI </system/integrations/cti/sipgate.html>`

Custom Development (CD)
We are constantly working on improving Zammad, and we keep adding new
Expand Down Expand Up @@ -432,7 +432,7 @@ Macro
An example of this is declaring a ticket as "spam".
The manual way here would be to assign an owner, set a status, and add the
tag "spam". Using a macro, all this can be done in just one action.
Macros can be used in the ticket zoom or within an overview
Macros can be used in the ticket detail view or within an overview
(using multiple selection).

Administrators can learn more about Macros
Expand Down Expand Up @@ -614,10 +614,10 @@ Sidebar
- One or more open tickets
- Bottom section:

- Avatar
- Reporting
- Admin settings
- Button for ticket creation
- Avatar
- Reporting
- Admin settings
- Button for ticket creation

Signature
The signature is your footer in an outgoing message.
Expand Down
2 changes: 1 addition & 1 deletion extras/ai-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ original text and the AI suggestion:
:alt: Screenshots shows AI suggestion dialog
:align: center

Click on the **Approve** button to accept the changes and to insert it in the
Click on the ``Approve`` button to accept the changes and to insert it in the
article. After accepting the suggestion, you can still edit the text in the
article editor.

Expand Down
6 changes: 3 additions & 3 deletions extras/caller-log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ will also help you during answering calls.
New Ticket dialog
Zammad will open a new ticket dialogue if:

* it's able to either guess a single user (see `maybe entries`_)
* the callers number belongs to a user known to Zammad
* the callers number is yet unknown
- it's able to either guess a single user (see `maybe entries`_)
- the callers number belongs to a user known to Zammad
- the callers number is yet unknown

If the user is known to Zammad it will automatically set the ticket
customer for you. You can correct this at any time if needed.
Expand Down
10 changes: 5 additions & 5 deletions extras/chat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ Overview
be able to initiate a chat.

Usage tips
* 🔍 Use the :ref:`search bar <search-tickets>` to pull up old chats from the archive anytime.
* 📋 Copy & paste **supports 🌄 inline images** as well as plain text.
* ⌨️ Live chat supports :admin-docs:`text modules </manage-text-modules.html>`.
* 📝 Chats can be **renamed** or **tagged**, and record technical details about
- 🔍 Use the :ref:`search bar <search-tickets>` to pull up old chats from the archive anytime.
- 📋 Copy & paste **supports 🌄 inline images** as well as plain text.
- ⌨️ Live chat supports :admin-docs:`text modules </manage-text-modules.html>`.
- 📝 Chats can be **renamed** or **tagged**, and record technical details about
the customer's connection.

.. figure:: /images/extras/chat-details.png
Expand All @@ -66,7 +66,7 @@ Once your chat is over, you can create a ticket for it with a single click:
:alt: Completed chat window
:align: center

The **Turn chat into ticket** button appears as soon as the chat is finished.
The ``Turn chat into ticket`` button appears as soon as the chat is finished.

.. figure:: /images/extras/chat-new-ticket-dialog.jpg
:alt: New ticket view
Expand Down
4 changes: 2 additions & 2 deletions extras/customers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Customers
=========

Use the **ticket pane** to view and manage customer profiles.
Use the **ticket sidebar** to view and manage customer profiles.

Overview
--------
Expand All @@ -10,7 +10,7 @@ Overview
:alt: Ticket pane (customer view)
:align: center

Click the 👨 tab in the ticket pane to see the customer's profile.
Click the 👨 tab in the ticket sidebar to see the customer's profile.

If the customer has other tickets too, you can see a summary when you
hover over the **open/closed** labels:
Expand Down
8 changes: 4 additions & 4 deletions extras/github-gitlab-integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GitHub / GitLab Integration
With issue tracker integration,
you can monitor GitHub / GitLab issues right from within a Zammad ticket.

This feature is **optional**; if you don't see it in the ticket pane,
This feature is **optional**; if you don't see it in the ticket sidebar,
that means your administrator hasn't enabled it yet.
Administrators can learn more
:admin-docs:`here </system/integrations.html#integrations-for-issue-trackers>`.
Expand All @@ -13,21 +13,21 @@ Administrators can learn more
:alt: Ticket detail view showing activated GitHub & GitLab function
:align: center

Use the |github| and |gitlab| tabs on the ticket pane
Use the |github| and |gitlab| tabs on the ticket sidebar
for an overview of issues related to the ticket.

What Can It Do?
---------------

View related issues
Use the |github| and |gitlab| tabs on the ticket pane to see linked issues,
Use the |github| and |gitlab| tabs on the ticket sidebar to see linked issues,
along with metadata like status (open/closed), assignee, labels, and more.
Or, simply click the title to view the issue on GitHub / GitLab.

A badge on the tab icon indicates how many issues are linked to this ticket.

Link a new issue
At the top of the ticket pane, select **GitHub / GitLab > Link Issue**,
At the top of the ticket sidebar, select **GitHub / GitLab > Link Issue**,
then enter a valid issue URL. Please note that linking a new issue can be
slow sometimes.

Expand Down
8 changes: 4 additions & 4 deletions extras/i-doit-track-company-property.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ So How Does It Work?
In Zammad: Link i-doit Assets To Tickets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

First, add i-doit assets to a ticket in the ticket pane:
First, add i-doit assets to a ticket in the ticket sidebar:

.. figure:: /images/extras/i-doit-track-company-property/add-ticket-with-idoit-asset_via-zammad.gif
:alt: (Screencast) Create a new ticket and link it to an i-doit asset
Expand All @@ -54,7 +54,7 @@ Once assets have been linked to a ticket, they can be accessed directly from the
:alt: (Screencast) Access an i-doit asset directly from the Zammad ticket view
:align: center

Click on a linked asset in the ticket pane to open its page in i-doit.
Click on a linked asset in the ticket sidebar to open its page in i-doit.

In i-doit: List & Create Tickets For a Given Asset
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -67,7 +67,7 @@ a list of all the tickets associated with each asset:
:align: center

Click the 💬 in the toolbar to list an asset's tickets.
Use the **🔗 Open in ticketsystem** button to open the ticket in Zammad.
Use the ``🔗 Open in ticketsystem`` button to open the ticket in Zammad.

You can even launch Zammad's new ticket dialog directly from i-doit,
with the asset already linked for you:
Expand All @@ -76,5 +76,5 @@ with the asset already linked for you:
:alt: (Screencast) Launch the new ticket dialog from within i-doit
:align: center

Use the **📄 Create ticket** button in the asset ticket list
Use the ``📄 Create ticket`` button in the asset ticket list
to start a new, pre-linked ticket dialog.
Loading
Loading