Predefinição:Arquivo do MW

Arquivo do MediaWiki: {{{1}}}
Localização:	/
Código-fonte:	master • 1.44.2 • 1.43.5 • 1.39.15
Classes:	Encontrar código • Encontrar documentação

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|}}

Arquivo do MediaWiki: index.php
Localização:
Código-fonte:	master • 1.44.2 • 1.43.5 • 1.39.15
Classes:	Encontrar código • Encontrar documentação

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

Arquivo do MediaWiki: Article.php
Localização:	includes/page/ (includes/Page/ in 1.46 or later)
Código-fonte:	master • 1.44.2 • 1.43.5 • 1.39.15
Classes:	Article

---

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

Arquivo do MediaWiki: WikiPage.php
Localização:	includes/page/ (includes/Page/ in 1.46 or later)
Código-fonte:	master • 1.44.2 • 1.43.5 • 1.39.15
Classes:	WikiPage • Page

---

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

Arquivo do MediaWiki: LocalSettings.php
Localização:
Código-fonte:	não está no Git (criado durante a instalação)
Classes:

Ver também

• {{Git file }} — uma ligação simples a um arquivo no gerrit (do mediawiki/core ou não)
• Category:MediaWiki code pages without class names — páginas incompletamente preenchidas são listadas automaticamente por essa predefinição
• Category:MediaWiki code pages without namespaces — File pages without a namespace declared are automatically added here. They should probably have a namespace.

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.

Parameter		Description	Type	Status
File name	1	Name of the file, including extension. If the file has been recently renamed, you can use the stable= and the legacy= parameters to provide the old name so links work; you'll need to update the template invocation as the release in which the file was renamed moves from master → stable → legacy. Example LocalSettings.php	String	required
File path	2	Path to the file; do not include a leading slash, include the trailing slash. Leave it blank for files in the root directory. Example includes/libs/	String	required
Not in Git?	NotInGit	Whether the version is in Git version control (only rarely used for files like LocalSettings.php and DevelopmentSettings.php). Optional and should only be used if the file is not in Git for some reason. Reason= is the reason that is displayed in the infobox. Note that NotInGit is CASE-SENSITIVE. Example created during installation	String	optional
Stable MediaWiki version	stable	no description	Unknown	optional
Legacy MediaWiki version	legacy	no description	Unknown	optional
LTS MediaWiki Version	lts	Long-Term Support version for MediaWiki	Unknown	optional
Class 1	class1	Class arguments are all optional, and if supplied will link to the generated documentation. Class should be the class name, as used in the URL. The template allows up to six class parameters Example "Parser" would generate a link to "classParser.html"	String	suggested
Class 2	class2	no description	Unknown	optional
Class 3	class3	no description	Unknown	optional
Class 4	class4	no description	Unknown	optional
Class 5	class5	no description	Unknown	optional
Class 6	class6	no description	Unknown	optional
Interface 1	interface1	Similar to Class. The template allows up to three interface parameters.	Unknown	suggested
Interface 2	interface2	no description	Unknown	optional
Interface 3	interface3	no description	Unknown	optional
Example	example	no description	Unknown	optional
nodisplaytitle	nodisplaytitle	no description	Unknown	optional

Editores podem experimentar nas páginas de caixa de areia (criar | espelhar) e casos de teste (criar) desta predefinição.
Subpáginas deste(a) predefinição.