Features/english-typing-booster

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(Comments and Discussion)
(Current status)
 
(32 intermediate revisions by 3 users not shown)
Line 7: Line 7:
  
 
== Summary ==
 
== Summary ==
English Typing Booster is a predictive input method for ibus platform. It predicts complete words based on partial input. One can then simply select word from suggestion list and improve typing speed with more accuracy.
+
English Typing Booster is a predictive input method for the ibus platform. It predicts complete words based on partial input. One can then simply select the desired word from a list of suggestions and improve one's typing speed and spelling.
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
+
  
 
== Owner ==
 
== Owner ==
<!--This should link to your home wiki page so we know who you are-->
+
* Name: Anish Patil, Pravin Satpute
* Name:anishpatil,pravins
+
  
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
+
* Email: apatil@redhat.com, psatpute@redhat.com
* Email: apatil@redhat.com,psatpute@redhat.com
+
  
 
== Current status ==
 
== Current status ==
Targeted release: Fedora 17
+
* Targeted release: Fedora 17
*Last updated: 2012-01-20
+
* Last updated: 2012-02-23
*Percentage of completion: 100%
+
* Percentage of completion: 100%
 
+
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
  
 
== Detailed Description ==
 
== Detailed Description ==
Our aim is to provide efficacious input method that will assist user while typing text.
+
The goal is to provide an efficient completing input method that will assist users while typing text.
  
More description of the project can be found on https://fedorahosted.org/ibus-european-table/ and
+
'''Boost:'''
https://fedorahosted.org/english-typing-booster/
+
Within few keystrokes user gets the desire word within the list.
 
+
It saves user's typing and makes typing faster.
English typing booster supports all the supports currently widely used maps, so the user does not need to switch his existing input maps.
+
e.g For typing word "wordnet", it requires three 6 key strokes. With Typing Booster it requires only three keystrokes.
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+
 
+
== Benefit to Fedora ==
+
'''Impetus typing method:'''
+
 
+
Within few keystrokes user gets the desire word within the list.
+
 
+
It saves user's typing and makes typing faster.
+
 
+
e.g For typing word "wordnet", it requires three 6 key strokes.With European typing it requires only three keystrokes.
+
  
 
'''Easiness:'''
 
'''Easiness:'''
 
+
No need to learn new method or technology. 
No need to learn new method or technology. 
+
User can add/delete new words into the user dictionary.
 
+
New words will get added automatically.
User can add/delete new words into the user dictionary.
+
 
+
New words will get added automatically.
+
  
 
'''Accuracy:'''
 
'''Accuracy:'''
 +
Since the suggestions come from a validated word dictionary database,
 +
the selected words always give 100% accurate spelling.
 +
Note: correctly the present generated database is from unreviewed web data, in the long term with community help,
 +
they can be reviewed and the correctness checked as per standard.
 +
Also infrequent words which may be mis-spellings can be filtered easily from the dictionaries.
  
Since the suggestions come from a validated word dictionary database, the selected words always give 100% accurate spelling. Note: correctly the present generated database is from unreviewed web data, in the long term with community help, they can be reviewed and the correctness checked as per standard. Also infrequent words which may be mis-spellings can be filtered easily from the dictionaries.
+
== Benefit to Fedora ==
 +
Fedora will get a new input method for English language, which will enhance the text creation process, and end users will be able to type more accurately and faster with this input method.
 +
English typing booster offers features such as, prediction of words (auto-completion), suggestions of words if the user misspells: suggestions are by frequency of use.
  
Fedora will get one new input method for english language, it will enhance data creation process and end users can type with more accuracy and faster with this input method.
+
This feature will give Fedora users a interesting, more modern input experience.
 
+
Yes this is major capability, since existing input method does not have much intelligence in it. On the other hand english-typing-booster maintains background database, it maintain users word frequency count so as soon as user start using it he gets his frequently used words in suggestion box. As well if he misplell any word, he will get nearest matching correct word in suggestion list.
+
 
+
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
+
  
 
== Scope ==
 
== Scope ==
 
+
* Develop initial version of ibus-european-table. [done]
Step1: Initial version of ibus-european-table is done. New package request is under https://bugzilla.redhat.com/show_bug.cgi?id=761474
+
* Submit package for [https://bugzilla.redhat.com/show_bug.cgi?id=761474 review] and build. [done]
      package added ibus-european-table [Done]
+
* Create dictionary tables from  stardict-dic-en for English. [done]
 
+
* [https://bugzilla.redhat.com/show_bug.cgi?id=769173 Package] English language database for Fedora. [done]
Step2: Packaging English language database New package request is under https://bugzilla.redhat.com/show_bug.cgi?id=769173
+
* Test in rawhide and updates-testing. [in progress]
      Create dictionary tables from wikipedia dumps for English. More languages will follow later.
+
* Fix bugs reported
 
+
* Add additional databases for some other European languages.
Step3: Initial testing with english language is done.
+
 
+
Step4: Fixing bugs and adding additional database for other European languages.
+
 
+
This is new package and do not affect any other existing package, its dependancies are ibus and ibus-european-table.
+
 
+
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
  
 
== How To Test ==
 
== How To Test ==
A) Add input-methods to ibus from preferences
+
* Addition/installation of input method
 +
** sudo yum install english-typing-booster ibus-european-table -y
 +
** Run im-chooser (Input method selector) and select ibus
 +
** Right click on desktop panel's ibus icon -> select preference -> click on input method
 +
** Choose English typing booster from English language submenu
 +
* Testing the appication
 +
** Open any text creation application
 +
** Click on ibus icon and select English typing booster to start english-typing-booster
  
1) $sudo yum install english-typing-booster ibus-european-table -y
+
Enjoy! and report any bugs or suggestions!
 
