Page MenuHomePhabricator

VisualEditor: Document what is needed in terms of support for custom MediaWiki skins
Closed, ResolvedPublic

Description

Author: duongxvu

Description:
I was wondering whether it is possible for VisualEditor to work with other skins besides the officially supported ones (which I believe to be Vector, Monobook, and Apex). I’ve been tasked with creating a custom skin to meet my organization’s existing design standards, but it does not seem so easy to add support for VisualEditor in this regard. And documentation addressing similar issues to mine seem to be rare at the moment.

For now, I've heavily modified Vector as a workaround, but would prefer a more long-term solution if one exists. I assume that the Vector skin will continue to receive regular updates in the future, and I’d like to avoid having to modify it every time that happens.


Version: unspecified
Severity: enhancement
URL: https://www.mediawiki.org/wiki/VisualEditor/Skin_requirements

Details

Reference
bz61500

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 22 2014, 3:02 AM
bzimport set Reference to bz61500.

Yes, we currently don't document well what requirements we have on skins (because we're adding requirements as we go). We should improve documentation so that it's easier for skin maintainers to know what they need to do.

I started writing some notes about what VE expects of skins in https://docs.google.com/a/wikimedia.org/document/d/1awG4IKujTFd72RJzr_4DVInKDO1BqRxRHbTnCHvYLr4/edit (Obviously, when I started a Google doc I expected to end up writing more. :/). Looking for feedback.

Currently it starts with the IDs it expects to be present and then a note relating to Gerrit change 130085 and Gerrit change 130656.

Never having made a skin myself I'm not 100% confident about what we need to make clear here or what's wanted by the bug reporter.

I have a skin ([[Skin::Cameleon]]) that's based on Dantmman's excellent tutorial ([[Manual:Skinning/Tutorial]]). All I really did (aside from installing Visual Editor) was to add my skin's name to the $wgVisualEditorSupportedSkins global array variable.

We already found a number of CSS issues, that need fixing, but aside from that it seems to work.