Skip to content

Commit bf6bdb6

Browse files
authored
Fixes # 235 - Cleaning info/note containers without losing information (backport)
1 parent 31f6509 commit bf6bdb6

27 files changed

+1306
-1478
lines changed

advanced/keyboard-shortcuts.rst

+32-31
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,21 @@ Keyboard Shortcuts
66
Zammad supports a wide array of keyboard shortcuts to expedite your workflow as
77
an expert user. But don't be afraid, you don't have to remember all of them.
88

9-
.. tip:: **🤓 Have a look here to find the keyboard shortcuts**
9+
Where to find them?
10+
-------------------
1011

11-
Click on your avatar at the bottom of the main menu to access the
12-
**keyboard shortcuts cheat sheet**.
12+
Click on your avatar at the bottom of the main menu to access the
13+
**keyboard shortcuts cheat sheet**.
1314

14-
.. figure:: /images/advanced/profile-shortcuts.png
15-
:alt: User submenu
16-
:align: center
17-
:scale: 85%
15+
.. figure:: /images/advanced/profile-shortcuts.png
16+
:alt: User submenu
17+
:align: center
18+
:scale: 85%
1819

19-
Alternately, open it with one of the shortcuts below:
20+
Alternatively, open it with one of the shortcuts below:
2021

21-
* ``ctrl`` + ``shift`` + ``h`` (on Linux and Windows)
22-
* ``cmd`` + ``ctrl`` + ``shift`` + ``h`` (on macOS)
22+
* ``ctrl`` + ``shift`` + ``h`` (on Linux and Windows)
23+
* ``cmd`` + ``ctrl`` + ``shift`` + ``h`` (on macOS)
2324

2425
This will open an overview of available keyboard-shortcuts as in the following
2526
screenshot:
@@ -100,7 +101,7 @@ Key / key combination Function
100101
Text Editing
101102
^^^^^^^^^^^^
102103

103-
.. tip::
104+
How
104105
You can apply a text format *before* typing or *after* typing. Example:
105106

106107
Before typing:
@@ -115,24 +116,24 @@ Text Editing
115116
* click-and-drag with the mouse to select it, and
116117
* press ``cmd`` + ``i`` to set the text in *italics*.
117118

118-
119-
==================================== =============================================================
120-
Key / key combination Function
121-
==================================== =============================================================
122-
``ctrl`` + ``u`` Format text underlined
123-
``ctrl`` + ``b`` Format text in **bold**
124-
``ctrl`` + ``i`` Format text in *italics*
125-
``ctrl`` + ``s`` Format text as ̶s̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶
126-
``ctrl`` + ``v`` Paste text from clipboard
127-
``ctrl`` + ``shift`` + ``v`` Paste text from clipboard (as plain text)
128-
``shift`` + ``ctrl`` + ``f`` Remove formatting of text
129-
``shift`` + ``ctrl`` + ``y`` Remove formatting of the whole text
130-
``shift`` + ``ctrl`` + ``z`` Insert a horizontal line
131-
``shift`` + ``ctrl`` + ``l`` Format as unordered list
132-
``shift`` + ``ctrl`` + ``k`` Format as ordered list
133-
``shift`` + ``ctrl`` + ``1`` Format as h1 heading
134-
``shift`` + ``ctrl`` + ``2`` Format as h2 heading
135-
``shift`` + ``ctrl`` + ``3`` Format as h3 heading
136-
``shift`` + ``ctrl`` + ``x`` Remove any hyperlink
137-
==================================== =============================================================
119+
Key Combinations
120+
============================== =============================================
121+
Key / key combination Function
122+
============================== =============================================
123+
``ctrl`` + ``u`` Format text underlined
124+
``ctrl`` + ``b`` Format text in **bold**
125+
``ctrl`` + ``i`` Format text in *italics*
126+
``ctrl`` + ``s`` Format text as ̶s̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶
127+
``ctrl`` + ``v`` Paste text from clipboard
128+
``ctrl`` + ``shift`` + ``v`` Paste text from clipboard (as plain text)
129+
``shift`` + ``ctrl`` + ``f`` Remove formatting of text
130+
``shift`` + ``ctrl`` + ``y`` Remove formatting of the whole text
131+
``shift`` + ``ctrl`` + ``z`` Insert a horizontal line
132+
``shift`` + ``ctrl`` + ``l`` Format as unordered list
133+
``shift`` + ``ctrl`` + ``k`` Format as ordered list
134+
``shift`` + ``ctrl`` + ``1`` Format as h1 heading
135+
``shift`` + ``ctrl`` + ``2`` Format as h2 heading
136+
``shift`` + ``ctrl`` + ``3`` Format as h3 heading
137+
``shift`` + ``ctrl`` + ``x`` Remove any hyperlink
138+
============================== =============================================
138139

