AppSuite:Emoji - Revision history

Khgras: Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/miscellaneous/emoji.html Note: Open-Xchange is in the process of migrating all its..."

2017-05-22T10:05:02Z

Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/miscellaneous/emoji.html Note: Open-Xchange is in the process of migrating all its..."

← Older revision		Revision as of 10:05, 22 May 2017
Line 1:		Line 1:
	~~<!-- !!! -->~~		The content on this page has moved to https://documentation.open-xchange.com/latest/ui/miscellaneous/emoji.html
	~~<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION~~: ~~wd/frontend~~/~~web~~/documentation -->
	~~<!-- !!! -->~~

	~~<div class="title">Emoji Support</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 emoji support ==~~
	~~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 following settings are relevant for emoji support:~~
	~~<pre>~~
	~~io.ox/mail/emoji//defaultCollection=unified~~
	~~io.ox/mail/emoji//availableCollections=unified,two,three~~
	~~io.ox/mail/emoji//forceEmojiIcons=false~~
	~~io.ox/mail/emoji//collectionControl=none # possible values 'none', 'tabs', 'dropdown'~~
	~~io.ox/mail/emoji//autoClose=false~~
	~~io.ox/mail/emoji//userCollection=emoji/defaultCollection~~
	~~io.ox/mail/emoji//overrideUserCollection=false~~
	~~io.ox/mail/emoji//sendEncoding=unified # possible values 'unified', 'pua'~~
	~~</pre>~~

	~~In order to configure this server-side, just append~~ to ~~existing appsuite.properties or create~~ a new ~~file emoji.properties~~ (~~in same directory; please mind the double-slash, this in not a typo! plus: changing such settings requires a backend restart)~~.

	{\|
	\|-
	~~! Setting !! Description~~
	\|-
	~~\| defaultCollection \|\| Default collection~~.
	\|-
	~~\| availableCollections \|\| Available collections~~. ~~Comma separated. The order is important, since this will be used~~ as ~~an order for~~ the ~~fallback mechanism. If an icon is not found in the userCollection, the icon is looked up in each available collection and the first 'hit'~~ will be ~~used.~~
	\|-
	~~\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags~~
	\|-
	~~\| collectionControl \|\| none, dropdown, tabs.~~
	\|-
	~~\| autoClose \|\| Emoji pallet closes when user click or presses any key inside editor~~
	\|-
	~~\| userCollection \|\| Current user collection~~
	\|-
	~~\| overrideUserCollection~~
	\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. (See comment for availableCollections describing the fallback mechanism.) Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the ~~icon that is shown.~~
	\|-
	~~\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)~~
	\|}

	~~== How to add a new icon set ==~~

	~~It is possible to add~~ new ~~icon sets by [https://documentation.open-xchange.com/7.8.4/ui/customize/app/simple-application.html 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>~~

	~~=== Naming conventions in CSS code ===~~

	~~The CSS must follow some easy structure. There must be a base class for all icons that defines the background image. It must match the name~~ of ~~your icon set prefixed with “.emoji-”.~~

	~~Each icon will then be identified by a string that can be defined in the icon set metadata~~.

	~~Find here a short example copied from the unified icon set shipped with Appsuite.~~
	~~<pre>~~
	~~.emoji-unified {~~
	~~background: url("emoji.png") top left no-repeat;~~
	~~width: 20px;~~
	~~height: 20px;~~
	~~display: -moz-inline-stack;~~
	~~display: inline-block;~~
	~~vertical-align: top;~~
	~~zoom: 1;~~
	*display: inline;
	}
	~~.emoji2600 {~~
	~~background-position: -500px -120px;~~
	}
	~~</pre>~~


	~~[[Category:Server]]~~
	~~[[Category:UI]]~~
	~~[[Category:i18n]]~~
	~~[[Category:Config]]~~
	~~[[Category:AppSuite]]~~

Khgras at 09:26, 22 May 2017

2017-05-22T09:26:09Z

← Older revision		Revision as of 09:26, 22 May 2017
Line 58:		Line 58:
	== How to add a new icon set ==		== 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		It is possible to add new icon sets by [https://documentation.open-xchange.com/7.8.4/ui/customize/app/simple-application.html writing a core plugin]. It is recommended, to install the files to

	<pre>		<pre>

Frank.paczynski at 05:58, 11 February 2016

2016-02-11T05:58:36Z

← Older revision		Revision as of 05:58, 11 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->

	<div class="title">Emoji Support</div>		<div class="title">Emoji Support</div>

J.ohny.b: /* Settings */

2013-08-02T15:52:21Z

Settings

← Older revision		Revision as of 15:52, 2 August 2013
Line 47:		Line 47:
	\|-		\|-
	\| overrideUserCollection		\| overrideUserCollection
	\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. (See comment for availableCollections) Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.		\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. (See comment for availableCollections describing the fallback mechanism.) Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.
	\|-		\|-
	\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)		\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)

