Plantilla:Archivo de MW
| Archivo de MediaWiki: {{{1}}} | |
|---|---|
| Ubicación: | / |
| Código fuente: | master • 1.44.2 • 1.43.5 • 1.39.15 |
| Clases: | Buscar código • Buscar documentación |
| This template is used on approximately 6,500+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
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.
{{MW file|FILENAME|PATH
|class1=CLASS
|class2=CLASS
|class3=CLASS
|...
|interface1=INTERFACE
|interface2=INTERFACE
|interface3=INTERFACE
|NotInGit=REASON
}}
- FILENAME es el nombre del archivo, incluyendo la extensión.
- Si el archivo ha sido renombrado recientemente, puede usar los parámetros
stable=ylegacy=para proporcionar el nombre anterior para que los enlaces funcionen; deberá actualizar la invocación de la plantilla ya que la versión en la que se cambió el nombre del archivo se mueve de master->stable->legacy.
- Si el archivo ha sido renombrado recientemente, puede usar los parámetros
- PATH es la ruta del archivo, sin incluir la barra inclinada del inicio, pero incluyendo la del final. Déjalo sin informar para archivos situados en el directorio raíz.
- Los argumentos de la
classson todos opcionales y, si se proporcionan, se vincularán a la documentación generada. CLASS debe ser el nombre de la clase, de la misma forma que se usa en la URL. Por ejemplo, "Parser" generará un enlace a "classParser.html". The template allows up to six class parameters,class1-class6 - INTERFACE es similar. The template allows up to three interface parameters
- El argumento
NotInGites opcional y debe ser usado sólo si el archivo no se encuentra en el Git por algún motivo (posiblemente aplique sólo aLocalSettings.php). REASON es el motivo que se mostrará en la infobox. ¡Ten en cuenta queNotInGites sensible a mayúsculas!
El Manual utiliza esta plantilla ampliamente.
Ejemplos
{{MW file|index.php|}}
| Archivo de MediaWiki: index.php | |
|---|---|
| Ubicación: | |
| Código fuente: | master • 1.44.2 • 1.43.5 • 1.39.15 |
| Clases: | Buscar código • Buscar documentación |
{{MW file|Article.php|includes/page/
|class1=Article
}}
| Archivo de MediaWiki: Article.php | |
|---|---|
| Ubicación: | includes/page/ (includes/Page/ in 1.46 or later) |
| Código fuente: | master • 1.44.2 • 1.43.5 • 1.39.15 |
| Clases: | Article |
{{MW file|WikiPage.php|includes/page/
|class1=WikiPage
|interface1=Page
}}
| Archivo de MediaWiki: WikiPage.php | |
|---|---|
| Ubicación: | includes/page/ (includes/Page/ in 1.46 or later) |
| Código fuente: | master • 1.44.2 • 1.43.5 • 1.39.15 |
| Clases: | WikiPage • Page |
{{MW file|LocalSettings.php|
|NotInGit=creado durante la instalación
}}
| Archivo de MediaWiki: LocalSettings.php | |
|---|---|
| Ubicación: | |
| Código fuente: | no se encuentra en Git (creado durante la instalación) |
| Clases: | |
Véase también
- {{Git file}} — a simple link to a file on gerrit (from mediawiki/core or otherwise)
- Category:MediaWiki code pages without class names — incompletely filled pages are automatically listed by this template
- 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.
| 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.
| 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.
| 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.
| 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
| 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 |