Modèle:MW file

Fichier MediaWiki : {{{1}}}
Emplacement :	/
Code source :	master • 1.45.1 • 1.44.3 • 1.43.6
Classes :	Accès au code • Accès à la documentation

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

Fichier MediaWiki : index.php
Emplacement :
Code source :	master • 1.45.1 • 1.44.3 • 1.43.6
Classes :	Accès au code • Accès à la documentation

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

Fichier MediaWiki : Article.php
Emplacement :	includes/page/ (includes/Page/ in 1.46 or later)
Code source :	master • 1.45.1 • 1.44.3 • 1.43.6
Classes :	MediaWiki\Page\Article

---

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

Fichier MediaWiki : WikiPage.php
Emplacement :	includes/page/ (includes/Page/ in 1.46 or later)
Code source :	master • 1.45.1 • 1.44.3 • 1.43.6
Classes :	MediaWiki\Page\WikiPage • MediaWiki\Page\Page

---

{{MW file|LocalSettings.php|
|NotInGit=créé durant l'installation
}}

Fichier MediaWiki : LocalSettings.php
Emplacement :
Code source :	pas dans Git (créé durant l'installation)
Classes :

{{MW file|includes/Title/Title.php
|stable=includes/title/Title.php
|legacy=includes/title/Title.php
|lts=includes/Title.php
|class1=MediaWiki\Title\Title
}}

Fichier MediaWiki : includes/Title/Title.php
Code source :	master • 1.45.1 • 1.44.3 • 1.43.6
Classes :	MediaWiki\Title\Title

Voir aussi

• {{Git file }} – simple lien vers un fichier de gerrit (du noyau Mediawiki ou d'ailleurs)
• Categorie:Pages de code MediaWiki sans noms de classes – les pages non complètement remplies sont listées automatiquement par ce modèle
• 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

Les éditeurs peuvent expérimenter dans le bac à sable (créer | mirroir) et dans la page de test (créer) de ce modèle.
Sous-pages de ce modèle.