Fixes #423 - Reduced info/note/hint/warning containers (without losin…

…g information)

admin/console.rst

@@ -6,7 +6,7 @@ Zammad uses Ruby on Rails so you can make use of the `rails console`_.
 .. _rails console:
    http://guides.rubyonrails.org/command_line.html
 
-.. warning:: 
+.. warning::
 
    Please double check your commands before running, as some of those commands
    might cause data loss or damaged tickets! If you're unsure,

admin/console/working-on-tickets.rst

@@ -53,7 +53,7 @@ Get ticket state types
 
 This will show all state types needed for creating new ticket states.
 
-.. tip:: **😖 What are state types?**
+.. tip:: **What are state types?**
 
    Zammad uses state types to know what it should do with your state.
    This allows you to have different types like *pending actions*,
@@ -63,6 +63,9 @@ This will show all state types needed for creating new ticket states.
    You can learn more about that
    :user-docs:`in our user documentation </basics/service-ticket/settings/state.html>`.
 
+   If you want to add custom states, have a look in our
+   :admin-docs:`admin documentation section </system/objects.html#system-attributes>`.
+
 .. code-block:: ruby
 
    >> Ticket::StateType.pluck(:id, :name)

admin/console/working-on-users.rst

@@ -55,11 +55,11 @@ If needed, you can simply change the Email address of the user.
    Please note that the login attribute is not affected by this and Zammad thus
    might show different information within the UI.
 
-   .. code-block:: ruby
+.. code-block:: ruby
 
-      >> u = User.find(**USERID**)
-      >> u.email = 'user@exmaple.com'
-      >> u.save!
+   >> u = User.find(**USERID**)
+   >> u.email = 'user@exmaple.com'
+   >> u.save!
 
 
 You need to find the user ID of the user first for this.

admin/console/zammad-settings.rst

@@ -19,10 +19,10 @@ FQDN setting
 
 Get the current FQDN setting of Zammad and, if needed, adjust it.
 
-   .. note::
+.. note::
 
-      This setting has no effect on SSL certificates or any web server
-      configurations.
+   This setting has no effect on SSL certificates or any web server
+   configurations.
 
 .. code-block:: ruby
 
@@ -35,16 +35,16 @@ HTTP(s) setting
 This setting indirectly belongs to your FQDN setting and is relevant for
 variable based URLs (e.g. in notifications) Zammad generated.
 
-   .. warning::
+.. warning::
 
-      This setting also affects Zammad's CSRF token behavior.
-      If you set this setting to e.g. HTTPs but you're using HTTP,
-      *logging in will fail*!
+   This setting also affects Zammad's CSRF token behavior.
+   If you set this setting to e.g. HTTPs but you're using HTTP,
+   *logging in will fail*!
 
-      .. note::
+.. note::
 
-         This setting has no effect on SSL certificates or any web server
-         configurations.
+   This setting has no effect on SSL certificates or any web server
+   configurations.
 
 .. code-block:: ruby
 
@@ -65,12 +65,10 @@ Use the following command
    >> Setting.get('storage_provider')        # get the current Attachment-Storage
    >> Setting.set('storage_provider', 'DB')  # Change Attachment-Storage to database
 
-.. tip::
+The following settings are available in a default installation:
 
-   The following settings are available in a default installation:
-
-      * ``DB`` (database)
-      * ``File`` (Filesystem (``/opt/zammad/storage/``))
+   * ``DB`` (database)
+   * ``File`` (Filesystem (``/opt/zammad/storage/``))
 
 Configuring Elasticsearch
 -------------------------

api/generic-cti/answer-event.rst

@@ -1,8 +1,6 @@
 Call answered
 =============
 
-.. include:: /api/generic-cti/cti-endpoint-limitations.include.rst
-
 .. list-table:: Available attributes and sample data for answered events
    :widths: 20, 40, 40
    :header-rows: 1

api/generic-cti/generic-cti_context-note-configuration.include.rst

@@ -1,13 +1,14 @@
-.. note:: **🤔 For your context**
-
+**Example:**
    Below calls have been sent with the following configuration.
    This is important for *you* to understand the returns we're showing here.
 
