doc

Template:Mbox Template:Translating/pt-br Esta predefinição deve ser adicionada a todas as páginas de extensão neste wiki (mas apenas a página principal). Ele irá adicionar uma infobox útil (veja abaixo) e irá automaticamente acrescentar a extensão para a categoria All extensions, juntamente com as categorias status e tipo de implementação apropriadas.

Uso

Copie e cole os parâmetros necessários: {{Extension/pt-br |templatemode = |name = |status = |type1 = |type2 = |hook1 = |hook2 = |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 = }} Para obter ajuda com os valores dos parâmetros, consulte o modelo ao lado.

Manual de Extensões do MediaWiki 40px {{{name}}} Status: desconhecido 220px Implementação {{{type1}}}, {{{type2}}} Descrição {{{description}}} Autor(es) SomeAuthor (SomeUsertalk) Última versão {{{version}}} ({{{update}}}) Prévia da versão mais recente {{{version preview}}} ({{{update preview}}}) MediaWiki {{{mediawiki}}} PHP {{{php}}} Mudanças de banco de dados {{{needs-updatephp}}} Compositor {{{composer}}} Licença {{{license}}} Download {{{download}}} {{{readme}}} {{{changelog}}} Exemplo {{{example}}} Namespace {{{namespace}}} Parâmetros {{{parameters}}} Tags {{{tags}}} Direitos adicionados {{{rights}}} Hooks usados hook1 hook2 {{{compatibility}}} [[translatewiki:Special:Translate/ext-|Traduza a extensão Extension/pt-br]], se estiver disponível no translatewiki.net Bugs: listar abertos listar todos relatório

Parâmetros de conteúdo

Esta seção descreve os parâmetros que regem o conteúdo da caixa informativa. Para obter ajuda sobre o templatemode e outros parâmetros de controle, consulte Parâmetros de controle.

Parâmetros de conteúdo

Parâmetro	Descrição
name	Name da extensão
status	Status da versão atual One of: unstable (instável - não use esta extensão) experimental (estágios iniciais de desenvolvimento, pode mudar drasticamente) beta (estável, mas não totalmente testado) stable (versão estável) unmaintained (sem manutenção - anteriormente considerada estável, agora sem manutenção) unknown (padrão) Se o status for qualquer coisa diferente dos referidos acima, ele será ignorado e o valor padrão Unknown será exibido na predefinição em seu lugar. Nos casos em que o valor for omitido, ela será classificada como desconhecida.Nos casos em que o valor é inválido, ele será colocado numa categoria especial, de modo que o erro pode ser capturado e reparado. Esquema de cores do Status da Versão
type1 type2 type3 type4 type5 type6	tipo de implementação A estratégia (s) de implementação empregada na construção desta extensão. Este parâmetro é usado para criar categorias que ajudam os programadores a encontrar exemplos de várias estratégias específicas de implementação do MediaWiki ou padrões. Embora os valores deste parâmetro, por vezes, coincidem com o caso de uso ou finalidade de uma extensão, isso não é razão para este parâmetro. Se os valores que você escolheu para este parâmetro não identificarem adequadamente o propósito ou casos de uso possíveis, recomendamos que você adicione links de categoria adicionais conforme necessário. Os valores válidos para os parâmetros type1, type2, ... são: parser - catchall for uncategorized parser extensions. If you have written a parser extension, please use one of the following more specific types: contenthandler - Extensions using ContentHandler. link - customized link markup, e.g. [[...]] parser function - custom parameterized template markup, e.g. {{#name: ... }} tag - custom XML tag markup, e.g. <tagname>...</tagname> variable - custom unparameterized template markup, e.g. {{NAME}} extended syntax - Extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables). 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: user activity - extensions that monitor user activity (logins, logouts, new user creation, etc.) user identity - extensions that create and delete users, and/or verify the identity of a user 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) interface - catchall for uncategorized user interface extensions. media - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers. mywiki - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure notify - extensions that email users, broadcast messages and provide other forms of community notification 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). search - extensions that search through and select articles for users. skin - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework. ajax - extensions that use Ajax programming techniques. special - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Manual:Special pages for more information. other api - extensions that add a new API module or extend a core API module. hook - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension database - adds tables and/or fields to the database backing a MediaWiki installation data extraction - Data extraction filerepo - extension that adds new file repository types as file backend 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 type. 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: use extensionName/hookName. For a partial list of custom hooks, see Extension hook registry. For multiple hooks, assign the first hook to hook1, the second to hook2 and so on.
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:TNTN |1=A variável $IP refere-se ao caminho (ou "diretório") de sua instalação do MediaWiki, o mesmo diretório que contém os arquivos LocalSettings.php, index.php etc..}}
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(s) governing use of this extension, e.g. GPL
download	link to the download : Git, Template:Tl with server=svn in case it was not migrated from SVN. 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. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/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	compatibility chart, e.g. Template:Extension Testing
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 /browse/master/groups/MediaWiki/mediawiki-defines.txt config)), aka the parameter you get in the URL after typing the name of the extension in the search/filter box at translatewiki:Special:Translate or searching for its name in languagestats after clicking "expand all".
bugzilla	Bugzilla MediaWiki extension component 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 extensions 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.

