Jump to content
MediaWiki

Template:MW file

From mediawiki.org
This page is a translated version of the page Template:MW file and the translation is 100% complete.
Soubor MediaWiki: {{{1}}}
Lokalita: /
Zdrojový kód: master1.44.01.43.31.39.13
Třídy: Vyhledat zdrojový kódVyhledat dokumentaci


Dokumentace šablony
Tato šablona se používá přibližně na 6,500+ stránkách.

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= 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|}}
Soubor MediaWiki: index.php
Lokalita:
Zdrojový kód: master1.44.01.43.31.39.13
Třídy: Vyhledat zdrojový kódVyhledat dokumentaci


{{MW file|Article.php|includes/page/
|class1=Article
}}
Soubor MediaWiki: Article.php
Lokalita: includes/page/
Zdrojový kód: master1.44.01.43.31.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: master1.44.01.43.31.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

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
File name1

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
Stringrequired
File path2

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/
Stringrequired
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
Stringoptional
Stable MediaWiki versionstable

no description

Unknownoptional
Legacy MediaWiki versionlegacy

no description

Unknownoptional
LTS MediaWiki Versionlts

Long-Term Support version for MediaWiki

Unknownoptional
Class 1class1

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"
Stringsuggested
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

Similar to Class. The template allows up to three interface parameters.

Unknownsuggested
Interface 2interface2

no description

Unknownoptional
Interface 3interface3

no description

Unknownoptional
Exampleexample

no description

Unknownoptional
nodisplaytitlenodisplaytitle

no description

Unknownoptional

Maintenance: noslash

S touto šablonou mohou editoři experimentovat na stránkách pískoviště (založit | kopie) a testovací případy (založit).
Podstránky této šablony.

AltStyle によって変換されたページ (->オリジナル) /