Difference between revisions of "Template:Extension/doc"

This section describes parameters that govern infobox content. For help with '''templatemode''' and other control parameters, please see ''[[#Control parameters|Control parameters]]''.

     If you change an id, please update the code in Template:Extension accordingly

* ''[[:Category:Experimental extensions|experimental]]'' (early stages of development, may change drastically.)

If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed.

The  implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|category links]] as needed.

Legal values for the '''type1''','''type2''',... parameters are:

* [[:Category:User access extensions|'''''access''''']] - catchall for [[Manual:User access extensions|user access extensions]], that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:

** [[:Category:User activity extensions|''user activity'']] - extensions that monitor user activity (logins, logouts, new user creation, etc)

** [[:Category:User rights extensions|''user rights'']] - extensions to the rights management system, e.g. changes to the way rights are assigned, apis, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension.  For this purpose use the [[#rights|rights parameter]].).

** ''[[:Category:Page action extensions|''page action'']]'' - extensions that enhance or modify [[Manual:Page action|page action]]s. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (use ''user rights'') or logs (use ''user activity'').

** [[:Category:Hook extensions|''hook'']] - Hook extension - defines a <em>new</em> hook - see hook1, etc below if you want to define hooks <em>used</em> by your extension

<div style="border: thin solid blue">We are in the process of revising the values of this page. Types below this point are likely to be deprecated or redefined. We apologize for the inconvenience. See [[Template talk:Extension#Type taxonomy]] for more information.</div>

Note: Many extensions have more than one type, if this applies to yours,replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension.

Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook article so that programmers can easily find examples of extensions that use a particular hook.

* use the hook name alone. Please see [[Manual:Hooks]] for values (but omit introductory '/').

* use ''extensionName''/''hookName''. For a partial list of custom hooks, see [[Extension hook registry]].   

| <span id="download">'''download'''</span>|| '''link to the download''' : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN] or other. If you put the code into page in the MediaWiki Wiki, link to it using a full page name and section name, e.g. <code> <nowiki>[[Extension:Example/version_1.22a#Code]]</nowiki> </code> (it must remain valid when bot-copied elsewhere)

| <span id="bugzilla">bugzilla</span> || bugzilla MediaWiki extension component name