<inputbox> type=create bgcolor=#eeeeff width=40 placeholder=Enter your extension's name here prefix=Extension: preload=Template:Extension/Sample buttonlabel=Create </inputbox> A developer sharing their code on the MediaWiki wiki or code repository should expect:

Feedback / Criticism / Code reviews

Review and comments by other developers on things like framework use, security, efficiency and usability.

Developer tweaking

Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.

Improved access for wiki sysadmins

If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.

Future versions by other developers

New branches of your code being created by other developers as new versions of MediaWiki are released.

Merger of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.

Credit

Credit for your work being preserved in future versions — including any merged extensions.

Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host their code directly on the MediaWiki wiki or code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it. You may also add the Template:Tl template to your extension requesting other developers refrain from modifying your code, although no guarantees can be made that an update will be made if deemed important for security or compatibility reasons. You may use the current issues noticeboard if you feel another developer has violated the spirit of these expectations in editing your extension.

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:

• Template:Extension/Sample: The boilerplate extension that is preloaded into newly-created pages.
• Template:Extension/CreateExtensionInputBox: An input box that can be inserted wherever you want users to easily create extensions. For documentation on the <inputbox> tag, please see Extension:InputBox.
• Extension:MyExtension: - Defines a placeholder, in case a user accidentally hits the create button without changing the extension name.

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:

• Check the talk page - there have been some extensive discussions about this field.
• Template:Extension/TypeSwitch: Stores the possible values for the type field. Multiple values are implemented by calling this template with Template:Foreach.
• Template:Extension/TypeSwitchNoCats: Does not need to be modified when adding a new type. Used instead of Template:Extension/TypeSwitch when this template is used in templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/TypeSwitch with another template that sets the mode.
• Template:Extension/doc: Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy.

To change the behavior of the hook parameters:

• Template:Extension/HookInUse: Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with Template:Foreach.
• Template:Extension/HookInUseNoCats: Used instead of Template:Extension/HookInUse when this template is used in templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/HookInUse with another template that sets the mode.

Test case

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

• Extension:Description2
• Template:Extension

TemplateData

