Nápověda:Systémové proměnné a jejich použití

From DCEwiki
Revision as of 20:46, 26 August 2008 by Kapica (talk | contribs) (Proměnné a funkce)
Jump to: navigation, search

Šablona:PD Help Page

Systémové proměnné (v orig. Magic words) jsou řetězce textu, místo kterých MediaWiki vrací nějakou návratovou hodnotu či výsledek funkce, např. aktuální čas, informace o stránce, nebo název stránky. Tato stránka se zaobírá jejich použitím. Jejich přehled najdete na Šablona:mediawiki.

Důležitá poznámka

  • Inheritance: Proměnné, jejichž výsledek závisí na stránce vracejí vždy výsledek který je spojen s aktuální stránkou, resp. stránkou která je má vložené do svého kódu - šablony.

Tabulka systémových konstant podle použití

A behaviour switch controls the layout or behaviour of the page. Většinou to jsou řetězce vymezené dvojitými podržítky.

Řetězec Popis Verze
Obsah
__NOTOC__ Skryje obsah (TOC).
__FORCETOC__ Vynutí vložení obsahu na jiné než obvyklé pozici (před prvním titulkem).
__TOC__ Umístí obsah na pozici tohoto řetězce (pozor, má vyšší prioritu než řetězec __NOTOC__ !). Je-li tento řetězec uveden ve stránce vícekrát, vygeneruje se obsah na místě prvního z nich.
Úpravy
__NOEDITSECTION__ Skryje pod titulkem linku pro úpravy.
__NEWSECTIONLINK__ Přidá odkaz (("+" by default) mezi záložku "editovat" tab for adding a new section on a non-talk page (see Šablona:mediawiki). 1.7+
Kategorie
__NOGALLERY__ Je-li použita na stránce která patří do jmenného prostoru Kategorie, vygenerují se místo náhledů normální odkazy. 1.7+
__HIDDENCAT__ Je-li použita na stránce, která patří mezi podkategorie, pak zajistí že se odkaz na tuto stránku u nadřazené kategorie nevygeneruje (pokud ovšem není tato volba negována na stavením v uživatelském nastavení). 1.13+
{{DEFAULTSORT:xyz}} Je-li použit tento řetězec na stránce která vypisuje kategorizované stránky, pak nastaví třídící klíč. 1.10+
Jazyková konverze
__NOCONTENTCONVERT__
__NOCC__
U stránek které mají více jazykových variant zamezí konverzi obsahu (character and phase) ve zobrazovaném článku; např. u Čínštiny zobrazí pouze zkratku (zh) místo převodu do zh_cn, zh_tw, zh_sg, nebo zh_hk.
__NOTITLECONVERT__
__NOTC__
U stránek které mají více jazykových variant zamezí konverzi nadpisu (zbylý obsah převede).
Formátování stránky
{{DISPLAYTITLE:xyz}} Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores. It can be disabled or enabled by Šablona:mediawiki; disabled by default before 1.10+, enabled by default thereafter. 1.7+
__END__ Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in Šablona:mediawiki.
Jiné
__START__ Nemá zatím žádný význam.
__NOINDEX__ Tell search engines not to index the page (ie, do not list in search engines' results). Šablona:mediawiki
__INDEX__ Tell search engines to index the page (overrides Šablona:mediawiki, but not robots.txt). 1.13+
__STATICREDIRECT__ On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title". Šablona:mediawiki
#REDIRECT [[Page name]] Causes the current page to redirect viewers to another page.

Proměnné a funkce

Proměnné mohou vracet informace o aktuální stránce, wiki, čase aj. Jejich syntaxe je podobná jako u šablon, but capitalized to help avoid conflicts. Pokud má šablona stejný název jako proměnná, bude místo ní použita proměnná. Použití šablony může být vynuceno přidáním modifikátoru "msg:" (např., "{{msg:CURRENTYEAR}}"). Rovněž omylem přidané parametry způsobí, že parser bude proměnnou interpretovat jako šablonu; např. následující kód {{CURRENTDAYNAME|x}} zpracuje jako "Šablona:CURRENTDAYNAME".

Funkce jsou svým zápisem proměnným velmi podobné, ovšem jejich vstupním parametrem není aktuální stránka, ale uživatelský vstup. První parameter je oddělen dvojtečkou (:), místo svislítka (|). (Tato stránka neobsahuje žádnou z funkcí kterou přidává rozšíření Extensions (rozšíření) jsou doplňkové moduly, které nejsou součástí základní instalace MediaWiki, ale které významně rozšiřují její možnosti. Na této stránce je stručný přehled námi aktuálně používaných rozšíření:

  • AccessControl - Rozšíření naší vlastní provenience, které umožňuje aby sami uživatelé mohli upravit omezení přístupu k obsahu svých stránek. Více viz AccessControl
  • Cite - Umožňuje vkládat do stránek poznámky pod čarou
  • CiteThisPage - Přidává do postranního menu položku Citovat stránku, která zavolá speciální stránku, na které budou vygenerované různé formy citace příslušné stránky, vhodné k použití na jiných webech či publikacích.
  • ConfirmAccount - Rizšíření integruje ověřovací mechanismy do procesu založení uživatelského účtu (získání a ověření základních údajů o uživateli, schvalovací mechanismus)
  • DynamicPageList - Komplexní rozšíření, které umožňuje tvořit dynamické seznamy
  • DynamicSidebar - Rozšíření zpřístupňuje obsah parametricky generovaného postraního panelu
  • LabeledSectionTransclusion - Rozšiřuje možnosti transkluze (vkládání obsahu do stránky) na základě parametrů, což v kombinaci s rozšířením ParserFunctions výrazně zvyšuje možnosti šablon.
  • LiquidThreads - Více viz LiquidThreads
  • LookupUser - Umožňuje vybrané skupině uživatelů pomocí speciální stránky Special:LookupUser prohlížet neveřejné údaje uživatelů, uvedené při registraci účtu.
  • Loops - Rozšiřuje možnosti ParserFunctions tím, že umožňuje zpracovávat řetězce ve smyčkách.
  • Math - Dovoluje v obsahu generovat vizualizované matematické funkce na základě LaTeX syntaxe
  • MultiBoilerplate - Toto rozšíření aktivuje používání předdefinovaných šablon pro zakládání nových stránek
  • MyVariables - Rozšiřuje možnosti ParserFunctions tím, že umožňuje používat v šablonách uživatelsky definované proměnné
  • ParserFunctions - Rozšíření které umožňuje ve wiki používat nejrůznější funkce viz http://meta.wikimedia.org/wiki/Help:ParserFunctions ParserFunctions
  • PdfHandler - Umožňuje prohlížení vložených pdf dokumentů bez toho že by je bylo nutné stahovat. Funguje podobným způsobem jak prohlížení djvu souborů, které je v MediaWiki standardní součástí, za předpokladu, že jsou na serveru nainstalovány knihovny a utility djvulibre.
  • Renameuser - Umožňuje přes speciální stránku Special:Renameuser přejmenovat uživatele
  • SyntaxHighlight - Více viz SyntaxHighlight
  • Translate - Více viz Translate
  • UniversalLanguageSelector - Přidává všem uživatelům možnost změnit výchozí jazyk rozhraní a případně i obsahu stránky
  • UserMerge - Umožňuje přes speciální stránku Special:UserMerge slučovat uživatelské účty
  • Variables - Rozšiřuje možnosti ParserFunctions tím, že umožňuje používat v šablonách další proměnné

Přehled rozšíření používaných v minulosti

  • GroupPermissionManager - rozšíření umožňovalo sofistikovanější nastavení systémových uživatelských skupin a jejich práv, ale muselo být odstraněno, protože při jeho použití nebylo možné editovat stránky s javascriptem, jako je např. stránka MediaWiki:Common.js
  • ImportUsers - rozšíření mělo umožňovat hromadný import uživatelů, ale k jeho reálnému využití nikdy nedošlo. Mimo to byla v průběhu času zvolena jiná strategie zakládání účtů, při které se zároveň ověřuje e-mailová adresa žadatele o přístup do wiki.
  • Lockdown - rozšíření umožňovalo vymezit přístup ke stránkám v určitém jmenném prostoru pouze na určitou systémovou skupinu uživatelů. V praxi se ale nikdy nevyužilo a protože se časem změnila logika přístupových práv MediaWiki (systémové skupiny si zakládají podle potřeby rozšíření samy) pozbylo smysl.
  • PasswordReset - bylo rozšíření, které umožňovalo přes sepciální stránku Special:PasswordReset změnit uživateli jeho přístupové heslo. Od verze MW 1.18 je již tato stránka součástí standardní instalace MediaWiki
  • UserRightList - rozšíření umožňovalo přehledným způsobem nastavovat registrovaným uživatelům členství v systémových uživatelských skupinách. V podstatě jde o elegantnější správu členství v systémových skupinách než přes standardní stránku Special:Userrights ale rozšíření nebylo udržováno a v novějších verzích MW přestalo fungovat
  • YouTube - rozšíření umožňovalo vkládat do wiki stránek videa z Youtube, ale rozšíření nebylo udržováno a v novějších verzích MW přestalo fungovat.)

Datum & čas

The following variables return the current date and time according to the user's timezone preferences, defaulting to the UTC timezone.

Due to MediaWiki and browser caching, these variables frequently show when the page was cached rather than the current time.

Proměnná Výstup Popis Verze
Rok
{{CURRENTYEAR}} 2020 Rok
Měsíc
{{CURRENTMONTH}} 05 Měsíc (dvojciferným číslem)
{{CURRENTMONTHNAME}} květen Měsíc (jménem)
{{CURRENTMONTHNAMEGEN}} května Měsíc (v genitivu)
{{CURRENTMONTHABBREV}} 5. Měsíc (pořadovým číslem) 1.5+
Den
{{CURRENTDAY}} 26 Den v měsíci (pořadovým číslem)
{{CURRENTDAY2}} 26 Den v měsíci (dvojciferným číslem) 1.6+
{{CURRENTDOW}} 2 Den v týdnu (unpadded number)
{{CURRENTDAYNAME}} úterý Den v týdnu (jménem)
Čas
{{CURRENTTIME}} 11:14 Aktuální čas (24-hodinový tvar HH:mm )
{{CURRENTHOUR}} 11 Hodina (24-hodinový dvouciferný tvar)
Další
{{CURRENTWEEK}} 22 Týden (číslo)
{{CURRENTTIMESTAMP}} 20200526111452 ISO 8601 time stamp 1.7+

Následující proměnné dělají totéž co výše uvedené, ovšem výsledek je závislý na locales a ne uživatelském nastavení a UTC:

  • {{LOCALYEAR}}
  • {{LOCALMONTH}}
  • {{LOCALMONTHNAME}}
  • {{LOCALMONTHNAMEGEN}}
  • {{LOCALMONTHABBREV}}
  • {{LOCALDAY}}
  • {{LOCALDAY2}}
  • {{LOCALDOW}}
  • {{LOCALDAYNAME}}
  • {{LOCALTIME}}
  • {{LOCALHOUR}}
  • {{LOCALWEEK}}
  • {{LOCALTIMESTAMP}}

Technical metadata

Revision variables return data about the latest edit to the current page, even if viewing an older version of the page.

Proměnná Výstup Popis Verze
Stránka
{{SITENAME}} DCEwiki Titulek wiki (Šablona:mediawiki).
{{CURRENTVERSION}} 1.31.1 Verze MediaWiki. 1.7+
{{CONTENTLANGUAGE}} cs Výchozí jazyk rozhraní (Šablona:mediawiki) 1.7+
Poslední revize aktuální stránky
{{REVISIONID}} 621 Unikátní ID revize 1.5+
{{REVISIONDAY}} 26 Den kdy byla provedena poslední úprava stránky (unpadded number) 1.8+
{{REVISIONDAY2}} 26 Den kdy byla provedena poslední úprava stránky (zero-padded number) 1.8+
{{REVISIONMONTH}} 08 Měsíc kdy byla provedena poslední úprava stránky (unpadded number) 1.8+
{{REVISIONYEAR}} 2008 Rok kdy byla provedena poslední úprava stránky 1.8+
{{REVISIONTIMESTAMP}} 20080826204618 Timestamp poslední úpravy stránky 1.8+

Statistika

Numbers returned by these variables contain number separators, but can return raw numbers with the ":R" flag (for example, {{NUMBEROFPAGES}} = 6 654 and {{NUMBEROFPAGES:R}} = 6654). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}).

