Jump to content

Templat:MW file

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


Dokumentasi templat

Menampilkan kotak informasi mengenai berkas dalam inti MediaWiki, dengan pranala ke kode sumbernya dalam cabang master, stabil, dan warisan, dan pranala ke kelas dan antarmukanya dalam dokumentasi PHP yang dihasilkan.

{{MW file|FILENAME|PATH
|class1=CLASS
|class2=CLASS
|class3=CLASS
|...
|interface1=INTERFACE
|interface2=INTERFACE
|interface3=INTERFACE
|NotInGit=REASON
}}
  • FILENAME adalah nama berkas, termasuk ekstensi.
    • Jika berkasnya baru saja diganti namanya, Anda bisa menggunakan paramter stable= dan legacy= untuk memberikan nama lamanya agar pranalanya bekerja; Anda perlu memperbarui pemanggilan templat ketika rilis di mana berkas diganti namanya berpindah dari master->stabil->warisan.
  • PATH adalah jalur ke berkas; jangan masukkan garis miring di awal, masukkan garis miring di akhir. Kosongkan untuk berkas di direktori akar.
  • Argumen class semuanya opsional, dan jika diberikan akan menaut ke dokumentasi yang dihasilkan. CLASS seharusnya nama kelas, sebagaimana digunakan di URL. Contoh: "Parser" akan menghasilkan pranala ke "classParser.html". Templat memungkinkan hingga enam parameter kelas, class1-class6
  • INTERFACE tidak jauh berbeda. Templat memungkinkan hingga tiga parameter antarmuka
  • Argumen NotInGit bersifat opsional dan hanya digunakan apabila berkasnya tidak terdapat dalam Git untuk suatu alasan (Aku rasa ini hanya berlaku pada LocalSettings.php). REASON adalah alasan yang ditampilkan di kotak info. Perhatikan bahwa NotInGit peka kapital!

Manual menggunakan templat ini secara luas.

Contoh

{{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=dibuat saat pemasangan
}}


Lihat pula

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