<templatedata> { "description": "An infobox for a MediaWiki extension.", "params": { "status": { "description": "Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.", "default": "unknown" }, "name": { "description": "name of the extension" }, "license": { "description": "Extension's license." }, "templatemode": { "description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage." }, "image": { "description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s." }, "imagesize": { "description": "Facultative, size of the image (default size is 220px)" }, "type": { "description": "Implementation type. See detailed doc." }, "type1": { "description": "Implementation type. See detailed doc." }, "type2": { "description": "Implementation type. See detailed doc." }, "type3": { "description": "Implementation type. See detailed doc." }, "type4": { "description": "Implementation type. See detailed doc." }, "type5": { "description": "Implementation type. See detailed doc." }, "type6": { "description": "Implementation type. See detailed doc." }, "description": { "description": "Short description." }, "author": { "description": "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)." }, "username": { "description": "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." }, "version": { "aliases": [ "latest release version", "latest_release_version" ] }, "update": { "description": "date of the last update" }, "version preview": { "description": "version preview" }, "update preview": { "description": "version preview" }, "mediawiki": { "description": "Required version of MediaWiki" }, "php": { "description": "Required version of PHP" }, "needs-updatephp": { "description": "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." }, "composer": { "description": "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": { "description": "Name of a non-core table used by the extension." }, "table2": { "description": "Name of a non-core table used by the extension." }, "table3": { "description": "Name of a non-core table used by the extension." }, "table4": { "description": "Name of a non-core table used by the extension." }, "table5": { "description": "Name of a non-core table used by the extension." }, "table6": { "description": "Name of a non-core table used by the extension." }, "table7": { "description": "Name of a non-core table used by the extension." }, "table8": { "description": "Name of a non-core table used by the extension." }, "table9": { "description": "Name of a non-core table used by the extension." }, "table10": { "description": "Name of a non-core table used by the extension." }, "download": { "description": "Link to the download." }, "readme": { "description": "external link to the readme file" }, "changelog": { "description": "external link to the changelog file" }, "example": { "description": "example, website or screenshot of working extension" }, "namespace": { "description": "namespace in which this extension is used" }, "parameters": { "description": "available parameters for LocalSettings.php" }, "tags": { "description": "any tags your extension uses" }, "rights": { "description": "Rights added by the extension. Not to be confused with the license!" }, "hook1": { "description": "Name of a hook used by the extension." }, "hook2": { "description": "Name of a hook used by the extension." }, "hook3": { "description": "Name of a hook used by the extension." }, "hook4": { "description": "Name of a hook used by the extension." }, "hook5": { "description": "Name of a hook used by the extension." }, "hook6": { "description": "Name of a hook used by the extension." }, "hook7": { "description": "Name of a hook used by the extension." }, "hook8": { "description": "Name of a hook used by the extension." }, "hook9": { "description": "Name of a hook used by the extension." }, "hook10": { "description": "Name of a hook used by the extension." }, "hook11": { "description": "Name of a hook used by the extension." }, "hook12": { "description": "Name of a hook used by the extension." }, "hook13": { "description": "Name of a hook used by the extension." }, "hook14": { "description": "Name of a hook used by the extension." }, "hook15": { "description": "Name of a hook used by the extension." }, "hook16": { "description": "Name of a hook used by the extension." }, "hook17": { "description": "Name of a hook used by the extension." }, "hook18": { "description": "Name of a hook used by the extension." }, "hook19": { "description": "Name of a hook used by the extension." }, "hook20": { "description": "Name of a hook used by the extension." }, "hook21": { "description": "Name of a hook used by the extension." }, "hook22": { "description": "Name of a hook used by the extension." }, "hook23": { "description": "Name of a hook used by the extension." }, "hook24": { "description": "Name of a hook used by the extension." }, "hook25": { "description": "Name of a hook used by the extension." }, "hook26": { "description": "Name of a hook used by the extension." }, "hook27": { "description": "Name of a hook used by the extension." }, "hook28": { "description": "Name of a hook used by the extension." }, "hook29": { "description": "Name of a hook used by the extension." }, "hook30": { "description": "Name of a hook used by the extension." }, "hook31": { "description": "Name of a hook used by the extension." }, "hook32": { "description": "Name of a hook used by the extension." }, "hook33": { "description": "Name of a hook used by the extension." }, "hook34": { "description": "Name of a hook used by the extension." }, "hook35": { "description": "Name of a hook used by the extension." }, "hook36": { "description": "Name of a hook used by the extension." }, "hook37": { "description": "Name of a hook used by the extension." }, "hook38": { "description": "Name of a hook used by the extension." }, "hook39": { "description": "Name of a hook used by the extension." }, "hook40": { "description": "Name of a hook used by the extension." }, "hook41": { "description": "Name of a hook used by the extension." }, "hook42": { "description": "Name of a hook used by the extension." }, "hook43": { "description": "Name of a hook used by the extension." }, "hook44": { "description": "Name of a hook used by the extension." }, "hook45": { "description": "Name of a hook used by the extension." }, "hook46": { "description": "Name of a hook used by the extension." }, "hook47": { "description": "Name of a hook used by the extension." }, "hook48": { "description": "Name of a hook used by the extension." }, "compatibility": { "description": "Compatibility chart, e.g. Template:Extension Testing." }, "translate": { "description": "Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled." }, "bugzilla": { "description": "Bugzilla MediaWiki extension component name" } } } </templatedata>