Modèle:MW file

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

Documentation du modèle

Affiche une boîte d'information concernant un fichier du noyau de MediaWiki, avec ses liens vers le code source dans le master, et les branches stable et ancienne, ainsi que les liens vers ses classes et ses interfaces dans la documentation PHP générée.

{{MW file|FILENAME|PATH
|class1=CLASS
|class2=CLASS
|class3=CLASS
|...
|interface1=INTERFACE
|interface2=INTERFACE
|interface3=INTERFACE
|NotInGit=REASON
}}
  • FILENAME est le nom du fichier, avec son extension.
    • Si le fichier a été renommé récemment, vous pouvez utiliser les paramètres stable= et legacy= pour fournir l'ancien nom pour que les liens fonctionnent; vous devrez mettre à jour l'appel du modèle car la version dans laquelle le fichier a été renommé évolue parmi master→stable→legacy.
  • PATH est le chemin vers le fichier; n'incluez pas de "/" initial, incluez le "/" final. Laisser vierge pour les fichiers du répertoire racine.
  • Les arguments de class sont tous optionnels et s'ils sont fournis, ils permettent l'accès à la documentation générée. CLASS doit être le nom de la classe, comme utilisé dans l'URL. Par exemple Parser générerait un lien vers « classParser.html ». Le modèle prend en charge jusqu'à six paramètres de classe, class1-class6
  • INTERFACE est similaire. Le modèle permet jusqu'à trois paramètres d'interface
  • L'argument NotInGit est optionnel et doit être utilisé seulement quand le fichier n'est pas dans Git pour une raison quelconque (probablement utile uniquement pour LocalSettings.php) REASON est le motif affiché dans la boîte d'information. Notez que NotInGit est sensible à la casse !

Le Manuel utilise intensivement ce modèle.

Exemples

{{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=créé durant l'installation
}}

Voir aussi

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