<translate> [[<tvar|1>Special:MyLanguage/Phabricator</>|Issue tracker]]:</translate> [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Difference between revisions of "Template:Extension/doc"

From WPRDC Wiki
Jump to navigation Jump to search
>Prateado Onesifor Lourenco
m (Prateado Onesifor Lourenco moved page Template:Extension/doc to Help:Extension/doc)
>Shirayuki
m (Shirayuki moved page Help:Extension/doc to Template:Extension/doc over a redirect without leaving a redirect: Vandalism)

Revision as of 11:29, 9 June 2016

Template:TNT

This template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to [[:Category:All extensionsTemplate:Translation]], along with the appropriate [[:Category:Extensions by statusTemplate:Translation|status]] and [[:Category:Extensions by implementation typeTemplate:Translation|implementation type]] categories.

Usage

Copy and paste:

{{ {{TNTN|Extension}} |templatemode =
|name            = 
|status          = 
|type1           = 
|type2           = 
|hook1           = 
|hook2           = 
|newhook1        = 
|newhook2        = 
|username        = 
|author          = 
|description     = 
|image           = 
|imagesize       = 
|version         = 
|update          = 
|version preview = 
|update preview  = 
|mediawiki       = 
|php             = 
|needs-updatephp = 
|composer        =
|table1          = 
|table2          = 
|license         = 
|download        = 
|readme          = 
|changelog       = 
|example         = 
|namespace       = 
|parameters      = 
|tags            = 
|rights          = 
|compatibility   = 
|bugzilla        = 
|phabricator     =
|vagrant-role    = 
}}

For help with parameter values, see below.

Lua error: callParserFunction: function "#translation" was not found.
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
{{{name}}}
Release status: unknown
Placeholder.png
Implementation Lua error: callParserFunction: function "#translation" was not found.
Description {{{description}}}
Author(s) SomeAuthor (SomeUsertalk)
Latest version Lua error: callParserFunction: function "#translation" was not found. ({{{update}}})
Latest preview version {{{version preview}}} ({{{update preview}}})
MediaWiki Lua error: callParserFunction: function "#translation" was not found.
PHP {{{php}}}
Database changes {{{needs-updatephp}}}
Composer {{{composer}}}
Tables [[Special:MyLanguage/Template:Extension/doc/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/doc/{{{table1}}} table| ]]
[[Special:MyLanguage/Template:Extension/doc/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/doc/{{{table2}}} table| ]]
License Lua error: callParserFunction: function "#translation" was not found.
Download {{{download}}}
{{{readme}}}
{{{changelog}}}
Example {{{example}}}
{{{namespace}}}
{{{parameters}}}
{{{tags}}}

{{{rights}}}

{{{compatibility}}}
Translate the Extension/doc extension if it is available at translatewiki.net
Vagrant role {{{vagrant-role}}}
Issues [[phab:tag/{{{phabricator}}}|Open tasks]] · Report a bug
Lua error: callParserFunction: function "#translation" was not found.


Content parameters

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

Content parameters
Parameter Description
name name of the extension
status current release status

One of:

  • [[:Category:Unstable extensionsTemplate:Translation|unstable]] (broken - do not use this extension)
  • [[:Category:Experimental extensionsTemplate:Translation|experimental]] (early stages of development, may change drastically)
  • [[:Category:Beta status extensionsTemplate:Translation|beta]] (stable but not fully tested)
  • [[:Category:Stable extensionsTemplate:Translation|stable]] (stable version)
  • [[:Category:Not LTS readyTemplate:Translation|unmaintained]] (unmaintained - previously claimed to be stable, now unmaintained)
  • [[:Category:Extensions with unknown statusTemplate:Translation|unknown]] (default)

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 unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed.

type1
type2
type3
type4
type5
type6
implementation type

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 purpose or possible use cases, we recommend you add additional category links as needed.


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

  • [[:Category:Parser extensionsTemplate:Translation|parser]] - catchall for uncategorized parser extensions. If you have written a parser extension, please use one of the following more specific types:
  • [[:Category:User access extensionsTemplate:Translation|access]] - catchall for 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 extensionsTemplate:Translation|user activity]] - extensions that monitor user activity (logins, logouts, new user creation, etc.)
    • [[:Category:User identity extensionsTemplate:Translation|user identity]] - extensions that create and delete users, and/or verify the identity of a user
    • [[:Category:User rights extensionsTemplate:Translation|user rights]] - extensions to the rights management system, e.g. changes to the way rights are assigned, API, 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 parameter)
  • [[:Category:User interface extensionsTemplate:Translation|interface]] - catchall for uncategorized user interface extensions.
    • [[:Category:Media handling extensionsTemplate:Translation|media]] - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers.
    • [[:Category:Personalization extensionsTemplate:Translation|mywiki]] - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
    • [[:Category:Notification extensionsTemplate:Translation|notify]] - extensions that email users, broadcast messages and provide other forms of community notification
    • [[:Category:Page action extensionsTemplate:Translation|page action]] - extensions that enhance or modify page actions. 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:Search extensionsTemplate:Translation|search]] - extensions that search through and select articles for users.
    • [[:Category:Skin extensionsTemplate:Translation|skin]] - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
    • [[:Category:Ajax extensionsTemplate:Translation|ajax]] - extensions that use Ajax programming techniques.
    • [[:Category:Special page extensionsTemplate:Translation|special]] - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Special:MyLanguage/Manual:Special pages for more information.
  • other
    • [[:Category:API extensionsTemplate:Translation|api]] - extensions that add a new API module or extend a core API module.
    • [[:Category:Hook extensionsTemplate:Translation|hook]] - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension
    • [[:Category:Database extensionsTemplate:Translation|database]] - adds tables and/or fields to the database backing a MediaWiki installation
    • [[:Category:Data extraction extensionsTemplate:Translation|data extraction]] - Data extraction
    • [[:Category:File repository extensionsTemplate:Translation|filerepo]] - extension that adds new file repository types as file backend
    • [[:Category:Extension examplesTemplate:Translation|example]] - Not a real extension, but an example of how to write one

Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing typeTemplate:Translation]].

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

