Template:MW file
Soubor MediaWiki: {{{1}}} | |
---|---|
Lokalita: | / |
Zdrojový kód: | master • 1.44.0 • 1.43.3 • 1.39.13 |
Třídy: | Vyhledat zdrojový kód • Vyhledat dokumentaci |
Aby nedošlo k rozsáhlému narušení a zbytečnému zatížení serveru, měly by být veškeré změny této šablony nejprve otestovány na jejích stránkách /sandbox nebo /testcases podstránkách nebo na vaší vlastní uživatelské podstránce . Testované změny pak mohou být přidány na tuto stránku v jediné úpravě.
Před implementací jakýchkoli změn zvažte prosím diskusi na diskusní stránce.Zobrazí informativní rámeček o souboru v jádru MediaWiki s odkazy na jeho zdrojový kód v hlavních, stabilních a starších větvích a odkazy na jeho třídy a rozhraní ve vygenerované dokumentaci PHP.
{{MW file|FILENAME|PATH |class1=CLASS |class2=CLASS |class3=CLASS |... |interface1=INTERFACE |interface2=INTERFACE |interface3=INTERFACE |NotInGit=REASON }}
- FILENAME je název souboru včetně přípony.
- Pokud byl soubor nedávno přejmenován, můžete použít parametry
stable=
alegacy=
k zadání starého názvu, aby odkazy fungovaly. Budete muset aktualizovat vyvolání šablony, protože vydání, ve kterém byl soubor přejmenován, se přesune z master->stable->legacy.
- Pokud byl soubor nedávno přejmenován, můžete použít parametry
- PATH je cesta k souboru. Nezahrnujte úvodní lomítko, zahrňte koncové lomítko. U souborů v kořenovém adresáři ponechte pole prázdné.
- Všechny argumenty
class
jsou volitelné a pokud jsou uvedeny, odkazují na vygenerovanou dokumentaci. CLASS by měl být název třídy, jaký je použit v URL. Např. "Parser" vygeneruje odkaz na "classParser.html". Šablona umožňuje až šest parametrů třídy,class1
-class6
- INTERFACE je podobný. Šablona umožňuje až tři parametry rozhraní
- Argument
NotInGit
je volitelný a měl by být použit pouze v případě, že soubor z nějakého důvodu není v Gitu (myslím, že to platí pouze proLocalSettings.php
). REASON je důvod, který se zobrazuje v infoboxu. Pamatujte, žeNotInGit
rozlišuje velká a malá písmena!
Příručka tuto šablonu široce používá.
Příklady
{{MW file|index.php|}}
Soubor MediaWiki: index.php | |
---|---|
Lokalita: | |
Zdrojový kód: | master • 1.44.0 • 1.43.3 • 1.39.13 |
Třídy: | Vyhledat zdrojový kód • Vyhledat dokumentaci |
{{MW file|Article.php|includes/page/ |class1=Article }}
Soubor MediaWiki: Article.php | |
---|---|
Lokalita: | includes/page/ |
Zdrojový kód: | master • 1.44.0 • 1.43.3 • 1.39.13 |
Třídy: | Article |
{{MW file|WikiPage.php|includes/page/ |class1=WikiPage |interface1=Page }}
Soubor MediaWiki: WikiPage.php | |
---|---|
Lokalita: | includes/page/ |
Zdrojový kód: | master • 1.44.0 • 1.43.3 • 1.39.13 |
Třídy: | WikiPage • Page |
{{MW file|LocalSettings.php| |NotInGit=vytvořené během instalace }}
Soubor MediaWiki: LocalSettings.php | |
---|---|
Lokalita: | |
Zdrojový kód: | není udržován v Gitu (vytvořené během instalace) |
Třídy: |
Související odkazy
- {{Git file }} — jednoduchý odkaz na soubor z Gerritu (z mediawiki/core nebo jinak)
- Kategorie:Kódové stránky MediaWiki bez názvů tříd — neúplně vyplněné stránky jsou automaticky vypsány touto šablonou
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 |
Maintenance: noslash
Podstránky této šablony.