Hi, When the ResourceLoader was deployed (or even before it) to production, there were migration development guides for gadget/extension developers:
- http://www.mediawiki.org/wiki/ResourceLoader/Migration_guide_for_extension_d... - http://www.mediawiki.org/wiki/ResourceLoader/Developing_with_ResourceLoader
Such guides allowed easier adoption of ResourceLoader. We need something similar for the visual editor:
- Migration - What are the recommended steps to make gadget/extension VE adapted? [with answers to questions such as: how to get the underlying model - instead of $('#wpTextbox1').val() and what is this model [and what modifications to the underlying model are supported/to be avoided by gadgets/user scripts ] ] - Development with the VE: guides with explanation for common editor UI customization, and what is recommended API for it (for example: add custom toolbar buttons).
Eran
On Mon, Jul 22, 2013 at 9:51 AM, Eran Rosenthal eranroz89@gmail.com wrote:
Hi, When the ResourceLoader was deployed (or even before it) to production, there were migration development guides for gadget/extension developers:
http://www.mediawiki.org/wiki/ResourceLoader/Migration_guide_for_extension_d...
http://www.mediawiki.org/wiki/ResourceLoader/Developing_with_ResourceLoader
Such guides allowed easier adoption of ResourceLoader. We need something similar for the visual editor:
Yes we do :) . More generally, VE needs plugin infrastructure. Most of it is already there, and I'm working on the last bits of it.
- Migration - What are the recommended steps to make gadget/extension
VE adapted? [with answers to questions such as: how to get the underlying model - instead of $('#wpTextbox1').val() and what is this model [and what modifications to the underlying model are supported/to be avoided by gadgets/user scripts ] ]
- Development with the VE: guides with explanation for common editor UI
customization, and what is recommended API for it (for example: add custom toolbar buttons).
These are excellent suggestions for documentation we should write once the plugin infrastructure work is done. I intend to do this in the next few weeks.
Roan
On Mon, Jul 22, 2013 at 3:00 PM, Roan Kattouw roan.kattouw@gmail.comwrote:
On Mon, Jul 22, 2013 at 9:51 AM, Eran Rosenthal eranroz89@gmail.com wrote:
Hi, When the ResourceLoader was deployed (or even before it) to production, there were migration development guides for gadget/extension developers:
http://www.mediawiki.org/wiki/ResourceLoader/Migration_guide_for_extension_d...
http://www.mediawiki.org/wiki/ResourceLoader/Developing_with_ResourceLoader
Such guides allowed easier adoption of ResourceLoader. We need something similar for the visual editor:
Yes we do :) . More generally, VE needs plugin infrastructure. Most of it is already there, and I'm working on the last bits of it.
- Migration - What are the recommended steps to make gadget/extension
VE adapted? [with answers to questions such as: how to get the
underlying
model - instead of $('#wpTextbox1').val() and what is this model [and
what
modifications to the underlying model are supported/to be avoided by gadgets/user scripts ] ]
- Development with the VE: guides with explanation for common editor
UI
customization, and what is recommended API for it (for example: add
custom
toolbar buttons).
These are excellent suggestions for documentation we should write once the plugin infrastructure work is done. I intend to do this in the next few weeks.
Roan
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Roan, how did that go? Any links? :-)
Sumana Harihareswara Engineering Community Manager Wikimedia Foundation
On Tue, Sep 24, 2013 at 11:45 AM, Sumana Harihareswara sumanah@wikimedia.org wrote:
Roan, how did that go? Any links? :-)
The code ended up being written and merged. The documentation ended up not being written before Wikimania, and then Life happened. Some Time Soon I hope to get around to actually writing this up properly.
In the meantime, https://gerrit.wikimedia.org/r/#/c/75270/ fixes a ResourceLoader bug that fatally breaks VE's plugin infrastructure for on-wiki scripts (Gadgets and user/site JS), so until that's merged and deployed, the interface I'd be documenting doesn't actually work anyway.
Another thing I'm gonna do soon is take the GSoC project code for Math and SyntaxHighlight and move it out of the VisualEditor extension into the respective extensions. That'll be a good showcase for the extension plugin integration, which does already work. Right after I get that done would be a good time to document this, because I'll have just gone through the process and know the pitfalls etc. first-hand.
Roan
i've also been writing the togetherjs extension "out of tree" from v.e. so have a little bit of experience there. a couple more apis could be stabilized to help extensions find ve instances on a page.... --scott
On Wed, Sep 25, 2013 at 5:55 PM, Roan Kattouw roan.kattouw@gmail.comwrote:
On Tue, Sep 24, 2013 at 11:45 AM, Sumana Harihareswara sumanah@wikimedia.org wrote:
Roan, how did that go? Any links? :-)
The code ended up being written and merged. The documentation ended up not being written before Wikimania, and then Life happened. Some Time Soon I hope to get around to actually writing this up properly.
In the meantime, https://gerrit.wikimedia.org/r/#/c/75270/ fixes a ResourceLoader bug that fatally breaks VE's plugin infrastructure for on-wiki scripts (Gadgets and user/site JS), so until that's merged and deployed, the interface I'd be documenting doesn't actually work anyway.
Another thing I'm gonna do soon is take the GSoC project code for Math and SyntaxHighlight and move it out of the VisualEditor extension into the respective extensions. That'll be a good showcase for the extension plugin integration, which does already work. Right after I get that done would be a good time to document this, because I'll have just gone through the process and know the pitfalls etc. first-hand.
Roan
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
wikitech-l@lists.wikimedia.org