Proměnná Výstup Popis Verze
Entire wiki
{{NUMBEROFPAGES}} 6 654 Počet stránek. 1.7+
{{NUMBEROFARTICLES}} 2 707 Počet stránek v hlavním jmenném prostoru.
{{NUMBEROFFILES}} 2 781 Počet natažených souborů. 1.5+
{{NUMBEROFEDITS}} 34 133 Number of page edits. Šablona:mediawiki
{{NUMBEROFUSERS}} 204 Počet registrovaných uživatelů. 1.7+
{{NUMBEROFADMINS}} 7 Počet členů skupiny sysop Šablona:mediawiki. 1.7+
Per namespace
{{PAGESINNS:2}}
{{PAGESINNAMESPACE:2}}
Šablona:PAGESINNS:2
Šablona:PAGESINNAMESPACE:2
Number of pages in the given namespace (replace 2 with the relevant namespace ID). Disabled by default, enable with Šablona:mediawiki. 1.7+
Other
{{PAGESINCATEGORY:Help}}
{{PAGESINCAT:Help}}
0
0
Number of pages in the given category (replace "Help" with the relevant category name). 1.13+
{{PAGESIZE:Help:Magic_words}} 0 Returns the byte size of the specified page. Šablona:mediawiki

URL data

URLs

