View source for Grants:IEG/Visual editor- gadgets compatibility

{{IEG/Proposals/Infobox
<!--List the names of all project participants in the space below. Please link them to active usernames wherever possible, for example, [[User:Me|My Full Name]], [[User:Guy|Guys' Name]].-->
|grantees=[[User:ערן|eranroz]], [[User:Ravid ziv|Ravid ziv]]
|volunteers=
|advisors=
|contact=eranroz89{{@}}gmail.com or ravidziv{{@}}gmail.com
|summary=<br>
*Map all the gadgets for editing-aid in various Wikipedia languages
*Add support for Visual editor for some of the most common editing gadgets
*Write documentation/create JS library for partial-compatibility between the "classic" and the Visual editor editing mode
|more participants=NO
|title={{SUBPAGENAME}}<!--You don't need to change this entry-->
|round=2<!--You don't need to change this entry-->
|year=2013<!--You don't need to change this entry-->
|status=DRAFT<!--When you have completed all 3 parts of your proposal and it is ready for review, change DRAFT to PROPOSED (all caps).-->
|IdeaLab=YES<!--If you want to remove your proposal from the IdeaLab, delete "YES"-->
|target=Wikimedia Projects, VisualEditor
|amount=4500 USD
}}

==Project idea==
Many gadgets and scripts have been created by volunteers across Wikimedia projects, which add various features. Many of them are intended for editors for improved editing experience. In the last few months, there is a new VisualEditor interface for editing articles. While this interface is still in "beta" there are many non-supported features yet. The known non-supported features are core features (such as [[bugzilla:39596|tables]]) and extension features (such as [[bugzilla:43115|timelines]]), but there are many unknown non-supported features - gadgets.

Moreover, since there is no central repository for gadgets there is a huge mess with them: there is no easy way to tell what gadgets exist across all wikis, some projects use older versions of gadgets, small communities don't get useful gadgets and some cool gadgets are used only by small communities.

The project aims to organize the gadget mess, improve gadgets sharing among communities, and to push gadgets improvements for edit interface to VisualEditor.

The project is defined in few stages, each of them will have it's own benefit:
{| border="1"
! Stage !! width="70%" | Description !! benefits
|-
| 1
| First stage is to map all the gadgets (in any language) and to create a list of all the gadgets in various projects
| Based on this list we may call different projects (in Village pump) to update their gadgets to newer versions. [gadgets which exist in various languages]
|-
| 2
| programmatically understand what of these gadgets are related to editing [Searching the code for common edit interface elements: textarea, WikiEditor api (enhanced editing toolbar) etc]
| can help understand what features/gadgets that may possibly need patch to support visual editor. [Unknown=>Known]
|-
| 3
| Rate gadgets by popularity across projects
| [no real benefit by itself, but may help communities to adopt new gadgets]
|-
| 4
| Convert some of the most popular editing gadgets to support the new VisualEditor. We assume that in some cases it will require very similar changes. We hope it will be possible to create a small JS library so volunteers will find it easier to add compatibility to the new VisualEditor for their gadgets. In case it won't be possible we will at least create a documentation for how to do it in common cases.
| 
*Improve the visual editor with some new features [gadgets conversion]
*Make VisualEditor adoption easier for gadgets developers
|}

==Project goals==
* Improved sharing of gadgets on various projects:
** Wider adoption for gadgets across communities
** Upgrade old versions of gadgets that exist in some projects to newer versions
* Extend VisualEditor with some of the most popular gadgets


<!--The templates below help maintain your proposal, please leave them, thank you!-->
{{IEG/Proposals/Button/2}}

== Part 2: The Project Plan ==

__TOC__<!--The sections below provide the required structure for part 2 of your project proposal, feel free to add to them but please keep the provided subsections.-->
==Project plan==
<!--Leave this blank.-->
===Scope:===
====Scope and activities====
<!--What will you spend your time doing if this project is funded? What will be completed by the end of the project?-->
* see the above table [or for more technical explanation see next section]

====Tools, technologies, and techniques====
<!--What kinds of things do you expect you’ll need most in order to complete your project? -->
*Implement some python scripts/bots for the first stages:
** to query [[MediaWiki:Gadgets-definition]] on each project to find what gadgets exist
** some statistics on this list (versions - according to revision history) & user preferences (similar to [[:en:Wikipedia:Database reports/User preferences|gadgets popularity]])
** classification of edit-interface gadgets based on their source [since we don't speak so many languages :) ]
** create bot to leave message on various village pumps regarding new versions of gadgets
* Patch some of the most common edit-interface gadgets to support VE.

===Budget:===
====Total amount requested====
<!--Please list the total grant amount you are requesting in USD or local currency (USD will be assumed if no other currency is specified).-->
4500 USD 

====Budget breakdown====
<!--How you will use the funds you are requesting? You can create a table with the table button from the toolbar above, or just list bullet points.-->
<!--Examples: Travel roundtrip from Bangladesh to India: (Amount) USD, Visual design contractor: (Amount) USD, Project management: (Amount) USD, Wikimedia merchandise for volunteer giveaways: (Amount) USD, etc.-->


===Intended impact:===
====Target audience====
* Gadget developers
* editors in Wikimedia projects

====Fit with strategy====
<!--What crucial thing are you trying to change or have an effect on in the Wikimedia movement with this project? Please select a Wikimedia strategic priority that your project most directly aims to impact and explain how your project fits-->
<!--Examples of strategic priorities: Increasing Reach (more people are able to access Wikimedia projects), Improving Quality (better quality and quantity of content on Wikimedia projects), Increasing Participation (larger and more diverse groups of people are contributing to Wikimedia projects)-->
*Increasing Participation - Extending the VE by volunteers and making the edit features of VE and classic editing more common will make editing experience better.

====Sustainability====
<!--What do you expect will happen to your project after the grant ends? How might the project be continued or grown in new ways afterwards?-->
* We would like to run regular reports and statistics about gadgets popularity across projects using Labs.
* After introducing VE support to some of the most popular gadgets it will be easier for gadget developers volunteers to adopt it to their tools as well.

====Measures of success====
<!--How will you know if the project is successful? What are the targets, metrics, or measurable criteria will you use to learn if you’ve met your goals?-->
* Accessible statistics of gadget popularity across wikis. (It will help wiki admins [who is able to edit MediaWiki namespace] to know about cool gadgets that could be adopted)
* Number of gadgets updated across wikis to newer version
* Number of gadgets updated to support VE

==Participant(s)==
<!--Please list all prospective grantees for this project and tell us something about each of you. We’re particularly interested in hearing about any related skills, experience, or other background that you think will help make this idea successful.-->
===Eran Roz===
I'm student for computer science and computational biology (3rd year). I'm mainly active in hewiki ([[:he:User:ערן]]), and contributing to Wikipedia since 2003. I developed some bots (using pywikipedia and DotNetWikiBot frameworks) for hewiki, wrote some scripts and gadgets in hewiki and commons, and contributed [https://gerrit.wikimedia.org/r/#/q/owner:self+status:merged,n,z patches] to core/extensions.
  
===Ravid Ziv===
I'm 3rd year student for computer science and computational biology.
I'm active in an organization that called The Public Knowledge Workshop that it's mission is to release public information, and I mainly developing in djagno.

==Discussion==
<!--Leave this blank.-->
===Community Notification:===
<!--You are responsible for notifying relevant communities of your proposal. Depending on your project, notification may be most appropriate on a Village Pump, talk page, mailing list, etc.-->
Please paste a link to where the relevant communities have been notified of this proposal, and to any other relevant community discussions, here.   

===Endorsements:===
<!--This section is for community members to describe why they think a project idea is of value.-->
Do you think this project should be selected for an Individual Engagement Grant? Please add your name and rationale for endorsing this project in the list below. Other feedback, questions or concerns from community members are also highly valued, but please post them on the [[Grants talk:{{PAGENAME}}|talk page]] of this proposal.

*''Community member: add your name and rationale here.''

==See also==
* http://lists.wikimedia.org/pipermail/wikitech-l/2013-September/071990.html - discussion in wikitech regarding VE/Migration guide for gadgets developers.

<!--You have finished creating all sections of your proposal. Have a great time continuing to develop your project idea, we look forward to your completed submission!-->