Good question (and no good answer) and I think it address to the weakest
point of VE documentation - it doesn't have enough code examples, or high
view documentation.
(the best answer you can get may be
)
My advice is to AVOID using this documentation - this is usually micro
level documentation, and it is not enough.
You should prefer to grep the codebase to get some working examples and
craft it.
Here is the example of graph:
and old (possibly outdated) but good into and high level documentation for
VE:
On Thu, Jan 21, 2016 at 10:49 PM, Daniel Barrett <danb(a)cimpress.com> wrote:
Thank you! Which class on this page is the best
starting point for
learning to write a plugin?
https://doc.wikimedia.org/VisualEditor/master/
DanB
----------------------------------------------------------------------------------------------------------------------------
From: Wikitech-l [mailto:wikitech-l-bounces@lists.wikimedia.org] On
Behalf Of Trevor Parscal
Sent: Thursday, January 21, 2016 11:28 AM
To: Wikimedia developers
Subject: Re: [Wikitech-l] VisualEditor roadmap - extensibility within
MediaWiki?
VisualEditor is very extendable by design. You can do pretty much anything
you want with a plugin, and we've demonstrated this with many existing
plugins that provide all sorts of interesting features.
The APIs for adding features to VisualEditor, while perhaps not as well
documented as we'd like them to be, have existed for years and are now
quite stable.
We have seen extensions such as math, graph and score be integrated into
VisualEditor by developers who are relatively new to the code base.
However, direct communication with the team was still important to those
efforts.
The documentation that does exist is generated from code comments, and the
VisualEditor code base is particularly well documented. There was
a supplemental documentation effort for OOjs UI this time last year, and I
think that worked out pretty well. This may be something we can do in the
next six months, but there are not yet any concrete plans to do so.
Ed Sanders is a good person to be in touch with, along with others on the
VosualEditor team, who are easily reached on IRC. See the MediaWiki page on
VisialEditor for details.
- Trevor
On Thursday, January 21, 2016, Daniel Barrett <danb(a)cimpress.com> wrote:
I was looking through the VisualEditor roadmap (
https://www.mediawiki.org/wiki/VisualEditor/Roadmap) and did not notice
anything about third-party MediaWiki extensions for the editor. Did I
miss it?
I do see plans for "non-Mediawiki" extensions (under "Release for
third-party non-MediaWiki users"), and also for Mediawiki admins to
"easily install and use VisualEditor" (under "Release for third-party
MediaWiki users"), but nothing about extending it within MediaWiki. For
example, adding a button or menu item to insert a particular parser tag.
Is this by design?
I did notice "Non-template transclusions" on the roadmap, which looks
like
a way to insert parser tags & parser
functions if you already know their
name (the way template transclusions work right now). That will be a big
help. However, for (say) inserting a given parser tag, it would be great
if
we could easily add a button or menu item for
it.
Thank you very much for any info.
DanB
_______________________________________________
Wikitech-l mailing list
Wikitech-l(a)lists.wikimedia.org <javascript:;>
https://lists.wikimedia.org/mailman/listinfo/wikitech-l
_______________________________________________
Wikitech-l mailing list
Wikitech-l(a)lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l
_______________________________________________
Wikitech-l mailing list
Wikitech-l(a)lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l