Variable Output Description Versions
{{SERVER}} https://support.dce.felk.cvut.cz domain URL (Šablona:mediawiki)
{{SERVERNAME}} support.dce.felk.cvut.cz domain name (Šablona:mediawiki)
{{SCRIPTPATH}} /mediawiki relative script path (Šablona:mediawiki)
{{localurl:page name}}
{{localurl:page name|query string}}
/mediawiki/index.php/page_name
/mediawiki/index.php?title=page_name&query string
relative path to title
{{fullurl:page name}}
{{fullurl:page name|query_string}}
https://support.dce.felk.cvut.cz/mediawiki/index.php/page_name
https://support.dce.felk.cvut.cz/mediawiki/index.php?title=page_name&query_string
absolute path to title 1.5+
{{filepath:Wiki.png}} The absolute URL to a media file. Šablona:mediawiki
{{urlencode:x y z}} x+y+z The input encoded for use in URLs. Šablona:mediawiki
{{anchorencode:x y z}} x_y_z The input encoded for use in URL section anchors (after the '#' symbol in a URL). Šablona:mediawiki

Page names

Variable Output Description Versions
{{FULLPAGENAME}} Nápověda:Systémové proměnné a jejich použití Namespace and page title. 1.6+
{{PAGENAME}} Systémové proměnné a jejich použití Page title.
{{BASEPAGENAME}} Systémové proměnné a jejich použití Page title excluding the current subpage and namespace ("Title" on "Title/foo"). 1.7+
{{SUBPAGENAME}} Systémové proměnné a jejich použití The subpage title ("foo" on "Title/foo"). 1.6+
{{SUBJECTPAGENAME}} Nápověda:Systémové proměnné a jejich použití The namespace and title of the associated content page. 1.7+
{{TALKPAGENAME}} Diskuse k nápovědě:Systémové proměnné a jejich použití The namespace and title of the associated talk page. 1.7+