advanced/macros.rst

+4-8
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ If you find yourself making the same changes to lots of tickets
77
(*e.g.,* close-and-tag-as-spam or reassign-to-another-group),
88
macros can make the job a whole lot easier.
99

10-
.. note:: 🤔 **How do I make macros?**
10+
Macros can be created by your :admin-docs:`administrator </manage/macros.html>`.
11+
If you have an idea for a macro you'd like to use, your Zammad admin can
12+
probably make it happen.
1113

12-
You don't - that's the
13-
:admin-docs:`administrator's job </manage/macros.html>`.
14-
If you have an idea for a macro you'd like to use,
15-
your Zammad admin can probably make it happen.
16-
17-
Macros can be applied in one of two ways:
18-
on a single ticket, or in bulk.
14+
Macros can be applied in two ways: on a single ticket, or in bulk.
1915

2016
On a Single Ticket
2117
------------------

advanced/search.rst

+19-32
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Advanced Search
22
===============
33

4-
With Zammad, you can limit your search to specific Information.
5-
This allows you to find e.g. Tickets with specific key words and states.
4+
With Zammad, you can limit your search to specific attributes.
5+
This allows you to find e.g. tickets with specific key words and states.
66
Below information will help you to improve your search results.
77

8-
For instance you can search for a specific customer
8+
For instance you can search for a specific customer
99
by using ``customer.attribute``::
1010

1111
customer.firstname: John
@@ -15,29 +15,15 @@ or::
1515
customer.lastname: Doe
1616

1717

18-
If you want to run a more complex search you can use conditions
18+
If you want to run a more complex search, you can use conditions
1919
with ``()`` and ``AND``/``OR`` options::
2020

2121
state.name: open AND (article.from:me OR article.from:somebody)
2222

23-
.. note:: **🤓 Search phrases changed for Zammad 4.0**
24-
25-
With Zammad <=3.6 the following keys contained a string only:
26-
27-
* group
28-
* priority
29-
* state
30-
* organization
31-
32-
With Zammad >=4.0 these keys contain the whole object. This means you
33-
now have to add ``.name`` (e. g. ``group.name`` or ``priority.name``)
34-
to receive the same search results.
35-
36-
3723
Available attributes
3824
--------------------
3925

40-
.. hint::
26+
.. hint::
4127