-      Outbound
-         * Destination caller ID ``4989*`` set outbound caller ID
-           ``498999998145`` with note "All from munich"
-         * Destination caller ID ``4930*`` set outbound caller ID
-           ``493023125877`` "All from Berlin"
+   **Outbound:**
+
+   * Destination caller ID ``4989*`` set outbound caller ID
+     ``498999998145`` with note "All from munich"
+   * Destination caller ID ``4930*`` set outbound caller ID
+     ``493023125877`` "All from Berlin"
+
+   **Other settings:**
 
-      Other settings
-         * Default caller ID for outbound calls ``496990009111``
+   * Default caller ID for outbound calls ``496990009111``

api/generic-cti/hangup-event.rst

@@ -1,8 +1,6 @@
 Call hangup
 ===========
 
-.. include:: /api/generic-cti/cti-endpoint-limitations.include.rst
-
 .. list-table:: Available attributes and sample data for hangup events
    :widths: 20, 40, 40
    :header-rows: 1
@@ -34,7 +32,7 @@ Call hangup
      - .. list-table::
           :widths: 10, 30
           :header-rows: 1
-          
+
           * - Cause type
             - Description
           * - ``normalClearing``
@@ -171,7 +169,7 @@ There's two options on how to ``POST`` the relevant data to Zammad.
                {}
 
          Sample curl command:
-         
+
             .. code-block:: sh
 
                $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
@@ -202,7 +200,7 @@ There's two options on how to ``POST`` the relevant data to Zammad.
                {}
 
          Sample curl command:
-         
+
             .. code-block:: sh
 
                $ curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \

api/generic-cti/index.rst

@@ -3,36 +3,36 @@ Generic CTI
 
 This page describes the generic CTI API scopes and functionalities.
 
+.. include:: /api/generic-cti/cti-endpoint-limitations.include.rst
+
 Features
    Here's a small condensed list of the possibilities this CTI API provides.
 
    Inbound
       * :user-docs:`Caller log functions </extras/caller-log.html>` for your
         agents.
-      * Blocking of CallerIDs during signaling. *
+      * Blocking of CallerIDs during signaling.
 
    Outbound
       * :user-docs:`Caller log functions </extras/caller-log.html>` for your
         agents.
       * Set outbound caller IDs depending on the caller ID target.
 
-.. include:: /api/generic-cti/cti-endpoint-limitations.include.rst
-
 Endpoint
    The endpoint can be found in the generic CTI integration and contains a
    unique token which acts as authentication. Make sure to keep this endpoint
    URL safe.
 
-      .. hint::
+   .. hint::
 
-         Generic CTI configuration and the correct endpoint can be found in your
-         Zammad integration settings and are documented in our
-         :admin-docs:`admin documentation </system/integrations/cti/generic.html>`.
+      Generic CTI configuration and the correct endpoint can be found in your
+      Zammad integration settings and are documented in our
+      :admin-docs:`admin documentation </system/integrations/cti/generic.html>`.
 
-         | Please also note the there listed requirements and limitations.
-         | All options that require returns (e.g. blocking, manipulating
-           outgoing caller IDs) rely on configurations within the Zammad CTI
-           integration page.
+      | Please also note the there listed requirements and limitations.
+      | All options that require returns (e.g. blocking, manipulating
+        outgoing caller IDs) rely on configurations within the Zammad CTI
+        integration page.
 
 Events
    There are several events in terms of an ongoing call.

api/generic-cti/newcall-event.rst

@@ -1,8 +1,6 @@
 New call
 ========
 
-.. include:: /api/generic-cti/cti-endpoint-limitations.include.rst
-
 .. list-table:: Available attributes and sample data for newCall events
    :widths: 20, 40, 40
    :header-rows: 1

api/intro.rst

@@ -23,11 +23,8 @@ endpoints listed here.
    * `Android API-Client <https://github.com/KirkBushman/zammad-android>`_ 
      *(Third-Party)*
    * `Go Client <https://github.com/AlessandroSechi/zammad-go>`_
