Template:MW file

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

Template documentation

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= a legacy= 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.
  • 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 pro LocalSettings.php). REASON je důvod, který se zobrazuje v infoboxu. Pamatujte, že NotInGit rozlišuje velká a malá písmena!

Příručka tuto šablonu široce používá.

Příklady

{{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=vytvořené během instalace
}}

Související odkazy

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