Features/GNOMEIBusIntegration

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(User Experience)
 
(27 intermediate revisions by 4 users not shown)
Line 6: Line 6:
 
The integration includes a gnome-shell input indicator combining keyboard layouts and input methods selection, and also setup of input methods inside gnome-control-center.
 
The integration includes a gnome-shell input indicator combining keyboard layouts and input methods selection, and also setup of input methods inside gnome-control-center.
  
For this to be a smooth transition for Fedora users, various changes and testing are needed, and this is covered by this feature.
+
For this to be a smooth transition for Fedora users, various changes behind the scenes and testing are required, and this is covered by this feature.
  
 
== Owner ==
 
== Owner ==
Line 14: Line 14:
 
== Current status ==
 
== Current status ==
 
* Targeted release: [[Releases/18 | Fedora 18 ]]  
 
* Targeted release: [[Releases/18 | Fedora 18 ]]  
* Last updated: 2012-07-17
+
* Last updated: 2012-10-04
* Percentage of completion: 50%
+
* Percentage of completion: 100%
  
The bulk of the integration patches have been merged upstream for GNOME 3.5.4, and should appear shortly in Rawhide.
+
The bulk of the integration patches have been merged upstream for GNOME 3.5.91, and is now in rawhide.
  
 
See http://live.gnome.org/ThreePointFive/Features/IBus for more detailed upstream status.
 
See http://live.gnome.org/ThreePointFive/Features/IBus for more detailed upstream status.
  
 
== Detailed Description ==
 
== Detailed Description ==
This work partly extends and replaces the experimental gnome-shell extension called ibus-gnome3 that has been in Fedora since F16.
+
* gnome-settings-daemon will start ibus-daemon in gnome-shell, rather than imsettings
 
+
* gnome-settings-daemon will not start ibus-daemon if it is requires rather than imsettings
+
 
* users will be able to choose input methods in gnome-control-center along with keyboard layouts
 
* users will be able to choose input methods in gnome-control-center along with keyboard layouts
 
* gnome-shell input indicator will show the current keyboard layout or input method in use if they have been added
 
* gnome-shell input indicator will show the current keyboard layout or input method in use if they have been added
 
* basic hotkey configuration for switch layouts and input methods will also be handled by gnome-control-center
 
* basic hotkey configuration for switch layouts and input methods will also be handled by gnome-control-center
 +
* keyboard layout variations will partially be handled in gnome-control-center, and partially in gnome-tweak-tool
 +
* default IMEs and XKBs will be configured in gnome-initial-setup
 +
* IME switcher UI (likes Fedora 17 one) will be implemented in gnome-settings-daemon for gnome-shell
 +
* IME list will be hard-coded in gnome-control-center
 +
* The number of IME menu will be restricted to one or two.
 +
 +
The new indicator extends and replaces the optional experimental ibus-gnome3 gnome-shell extension that has been in Fedora from F16.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
Currently the ibus-gnome3 package is not enabled by default and users need to enable the ibus indicator manually in Fedora 17.
+
Users will have native gnome-shell support for ibus input methods seamlessly integrated with the current gnome support for keyboard layouts.
  
When the ibus integration is done in gnome-shell, ibus input methods will be available in the control-center region panel and in the gnome-shell keyboard input menu without any manual steps (other than making sure that ibus and suitable ibus engines are installed).
+
With the ibus integration in gnome-shell, ibus input methods will be listed in the control-center region panel and in the gnome-shell input indicator, without having to use the separate ibus-setup tool.
  
 
== Scope ==
 
== Scope ==
* gnome-shell's input indicator will include input method support
+
* gnome-shell input indicator will include input method support (done)
* in gnome-shell ibus will no longer runs an applet on the panel
+
* in gnome-shell ibus will no longer runs an applet on the panel (done)
* gnome-control-center will provide ibus configuration
+
* gnome-control-center will provide ibus configuration (done)
* gnome-settings-daemon launches ibus-daemon and switches engines
+
* gnome-settings-daemon launches ibus-daemon and switches engines (done)
* gnome-control-center will provide basic configuration for hotkeys for changing keyboard layout and input methods
+
* gnome-control-center will provide basic configuration for hotkeys for changing keyboard layout and input methods (done)
 
