Page MenuHomePhabricator

Gadgets 2.0: Write documentation
Closed, ResolvedPublic3 Estimated Story Points

Description

We need to write documentation for Gadgets 2.0.

Specifically, flesh out the sections at https://www.mediawiki.org/wiki/Gadgets_2.0.

Event Timeline

DannyH raised the priority of this task from to Needs Triage.
DannyH updated the task description. (Show Details)
DannyH added a project: Community-Tech.
DannyH moved this task to To Be Estimated/Discussed on the Community-Tech board.
DannyH added a subscriber: DannyH.
kaldari set Security to None.
DannyH triaged this task as Medium priority.Nov 10 2015, 6:08 PM
DannyH edited a custom field.
DannyH edited projects, added Community-Tech-Sprint; removed Community-Tech.

Would be good to use some of the screenshots posted by Krinkle in T31398.

@Legoktm, @Krinkle: I imagine we want to encourage gadget writers to use some sort of namespacing for their translatable messages (so that they don't collide with other gadget messages or MediaWiki software messages). Any suggestions regarding that? Maybe MediaWiki:gadget-foo-message? (For example, MediaWiki:gadget-hotcat-submit-button.)

@kaldari: Indeed. That should be the encouraged pattern. However I don't think we should enforce it by design since there is value in re-using core and extension messages as well. This is no different from other messages administrators can (and do) create for the sidebar and various other interface components.

In extensions we have conventions against re-use of messages but that's more viable there due to being backed by translatewiki.net. That isn't the case for gadgets.

@Krinkle: Thanks for the feedback. Feel free to tweak the documentation further at https://www.mediawiki.org/wiki/Gadgets_2.0.

The mw.Message constructor accepts an instance of mw.Map as argument. A separate mw.Map of messages could be provided to each gadget.

Qgil added a project: Developer-notice.
Qgil added a subscriber: Qgil.