Last modified: 2013-08-12 06:00:28 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 46563 - ResourceLoader: Modules should have a built-in list with details on all available modules
ResourceLoader: Modules should have a built-in list with details on all avail...
Status: NEW
Product: MediaWiki
Classification: Unclassified
ResourceLoader (Other open bugs)
1.22.0
All All
: Low enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2013-03-26 12:20 UTC by Daniel Friesen
Modified: 2013-08-12 06:00 UTC (History)
3 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Daniel Friesen 2013-03-26 12:20:50 UTC
We should add some built-in documentation/listing for RL modules like we have for Api modules, extensions, and special pages.

We'll add some more metadata and i18n for modules:
* Description message keys go into a module definition like we do with extension credits (or we could just use the module name and hardcode the pattern like we to with special page names)
* Another key defines the origin of the module (ie: core, ext.CodeEditor, etc...) so you can tell if the code is going to disappear if an extension is uninstalled.
* In i18n we define a block description of the module. And label names for the module groups we already have.

Then we'll add a new special page. On it we'll list all the available modules. Described by the description we added to i18n. Grouped by the group. With a few bits of extra helpful information like; Origin. Source if we implement RL2's multiple module sources. Dependencies. Top loading and the non-js css property we have a bug open to add. Has scripts? Styles? Custom implementation class?

We can probably add a list of i18n message keys inside a collapsible area. Perhaps even display it in an Allmessages table. This would allow an easy way for sites to find and customize the messages that modules use.

When we start generating documentation for extension scripts and RL modules we should also consider making it so that RL modules have enough information for the special page to link to generated documentation on the modules. For now we may want to consider documentation urls to pages like RL's Default modules page on MW.org.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links