Jump to content

Topic on Talk:ResourceLoader/Version 2 Design Specification

Better documentation of gadgets, gadget manager

4
Jeblad (talkcontribs)

In ver 1 of the gadget manager the whole descriptive string is used as a label. In a new system it should be possible to write a descriptive text with links. Hopefully you fine folks have already solved that problem! ;)

Krinkle (talkcontribs)

Short answer: Using descriptive text with links is still possible. In addition to that we've introduced the ability to give a gadget a "Title". These are now separate.

Long answer:


I assume you mean version 1 of the "Gadgets" extension. The "Gadget manager" is entirely new and hasn't existed until now.

Previously a gadget had a codename and a description:

-- MediaWiki:Gadgets-definition:
*codename

-- MediaWiki:Gadget-codename
Description here with ''style'' and [[links]].

-- Special:Preferences
Gadgets:

[_] Description here with ''style'' and [[links]].

In Gadgets 2.0 we've introduced a "title" so that the "codename" doesn't have to be used as much, and this also allows for:

  • Titles to be localized in multiple languages (MediaWiki:Gadget-foo-title/fr)
  • Title to change without breaking existing preferences (since Title is now separate from codename)

New structure:

-- Special:Gadgets
== Title (edit) ==
Description (edit)

-- MediaWiki:Gadget-codename-title
Title

-- MediaWiki:Gadget-codename-desc
Description here with ''style'' and [[links]].


-- Special:Preferences
[_] Title
    Description here with ''style'' and [[links]].
Jeblad (talkcontribs)

Good! I like it! =)

Just don't do as in the Special:Preferences where the descriptions are wrapped up in label-tags, it creates a lot of problems if some one iterating back and forth between the special page and a linked description page. Doing so they ticks and unticks gadgets without noticing.

He7d3r (talkcontribs)

Indeed. Maybe only the title should be clickable?