The following are URL-encoded equivalents:

  • {{FULLPAGENAMEE}}
  • {{PAGENAMEE}}
  • {{BASEPAGENAMEE}}
  • {{SUBPAGENAMEE}}
  • {{SUBJECTPAGENAMEE}}
  • {{TALKPAGENAMEE}}

Jmenné prostory

Proměnná Výstup Popis Verze
{{NAMESPACE}} Nápověda Namespace (name)
{{SUBJECTSPACE}}
{{ARTICLESPACE}}
Nápověda
Nápověda
Name of the associated content namespace 1.7+
{{TALKSPACE}} Diskuse k nápovědě Name of the associated talk namespace 1.7+

The following are URL-encoded equivalents:

  • {{NAMESPACEE}}
  • {{SUBJECTSPACEE}}
  • {{TALKSPACEE}}

{{ns:}} returns the localized namespace name for that number constant. The default values are:

Použití Výstup
{{ns:-2}} or {{ns:Media}} Média
{{ns:-1}} or {{ns:Special}} Speciální
{{ns:0}}
{{ns:1}} or {{ns:Talk}} Diskuse
{{ns:2}} or {{ns:User}} Uživatel
{{ns:3}} or {{ns:User_talk}} Diskuse s uživatelem
{{ns:4}} or {{ns:Project}} DCEwiki
{{ns:5}} or {{ns:Project_talk}} Diskuse k DCEwiki
{{ns:6}} or {{ns:Image}} Soubor
{{ns:7}} or {{ns:Image_talk}} Diskuse k souboru
{{ns:8}} or {{ns:MediaWiki}} MediaWiki
{{ns:9}} or {{ns:MediaWiki_talk}} Diskuse k MediaWiki
{{ns:10}} or {{ns:Template}} Šablona
{{ns:11}} or {{ns:Template_talk}} Diskuse k šabloně
{{ns:12}} or {{ns:Help}} Nápověda
{{ns:13}} or {{ns:Help_talk}} Diskuse k nápovědě
{{ns:14}} or {{ns:Category}} Kategorie
{{ns:15}} or {{ns:Category_talk}} Diskuse ke kategorii