hook1
hook2
hook3
hook4
...
hook30
name of each hook used by the 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.

For built-in hooks:

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

For custom hooks defined by extensions:

For multiple hooks, assign the first hook to hook1, the second to hook2 and so on.

newhook1
newhook2
newhook3
newhook4
...
newhook30
name of each hook provided by the extension

You might also want to add the hooks to Extension hook registry.

username The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.
author The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
description short description
image screenshot or logo of extension. It should be provided without namespace and without [[]]s.
imagesize facultative, size of the image (default size is 220px)
version last version
update date of the last update
mediawiki required version of MediaWiki
php required version of PHP
needs-updatephp Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty

Extensions which conform to MediaWiki extension standards come with a schema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to $IP/extensions/ExtensionName and inserted require_once "$IP/extensions/ExtensionName"; to "LocalSettings.php":

php $IP/maintenance/update.php

Template:TNT

composer If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.
table1
table2
table3
table4
...
table30
name of each non-core table used by the extension

Links to a subpage of your extension page. For instance, "table1 = cu_changes" at Extension:CheckUser will link to Extension:CheckUser/cu_changes table. Don't list core tables such as page or revision; only list tables that are added by extensions.

license license governing use of this extension, as one of the codes found in https://spdx.org/licenses/
download link to the download : Git, {{WikimediaDownload}} with server=svn in case it was not migrated from Subversion. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Extension:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
readme external link to the readme file, e.g. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
changelog external link to the changelog file, e.g. Extension:LDAP Authentication/Changelog
parameters available parameters for LocalSettings.php
tags any tags your extension uses (e.g. <tag1>, <tag2>).
rights rights added by the extension. Not to be confused with the license! Rights are such as makebot or desysop, not such as GFDL or LGPL or GPL - those are licenses!
namespace namespace in which this extension is used
example example, website or screenshot of working extension
compatibility Additional compatibility information, for instance compatibility charts (formerly using Template:Extension Testing). It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.
translate Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. If the default link is incorrect, manually set it to:
  • ext-LOWERCASE(NOSPACES(Label as defined in config)), aka
  • the parameter you get in the URL after
