https://bugzilla.wikimedia.org/show_bug.cgi?id=46563
Web browser: ---
Bug ID: 46563
Summary: ResourceLoader Modules should have a built-in list
with details on all available modules
Product: MediaWiki
Version: unspecified
Hardware: All
OS: All
Status: NEW
Severity: normal
Priority: Unprioritized
Component: ResourceLoader
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected], [email protected],
[email protected]
Classification: Unclassified
Mobile Platform: ---
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.
--
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