Formátování

Použití Výstup Popis Verze
{{lc:XYZ}} xyz The lowercase input. 1.5+
{{lcfirst:XYZ}} xYZ The input with the first character lowercase. 1.5+
{{uc:xyz}} XYZ The uppercase input. 1.5+
{{ucfirst:xyz}} Xyz The input with the first character uppercase. 1.5+
{{formatnum:-987654321.654321}} -987 654 321,654321 The input with decimal and decimal group separators, and localized digit script, according to the wiki's default locale. 1.7+
{{padleft:xyz|5|_}}
{{padleft:xyz|5}}
__xyz
00xyz
The input (first parameter) padded on the left side to the specified width (second parameter) using the specified character (third parameter). If a padding character isn't specified, '0' is used by default.
bug: multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters.
1.8+
{{padright:xyz|5|_}}
{{padright:xyz|5}}
xyz__
xyz00
Identical to padleft, but adds padding characters to the right side.
{{DIRMARK}}
{{DIRECTIONMARK}}

Outputs a unicode-directional mark that matches the wiki's default language's direction (‎ on left-to-right wikis, ‏ on right-to-left wikis), useful in text with multi-directional text. 1.7+
{{plural:2|is|are}} are Outputs the correct given pluralization form (parameters except first) depending on the count (first parameter). Plural transformations are used for languages like Russian based on "count mod 10".

Různé

Použití Výstup Popis Verze
{{#language:eo}} Esperanto The native name for the given language code. 1.7+
{{#special:userlogin}} Speciální:Přihlásit The localized name for the given canonical Special: page. Šablona:mediawiki
{{#tag:tagname}}
{{#tag:tagname|inner content|parameter=value|parameter2=value}}
(depends on parser tag) Alias for XML-style parser or extension tags, but parsing wiki code. Attribute values can be passed as parameter values ('<tagname attribute="value">' → '{{#tag:tagname|attribute=value}}'), and inner content as an unnamed parameter ('<tagname>content</tagname>' → '{{#tag:tagname|content}}'). 1.12+