|
|
| (19 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| {{Stability-unstable}}
| | The content on this page has moved to https://documentation.open-xchange.com/latest/ui/miscellaneous/emoji.html |
|
| |
|
| <div class="title">Emoji Configuration</div>
| | Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition. |
| | |
| '''Abstract.''' In this article, the support for emoji is described in detail. Learn about how different icon sets can be included and configured.
| |
| __TOC__
| |
| == Enabling the feature ==
| |
| Emoji support is disabled by default. In order to enable the feature, you must define the capability '''emoji'''. This is done by just adding the word "emoji" to the property "permissions" in '''/opt/openexchange/etc/permission.properties''':
| |
| | |
| <pre>
| |
| permissions=...,emoji
| |
| </pre>
| |
| | |
| == Settings ==
| |
| Configuration will be served via [[AppSuite:jslob|jslob]] service at the following path.
| |
| <pre>
| |
| io.ox/mail/emoji
| |
| </pre>
| |
| | |
| The object can contain these keys (default values in brackets):
| |
| <pre>
| |
| io.ox/mail/emoji//defaultCollection ('unified')
| |
| io.ox/mail/emoji//availableCollections ('unified')
| |
| io.ox/mail/emoji//forceEmojiIcons (false)
| |
| io.ox/mail/emoji//collectionControl ('none') // possible: 'none', 'tabs', 'dropdown'
| |
| io.ox/mail/emoji//autoClose (false)
| |
| | |
| io.ox/mail/emoji//recently ({})
| |
| io.ox/mail/emoji//userCollection (emoji/defaultCollection)
| |
| </pre>
| |
| | |
| == How to add a new icon set ==
| |
| | |
| It is possible to add new icon sets by [[Appsuite:Writing_a_simple_application|writing a core plugin]]. It is recommended, to install the files to
| |
| | |
| <pre>
| |
| apps/3rd.party/emoji/<iconSetName>/
| |
| </pre>
| |
| | |
| Put all your CSS code and images into this directory and create a register.js adding the CSS/LESS files as dependencies.
| |
| | |
| Once this is done, you need to add the CSS also to the tinyMCE editor, because an iframe is used to edit the text and in order to have full emoji support, you need to load the CSS code there as well. Doing so is really easy. There is an extension point you can use to add the paths to your CSS files.
| |
| | |
| <pre class="language-javascript">
| |
| define('3rd.party/emoji/greatestIconSet/register',
| |
| [
| |
| 'io.ox/core/extensions',
| |
| 'css!3rd.party/emoji/greatestIconSet/emoji.css',
| |
| 'css!3rd.party/emoji/greatestIconSet/emoji_categories.css'
| |
| ], function (ext) {
| |
| "use strict";
| |
| | |
| ext.point('3rd.party/emoji/editor_css').extend({
| |
| id: 'greatestIconSet/categories',
| |
| css: '3rd.party/emoji/greatestIconSet/emoji_categories.css'
| |
| });
| |
| ext.point('3rd.party/emoji/editor_css').extend({
| |
| id: 'greatestIconSet/icons',
| |
| css: '3rd.party/emoji/greatestIconSet/emoji.css'
| |
| });
| |
| | |
| });
| |
| </pre>
| |