bugzilla Bugzilla MediaWiki extension component name
phabricator Phabricator project name
CheckUsageNameOverride override the page name used for the check usage link.

Control parameters

Control parameters
Parameter Description
templatemode Controls auto-categorization of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorization and the 'check usage' link. Use this value if you are adding this template to subpages of an extension or to how-to documentation of extensions. For example, the usage image above sets templatemode=nocats because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
  • nousage - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats'


If this is left blank, this template will add the host page to [[:Category:All extensionsTemplate:Translation]] and to one or more additional categories, depending on the values assigned to the Content parameters.

Using the infobox

Existing extension pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new extension article

If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.



<translate> A developer sharing their code in the MediaWiki code repository should expect:</translate>

<translate> Feedback / Criticism / Code reviews</translate>
<translate> Review and comments by other developers on things like [<tvar

Enhancing this template

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation

If you would like to fix documentation, please be aware that documentation and code is split into two files:

  • Template:Extension/doc - stores all documentation.
  • Template:Extension - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).


In addition, Template:Extension/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Extension/doc.

The Create extension button

To improve the create extension button behavior:

Infobox parameters

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.


To change/correct/add to the implementation type parameters:


To change the behavior of the hook parameters:

Test case

See if the following pages are still ok, after edited this template.

TemplateData

An infobox for a MediaWiki extension.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Statusstatus

Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.

Default
unknown
Stringoptional
Namename

name of the extension

Stringoptional
Licenselicense

Extension's license.

Stringoptional
Modetemplatemode

Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.

Unknownoptional
Screenshot or logoimage

Screenshot or logo of extension. It should be provided without namespace and without [[]]s.

Unknownoptional
imagesizeimagesize

Facultative, size of the image (default size is 220px)

Unknownoptional
Primary typetype

Implementation type. See detailed doc.

Unknownoptional
Secondary typetype1

Implementation type. See detailed doc.

Unknownoptional
Tertiary typetype2

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype3

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype4

Implementation type. See detailed doc.

Unknownoptional
Quinary typetype5

Implementation type. See detailed doc.

Unknownoptional
Senary typetype6

Implementation type. See detailed doc.

Unknownoptional
descriptiondescription

Short description.

Unknownoptional
authorauthor

The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).

Unknownoptional
usernameusername

The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.

Unknownoptional
versionversion latest release version latest_release_version

no description

Unknownoptional
updateupdate

date of the last update

Unknownoptional
version previewversion preview

version preview

Unknownoptional
update previewupdate preview

version preview

Unknownoptional
mediawikimediawiki

Required version of MediaWiki

Unknownoptional
phpphp

Required version of PHP

Unknownoptional
needs-updatephpneeds-updatephp

Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty.

Unknownoptional
composercomposer

If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.

Unknownoptional
table1table1

Name of a non-core table used by the extension.

Unknownoptional
table2table2

Name of a non-core table used by the extension.

Unknownoptional
table3table3

Name of a non-core table used by the extension.

Unknownoptional
table4table4

Name of a non-core table used by the extension.

Unknownoptional
table5table5

Name of a non-core table used by the extension.

Unknownoptional
table6table6

Name of a non-core table used by the extension.

Unknownoptional
table7table7

Name of a non-core table used by the extension.

Unknownoptional
table8table8

Name of a non-core table used by the extension.

Unknownoptional
table9table9

Name of a non-core table used by the extension.

Unknownoptional
table10table10

Name of a non-core table used by the extension.

Unknownoptional
downloaddownload

Link to the download.

Unknownoptional
readmereadme

external link to the readme file