-     *(Third-Party)*
-
-      .. note:: 
+     *(Third-Party; API client only, no "ready to use" App)*
 
-         Please note that this is a API client only, it's no "ready to use" App.
 
 Authentication
 ==============
@@ -561,14 +558,12 @@ may have to use pagination at some points.
 
    .. note::
 
-      Number of returned objects
-         Zammad has hard limits for the maximum returned objects.
-         You can't raise these limits.
+      **Number of returned objects:** Zammad has hard limits for the maximum
+      returned objects. You can't raise these limits.
 
-      Number of total to return objects
-         Zammad does not provide a total count of objects available for your
-         query. This forces you to cycle through the pages until Zammad no
-         longer returns further objects.
+      **Number of total to return objects:** Zammad does not provide a total
+      count of objects available for your query. This forces you to cycle
+      through the pages until Zammad no longer returns further objects.
 
 In order to use pagination you'll need two get options:
 ``per_page`` and ``page``. Combine them like so to receive 5 results from
@@ -600,10 +595,8 @@ order_by
 Actions on behalf of other users
 ================================
 
-.. note::
-
-   The user used for running the on behalf query requires ``admin.user``
-   permission.
+**Requirement:** the user used for running the query on behalf requires
+``admin.user`` permission.
 
 Running API queries on behalf of other users allows you to e.g. create tickets
 on behalf of the user. The UI will display these kind of operations much better.

api/notification.rst

@@ -13,10 +13,10 @@ List
 
 Required permission: ``any``
 
-   .. tip::
+.. tip::
 
-      Use the expand request to know the affected objects.
-      Other wise you'll need to find out what ID stands for which object type.
+   Use the expand request to know the affected objects.
+   Otherwise you'll need to find out what ID stands for which object type.
 
 ``GET``-Request sent: ``/api/v1/online_notifications?expand=true``
 

api/object.rst

@@ -417,7 +417,7 @@ Response:
          "object": "Ticket",
          "deletable": false
       },
-      
+
       [ ... ]
    ]
 
@@ -548,7 +548,7 @@ Required permission: ``admin.object``
                }
             }
          }
-         
+
 
       Response:
 
@@ -1525,15 +1525,13 @@ Update
 
 Required permission: ``admin.object``
 
-.. tip::
+Except on the request method, payloads or updating and creating objects are
+identical. For full payload samples thus scroll up to :ref:`create_object`.
 
-   Except on the request method, payloads or updating and creating objects are
-   identical. For full payload samples thus scroll up to :ref:`create_object`.
-
-   Zammad will return two attributes during update: ``data_option`` and
-   ``data_option_new``. The first attribute contains the current active values
-   and the second one the new to be values
-   (they'll become active after executing the database migrations).
+Zammad will return two attributes during update: ``data_option`` and
+``data_option_new``. The first attribute contains the current active values
+and the second one the new to be values
+(they'll become active after executing the database migrations).
 
 ``PUT``-Request sent: ``/api/v1/object_manager_attributes/{id}``
 
@@ -1545,7 +1543,7 @@ Required permission: ``admin.object``
       "object": "Ticket",
       "display": "Sample Boolean",
       "data_type": "boolean",
-      "position": 1200, 
+      "position": 1200,
       "data_option": {
          "options": {
             "true": "yes",

api/organization.rst

@@ -6,10 +6,10 @@ List
 
 Required permission: ``ticket.agent`` **or** ``admin.organization``
 
-   .. note::
+.. note::
 
-      Technically, customers can only see their own organization
-      if applicable.
+   Technically, customers can only see their own organization
+   if applicable.
 
 ``GET``-Request sent: ``/api/v1/organizations``
 
@@ -180,9 +180,9 @@ Show
 
 Required permission: ``ticket.agent`` **or** ``admin.organization``
 
-   .. note::
+.. note::
 
-      Technically any users in question can only see their own organization.
+   Technically, any users in question can only see their own organization.
 
 ``GET``-Request sent: ``/api/v1/organizations/{id}``