J.ohny.b: /* Settings */

2013-08-02T15:51:36Z

Settings

← Older revision		Revision as of 15:51, 2 August 2013
Line 36:		Line 36:
	\| defaultCollection \|\| Default collection.		\| defaultCollection \|\| Default collection.
	\|-		\|-
	\| availableCollections \|\| Available collections. Comma separated. The order is important, since this will be used as an order for the fallback mechanism. If an icon is not found in the userCollection, the icon looked up in each available collection and the first 'hit' will be used.		\| availableCollections \|\| Available collections. Comma separated. The order is important, since this will be used as an order for the fallback mechanism. If an icon is not found in the userCollection, the icon is looked up in each available collection and the first 'hit' will be used.
	\|-		\|-
	\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags		\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags

J.ohny.b: /* Settings */

2013-08-02T15:51:00Z

Settings

← Older revision		Revision as of 15:51, 2 August 2013
Line 36:		Line 36:
	\| defaultCollection \|\| Default collection.		\| defaultCollection \|\| Default collection.
	\|-		\|-
	\| availableCollections \|\| Available collections. Comma separated.		\| availableCollections \|\| Available collections. Comma separated. The order is important, since this will be used as an order for the fallback mechanism. If an icon is not found in the userCollection, the icon looked up in each available collection and the first 'hit' will be used.
	\|-		\|-
	\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags		\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags
Line 47:		Line 47:
	\|-		\|-
	\| overrideUserCollection		\| overrideUserCollection
	\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.		\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. (See comment for availableCollections) Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.
	\|-		\|-
	\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)		\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)

J.ohny.b: /* Settings */

2013-08-02T15:48:16Z

Settings

← Older revision		Revision as of 15:48, 2 August 2013
Line 38:		Line 38:
	\| availableCollections \|\| Available collections. Comma separated.		\| availableCollections \|\| Available collections. Comma separated.
	\|-		\|-
	\| forceEmojiIcons \|\| -		\| forceEmojiIcons \|\| always convert emoji unicode characters to img-tags
	\|-		\|-
	\| collectionControl \|\| none, dropdown, tabs.		\| collectionControl \|\| none, dropdown, tabs.
Line 48:		Line 48:
	\| overrideUserCollection		\| overrideUserCollection
	\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.		\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.
			\|-
			\| sendEncoding \|\| Override the default send encoding to use something else than unified (unicode6)
	\|}		\|}

J.ohny.b: add sendEncoding option

2013-08-02T14:16:59Z

add sendEncoding option

← Older revision		Revision as of 14:16, 2 August 2013
Line 25:		Line 25:
	io.ox/mail/emoji//userCollection=emoji/defaultCollection		io.ox/mail/emoji//userCollection=emoji/defaultCollection
	io.ox/mail/emoji//overrideUserCollection=false		io.ox/mail/emoji//overrideUserCollection=false
			io.ox/mail/emoji//sendEncoding=unified # possible values 'unified', 'pua'
	</pre>		</pre>

Tierlieb: + categories

2013-07-09T12:06:39Z

+ categories

← Older revision		Revision as of 12:06, 9 July 2013
Line 103:		Line 103:
	}		}
	</pre>		</pre>


			[[Category:Server]]
			[[Category:UI]]
			[[Category:i18n]]
			[[Category:Config]]
			[[Category:AppSuite]]

Mattes: /* Settings */

2013-07-08T07:07:29Z

Settings

← Older revision		Revision as of 07:07, 8 July 2013
Line 33:		Line 33:
	! Setting !! Description		! Setting !! Description
	\|-		\|-
	\| defaultCollection \|\| ~~Example~~		\| defaultCollection \|\| Default collection.
	\|-		\|-
	\| availableCollections \|\| ~~Example~~		\| availableCollections \|\| Available collections. Comma separated.
	\|-		\|-
	\| forceEmojiIcons \|\| ~~Example~~		\| forceEmojiIcons \|\| -
	\|-		\|-
	\| collectionControl \|\| ~~Example~~		\| collectionControl \|\| none, dropdown, tabs.
	\|-		\|-
	\| autoClose \|\| ~~Example~~		\| autoClose \|\| Emoji pallet closes when user click or presses any key inside editor
	\|-		\|-
	\| userCollection \|\| ~~Example~~		\| userCollection \|\| Current user collection
	\|-		\|-
	\| overrideUserCollection		\| overrideUserCollection
	\|\|		\|\|Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.
	Set this setting to true and the current user collection will not be prefered when replacing unicode characters with an image. Since Mail compose works with a current collection object, this setting has no effect when inserting icons from the editor plugin into the text. But when rendering any text with unicode characters, this setting will have an effect on the icon that is shown.
	\|}		\|}