+
* ibus-setup will no longer be accessible from gnome-shell GUI (done)
Nice to have in Fedora:
+
* individual input method setup UI will be accessible from gnome-control-center (done)
* setup input method hotkey for CIJK users
+
* imsettings will no longer run under gnome-shell (done)
* setup default IMEs for CIJK users
+
* im-chooser will no longer run under gnome-shell (done)
* ibus-xkb for other desktops: [https://bugzilla.redhat.com/show_bug.cgi?id=825143 package review]
+
  
 
== How To Test ==
 
== How To Test ==
Line 65: Line 69:
  
 
Users will be able to configure hotkeys if they wish to switch keyboard layout or input method.
 
Users will be able to configure hotkeys if they wish to switch keyboard layout or input method.
 +
 +
In Fedora we would also like to:
 +
* setup input method hotkey for CIJK users
 +
* setup default IMEs for CIJK users
  
 
== Dependencies ==
 
== Dependencies ==
 
See https://live.gnome.org/ThreePointFive/Features/IBus for details on status of upstream patches.
 
See https://live.gnome.org/ThreePointFive/Features/IBus for details on status of upstream patches.
  
* gnome-shell depends on ibus libraries
+
Some changes are also needed in ibus upstream to complete the integration.
* gnome-control-center depends on ibus libraries
+
* ibus-setup won't be accessible from GUI in gnome-shell, but input methods will be configurable from the control-center
+
  
Q: so can you clarify in our feature page, what features are approved/agreed to include in 3.6 and what features are proposed but not yet approved/agreed?<br />
+
(Q&A comments previously here were moved to the [[Talk:Features/GNOMEIBusIntegration|Talk page]].)
A: Currently approved patches are gnome-shell and switching engines by g-s-d. Running ibus-daemon and g-c-c is under the review.<br />
+
 
+
Q: which features of the above contains ibus-setup replacement say?<br />
+
A: g-c-c.<br />
+
 
+
Q: When gnome-settings-daemon is implemented to run ibus-daemon
+
* if imsettings disables to run ibus-daemon
+
* im-chooser can be run by users
+
* if any UIs provide the option to disable ibus-daemon
+
* if ibus-daemon runs on any locales
+
* if ibus-daemon runs without ibus engines
+
* if imsettings needs to be run to export QT_IM_MODULE and XMODIFIERS<br/>
+
A: As of 3.5.4, gnome-settings-daemon will only activate ibus-daemon when needed - ie when the list of active input sources contains input methods requiring IBus. If you don't want ibus-daemon to run, you can just not add any such input sources to the list. Or you can uninstall ibus-daemon. Users can run im-chooser if they want to, but it will probably interfere with the Input Sources UI in the control-center.
+
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 
gnome-3.6 is planning to support ibus, but in the worst case ibus support could be disabled from gnome-settings-daemon, imsettings could be reenabled for gnome, and ibus reverted to using the ibus upstream applet in the gnome panel.
 
gnome-3.6 is planning to support ibus, but in the worst case ibus support could be disabled from gnome-settings-daemon, imsettings could be reenabled for gnome, and ibus reverted to using the ibus upstream applet in the gnome panel.
 +
 +
The item will be postponed to GNOME 3.8 (Fedora 19) below.
 +
* gnome-initial-setup provides the default IMEs and XKBs list.
 +
 +
Currently ibus-anthy shows the IME menus. Probably we'll evaluate the menus again in the next release.
 +
* gnome-shell menu provides IME menus
  
 
== Documentation ==
 
== Documentation ==
Line 99: Line 98:
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
* Input methods (based on IBus) have been integrated directly into GNOME3.
+
* Input method support (based on IBus) has been integrated into GNOME3.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
Line 105: Line 104:
  
  
[[Category:FeatureReadyForFesco]]
+
[[Category:FeatureAcceptedF18]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 06:50, 4 October 2012

Contents

[edit] GNOME IBus Integration

[edit] Summary

Gnome 3.6 will provide support for input methods using IBus, in addition to keyboard layout configuration.

The integration includes a gnome-shell input indicator combining keyboard layouts and input methods selection, and also setup of input methods inside gnome-control-center.

For this to be a smooth transition for Fedora users, various changes behind the scenes and testing are required, and this is covered by this feature.

[edit] Owner

[edit] Current status

  • Targeted release: Fedora 18
  • Last updated: 2012-10-04
  • Percentage of completion: 100%

The bulk of the integration patches have been merged upstream for GNOME 3.5.91, and is now in rawhide.

See http://live.gnome.org/ThreePointFive/Features/IBus for more detailed upstream status.

[edit] Detailed Description

  • gnome-settings-daemon will start ibus-daemon in gnome-shell, rather than imsettings
  • users will be able to choose input methods in gnome-control-center along with keyboard layouts
  • gnome-shell input indicator will show the current keyboard layout or input method in use if they have been added
  • basic hotkey configuration for switch layouts and input methods will also be handled by gnome-control-center
  • keyboard layout variations will partially be handled in gnome-control-center, and partially in gnome-tweak-tool
  • default IMEs and XKBs will be configured in gnome-initial-setup
  • IME switcher UI (likes Fedora 17 one) will be implemented in gnome-settings-daemon for gnome-shell
  • IME list will be hard-coded in gnome-control-center
  • The number of IME menu will be restricted to one or two.

The new indicator extends and replaces the optional experimental ibus-gnome3 gnome-shell extension that has been in Fedora from F16.

[edit] Benefit to Fedora

Users will have native gnome-shell support for ibus input methods seamlessly integrated with the current gnome support for keyboard layouts.

With the ibus integration in gnome-shell, ibus input methods will be listed in the control-center region panel and in the gnome-shell input indicator, without having to use the separate ibus-setup tool.

[edit] Scope

  • gnome-shell input indicator will include input method support (done)
  • in gnome-shell ibus will no longer runs an applet on the panel (done)
  • gnome-control-center will provide ibus configuration (done)
  • gnome-settings-daemon launches ibus-daemon and switches engines (done)
  • gnome-control-center will provide basic configuration for hotkeys for changing keyboard layout and input methods (done)
  • ibus-setup will no longer be accessible from gnome-shell GUI (done)
  • individual input method setup UI will be accessible from gnome-control-center (done)
  • imsettings will no longer run under gnome-shell (done)
  • im-chooser will no longer run under gnome-shell (done)

[edit] How To Test

Install IBus and some engines, eg ibus-anthy.

Open gnome-control-center, region panel, input sources tab. Use the + button and add Anthy to the list of active input sources.

Verify that Anthy is now listed in the gnome-shell keyboard menu and can be activated from there.

Test that using Anthy to enter Japanese text works in gedit, firefox, and in gnome-shell itself, e.g. in the search entry.

Test that switching between keyboard layouts such as US layout and input methods such as Anthy works using both the shell menu and keyboard shortcuts.

Verify that the keyboard shortcuts can be changed in the control-center panel.

[edit] User Experience

gnome-shell input indicator supports input methods that have been configured.

gnome-control-center list available ibus input methods which can be selected for use.

Users will be able to configure hotkeys if they wish to switch keyboard layout or input method.

In Fedora we would also like to:

  • setup input method hotkey for CIJK users
  • setup default IMEs for CIJK users

[edit] Dependencies

See https://live.gnome.org/ThreePointFive/Features/IBus for details on status of upstream patches.

Some changes are also needed in ibus upstream to complete the integration.

(Q&A comments previously here were moved to the Talk page.)

[edit] Contingency Plan

gnome-3.6 is planning to support ibus, but in the worst case ibus support could be disabled from gnome-settings-daemon, imsettings could be reenabled for gnome, and ibus reverted to using the ibus upstream applet in the gnome panel.

The item will be postponed to GNOME 3.8 (Fedora 19) below.

  • gnome-initial-setup provides the default IMEs and XKBs list.

Currently ibus-anthy shows the IME menus. Probably we'll evaluate the menus again in the next release.

  • gnome-shell menu provides IME menus

[edit] Documentation

ibus-xkb is also integrated for non-GNOME desktop newly. ibus-xkb provides preloaded engines, all XKB layout, variant ibus engines, frequently used input method list on ibus-setup, customizable trigger key on ibus-setup.

[edit] Release Notes

  • Input method support (based on IBus) has been integrated into GNOME3.

[edit] Comments and Discussion