+
2) From im-chooser (Input method selector) select ibus
+
 
+
3) Right click on desktop panel's ibus icon -> select preference -> click on input method
+
 
+
4) from english language select English typing booster, add it
+
 
+
B) Activate input method and type with predictions in applications.
+
 
+
1) Open any data  creation application
+
 
+
2) from ibus icon select English - Typing booster
+
 
+
Have a nice usage experience !!
+
 
+
 
+
 
+
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
+
 
+
Remember that you are writing this how to for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
+
 
+
A good "how to test" should answer these four questions:
+
 
+
0. What special hardware / data / etc. is needed (if any)?
+
1. How do I prepare my system to test this feature? What packages
+
need to be installed, config files edited, etc.?
+
2. What specific actions do I perform to check that the feature is
+
working like it's supposed to?
+
3. What are the expected results of those actions?
+
-->
+
  
 
== User Experience ==
 
== User Experience ==
 
+
Users have a new predictive input method which allows them to write in English with completion.
1) No need to learn any new things
+
It is particularly convenient for typing longer unfamiliar words.
 
+
Boost in typing process with accurate spellings.
2) Assist the users by predicting words
+
 
+
3) Easy while typing of lengthy words
+
+
4) Boost in typing process with accurate spellings.  
+
 
+
 
+
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
+
  
 
== Dependencies ==
 
== Dependencies ==
 
+
* No other packages depend on this.
- No other packages depend on this.
+
* Upstream is maintained by feature owner
 
+
- upstream is maintained by feature owner
+
 
+
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
+
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 
As these are new input methods, no contingency plans necessary.
 
As these are new input methods, no contingency plans necessary.
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 
  
 
== Documentation ==
 
== Documentation ==
 
+
* https://fedorahosted.org/english-typing-booster/
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+
* https://fedorahosted.org/ibus-european-table/
* See the project website
+
 
+
https://fedorahosted.org/english-typing-booster/
+
  
 
== Release Notes ==
 
== Release Notes ==
Line 150: Line 88:
 
<!-- 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. -->
  
* English typing booster is a predictive text input method for English language. It enhance user typing experience.
+
* English typing booster is a predictive text input method for English language. It enhances user typing experience.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
Line 158: Line 96:
  
  
[[Category:FeatureReadyForWrangler]]
+
[[Category:FeatureAcceptedF17]]
 
<!-- 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 05:24, 23 February 2012


Contents

[edit] english-typing-booster

[edit] Summary

English Typing Booster is a predictive input method for the ibus platform. It predicts complete words based on partial input. One can then simply select the desired word from a list of suggestions and improve one's typing speed and spelling.

[edit] Owner

  • Name: Anish Patil, Pravin Satpute
  • Email: apatil@redhat.com, psatpute@redhat.com

[edit] Current status

  • Targeted release: Fedora 17
  • Last updated: 2012-02-23
  • Percentage of completion: 100%

[edit] Detailed Description

The goal is to provide an efficient completing input method that will assist users while typing text.

Boost: Within few keystrokes user gets the desire word within the list. It saves user's typing and makes typing faster. e.g For typing word "wordnet", it requires three 6 key strokes. With Typing Booster it requires only three keystrokes.

Easiness: No need to learn new method or technology.  User can add/delete new words into the user dictionary. New words will get added automatically.

Accuracy: Since the suggestions come from a validated word dictionary database, the selected words always give 100% accurate spelling. Note: correctly the present generated database is from unreviewed web data, in the long term with community help, they can be reviewed and the correctness checked as per standard. Also infrequent words which may be mis-spellings can be filtered easily from the dictionaries.

[edit] Benefit to Fedora

Fedora will get a new input method for English language, which will enhance the text creation process, and end users will be able to type more accurately and faster with this input method. English typing booster offers features such as, prediction of words (auto-completion), suggestions of words if the user misspells: suggestions are by frequency of use.

This feature will give Fedora users a interesting, more modern input experience.

[edit] Scope

  • Develop initial version of ibus-european-table. [done]
  • Submit package for review and build. [done]
  • Create dictionary tables from stardict-dic-en for English. [done]
  • Package English language database for Fedora. [done]
  • Test in rawhide and updates-testing. [in progress]
  • Fix bugs reported
  • Add additional databases for some other European languages.

[edit] How To Test

  • Addition/installation of input method
    • sudo yum install english-typing-booster ibus-european-table -y
    • Run im-chooser (Input method selector) and select ibus
    • Right click on desktop panel's ibus icon -> select preference -> click on input method
    • Choose English typing booster from English language submenu
  • Testing the appication
    • Open any text creation application
    • Click on ibus icon and select English typing booster to start english-typing-booster

Enjoy! and report any bugs or suggestions!

[edit] User Experience

Users have a new predictive input method which allows them to write in English with completion. It is particularly convenient for typing longer unfamiliar words. Boost in typing process with accurate spellings.

[edit] Dependencies

  • No other packages depend on this.
  • Upstream is maintained by feature owner

[edit] Contingency Plan

As these are new input methods, no contingency plans necessary.

[edit] Documentation

[edit] Release Notes

  • English typing booster is a predictive text input method for English language. It enhances user typing experience.

[edit] Comments and Discussion