4228
For a more detailed list of available attributes please take a look into our
4329
:docs:`Zammad System Documentation </install/elasticsearch/indexed-attributes.html>`.
@@ -57,20 +43,21 @@ Available attributes
5743
"article_count", "5 |br|\ [5 TO 10] |br|\ [5 TO \*] |br|\ [\* TO 5]", "article_count:5 |br|\ article_count: [5 TO 10] |br|\ article_count:[5 TO \*] |br|\ article_count:[\* TO 5]", "You can search for Tickets with a specific number of articles (you can even search for everything with 5 or more articles or even up to 5 articles, if needed)."
5844
"article.from", "\*bob\*", "article.from:\*bob\*", "Show all tickets that contain articles from ""Bob"""
5945
"article.body", "heat |br|\ heat~ |br|\ /joh?n(ath[oa]n)/", "article.body:heat |br|\ article.body:heat~ |br|\ articlebody:/joh?n(ath[oa]n)/", "First example shows every ticket containing the word ""heat"" - you can also use the fuzzy operator ""~"" to search for similar words like e.g. like ""head"". Zammad will also allow you to use regular expressions, where ever the attributes allows it."
60-
61-
.. hint:: **Combining search phrases**
62-
63-
You can combine search phrases by using ``AND``, ``OR`` and ``TO``,
64-
depending on the situation and phrases you use. If needed, you can parts of
65-
your search phrase for complex searches with ``()``. This allows you to
66-
combine several phrases with different dependencies (AND/OR). In case you
67-
receive search results that you want to exclude, you can use negation ``!``.
68-
Below are some examples that you could use with this:
69-
70-
.. csv-table:: Examples for search phrase combinations
46+
47+
Combining search phrases
48+
------------------------
49+
50+
You can combine search phrases by using ``AND``, ``OR`` and ``TO``,
51+
depending on the situation and phrases you use. If needed, you can parts of
52+
your search phrase for complex searches with ``()``. This allows you to
53+
combine several phrases with different dependencies (AND/OR). In case you
54+
receive search results that you want to exclude, you can use negation ``!``.
55+
Below are some examples that you could use with this:
56+
57+
.. csv-table:: Examples for search phrase combinations
7158
:header: "Search phrase", "Description"
7259
:widths: 10, 20
73-
60+
7461
"state.name:(closed OR open) AND (priority.name:""2 normal"" OR tags:feedback)", "Show every ticket that state is either closed or open and has priority normal or the tag feedback."
7562
"state.name:(closed OR open) AND (priority.name:""2 normal"" OR tags:feedback) AND !(*Zammad*)", "This gets the same result as above, expect that we don't want the ticket to contain anything matching to ""Zammad"""
7663
"owner.email:bob@example.net AND state.name:(open OR new)", "Show Tickets from bob@example.net that are either open or new"
@@ -91,7 +78,7 @@ Ticket attributes
9178
* state: object (state.name, ...)
9279
* organization: object (organization.name, ...)
9380
* owner: object (owner.firstname, owner.lastname, owner.email, ...)
94-
* customer: object
81+
* customer: object
9582
(customer.firstname, customer.lastname, customer.email, ...)
9683
* first_response_at: timestamp
9784
* first_response_in_min: integer (business min till first response)

advanced/suggested-workflows.rst

