Jump to content

Plantilla:Archivo de MW

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


Template documentation

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= y legacy= 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.
  • 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 class son 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 NotInGit es opcional y debe ser usado sólo si el archivo no se encuentra en el Git por algún motivo (posiblemente aplique sólo a LocalSettings.php). REASON es el motivo que se mostrará en la infobox. ¡Ten en cuenta que NotInGit es sensible a mayúsculas!

El Manual utiliza esta plantilla ampliamente.

Ejemplos

{{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=creado durante la instalación
}}


Véase también

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