Jump to content

Predefinição:Arquivo do MW

From mediawiki.org
This page is a translated version of the page Template:MW file and the translation is 100% complete.


Documentação da predefinição

Exibe uma caixa informativa sobre um arquivo do núcleo do MediaWiki, com ligações para seu código-fonte nas ramificações master, stable e legacy, e ligações para suas classes e interfaces na documentação PHP gerada.

{{MW file|FILENAME|PATH
|class1=CLASS
|class2=CLASS
|class3=CLASS
|...
|interface1=INTERFACE
|interface2=INTERFACE
|interface3=INTERFACE
|NotInGit=REASON
}}
  • FILENAME é o nome do arquivo, incluindo a extensão.
    • Se o arquivo foi recentemente renomeado, é possível utilizar os parâmetros stable= e legacy= para fornecer o nome antigo para as ligações funcionarem. Será necessário atualizar a invocação da predefinição à medida que o lançamento do arquivo renomeado mover da master para stable para legacy.
  • PATH é o caminho para o arquivo; não inclua uma barra inicial, e sim uma barra final. Deixe em branco para arquivos no diretório raiz.
  • Os argumentos class são todos opcionais, e se fornecidos apresentarão ligações para a documentação gerada. CLASS deve ser o nome da classe, tal como utilizado no URL. P. ex., “Parser” gerará uma ligação a “classParser.html”. A predefinição permite até seis parâmetros de classes, class1-class6
  • INTERFACE é similar. A predefinição permite até três parâmetros de interface
  • O argumento NotInGit é opcional e só deve ser usado se o arquivo não estiver no Git por algum motivo (provavelmente, isso só se aplica ao LocalSettings.php). REASON é o motivo a ser exibido na infocaixa. Note que NotInGit diferencia maiúsculas de minúsculas (case sensitive)!

O Manual utiliza essa predefinição extensivamente.

Exemplos

{{MW file|index.php|}}


{{MW file|Article.php|includes/page/
|class1=Article
}}

{{MW file|WikiPage.php|includes/page/
|class1=WikiPage
|interface1=Page
}}

{{MW file|LocalSettings.php|
|NotInGit=criado durante a instalação
}}


Ver também

Displays an informative box about a file in MediaWiki core, with links to its source code in master, stable, and legacy branches, and links to its classes and interfaces in the generated PHP documentation.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
nodisplaytitlenodisplaytitle

no description

Unknownoptional
File name1

no description

Unknownrequired
File path2

no description

Unknownrequired
Not in Git?NotInGit

Whether the version is in Git version control (only rarely used for files like LocalSettings.php and DevelopmentSettings.php)

Booleanoptional
Stable MediaWiki versionstable

no description

Unknownoptional
Legacy MediaWiki versionlegacy

no description

Unknownoptional
LTS MediaWiki Versionlts

Long-Term Support version for MediaWiki

Unknownoptional
Class 1class1

no description

Unknownsuggested
Class 2class2

no description

Unknownoptional
Class 3class3

no description

Unknownoptional
Class 4class4

no description

Unknownoptional
Class 5class5

no description

Unknownoptional
Class 6class6

no description

Unknownoptional
Interface 1interface1

no description

Unknownsuggested
Interface 2interface2

no description

Unknownoptional
Interface 3interface3

no description

Unknownoptional
Exampleexample

no description

Unknownoptional

Maintenance: noslash