Gaia/System/Keyboard/Layout - Revision history

Timdream: Replaced content with "This document have been moved to [https://developer.mozilla.org/en-US/Firefox_OS/Developing_Gaia/Customizing_the_keyboard MDN]. [https://wiki.mozilla.org/index.php?title=..."

2014-08-17T02:36:09Z

Replaced content with "This document have been moved to [https://developer.mozilla.org/en-US/Firefox_OS/Developing_Gaia/Customizing_the_keyboard MDN]. [https://wiki.mozilla.org/index.php?title=..."

← Older revision		Revision as of 02:36, 17 August 2014
Line 1:		Line 1:
	This document ~~explains how~~ to ~~add custom keyboard layouts containing their own languages~~/~~scripts to '''Firefox OS v1~~.~~2''' and up~~.		This document have been moved to [https://developer.mozilla.org/en-US/Firefox_OS/Developing_Gaia/Customizing_the_keyboard MDN].

	~~== Status of the Gaia Keyboard app & system architecture ==~~		[https://wiki.mozilla.org/index.php?title=Gaia/System/Keyboard/Layout&action=history History of this page].

	~~Two major features have been implemented in Firefox OS, as of October 2013.~~

	* A build flag to turn keyboard/spellcheck dictionaries to include in the build in the default Gaia Keyboard app on and off (see {{Bug\|884752}}).
	* An OS-level feature that allows users to install 3rd-party keyboard apps from the Firefox Marketplace. See {{Bug\|816869}}.

	~~To come up with a new keyboard layout, you can put a layout file in Gaia, build the keyboard app using a build config, or come up with your own keyboard app and install it on the phone.~~

	~~== How to make a keyboard app ==~~

	~~You can use Gaia's built-in keyboard app as a template, or fork it. The basic ideas are:~~

	* In the manifest file, declare your keyboard in the <code>role</code> property.
	* Make sure you have the <code>input</code> permission specified.

	After that, you can install your keyboard, and it will show up on the bottom half of the screen whenever the user is focused to a input field. The space issues that arise from this can be dealt with by:

	* Using the old, classic <code>window.resize</code> to update the area of your app should occupy.
	* Using the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given; see the [[WebAPI/KeboardIME\|KeyboardIME API page]] for details.

	~~TBD: provide sample code and/or a small template app~~

	~~== How to add a custom layout to your template in the Gaia keyboard app ==~~

	1. See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for details. Depending on the language you might want to add a dictionary, or include an interactive IME (for Asian languages).

	~~2. If you add layouts for a newly supported language, you may want to check the following file to see if the layouts are suitable to be set as default layouts for that language.~~

	~~https://github.com/mozilla-b2g/gaia/blob/master/build/config/keyboard-layouts.json~~

	~~=== Spell check / word suggestion dictionary ===~~

	~~(TBA)~~

	~~=== Asian IME ===~~

	~~==== Introduction ====~~

	~~East Asian languages (Chinese, Japanese, and Korean) use~~ [https:/~~/en.wikipedia.org~~/wiki/CJK a fairly complex script] that involves thousands of characters. As there is no way to put thousands of keys on a hardware or software keyboard, users rely on an indexing program called [https://en.wikipedia.org/wiki/Input_method input method], or IME for short, to convert series of symbols into selections of characters.

	How symbols should be converted and how "smart" the IME should be depends on the method chosen, implementation itself, and often [https://en.wikipedia.org/wiki/Natural_language_processing NLP] science, which is outside the scope of this document. One thing to note is that it is highly recommended to put the database part into IndexedDB, in order to conserve memory on a mobile device.

	~~==== IM Engine interface in Gaia keyboard app ====~~

	Assuming you have an IME library readily available for converting symbols into characters (''IM Engine'' in our terminology), you would need to use the defined interface within the Gaia Keyboard app to receive symbols from the layout and output the characters. The [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L32-L115 current API is documented on Github].

	~~We invite implementations in order to further refine this API within Gaia.~~

	~~==== Make your IM engine work with your layout ====~~

	~~To get your IM engine working with your keyboard layout:~~

	~~# Put a new layout in layout.js as described in the previous section.~~
	# Reference the IM engine with the <code>imEngine</code> property. When your layout is enabled, the keyboard app will start loading the script located at <code>keyboard/js/imes/<imEngine>/<imEngine>.js</code>.
	~~# Set up the APIs to receive and send the keys/characters when the script is loaded and <code>init</code>'d.~~
	~~# Do whatever you want in response to the user input. When the user taps any keys on the keyboard, it would typically get sent to the IM engine.~~

	~~==== Known implementations ====~~

	* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Traditional Chinese incorporating Zhuyin IME.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is written for Simplified Chinese and works by tapping Pinyin symbols.
	* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/~~show_bug~~.~~cgi~~?id=~~845685 cross-compiled with emscripten] and linked with the~~ Gaia ~~keyboard.~~
	* [https://~~bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] is a prototype IM engine for Korean, and is currently in development.~~
	* [https://github.com/~~mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jsavrophonetic jsAvroPhonetic] an IM Engine that transliterates latin text into Bangla.~~

	~~== Discussion, Q~~&~~A, etc~~ ==

	~~Please come to the [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia~~] ~~mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic~~.

RudyL: /* How to add a custom layout to your template in the Gaia keyboard app */

2014-04-29T04:32:44Z

How to add a custom layout to your template in the Gaia keyboard app

← Older revision		Revision as of 04:32, 29 April 2014
Line 26:		Line 26:
	== How to add a custom layout to your template in the Gaia keyboard app ==		== How to add a custom layout to your template in the Gaia keyboard app ==

	See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for details. Depending on the language you might want to add a dictionary, or include an interactive IME (for Asian languages).		1. See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for details. Depending on the language you might want to add a dictionary, or include an interactive IME (for Asian languages).

			2. If you add layouts for a newly supported language, you may want to check the following file to see if the layouts are suitable to be set as default layouts for that language.

			https://github.com/mozilla-b2g/gaia/blob/master/build/config/keyboard-layouts.json

	=== Spell check / word suggestion dictionary ===		=== Spell check / word suggestion dictionary ===

Aniruddha adhikary: /* Known implementations */

2013-11-26T14:43:44Z

Known implementations

← Older revision		Revision as of 14:43, 26 November 2013
Line 59:		Line 59:
	* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Traditional Chinese incorporating Zhuyin IME.		* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Traditional Chinese incorporating Zhuyin IME.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is written for Simplified Chinese and works by tapping Pinyin symbols.
	* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with the Gaia keyboard.		* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with the Gaia keyboard.
	* [https://bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] is a prototype IM engine for Korean, and is currently in development.		* [https://bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] is a prototype IM engine for Korean, and is currently in development.
			* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jsavrophonetic jsAvroPhonetic] an IM Engine that transliterates latin text into Bangla.

	== Discussion, Q&A, etc ==		== Discussion, Q&A, etc ==

	Please come to the [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.		Please come to the [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.

Chrisdavidmills: /* How to make a keyboard app */

2013-11-05T14:03:11Z

How to make a keyboard app

← Older revision		Revision as of 14:03, 5 November 2013
Line 20:		Line 20:

	* Using the old, classic <code>window.resize</code> to update the area of your app should occupy.		* Using the old, classic <code>window.resize</code> to update the area of your app should occupy.
	* Using the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for ~~detail~~.		* Using the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given; see the [[WebAPI/KeboardIME\|KeyboardIME API page]] for details.

	TBD: provide sample code and/or a small template app		TBD: provide sample code and/or a small template app

Chrisdavidmills at 13:55, 5 November 2013

2013-11-05T13:55:25Z

← Older revision		Revision as of 13:55, 5 November 2013
Line 1:		Line 1:
	~~Hello! The goal of this~~ document ~~is to allow people~~ to add keyboard ~~layout of~~ their own ~~language~~/~~script on~~ '''Firefox OS v1.2''' and up.		This document explains how to add custom keyboard layouts containing their own languages/scripts to '''Firefox OS v1.2''' and up.

	== Status of the Gaia Keyboard app & system architecture ==		== Status of the Gaia Keyboard app & system architecture ==

	~~As of Oct 2013, two~~ major features have been ~~recently~~ implemented in Firefox OS.		Two major features have been implemented in Firefox OS, as of October 2013.

	* A build flag ~~exist~~ to turn ~~on/off~~ keyboard/spellcheck ~~dictionary~~ to include in the build, in the default Gaia Keyboard app (see {{Bug\|884752}}).		* A build flag to turn keyboard/spellcheck dictionaries to include in the build in the default Gaia Keyboard app on and off (see {{Bug\|884752}}).
	* An OS-level feature that ~~allow~~ users to install 3rd-party keyboard apps from ~~marketplace~~. See {{Bug\|816869}}.		* An OS-level feature that allows users to install 3rd-party keyboard apps from the Firefox Marketplace. See {{Bug\|816869}}.

	To come up with a new keyboard layout, you ~~could either~~ put a layout file in Gaia, build the keyboard app ~~with~~ a build config, or come up with your own keyboard app and install it to the phone.		To come up with a new keyboard layout, you can put a layout file in Gaia, build the keyboard app using a build config, or come up with your own keyboard app and install it on the phone.

	== How~~-tos:~~ make a keyboard app ==		== How to make a keyboard app ==

	You ~~might want to~~ use ~~the~~ built-in keyboard as a template, or fork it. The basic ideas are		You can use Gaia's built-in keyboard app as a template, or fork it. The basic ideas are:

	* In the manifest, declare ~~yourself as a~~ keyboard in the <code>role</code> property.		* In the manifest file, declare your keyboard in the <code>role</code> property.
	* Make sure you have the <code>input</code> permission.		* Make sure you have the <code>input</code> permission specified.

	After that, ~~after installation and activation,~~ your keyboard will show up on the bottom half of the screen whenever the user is focused to a input field.		After that, you can install your keyboard, and it will show up on the bottom half of the screen whenever the user is focused to a input field. The space issues that arise from this can be dealt with by:

	* ~~Use~~ the old, classic <code>window.resize</code> to update the area of your app should occupy.		* Using the old, classic <code>window.resize</code> to update the area of your app should occupy.
	* ~~Use~~ the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for detail.		* Using the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for detail.

	~~(some~~ sample code and/or a small template app ~~will help here)~~		TBD: provide sample code and/or a small template app

	== How~~-tos:~~ add ~~your~~ layout to your in the Gaia keyboard app ==		== How to add a custom layout to your template in the Gaia keyboard app ==

	See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for ~~detail~~. ~~Depend~~ on the language, you might want to add a dictionary, or include an interactive IME (for Asian languages).		See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for details. Depending on the language you might want to add a dictionary, or include an interactive IME (for Asian languages).

	=== Spell check / word suggestion dictionary ===		=== Spell check / word suggestion dictionary ===
Line 36:		Line 36:
	==== Introduction ====		==== Introduction ====

	East Asian languages (Chinese, Japanese, and Korean) use [https://en.wikipedia.org/wiki/CJK a fairly complex script] that involves thousands of characters. As there is no way to put thousands of keys on a hardware ~~keyboard nor a~~ software keyboard, users ~~would~~ rely on ~~a piece of~~ indexing program called [https://en.wikipedia.org/wiki/Input_method input method], or IME for short, to convert series of symbols into a selections of ~~candidate~~ characters.		East Asian languages (Chinese, Japanese, and Korean) use [https://en.wikipedia.org/wiki/CJK a fairly complex script] that involves thousands of characters. As there is no way to put thousands of keys on a hardware or software keyboard, users rely on an indexing program called [https://en.wikipedia.org/wiki/Input_method input method], or IME for short, to convert series of symbols into selections of characters.

	How symbols should be converted and how "smart" the IME should be depends on the method chosen, implementation itself, and often [https://en.wikipedia.org/wiki/Natural_language_processing NLP] science, which is outside the scope of this document. One thing to note is that it is highly recommended to put the database part into IndexedDB, in order to conserve memory on a mobile device.		How symbols should be converted and how "smart" the IME should be depends on the method chosen, implementation itself, and often [https://en.wikipedia.org/wiki/Natural_language_processing NLP] science, which is outside the scope of this document. One thing to note is that it is highly recommended to put the database part into IndexedDB, in order to conserve memory on a mobile device.
Line 42:		Line 42:
	==== IM Engine interface in Gaia keyboard app ====		==== IM Engine interface in Gaia keyboard app ====

	Assuming you have an IME library readily available for converting symbols into characters (''IM Engine'' in our terminology), you would need to use the defined interface within Gaia Keyboard app~~, available to the library~~ to receive symbols from the layout, and to output the characters. The ~~current API is documented~~ [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L32-L115 ~~in the comment here~~]. We invite implementations in order to further refine this API within Gaia.		Assuming you have an IME library readily available for converting symbols into characters (''IM Engine'' in our terminology), you would need to use the defined interface within the Gaia Keyboard app to receive symbols from the layout and output the characters. The [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L32-L115 current API is documented on Github].

			We invite implementations in order to further refine this API within Gaia.

	==== Make your IM engine work with your layout ====		==== Make your IM engine work with your layout ====

	# Put a new layout in layout.js as the previous section ~~described~~.		To get your IM engine working with your keyboard layout:
	# Reference the IM engine with <code>imEngine</code> property. When your layout is enabled, the keyboard app ~~would~~ start loading the script located at <code>keyboard/js/imes/<imEngine>/<imEngine>.js</code>.
	# APIs to receive and send the keys/characters ~~should be setup~~ when the script is loaded and <code>init</code>'d.		# Put a new layout in layout.js as described in the previous section.
	# When the user ~~tap~~ any ~~key/symbols~~ on the keyboard, it would get ~~send~~ to the IM engine~~. Do whatever you want in response to the user input~~.		# Reference the IM engine with the <code>imEngine</code> property. When your layout is enabled, the keyboard app will start loading the script located at <code>keyboard/js/imes/<imEngine>/<imEngine>.js</code>.
			# Set up the APIs to receive and send the keys/characters when the script is loaded and <code>init</code>'d.
			# Do whatever you want in response to the user input. When the user taps any keys on the keyboard, it would typically get sent to the IM engine.

	==== Known implementations ====		==== Known implementations ====

	* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Zhuyin IME ~~for Traditional Chinese. Blame the author if you think the current API sucks~~.		* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Traditional Chinese incorporating Zhuyin IME.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.
	* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with Gaia keyboard.		* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with the Gaia keyboard.
	* [https://bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] ~~will be~~ a prototype IM engine for Korean.		* [https://bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] is a prototype IM engine for Korean, and is currently in development.

	== Discussion, Q&A, etc ==		== Discussion, Q&A, etc ==

	Please come to [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.		Please come to the [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.

Timdream: /* How-tos: make a keyboard app */

2013-11-02T05:59:24Z

How-tos: make a keyboard app

← Older revision		Revision as of 05:59, 2 November 2013
Line 15:		Line 15:

	* In the manifest, declare yourself as a keyboard in the <code>role</code> property.		* In the manifest, declare yourself as a keyboard in the <code>role</code> property.
	* Make sure you have the <code>~~keyboard~~</code> permission.		* Make sure you have the <code>input</code> permission.

	After that, after installation and activation, your keyboard will show up on the bottom half of the screen whenever the user is focused to a input field.		After that, after installation and activation, your keyboard will show up on the bottom half of the screen whenever the user is focused to a input field.
Line 22:		Line 22:
	* Use the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for detail.		* Use the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for detail.

	(some sample code and/or a small template app will help here)		(some sample code and/or a small template app will help here)

	== How-tos: add your layout to your in the Gaia keyboard app ==		== How-tos: add your layout to your in the Gaia keyboard app ==

Timdream at 07:57, 31 October 2013

2013-10-31T07:57:24Z

← Older revision		Revision as of 07:57, 31 October 2013
Line 1:		Line 1:
	Hello! The goal of this document is to allow people to add keyboard layout of their own language/script on ~~the~~ '''v1.2 ~~Gaia Keyboard app~~'''.		Hello! The goal of this document is to allow people to add keyboard layout of their own language/script on '''Firefox OS v1.2''' and up.

	== Status of the Gaia Keyboard app & system architecture ==		== Status of the Gaia Keyboard app & system architecture ==

Timdream at 07:55, 31 October 2013

2013-10-31T07:55:43Z

← Older revision		Revision as of 07:55, 31 October 2013
Line 1:		Line 1:
	Hello! The goal of this document is to allow people to add keyboard layout of their own language/script on the '''v1 Gaia Keyboard app'''.		Hello! The goal of this document is to allow people to add keyboard layout of their own language/script on the '''v1.2 Gaia Keyboard app'''.

	== Status of the Gaia Keyboard app & system architecture ==		== Status of the Gaia Keyboard app & system architecture ==

	~~=== Current version ===~~		As of Oct 2013, two major features have been recently implemented in Firefox OS.

	~~As of mid-2013~~, the ~~built-in~~ Gaia ~~keyboard~~ app ~~is the only keyboard app available in Firefox~~ OS~~. That means, if you would like~~ to ~~add your own~~ keyboard ~~layout, you would have to modify the app itself and push it to your unlocked developer phone~~.		* A build flag exist to turn on/off keyboard/spellcheck dictionary to include in the build, in the default Gaia Keyboard app (see {{Bug\|884752}}).
			* An OS-level feature that allow users to install 3rd-party keyboard apps from marketplace. See {{Bug\|816869}}.

	~~=== Next version ===~~		To come up with a new keyboard layout, you could either put a layout file in Gaia, build the keyboard app with a build config, or come up with your own keyboard app and install it to the phone.

	~~We plan to introduce plug~~-~~able keyboard/IME architecture directly into the OS in the next version. For details, see [https~~:~~//bugzilla.mozilla.org/show_bug.cgi?id=816869 bug 816869]. When the feature is released, the users should be able to buy or install their own~~ keyboard app~~, and use the layouts of those 3rd-party keyboard apps in conjunction with the built-in ones.~~		== How-tos: make a keyboard app ==

	~~== How~~-~~tos ==~~		You might want to use the built-in keyboard as a template, or fork it. The basic ideas are

	~~The section below assumes that you know how to flash your own Gaia on~~ the ~~phone (i.e.~~, <code>~~make install-gaia~~</code>~~), or update~~ the <code>~~application.zip~~</code> ~~of keyboard app for Firefox OS Simulator~~.		* In the manifest, declare yourself as a keyboard in the <code>role</code> property.
			* Make sure you have the <code>keyboard</code> permission.

	~~=== Add~~ a ~~simple layout in the Gaia keyboard app ===~~		After that, after installation and activation, your keyboard will show up on the bottom half of the screen whenever the user is focused to a input field.

	~~A simple layout refers to~~, e.~~g., Qwerty layout for English, where~~ the app ~~simply outputs what~~ the ~~user taps directly (as opposed~~ to ~~having~~ the ~~keys handles in Asian IMEs)~~.		* Use the old, classic <code>window.resize</code> to update the area of your app should occupy.
			* Use the new, shiny <code>navigator.mozInputMethod</code> API to mutate the content of the input given, see [[WebAPI/KeboardIME\|API page]] for detail.

	# Modify [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/layout.js layout.js] to add your own layout here. You should be able to figure out the syntax by looking at the definition of other layouts.		(some sample code and/or a small template app will help here)
	~~# Reference your keyboard layout by hard-coding its name [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L490 here] in the <~~code~~>enabledKeyboardNames<~~/~~code> array. That~~ will ~~enable your layout no matter what you'd choose in the Settings app.~~

	~~Obviously you would have to do something else in order to make~~ your ~~keyboard~~ layout ~~show up as a setting entry and~~ to ~~make it toggle-able, but this document describes~~ the ~~minimum.~~		== How-tos: add your layout to your in the Gaia keyboard app ==

	=== ~~Add a layout what works with an~~ Asian IME ===		See [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/CONFIGURE apps/keyboard/CONFIGURE] for detail. Depend on the language, you might want to add a dictionary, or include an interactive IME (for Asian languages).

			=== Spell check / word suggestion dictionary ===

			(TBA)

			=== Asian IME ===

	==== Introduction ====		==== Introduction ====

Channy: /* Known implementations */

2013-08-13T02:37:56Z

Known implementations

← Older revision		Revision as of 02:37, 13 August 2013
Line 49:		Line 49:
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.
	* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with Gaia keyboard.		* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with Gaia keyboard.
			* [https://bugzilla.mozilla.org/show_bug.cgi?id=835261 JSHangul] will be a prototype IM engine for Korean.

	== Discussion, Q&A, etc ==		== Discussion, Q&A, etc ==

	Please come to [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.		Please come to [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.

Marcosc: Fixed grammatical issues and typos.

2013-06-03T10:23:29Z

Fixed grammatical issues and typos.

← Older revision		Revision as of 10:23, 3 June 2013
Line 1:		Line 1:
	Hello! ~~This~~ goal of this document is to allow people to add keyboard layout of their own language/script on the '''v1 Gaia Keyboard app'''.		Hello! The goal of this document is to allow people to add keyboard layout of their own language/script on the '''v1 Gaia Keyboard app'''.

	== Status of the Gaia Keyboard app & system architecture ==		== Status of the Gaia Keyboard app & system architecture ==
Line 9:		Line 9:
	=== Next version ===		=== Next version ===

	We plan to introduce plug-able keyboard/IME architecture directly into the OS in the next version. ~~See~~ [https://bugzilla.mozilla.org/show_bug.cgi?id=816869 bug 816869] ~~for detail~~. When the feature is released, the users should be able to buy or install their own keyboard app, and use the layouts of those 3rd-party keyboard apps in conjunction with the built-in ones.		We plan to introduce plug-able keyboard/IME architecture directly into the OS in the next version. For details, see [https://bugzilla.mozilla.org/show_bug.cgi?id=816869 bug 816869]. When the feature is released, the users should be able to buy or install their own keyboard app, and use the layouts of those 3rd-party keyboard apps in conjunction with the built-in ones.

	== How-tos ==		== How-tos ==

	The section below ~~assume~~ that you ~~have already~~ know how to flash your own Gaia on the phone (i.e., <code>make install-gaia</code>), or update the <code>application.zip</code> of keyboard app for Firefox OS Simulator.		The section below assumes that you know how to flash your own Gaia on the phone (i.e., <code>make install-gaia</code>), or update the <code>application.zip</code> of keyboard app for Firefox OS Simulator.

	=== Add a simple layout in the Gaia keyboard app ===		=== Add a simple layout in the Gaia keyboard app ===
Line 19:		Line 19:
	A simple layout refers to, e.g., Qwerty layout for English, where the app simply outputs what the user taps directly (as opposed to having the keys handles in Asian IMEs).		A simple layout refers to, e.g., Qwerty layout for English, where the app simply outputs what the user taps directly (as opposed to having the keys handles in Asian IMEs).

	# Modify [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/layout.js layout.js] to add your own layout here. You should be able to figure out the syntax by looking at definition of other layouts.		# Modify [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/layout.js layout.js] to add your own layout here. You should be able to figure out the syntax by looking at the definition of other layouts.
	# Reference your keyboard layout by hard-~~code it's~~ name [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L490 here] in the <code>enabledKeyboardNames</code> array. That ~~would~~ enable your layout no matter what you'd choose in the Settings app.		# Reference your keyboard layout by hard-coding its name [https://github.com/mozilla-b2g/gaia/blob/master/apps/keyboard/js/keyboard.js#L490 here] in the <code>enabledKeyboardNames</code> array. That will enable your layout no matter what you'd choose in the Settings app.

	Obviously you would have to do something else in order to make your keyboard layout show up as a setting entry and toggle-able, but this document describes the minimum.		Obviously you would have to do something else in order to make your keyboard layout show up as a setting entry and to make it toggle-able, but this document describes the minimum.

	=== Add a layout what works with an Asian IME ===		=== Add a layout what works with an Asian IME ===
Line 28:		Line 28:
	==== Introduction ====		==== Introduction ====

	East Asian languages (Chinese, Japanese, and Korean) ~~uses~~ [https://en.wikipedia.org/wiki/CJK a fairly complex script] that involves thousands of characters. As there is no way to put thousands of keys on a hardware keyboard nor a software keyboard, users would rely on a piece of indexing program called [https://en.wikipedia.org/wiki/Input_method input method], or IME for short, to convert series of symbols into a selections of candidate characters.		East Asian languages (Chinese, Japanese, and Korean) use [https://en.wikipedia.org/wiki/CJK a fairly complex script] that involves thousands of characters. As there is no way to put thousands of keys on a hardware keyboard nor a software keyboard, users would rely on a piece of indexing program called [https://en.wikipedia.org/wiki/Input_method input method], or IME for short, to convert series of symbols into a selections of candidate characters.

	How symbols should be converted and how "smart" the IME should be ~~depend~~ on the method ~~chosed~~, implementation itself, and often [https://en.wikipedia.org/wiki/Natural_language_processing NLP] science, which is ~~not~~ the scope of this document. One thing to note is that it is highly recommended to put the database part into IndexedDB, in order to conserve ~~the~~ memory ~~usage~~ on a mobile device.		How symbols should be converted and how "smart" the IME should be depends on the method chosen, implementation itself, and often [https://en.wikipedia.org/wiki/Natural_language_processing NLP] science, which is outside the scope of this document. One thing to note is that it is highly recommended to put the database part into IndexedDB, in order to conserve memory on a mobile device.

	==== IM Engine interface in Gaia keyboard app ====		==== IM Engine interface in Gaia keyboard app ====
Line 45:		Line 45:
	==== Known implementations ====		==== Known implementations ====

	* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Zhuyin IME for Traditional Chinese. Blame the author if you think the current API ~~su*ks~~.		* [https://github.com/timdream/jszhuyin JSZhuyin] is the first implementation of Gaia Keyboard Asian IM engine, for Zhuyin IME for Traditional Chinese. Blame the author if you think the current API sucks.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jskanji JSKanji] is a prototype IM engine written for Japanese.
	* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.		* [https://github.com/mozilla-b2g/gaia/tree/master/apps/keyboard/js/imes/jspinyin JSPinyin] is a written for Simplified Chinese and works by tapping Pinyin symbols.
	* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-~~complied~~ with emscripten] and linked with Gaia keyboard.		* As a demonstration, [http://chewing.csie.net/ Chewing], an C/C++ open-source Zhuyin IME for Traditional Chinese, was [https://bugzilla.mozilla.org/show_bug.cgi?id=845685 cross-compiled with emscripten] and linked with Gaia keyboard.

	== Discussion, Q&A, etc ==		== Discussion, Q&A, etc ==

	Please come to [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.		Please come to [https://lists.mozilla.org/listinfo/dev-gaia dev-gaia] mailing list or the <code>#gaia</code> channel on irc.mozilla.org. <code>#mozilla-taiwan</code> is the de-facto Chinese-language channel for this topic.