Unknownoptional
changelogchangelog

external link to the changelog file

Unknownoptional
exampleexample

example, website or screenshot of working extension

Unknownoptional
namespacenamespace

namespace in which this extension is used

Unknownoptional
parametersparameters

available parameters for LocalSettings.php

Unknownoptional
tagstags

any tags your extension uses

Unknownoptional
rightsrights

Rights added by the extension. Not to be confused with the license!

Unknownoptional
hook1hook1

Name of a hook used by the extension.

Unknownoptional
hook2hook2

Name of a hook used by the extension.

Unknownoptional
hook3hook3

Name of a hook used by the extension.

Unknownoptional
hook4hook4

Name of a hook used by the extension.

Unknownoptional
hook5hook5

Name of a hook used by the extension.

Unknownoptional
hook6hook6

Name of a hook used by the extension.

Unknownoptional
hook7hook7

Name of a hook used by the extension.

Unknownoptional
hook8hook8

Name of a hook used by the extension.

Unknownoptional
hook9hook9

Name of a hook used by the extension.

Unknownoptional
hook10hook10

Name of a hook used by the extension.

Unknownoptional
hook11hook11

Name of a hook used by the extension.

Unknownoptional
hook12hook12

Name of a hook used by the extension.

Unknownoptional
hook13hook13

Name of a hook used by the extension.

Unknownoptional
hook14hook14

Name of a hook used by the extension.

Unknownoptional
hook15hook15

Name of a hook used by the extension.

Unknownoptional
hook16hook16

Name of a hook used by the extension.

Unknownoptional
hook17hook17

Name of a hook used by the extension.

Unknownoptional
hook18hook18

Name of a hook used by the extension.

Unknownoptional
hook19hook19

Name of a hook used by the extension.

Unknownoptional
hook20hook20

Name of a hook used by the extension.

Unknownoptional
hook21hook21

Name of a hook used by the extension.

Unknownoptional
hook22hook22

Name of a hook used by the extension.

Unknownoptional
hook23hook23

Name of a hook used by the extension.

Unknownoptional
hook24hook24

Name of a hook used by the extension.

Unknownoptional
hook25hook25

Name of a hook used by the extension.

Unknownoptional
hook26hook26

Name of a hook used by the extension.

Unknownoptional
hook27hook27

Name of a hook used by the extension.

Unknownoptional
hook28hook28

Name of a hook used by the extension.

Unknownoptional
hook29hook29

Name of a hook used by the extension.

Unknownoptional
hook30hook30

Name of a hook used by the extension.

Unknownoptional
hook31hook31

Name of a hook used by the extension.

Unknownoptional
hook32hook32

Name of a hook used by the extension.

Unknownoptional
hook33hook33

Name of a hook used by the extension.

Unknownoptional
hook34hook34

Name of a hook used by the extension.

Unknownoptional
hook35hook35

Name of a hook used by the extension.

Unknownoptional
hook36hook36

Name of a hook used by the extension.

Unknownoptional
hook37hook37

Name of a hook used by the extension.

Unknownoptional
hook38hook38

Name of a hook used by the extension.

Unknownoptional
hook39hook39

Name of a hook used by the extension.

Unknownoptional
hook40hook40

Name of a hook used by the extension.

Unknownoptional
hook41hook41

Name of a hook used by the extension.

Unknownoptional
hook42hook42

Name of a hook used by the extension.

Unknownoptional
hook43hook43

Name of a hook used by the extension.

Unknownoptional
hook44hook44

Name of a hook used by the extension.

Unknownoptional
hook45hook45

Name of a hook used by the extension.

Unknownoptional
hook46hook46

Name of a hook used by the extension.

Unknownoptional
hook47hook47

Name of a hook used by the extension.

Unknownoptional
hook48hook48

Name of a hook used by the extension.

Unknownoptional
newhook1newhook1

Name of a hook provided by the extension.

Unknownoptional
newhook2newhook2

Name of a hook provided by the extension.