+33-34
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ In these cases, there are three ways to assign the work to the right people:
1313
1. If a ticket is really about two different problems,
1414
you can :doc:`split it in two </advanced/ticket-actions/split>`,
1515
then assign each ticket to its respective “group” (department).
16-
2. If youve done all you can on a ticket
17-
and its now another agents (or departments) responsibility,
16+
2. If you've done all you can on a ticket
17+
and it's now another agent's (or department's) responsibility,
1818
**reassign it** to a new owner (or group).
19-
3. If you just need another agents input on something, you can **@mention**
20-
them. (And if *you* want to get notifications for *someone elses* ticket,
19+
3. If you just need another agent's input on something, you can **@mention**
20+
them. (And if *you* want to get notifications for *someone else's* ticket,
2121
use the **subscribe button**.)
2222

2323
Reassigning tickets
@@ -28,15 +28,15 @@ Reassigning tickets
2828
:align: center
2929

3030
Reassign a ticket (via the *Group* and *Owner* settings)
31-
to let colleagues know youre done with your part.
31+
to let colleagues know you're done with your part.
3232

3333
Suppose a call comes into the sales department.
3434
A sales rep takes the call, creates a ticket,
3535
and looks up some prices for the customer.
3636
After recording his notes,
3737
the rep then decides that this ticket needs to be passed onto customer service.
3838

39-
Our sales rep can simply un-assign himself has the **owner** of the ticket
39+
Our sales rep can simply un-assign himself as the **owner** of the ticket
4040
and re-assign the ticket to the Customer Service **group**.
4141
*All customer service agents will be notified of the incoming ticket*,
4242
and the first available agent can assign herself
@@ -52,23 +52,23 @@ to pick up where the sales rep left off.
5252
@mentions & the Subscribe Button
5353
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5454

55-
Now suppose youve reassigned the ticket to customer service.
56-
You wont receive notifications for this ticket anymore,
55+
Now suppose you've reassigned the ticket to customer service.
56+
You won't receive notifications for this ticket anymore,
5757
but maybe this is a really important contract,
5858
and you want to make sure they have an A+ experience from start to finish.
5959

60-
To enable notifications for a ticket that doesnt belong to you,
60+
To enable notifications for a ticket that doesn't belong to you,
6161
simply click the **Subscribe** button at the bottom of the ticket pane:
6262

6363
.. figure:: /images/advanced/suggested-workflows/mention-subscribe-yourself-to-a-ticket.gif
6464
:alt: Screencast of the Subscribe button feature
6565
:width: 90%
6666
:align: center
6767

68-
A list of all tickets youre subscribed to
68+
A list of all tickets you're subscribed to
6969
can be found in the **My mentioned Tickets** overview.
7070

71-
Or, suppose you *dont* want to reassign the ticket to customer service—you
71+
Or, suppose you *don't* want to reassign the ticket to customer service—you
7272
just have one quick question for them, and then you can take it from there.
7373

7474
To start sending someone else notifications for your own ticket,
@@ -82,12 +82,14 @@ type ``@@`` in the message composer and select their name from the pop-up menu:
8282
@mentioning a colleague in a message
8383
will automatically subscribe them to your ticket.
8484

85-
.. hint:: ⚙️ Check your :doc:`/extras/profile-and-settings`
85+
.. hint:: ⚙️ **Notification settings**
86+
87+
Check your :doc:`/extras/profile-and-settings`
8688
to customize how you receive notifications.
8789

88-
.. note:: 😖 **A colleague @mentioned me, but I don’t see the ticket!**
90+
**Can't see a ticket, in which a colleague @mentioned you?**
8991

90-
Is the ticket assigned to a group that you dont belong to?
92+
Is the ticket assigned to a group that you don't belong to?
9193
@mentions and subscriptions only work for tickets that you already have
9294
access to.
9395

@@ -102,35 +104,32 @@ This means you can adjust the following ticket information:
102104
* state (with pending time if applicable)
103105
* priority
104106

105-
After pressing "Confirm" Zammad also allows you to provide an internal or
107+
After pressing "Confirm", Zammad also allows you to provide an internal or
106108
public note of why you adjusted the settings.
107109

108-
.. note::
109-
110-
Zammad *will not* ask for
111-
:doc:`time accounting values </advanced/time-accounting>`
112-
in these situations.
110+
Zammad *will not* ask for
111+
:doc:`time accounting values </advanced/time-accounting>` in bulk actions.
113112

114-
.. figure:: /images/advanced/suggested-workflows/bulk-operations-on-ticket-lists.gif
115-
:alt: Bulk operations in overviews and detailed searches
116-
:align: center
113+
Bulk action via drop-downs:
114+
.. figure:: /images/advanced/suggested-workflows/bulk-operations-on-ticket-lists.gif
115+
:alt: Bulk operations in overviews and detailed searches
116+
:align: center
117117

118-
Use the check boxes in ticket listings to select a bunch of tickets.
119-
Now use below drop-downs to change ticket settings, press confirm and
120-
provide a note if you'd like.
118+
Use the check boxes in ticket listings to select a bunch of tickets.
119+
Now use below drop-downs to change ticket settings, press confirm and
120+
provide a note if you'd like.
121121

122-
.. tip:: **🤓 You can change owners and groups even faster 🚀**
122+
Bulk action via drag and drop:
123+
**🤓 You can change owners and groups even faster 🚀**
123124

124125
.. figure:: /images/advanced/suggested-workflows/drag-bulk-operation_assign-owner.gif
125126
:alt: Drag selected tickets and drop then on a group or agent to change
126127
ticket group / owner
127128
:align: center
128129

129-
Instead of using the drop-downs on the bottom of Zammad, you can also
130-
drag tickets. A new modal will appear and allow you to drop your
131-
selection on either just a group or agents. This operation allows you to
132-
quickly change the group and owner without further hassle!
133-
134-
.. note::
130+
Instead of using the drop-downs on the bottom of Zammad, you can also
131+
drag tickets. A new modal will appear and allow you to drop your
132+
selection on either just a group or agents. This operation allows you to
133+
quickly change the group and owner without further hassle!
135134

136-
This functionality is only available in ticket overviews.
135+
This functionality is only available in ticket overviews.

0 commit comments

Comments
 (0)