diff --git a/images/system/objects/object-types-translatable.png b/images/system/objects/object-types-translatable.png new file mode 100644 index 00000000..5e3efb7a Binary files /dev/null and b/images/system/objects/object-types-translatable.png differ diff --git a/locale/admin-docs.pot b/locale/admin-docs.pot index 1b048172..8a3092e9 100644 --- a/locale/admin-docs.pot +++ b/locale/admin-docs.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Zammad pre-release\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-08-17 14:49+0200\n" +"POT-Creation-Date: 2023-08-21 15:26+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -340,7 +340,7 @@ msgstr "" #: ../channels/email/accounts/secondary-addresses.rst:35 #: ../channels/email/accounts/secondary-addresses.rst:35 #: ../manage/groups/settings.rst:67 -#: ../system/objects/types.rst:125 +#: ../system/objects/types.rst:145 msgid "Email" msgstr "" @@ -404,7 +404,7 @@ msgid "Email Inbound" msgstr "" #: ../channels/email/accounts/account-setup.rst:113 -#: ../system/objects/types.rst:128 +#: ../system/objects/types.rst:148 msgid "Type" msgstr "" @@ -10831,7 +10831,7 @@ msgid "``A`` added with enter/tab, ``B`` and ``C`` separated with comma (resulti msgstr "" #: ../misc/object-conditions/basics.rst:397 -#: ../system/objects/types.rst:113 +#: ../system/objects/types.rst:133 msgid "Textarea field" msgstr "" @@ -10844,7 +10844,7 @@ msgid "Available matching: *contains*, *contains not* or *has changed*" msgstr "" #: ../misc/object-conditions/basics.rst:403 -#: ../system/objects/types.rst:16 +#: ../system/objects/types.rst:36 msgid "Boolean field" msgstr "" @@ -10853,7 +10853,7 @@ msgid "Check if any field of type boolean is true (or not)?" msgstr "" #: ../misc/object-conditions/basics.rst:409 -#: ../system/objects/types.rst:57 +#: ../system/objects/types.rst:77 msgid "Integer field" msgstr "" @@ -10862,7 +10862,7 @@ msgid "Check if any field of type integer has a specific value (or not)?" msgstr "" #: ../misc/object-conditions/basics.rst:415 -#: ../system/objects/types.rst:26 +#: ../system/objects/types.rst:46 msgid "Date field" msgstr "" @@ -11079,7 +11079,7 @@ msgid "To help you understand the time conditions of Zammad better, below diagra msgstr "" #: ../misc/object-conditions/basics.rst:557 -#: ../system/objects/types.rst:83 +#: ../system/objects/types.rst:103 msgid "Single selection field" msgstr "" @@ -11094,7 +11094,7 @@ msgid "Allows you to select one or more values of the attribute in question. Sel msgstr "" #: ../misc/object-conditions/basics.rst:574 -#: ../system/objects/types.rst:70 +#: ../system/objects/types.rst:90 msgid "Multiple selection field" msgstr "" @@ -11124,7 +11124,7 @@ msgid "*Matches if one specific given field value is not selected.*" msgstr "" #: ../misc/object-conditions/basics.rst:600 -#: ../system/objects/types.rst:145 +#: ../system/objects/types.rst:165 msgid "Single tree selection field" msgstr "" @@ -11134,7 +11134,7 @@ msgid "This attribute type technically allows several layers of values. You cann msgstr "" #: ../misc/object-conditions/basics.rst:622 -#: ../system/objects/types.rst:154 +#: ../system/objects/types.rst:174 msgid "Multiple tree selection field" msgstr "" @@ -17246,7 +17246,47 @@ msgstr "" msgid "You cannot change the object format / type as soon as it is applied. If you no longer need an object, consider disabling it instead of removing." msgstr "" -#: ../system/objects/types.rst:12 +#: ../system/objects/types.rst:11 +msgid "**What about the translation of my objects?**" +msgstr "" + +#: ../system/objects/types.rst:13 +msgid "For some object types you can decide if they should be translatable or not. To be precise, it works only for the selectable fields because the possible choices are known and limited. For the following object types, you can set the translatable flag:" +msgstr "" + +#: ../system/objects/types.rst:18 +msgid "*Boolean field*" +msgstr "" + +#: ../system/objects/types.rst:19 +msgid "*Single selection field*" +msgstr "" + +#: ../system/objects/types.rst:20 +msgid "*Multiple selection field*" +msgstr "" + +#: ../system/objects/types.rst:21 +msgid "*Single tree selection field*" +msgstr "" + +#: ../system/objects/types.rst:22 +msgid "*Multiple tree selection field*" +msgstr "" + +#: ../system/objects/types.rst:24 +msgid "For these types, you can find an additional field *Translate field contents*:" +msgstr "" + +#: ../system/objects/types.rst:0 +msgid "Screenshot showing translatable object types" +msgstr "" + +#: ../system/objects/types.rst:29 +msgid "Screenshot with example of translatable object type" +msgstr "" + +#: ../system/objects/types.rst:32 msgid "Provides a drop-down field with display values for ``true`` and ``false``. Allows setting a default value." msgstr "" @@ -17254,15 +17294,15 @@ msgstr "" msgid "Available settings for Boolean fields" msgstr "" -#: ../system/objects/types.rst:19 +#: ../system/objects/types.rst:39 msgid "Provides a date picker field and does not allow default values." msgstr "" -#: ../system/objects/types.rst:23 +#: ../system/objects/types.rst:43 msgid "Default time diff (hours)" msgstr "" -#: ../system/objects/types.rst:22 +#: ../system/objects/types.rst:42 msgid "This setting helps the user by highlighting the day from now plus the provided value. It *does not* pre-fill the field." msgstr "" @@ -17270,15 +17310,15 @@ msgstr "" msgid "Available settings for Date fields" msgstr "" -#: ../system/objects/types.rst:44 +#: ../system/objects/types.rst:64 msgid "Date & time field" msgstr "" -#: ../system/objects/types.rst:29 +#: ../system/objects/types.rst:49 msgid "Provides a date and time picker – does not allow default values" msgstr "" -#: ../system/objects/types.rst:33 +#: ../system/objects/types.rst:53 msgid "Allow future" msgstr "" @@ -17286,7 +17326,7 @@ msgstr "" msgid "Forbid dates and times in the future." msgstr "" -#: ../system/objects/types.rst:37 +#: ../system/objects/types.rst:57 msgid "Allow past" msgstr "" @@ -17294,11 +17334,11 @@ msgstr "" msgid "Forbid dates and times in the past." msgstr "" -#: ../system/objects/types.rst:41 +#: ../system/objects/types.rst:61 msgid "Default time diff (minutes)" msgstr "" -#: ../system/objects/types.rst:40 +#: ../system/objects/types.rst:60 msgid "This setting helps the user by highlighting the day from now plus the provided value. It does not pre-fill the field." msgstr "" @@ -17306,23 +17346,23 @@ msgstr "" msgid "Available settings for Date & time fields" msgstr "" -#: ../system/objects/types.rst:47 +#: ../system/objects/types.rst:67 msgid "Provides an input field that allows integer usage only. You may define a default value. You cannot enforce comma separation." msgstr "" -#: ../system/objects/types.rst:51 +#: ../system/objects/types.rst:71 msgid "Minimal" msgstr "" -#: ../system/objects/types.rst:51 +#: ../system/objects/types.rst:71 msgid "The minimal value the field accepts." msgstr "" -#: ../system/objects/types.rst:54 +#: ../system/objects/types.rst:74 msgid "Maximal" msgstr "" -#: ../system/objects/types.rst:54 +#: ../system/objects/types.rst:74 msgid "The maximum value the field accepts." msgstr "" @@ -17330,7 +17370,7 @@ msgstr "" msgid "Available settings for Integer fields" msgstr "" -#: ../system/objects/types.rst:60 +#: ../system/objects/types.rst:80 msgid "Provides a selection field that allows the selection of one or more out of several. This field does allow setting a default value." msgstr "" @@ -17338,7 +17378,7 @@ msgstr "" msgid "Available settings for Multiple selection fields" msgstr "" -#: ../system/objects/types.rst:73 +#: ../system/objects/types.rst:93 msgid "Provides a drop-down field that allows selection of one value out of several. This field does allow setting a default value." msgstr "" @@ -17346,37 +17386,37 @@ msgstr "" msgid "Available settings for Single selection fields" msgstr "" -#: ../system/objects/types.rst:86 +#: ../system/objects/types.rst:106 msgid "Provides a text area input field (multiple lines) and thus allows e.g. new lines. You can set a default field value." msgstr "" -#: ../system/objects/types.rst:91 +#: ../system/objects/types.rst:111 msgid "Please note that this field *does not* support text formatting or HTML content (rich text)." msgstr "" -#: ../system/objects/types.rst:94 +#: ../system/objects/types.rst:114 msgid "**🥵 This field can consume a lot of visual space**" msgstr "" -#: ../system/objects/types.rst:96 +#: ../system/objects/types.rst:116 msgid "Depending on where you use this field type, it may use a lot of visual space if you provide a lot of text. This may be an issue to work with." msgstr "" -#: ../system/objects/types.rst:101 +#: ../system/objects/types.rst:121 msgid "Default" msgstr "" -#: ../system/objects/types.rst:100 +#: ../system/objects/types.rst:120 msgid "The here provided text will be shown within the text area field or new data sets." msgstr "" -#: ../system/objects/types.rst:105 -#: ../system/objects/types.rst:131 +#: ../system/objects/types.rst:125 +#: ../system/objects/types.rst:151 msgid "Maxlength" msgstr "" #: ../system/objects/types.rst:0 -#: ../system/objects/types.rst:131 +#: ../system/objects/types.rst:151 msgid "You can pick the maximum length of the field." msgstr "" @@ -17384,7 +17424,7 @@ msgstr "" msgid "The default length of this object is ``500``." msgstr "" -#: ../system/objects/types.rst:110 +#: ../system/objects/types.rst:130 msgid "Rows" msgstr "" @@ -17400,31 +17440,31 @@ msgstr "" msgid "Available settings for Textarea fields" msgstr "" -#: ../system/objects/types.rst:136 +#: ../system/objects/types.rst:156 msgid "Text field" msgstr "" -#: ../system/objects/types.rst:116 +#: ../system/objects/types.rst:136 msgid "Provides a text field (one line) and allows choosing a default value." msgstr "" -#: ../system/objects/types.rst:119 +#: ../system/objects/types.rst:139 msgid "Defines the type of the input field. This allows e.g. your browser to ensure that you provide the specific type." msgstr "" -#: ../system/objects/types.rst:123 +#: ../system/objects/types.rst:143 msgid "Currently available:" msgstr "" -#: ../system/objects/types.rst:126 +#: ../system/objects/types.rst:146 msgid "Phone" msgstr "" -#: ../system/objects/types.rst:127 +#: ../system/objects/types.rst:147 msgid "Text" msgstr "" -#: ../system/objects/types.rst:128 +#: ../system/objects/types.rst:148 msgid "Url *(URL fields disable link-template availability)*" msgstr "" @@ -17432,7 +17472,7 @@ msgstr "" msgid "Available settings for Text fields" msgstr "" -#: ../system/objects/types.rst:139 +#: ../system/objects/types.rst:159 msgid "Provides a select-like field with up to 6 layers of options. Does not allow setting a default value." msgstr "" @@ -17441,43 +17481,43 @@ msgstr "" msgid "Available settings for Tree Select fields" msgstr "" -#: ../system/objects/types.rst:148 +#: ../system/objects/types.rst:168 msgid "Provides a select-like field with up to 6 layers of options allowing the selection of multiple values. Does not allow setting a default value." msgstr "" -#: ../system/objects/types.rst:159 +#: ../system/objects/types.rst:179 msgid "URL fields (Link-Template)" msgstr "" -#: ../system/objects/types.rst:163 +#: ../system/objects/types.rst:183 msgid "This function is restricted to Text and Select objects only." msgstr "" -#: ../system/objects/types.rst:165 +#: ../system/objects/types.rst:185 msgid "Link-Templates are an amazing way to dynamically generate URLs. They allow you to integrate other systems better without having to manually copy data from Zammad if possible." msgstr "" -#: ../system/objects/types.rst:171 +#: ../system/objects/types.rst:191 msgid "Another great way of communicating with another system may be Zammad's :doc:`Webhooks `." msgstr "" -#: ../system/objects/types.rst:174 +#: ../system/objects/types.rst:194 msgid "After filling a link-template enabled field, an URL icon will appear on its right. Clicking on the icon opens a new tab." msgstr "" -#: ../system/objects/types.rst:179 +#: ../system/objects/types.rst:199 msgid "Even though Zammad displays the link template within object edit and create screens, the function is optional. It's only active if you populate the field." msgstr "" -#: ../system/objects/types.rst:184 +#: ../system/objects/types.rst:204 msgid "What's the difference between URL and text fields with link template...?!" msgstr "" -#: ../system/objects/types.rst:186 +#: ../system/objects/types.rst:206 msgid "Both fields have different use cases. Use ``text`` type text fields when ever you have a *static* url that requires dynamic parameters. If you require a drag & drop like field that you can put in any URL, use ``URL`` type text fields." msgstr "" -#: ../system/objects/types.rst:191 +#: ../system/objects/types.rst:211 msgid "The difference is easier to spot when comparing the fields directly, below screencast shows the result - the dynamic approach uses existing values in the moment of updating to built the URL - e.g. ``https://google.com/search?q=cookies`` - while the URL approach uses the actual URL of the field - e.g. ``https://zammad.com``." msgstr "" @@ -17485,27 +17525,27 @@ msgstr "" msgid "Screencast showing the differents in between URL and text type fields with actual values" msgstr "" -#: ../system/objects/types.rst:203 +#: ../system/objects/types.rst:223 msgid "How does this work...?!" msgstr "" -#: ../system/objects/types.rst:205 +#: ../system/objects/types.rst:225 msgid "As an example, let's say you have an object called ``amazingobject`` - you want to open a google search directly with the input from that field." msgstr "" -#: ../system/objects/types.rst:208 +#: ../system/objects/types.rst:228 msgid "Providing below to the link-template field allows you to do so: ``https://www.google.com/search?q=#{ticket.amazingobject}``" msgstr "" -#: ../system/objects/types.rst:213 +#: ../system/objects/types.rst:233 msgid "You can use any :doc:`Zammad variable ` as long as it's available in the moment you need it." msgstr "" -#: ../system/objects/types.rst:216 +#: ../system/objects/types.rst:236 msgid "The result will look as follows." msgstr "" -#: ../system/objects/types.rst:221 +#: ../system/objects/types.rst:241 msgid "The above screencast shows how the link template will perform after object creation." msgstr "" diff --git a/system/objects/types.rst b/system/objects/types.rst index 1f4da51a..de6cf09a 100644 --- a/system/objects/types.rst +++ b/system/objects/types.rst @@ -3,11 +3,33 @@ Object types When adding a new object, you can choose between the following object types. -.. warning:: +.. warning:: You cannot change the object format / type as soon as it is applied. If you no longer need an object, consider disabling it instead of removing. +.. note:: **What about the translation of my objects?** + + For some object types you can decide if they should be translatable or not. + To be precise, it works only for the selectable fields because the possible + choices are known and limited. For the following object types, you can set + the translatable flag: + + * *Boolean field* + * *Single selection field* + * *Multiple selection field* + * *Single tree selection field* + * *Multiple tree selection field* + + For these types, you can find an additional field *Translate field contents*: + + .. figure:: /images/system/objects/object-types-translatable.png + :align: center + :alt: Screenshot showing translatable object types + :scale: 80% + + Screenshot with example of translatable object type + Boolean field Provides a drop-down field with display values for ``true`` and ``false``. Allows setting a default value. @@ -17,7 +39,7 @@ Boolean field Date field Provides a date picker field and does not allow default values. - + Default time diff (hours) This setting helps the user by highlighting the day from now plus the provided value. It *does not* pre-fill the field. @@ -46,7 +68,7 @@ Date & time field Integer field Provides an input field that allows integer usage only. You may define a default value. You cannot enforce comma separation. - + Minimal The minimal value the field accepts. @@ -158,7 +180,7 @@ Multiple tree selection field URL fields (Link-Template) -------------------------- -.. note:: +.. note:: This function is restricted to Text and Select objects only. @@ -174,7 +196,7 @@ manually copy data from Zammad if possible. After filling a link-template enabled field, an URL icon will appear on its right. Clicking on the icon opens a new tab. - .. hint:: + .. hint:: Even though Zammad displays the link template within object edit and create screens, the function is optional. It's only active if you populate