Unknownoptional
newhook3newhook3

Name of a hook provided by the extension.

Unknownoptional
newhook4newhook4

Name of a hook provided by the extension.

Unknownoptional
newhook5newhook5

Name of a hook provided by the extension.

Unknownoptional
newhook6newhook6

Name of a hook provided by the extension.

Unknownoptional
newhook7newhook7

Name of a hook provided by the extension.

Unknownoptional
newhook8newhook8

Name of a hook provided by the extension.

Unknownoptional
newhook9newhook9

Name of a hook provided by the extension.

Unknownoptional
newhook10newhook10

Name of a hook provided by the extension.

Unknownoptional
newhook11newhook11

Name of a hook provided by the extension.

Unknownoptional
newhook12newhook12

Name of a hook provided by the extension.

Unknownoptional
newhook13newhook13

Name of a hook provided by the extension.

Unknownoptional
newhook14newhook14

Name of a hook provided by the extension.

Unknownoptional
newhook15newhook15

Name of a hook provided by the extension.

Unknownoptional
newhook16newhook16

Name of a hook provided by the extension.

Unknownoptional
newhook17newhook17

Name of a hook provided by the extension.

Unknownoptional
newhook18newhook18

Name of a hook provided by the extension.

Unknownoptional
newhook19newhook19

Name of a hook provided by the extension.

Unknownoptional
newhook20newhook20

Name of a hook provided by the extension.

Unknownoptional
newhook21newhook21

Name of a hook provided by the extension.

Unknownoptional
newhook22newhook22

Name of a hook provided by the extension.

Unknownoptional
newhook23newhook23

Name of a hook provided by the extension.

Unknownoptional
newhook24newhook24

Name of a hook provided by the extension.

Unknownoptional
newhook25newhook25

Name of a hook provided by the extension.

Unknownoptional
newhook26newhook26

Name of a hook provided by the extension.

Unknownoptional
newhook27newhook27

Name of a hook provided by the extension.

Unknownoptional
newhook28newhook28

Name of a hook provided by the extension.

Unknownoptional
newhook29newhook29

Name of a hook provided by the extension.

Unknownoptional
newhook30newhook30

Name of a hook provided by the extension.

Unknownoptional
newhook31newhook31

Name of a hook provided by the extension.

Unknownoptional
newhook32newhook32

Name of a hook provided by the extension.

Unknownoptional
newhook33newhook33

Name of a hook provided by the extension.

Unknownoptional
newhook34newhook34

Name of a hook provided by the extension.

Unknownoptional
newhook35newhook35

Name of a hook provided by the extension.

Unknownoptional
newhook36newhook36

Name of a hook provided by the extension.

Unknownoptional
newhook37newhook37

Name of a hook provided by the extension.

Unknownoptional
newhook38newhook38

Name of a hook provided by the extension.

Unknownoptional
newhook39newhook39

Name of a hook provided by the extension.

Unknownoptional
newhook40newhook40

Name of a hook provided by the extension.

Unknownoptional
newhook41newhook41

Name of a hook provided by the extension.

Unknownoptional
newhook42newhook42

Name of a hook provided by the extension.

Unknownoptional
newhook43newhook43

Name of a hook provided by the extension.

Unknownoptional
newhook44newhook44

Name of a hook provided by the extension.

Unknownoptional
newhook45newhook45

Name of a hook provided by the extension.

Unknownoptional
newhook46newhook46

Name of a hook provided by the extension.

Unknownoptional
newhook47newhook47

Name of a hook provided by the extension.

Unknownoptional
newhook48newhook48

Name of a hook provided by the extension.

Unknownoptional
compatibilitycompatibility

Compatibility chart, e.g. Template:Extension Testing.

Unknownoptional
translatetranslate

Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled.

Unknownoptional
bugzillabugzilla

Bugzilla MediaWiki extension component name

Unknownoptional
Vagrant rolevagrant-role

A MediaWiki-Vagrant role that lets you use this extension, if present

Stringoptional