Last modified: 2011-03-13 18:05:25 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 7210 - Add "Template usage" namespace for describing parameters and examples
Add "Template usage" namespace for describing parameters and examples
Status: RESOLVED WONTFIX
Product: MediaWiki
Classification: Unclassified
Templates (Other open bugs)
unspecified
All All
: Lowest enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2006-09-02 21:28 UTC by Matthew W. Jackson
Modified: 2011-03-13 18:05 UTC (History)
0 users

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


Attachments

Description Matthew W. Jackson 2006-09-02 21:28:01 UTC
Right now there are three general methods used to describe how to use a template:
1) Put the documentation inside <noinclude> tags in the template page itself
(Template:Foo)
2) Put the documentation on the talk page (Template talk:Foo#Usage)
3) Put the documentation on a sub-page (Template:Foo/Usage)

Method 1 has the potential to add strain on the server when transcluding a
template, and if [[Wikipedia:Template limits]] are enabled, the template will
likely hit the size limit sooner. 

For methods 2 and 3, a message describing where to find the documentation is
still generally needed on the template itself in a <noinclude> section.  While
this is an improvement, it still clutters up the template code itself and adds
to the transclusion size.

The talk page, which is currently the generally preferred location, does not
seem to be the correct place for documenting a template, either.  Besides,
people who come to discuss the template have to worry about editing around the
documentation.  (I'm not sure if threaded talk pages will help or hinder the
situation).

Using sub-pages has the problem of discover-ability.  Without an explicit link
on the template or talk page, it would be almost impossible to find the
documentation page.  

By adding a "Template usage" namespace, the description of the template can be
put in a well-defined place, and all of these problems avoided.  A new tab could
appear between "Template" and "Discussion", making it more obvious where to find
usage help.
Comment 1 Rob Church 2006-09-03 13:50:41 UTC
The three existing methods mentioned (which aren't the only options) suffice fine.

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


Navigation
Links