Numinix MediaWiki Demo - User contributions [en]

API/Parsing wikitext

2026-07-25T17:02:15Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate>

'''GET/POST request''' to parse content of a page and obtain the output.

== API documentation == 
</translate>

<translate>
== Example 1: Parse content of a page == 

=== GET request === 
</translate>

<translate>
=== Response === 
</translate>
<syntaxhighlight lang="json">
{
"parse": {
"title": "Pet door",
"pageid": 3276454,
"revid": 852892138,
"text": {
"*": "<div class=\"mw-parser-output\"><div class=\"thumb tright\"><div class=\"thumbinner\" style=\"width:222px;\"><a href=\"/wiki/File:Doggy_door_exit.JPG\" class=\"image\"><img alt=\"\" src=\"//upload.wikimedia.org/wikipedia/commons/thumb/7/71/Doggy_door_exit.JPG/220px-Doggy_door_exit.JPG\" width=\"220\" height=\"165\" class=\"thumbimage\" srcset=\"//upload.wikimedia.org/wikipedia/commons/thumb/7/71/Doggy_door_exit.JPG/330px-Doggy_door_exit.JPG 1.5x,
...
}
}
}
</syntaxhighlight>

<translate>
== Sample code == 
</translate>

/Sample code 1}}

<translate>
== Example 2: Parse a section of a page and fetch its table data == 

=== GET request === 
</translate>

<translate>
=== Response === 
</translate>

<syntaxhighlight lang="json">
{
"parse": {
"title": "Wikipedia:Unusual articles/Places and infrastructure",
"pageid": 38664530,
"wikitext": {
"*": "===Antarctica===\n\n{| class=\"wikitable\"\n|-\n| '''[[Emilio Palma]]'''\n| An Argentine national who is the first person known to be born on the continent of Antarctica.\n|-\n| '''[[Scouting in the Antarctic]]'''\n| Always be prepared for glaciers and penguins.\n|}"
}
}
}
</syntaxhighlight>

<translate>
=== Sample code === 
</translate>

<syntaxhighlight lang="python3">
#!/usr/bin/python3

"""
parse_wikitable.py

MediaWiki Action API Code Samples
Demo of `Parse` module: Parse a section of a page, fetch its table data and save
it to a CSV file

MIT license
"""

import csv
import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

TITLE = "Wikipedia:Unusual_articles/Places_and_infrastructure"

PARAMS = {
'action': "parse",
'page': TITLE,
'prop': 'wikitext',
'section': 5,
'format': "json"
}

def get_table():
""" Parse a section of a page, fetch its table data and save it to a CSV file
"""
res = S.get(url=URL, params=PARAMS)
data = res.json()
wikitext = data['parse']['wikitext']['*']
lines = wikitext.split('|-')
entries = []

for line in lines:
line = line.strip()
if line.startswith("|"):
table = line[2:].split('||')
entry = table[0].split("|")[0].strip("'''[[]]\n"), table[0].split("|")[1].strip("\n")
entries.append(entry)

file = open("places_and_infrastructure.csv", "w")
writer = csv.writer(file)
writer.writerows(entries)
file.close()

if __name__ == '__main__':
get_table()

</syntaxhighlight>

<translate>
== Possible errors == 
</translate>
{| class="wikitable"
|+
! <translate> Code</translate>
! <translate> Info</translate>
|-
|missingtitle
|
|-
|nosuchsection
|
|-
|pagecannotexist
|
|-
|invalidparammix
|<nowiki/>
*
*
*
|}

<translate>
== Parameter history == 
</translate>
* v1.45: <translate> Introduced <tvar name=1><code>parser</code></tvar></translate>
* v1.43: <translate> Introduced <tvar name=1><code>usearticle</code></tvar></translate>
* v1.38: <translate> Introduced <tvar name=1><code>showstrategykeys</code></tvar></translate>
* v1.32: <translate> Deprecated <tvar name=1><code>disabletidy</code></tvar></translate>
* v1.31: <translate> Introduced <tvar name=1><code>disablestylededuplication</code></tvar></translate>
* v1.30: <translate> Introduced <tvar name=1><code>revid</code>, <code>useskin</code>, <code>wrapoutputclass</code></tvar></translate>

<translate>
== See also == 
</translate>
*[[API:Parsing wikitext/TOCData]]
*
*
*
*
*
*

----
''Sample content adapted from [[mediawikiwiki:API:Parsing_wikitext]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

API/Edit

2026-07-25T17:02:15Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate> '''POST request''' to edit a page.</translate>

__TOC__

<translate>
== API documentation == 
</translate>

<translate>
== Example == 


The sample code in this example is in Python.</translate>
<translate> See <tvar name=1></tvar> for examples and responses in <tvar name=2></tvar>.</translate>

<translate>
=== POST request === 


Making edits, and, indeed, any POST request, is a multi-step process.
</translate>

:1. <translate> Log in, via one of the methods described in <tvar name=1></tvar>.</translate> <translate> Note that while this is required to correctly attribute the edit to its author, many wikis do allow users to edit without registering or logging into an account.</translate> 

:2. <translate> GET a :</translate>
::

:3. <translate> Send a POST request, with the CSRF token, to take action on a page:</translate>
::

<translate> The Response section below is for the final POST request, to take action on the page.</translate>
<translate> See the pages on <tvar name=1></tvar> and <tvar name=2></tvar> for the intermediary JSON responses to earlier steps.</translate>

<translate> Also note that the tokens in the queries on this page are sample values.</translate>
<translate> Actual tokens are unique to each login session and cross-site request.</translate>
<translate> They are included only to demonstrate how to properly format queries.</translate>

<translate>
=== Response === 
</translate>
<div style="width:60%;">
<syntaxhighlight lang="json">
{
"edit": {
"result": "Success",
"pageid": 94542,
"title": "Wikipedia:Sandbox",
"contentmodel": "wikitext",
"oldrevid": 371705,
"newrevid": 371707,
"newtimestamp": "2018-12-18T16:59:42Z"
}
}
</syntaxhighlight>
</div>

<translate>
== Sample code == 
</translate>



/Sample code 1}}

<translate>
== User cases == 

=== Edit conflicts === 
</translate>
<translate> The [[<tvar name=1>#Sample code</tvar>|Python sample]] is a basic implementation of an edit request by a registered user.</translate>
<translate> In real-world scenarios, care should be taken to prevent edit conflicts.</translate>
<translate> These occur when two or more users are attempting to edit the same page at the same time.</translate>

<translate> Conflicts can be prevented by retrieving the last timestamp when we request a CSRF token.</translate>
<translate> Adding <tvar name=1><code>prop=info|revisions</code></tvar> to the CSRF token request in Step 3 allows us to access the timestamp for the last revision.</translate>
<translate> This timestamp will be used as the <tvar name=1><code>basetimestamp</code></tvar> when we make our the edit request.</translate>

<translate> We also need the exact time when we start our edit.</translate>
<translate> This can be retrieved by adding <tvar name=1><code>curtimestamp</code></tvar> to the CSRF request as well.</translate>
<translate> This value will serve as our <tvar name=1><code>starttimestamp</code></tvar>.</translate>

<translate>

Finally, in the actual edit request, set the <tvar name=1><code>basetimestamp</code></tvar> and <tvar name=2><code>starttimestamp</code></tvar> parameters, like so:
</translate>

<translate>
=== Large edits === 
</translate>
<translate> POST requests containing large amounts of text content (8000+ characters) should be sent with <tvar name=1><code>Content-Type: multipart/form-data</code></tvar> indicated in the [[<tvar name=2>devmo:Web/HTTP/Headers</tvar>|header]].</translate>
<translate> Because <tvar name=1><code>multipart/form-data</code></tvar> does not need to add HTML escape characters (i.e., [[<tvar name=2>devmo:Glossary/percent-encoding</tvar>|percent encoding]]) for spaces and punctuation, the amount of data passed will subsequently be much smaller than the percent-encoded equivalent.</translate>

<translate> However, there is still some overhead added by <tvar name=1><code>multipart/form-data</code></tvar> -- roughly, 160 bytes per parameter.</translate>
<translate> For short messages that don't require adding many escape characters, this amount of overhead can be inefficient, and percent-encoding is preferred.</translate><ref>
https://stackoverflow.com/a/4073451
</ref>

<translate>

Note that in our [[<tvar name=1>#Example</tvar>|Python sample code]], the request is percent-encoded by default.
</translate>

<translate> See [[<tvar name=1>devmo:Web/HTTP/Headers/Content-Type</tvar>|the MDN web docs]] for a more technical discussion of content-type and POST requests.</translate>
<translate> See [<tvar name=url>http://docs.python-requests.org/en/master/user/quickstart/#more-complicated-post-requests</tvar> the Python Requests documentation] for how to pass <tvar name=1><code>multipart/form-data</code></tvar> using syntax similar to our Python sample code.</translate>

<translate>
=== CAPTCHAs === 
</translate>
<translate> If the wiki you are targeting uses , your request may return an error containing an ID number and a simple test, such as a question, a math problem, or a URL to an image.</translate>
<translate> In order to complete your edit, you must complete the test, then retry your request with the id and the correct answer(s) appended to the original query string, like so:</translate> <code>captchaid=sampleId&captchaword=answer</code>

<translate> Other CAPTCHA systems and extensions may use different parameters for similar use.</translate>
<translate> In general, use the field names for the ID and test questions as the parameters in your second request.</translate>

<translate>
== Possible errors == 
</translate>
{| class="wikitable sortable"
! <translate> Code</translate> !! <translate> Info</translate>
|-
| notitle ||
|-
| missingparam || appendtextundo|3}}
|-
| notoken ||
|-
| invalidsection ||
|-
| protectedpage || |en | | }}
|-
| cantcreate ||
|-
| cantcreate-anon || <translate> Anonymous users can't create new pages</translate>
|-
| articleexists ||
|-
| noimageredirect-anon ||
|-
| noimageredirect ||
|-
| spamdetected ||
|-
| abusefilter-warning || <translate> This action has been automatically identified as harmful.</translate>
|-
| abusefilter-disallowed || <translate> This action has been automatically identified as harmful, and therefore disallowed.</translate>
|-
| contenttoobig || <br />Where '''bytes''' is the value of .
|-
| noedit-anon ||
|-
| noedit ||
|-
| pagedeleted ||
|-
| emptypage ||
|-
| emptynewsection ||
|-
| editconflict ||
|-
| revwrongpage || <br /><translate> Thrown if an invalid revid is given for <tvar name=undo><code>undo</code></tvar> or <tvar name=undoafter><code>undoafter</code></tvar></translate>
|-
| undofailure ||
|-
| missingtitle || <br /><translate> (see above <tvar name=nocreate><code>nocreate</code></tvar> [[<tvar name=1>#Parameters</tvar>|parameter]])</translate>
|-
| mustbeposted ||
|-
| readapidenied ||
|-
| writeapidenied ||
|-
| noapiwrite ||
|-
| badtoken ||
|-
| missingparam ||
|-
| invalidparammix ||
|-
| invalidtitle ||
|-
| invalid-content-data || <br/><translate> occurs when trying to edit a JSON page with non-conforming data, or while trying to edit a <tvar name=1>MassMessageListContent</tvar> page</translate>
|-
| nosuchpageid ||
|-
| pagecannotexist ||
|-
| nosuchrevid ||
|-
| nosuchrevid ||
|-
| badmd5 ||
|-
| hookaborted ||
|-
| parseerror ||
|-
| summaryrequired ||
|-
| blocked ||
|-
| ratelimited ||
|-
| unknownerror ||
|-
| nosuchsection ||
|-
| sectionsnotsupported ||
|-
| editnotsupported || <translate> Editing of this type of page is not supported using the text based edit API.</translate>
|-
| appendnotsupported ||
|-
| redirect-appendonly ||
|-
| edit-invalidredirect ||
|-
| badformat ||
|-
| customcssprotected ||
|-
| customjsprotected ||
|-
| taggingnotallowed || <translate> You don't have permission to set change tags</translate>
|-
| badtags || <br /> Tag2'''}}
|-
| tpt-target-page || <br/><translate> When using <tvar name=translate></tvar>, editing of a translated subpage is not allowed.</translate>
|}

<translate>
== Parameter history == 
</translate>
* v1.35: <translate> Introduced <tvar name=1><code>baserevid</code></tvar></translate>
* v1.25: <translate> Introduced <tvar name=1><code>tags</code></tvar></translate>
* v1.21: <translate> Introduced <tvar name=1><code>contentformat</code>, <code>contentmodel</code></tvar></translate>
* v1.20: <translate> Introduced <tvar name=1><code>pageid</code></tvar></translate>
* v1.19: <translate> Introduced <tvar name=1><code>sectiontitle</code></tvar></translate>
* v1.18: <translate> Deprecated <tvar name=1><code>captchaid</code>, <code>captchaword</code></tvar></translate>
* v1.17: <translate> Introduced <tvar name=1><code>redirect</code></tvar></translate>
* v1.16: <translate> Deprecated <tvar name=1><code>watch</code>, <code>unwatch</code></tvar></translate>
* v1.16: <translate> Introduced <tvar name=1><code>watchlist</code></tvar></translate>
* v1.15: <translate> Introduced <tvar name=1><code>undo</code>, <code>undoafter</code></tvar></translate>
* v1.14: <translate> Introduced <tvar name=1><code>starttimestamp</code></tvar></translate>

<translate>
== Additional notes == 


* Log in is not strictly required by the API, but it is needed to correctly attribute the edit to its author.</translate> <translate> A successful edit from a user who is not logged in will be attributed to their IP address.</translate>
<translate>

* Bots that are not logged in may face restrictions on editing and other write requests; see for more details.</translate>
<translate>

* Users who are not logged in will always be given the empty CSRF token, <tvar name=1><code>+\</code></tvar>.</translate>
<translate>

* The process for requesting a token has changed several times across versions.</translate> <translate> See <tvar name=1></tvar> for more information.</translate>
<translate>

* <tvar name=1></tvar> provides a way to access edit tokens when running code within a wiki page.</translate>
<translate>

* You can use the same CSRF token for all edit operations across the same wiki, during a single login session.</translate>
<translate>

* It is a good practice to pass any tokens in your request at the end of the query string, or at least after the text parameter.</translate> <translate> That way, if the connection is interrupted, the token will not be passed and the edit will fail.</translate> <translate> If you are using the <tvar name=1></tvar> object to make requests, this is done automatically.</translate>
<translate>

* Although <tvar name=1><code>captchaid</code></tvar> and <tvar name=2><code>captchaword</code></tvar> have, technically, been removed from API:Edit since v1.18, <tvar name=3></tvar> extends API:Edit to work with CAPTCHAs.</translate> <translate> Thus, with ConfirmEdit installed, these parameters are still available.</translate> <translate> ConfirmEdit comes packaged with the MediaWiki software, v1.18+.</translate>

== Limitations ==
* The API does not yet support editing [[Multi-Content Revisions|content slots]] (). You can do so instead with an extension like [[Extension:WSSlots]], which enables the <code>editslot</code> API action.

<translate>
== See also == 
</translate>
* - <translate> contains useful links on editing articles.</translate>
* - <translate> describes how to log in using a simplified interface when accessing wikis via a script or application, rather than the GUI.</translate>
* - <translate> more details on using a bot to automatically edit pages.</translate>
* - <translate> provides a way to access edit tokens when running JavaScript within a MediaWiki page.</translate>
* - <translate> has more details on using tokens to log in or make POST requests.</translate>
* - <translate> a deprecated API, distinct from <tvar name=1></tvar>, for requesting tokens in earlier versions of MediaWiki.</translate>
* - <translate> allows you to diff between edits on a page.</translate>
* - <translate> alters tags on a page.</translate>
* - <translate> reverts a series of edits.</translate>
* - <translate> rolls back files to an earlier state.</translate>
* - <translate> deletes and restores revisions to a page.</translate>

<translate>

== References == 
</translate>

[[Category:MediaWiki API]]

----
''Sample content adapted from [[mediawikiwiki:API:Edit]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

API/Search

2026-07-25T17:02:14Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate>

'''GET request''' to perform an advanced search for wiki pages by title or content text match.

== API documentation == 
</translate>

<translate>
=== GET request === 
</translate>

{{Note|1=<translate> Default search results are without UTF8 encoding.</translate> <translate> Replace <tvar name=1><code>utf8</code></tvar> in the get request above to see the difference.</translate>}}

<translate>
=== Response === 
</translate>
<syntaxhighlight lang="python3">
{
"batchcomplete": "",
"continue": {
"sroffset": 10,
"continue": "-||"
},
"query": {
"searchinfo": {
"totalhits": 5060
},
"search": [
{
"ns": 0,
"title": "Nelson Mandela",
"pageid": 21492751,
"size": 196026,
"wordcount": 23664,
"snippet": "<span class=\"searchmatch\">Nelson</span> Rolihlahla <span class=\"searchmatch\">Mandela</span> (/mænˈdɛlə/, Xhosa: [xoliɬaˈɬa <span class=\"searchmatch\">manˈdɛla</span>]; 18 July 1918 – 5 December 2013) was a South African anti-apartheid revolutionary,",
"timestamp": "2018-07-23T07:59:43Z"
},
{
"ns": 0,
"title": "Death of Nelson Mandela",
"pageid": 41284488,
"size": 133513,
"wordcount": 13512,
"snippet": "On December 5, 2013, <span class=\"searchmatch\">Nelson</span> <span class=\"searchmatch\">Mandela</span>, the first President of South Africa to be elected in a fully representative democratic election, as well as the country's",
"timestamp": "2018-07-19T17:30:59Z"
}
...
]
}
}
</syntaxhighlight>

<translate>
=== Sample code === 
</translate>


/Sample code 1}}

<translate>
== Possible errors == 
</translate>
{| class="wikitable"
|+
! <translate> Code</translate>
! <translate> Info</translate>
|-
| nosrsearch
|
|-
| search-text-disabled
|
|-
| search-title-disabled
|
|-
| search-error
| <translate> search error has occurred</translate>
|}

<translate>
== Parameter history == 
</translate>
* v1.24: <translate> Deprecated <tvar name=1><code>score</code>,<code>hasrelated</code></tvar></translate>
* v1.23:
** <translate> Removed <tvar name=1><code>srredirects</code></tvar>.</translate> <translate> Redirects are always included.</translate>
** <translate> Introduced <tvar name=1><code>srinterwiki</code></tvar></translate>
* v1.22: <translate> Introduced <tvar name=1><code>srbackend</code></tvar></translate>
* v1.17: <translate> Introduced <tvar name=1><code>nearmatch</code>, <code>score</code>, <code>titlesnippet</code>, <code>redirecttitle</code>, <code>redirectsnippet</code>, <code>sectiontitle</code>, <code>sectionsnippet</code>, <code>hasrelated</code></tvar></translate>
* v1.16: <translate> Introduced <tvar name=1><code>srinfo</code>, <code>srprop</code></tvar></translate>

<translate>
== Additional notes == 


* Depending on which search backend is in use, how <tvar name=1><code>srsearch</code></tvar> is interpreted may vary.</translate> <translate> On Wikimedia wikis which use CirrusSearch, see <tvar name=1></tvar> for information about the search syntax.</translate>

<translate>
== See also == 
</translate>
*
*

[[Category:MediaWiki API query lists|MediaWiki API query lists]]

----
''Sample content adapted from [[mediawikiwiki:API:Search]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

API/Query

2026-07-25T17:02:14Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate>

The <tvar name=1><code>action=query</code></tvar> module allows you to fetch information about a wiki and the data stored in it, such as the wikitext of a particular page, the links and categories of a set of pages, or the token you need to .
</translate>

<div style="overflow:auto">

</div>

<translate>
== API documentation == 
</translate>

<translate>
=== Query modules === 


The query module has three types of submodules (also called query modules):


* about the wiki and the logged-in user.</translate>
<translate>

* of pages, including page revisions and content.</translate>
<translate>

* of pages that match certain criteria.

== Examples == 
</translate>

<translate>
=== Example 1: Specifying pages === 


Unlike meta and list query modules, all property query modules work on a set of pages that can be specified in one of the following ways:


* By name using the <tvar name=1><code>titles</code></tvar> parameter, e.g. <tvar name=2><code>titles=Foo|Bar|Main_Page</code></tvar>.</translate>
<translate>

* By page ID using the <tvar name=1><code>pageids</code></tvar> parameter, e.g. <tvar name=2><code>pageids=123|456|75915</code></tvar>.</translate>
<translate>

* By revision ID using the <tvar name=1><code>revids</code></tvar> parameter, e.g. <tvar name=2><code>revids=478198|54872|54894545</code></tvar>.</translate> <translate> Most query modules will convert revision ID to the corresponding page ID.</translate> <translate> Only <tvar name=1>revisions}}</tvar> actually uses the revision ID itself.</translate>
<translate>

* Using a [[<tvar name=1>#Generators</tvar>|generator]].
</translate>

<translate>
==== GET request ==== 
</translate>
5487548945
|p3=format=json
|p4=formatversion=2
}}
<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"pages": [
{
"pageid": 1130,
"ns": 0,
"title": "Avicenna"
},
{
"pageid": 17412,
"ns": 0,
"title": "Klein bottle"
},
{
"pageid": 33642,
"ns": 0,
"title": "Warrant"
}
]
}
}
</syntaxhighlight>

<translate>
=== Example 2: Title normalization === 


Title normalization converts page titles to their canonical form.


This means capitalizing the first character, replacing underscores with spaces, and changing namespace to the localized form defined for that wiki.
</translate>

<translate>
==== GET request ==== 
</translate>
article_B
| p3=format=json
| p4=formatversion=2
}}
<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"normalized": [
{
"fromencoded": false,
"from": "Project:articleA",
"to": "Wikipedia:ArticleA"
},
{
"fromencoded": false,
"from": "article_B",
"to": "Article B"
}
],
"pages": [
{
"ns": 0,
"title": "Article B",
"missing": true
},
{
"ns": 4,
"title": "Wikipedia:ArticleA",
"missing": true
}
]
}
}
</syntaxhighlight>

<translate>
=== Example 3: Missing and invalid titles === 


Titles that don't exist or are invalid will have a <tvar name=1><code>missing</code></tvar> or <tvar name=2><code>invalid</code></tvar> attribute set in the response.


In output formats that support numeric array keys, missing and invalid titles will have negative page IDs.
</translate>

<translate> In some cases, a title can be viewed by a user but cannot be accessed by the API, such as pages that mirror content from another wiki.</translate>
<translate> These titles will have a <tvar name=1><code>known</code></tvar> attribute set in the response.</translate>

<translate>
==== GET request ==== 
</translate>
Main%20PageTalk:
|p3=format=json
|p4=formatversion=2
}}
<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"pages": [
{
"ns": 0,
"title": "Doesntexist",
"missing": true
},
{
"title": "Talk:",
"invalidreason": "The requested page title is empty or contains only the name of a namespace.",
"invalid": true
},
{
"pageid": 15580374,
"ns": 0,
"title": "Main Page"
}
]
}
}
</syntaxhighlight>

<translate>
=== Example 4: Continuing queries=== 


When all the data is not returned in the response of a query, there will be a <tvar name=1><code>continue</code></tvar> attribute to indicate that there is more data.
</translate>

<translate>
==== GET request ==== 
</translate>

<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"continue": {
"accontinue": "List_of_largest_companies_in_Sri_Lanka",
"continue": "-||"
},
"query": {
"allcategories": [
{
"category": "List of BioWare characters"
},
{
"category": "List of Harlequin Romance novels"
},
{
"category": "List of MPs elected in UK elections templates"
},
{
"category": "List of Metamorphoses characters"
},
{
"category": "List of Rockstar Games characters"
},
{
"category": "List of Star Trek awards and nominations"
},
{
"category": "List of Swedish films of the 2020s"
},
{
"category": "List of association football clubs in the Republic of Ireland templates"
},
{
"category": "List of awards and nominations received by Aleksej Pechkuroy"
},
{
"category": "List of cabinet templates"
}
]
}
}
</syntaxhighlight>

<translate>

To get further data, add its values to the original request:
</translate>

<translate>
==== GET request ==== 
</translate>

}}
<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"allcategories": [
{
"category": "List of largest companies in Sri Lanka"
},
{
"category": "List of longest beaches of the world"
},
{
"category": "List of ministers by ministry of Bangladesh"
},
{
"category": "List of people from Palm Beach, Florida"
},
{
"category": "List of video game characters"
}
]
}
}
</syntaxhighlight>

<translate>
=== Example 5: Batchcomplete === 


The API returns a <tvar name=1><code>batchcomplete</code></tvar> element to indicate that all data for the current batch of items has been returned.
</translate>

<translate>

In the response of the sample query below, <tvar name=1><code>batchcomplete</code></tvar> has been included to indicate that all the data for each of the three images has been returned.


The next continuation will begin returning data for the next set of 3 images.
</translate>

<translate>
==== GET request ==== 
</translate>

<translate>
===== Response ===== 
</translate>
<syntaxhighlight lang="json">
{
"batchcomplete": true,
"continue": {
"aicontinue": "20020822143445|Do_You_Want_to_Know_a_Secret_(Beatles_song_-_sample).ogg",
"continue": "-||"
},
"query": {
"allimages": [
{
"name": "Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
"timestamp": "2002-08-04T19:55:17Z",
"url": "https://upload.wikimedia.org/wikipedia/en/6/64/Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
"descriptionurl": "https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
"descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=67723",
"ns": 6,
"title": "File:Simon and Garfunkel - Mrs Robinson.ogg"
},
{
"name": "Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
"timestamp": "2002-08-04T20:01:36Z",
"url": "https://upload.wikimedia.org/wikipedia/en/c/c1/Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
"descriptionurl": "https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
"descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=67779",
"ns": 6,
"title": "File:Simon and Garfunkel - Scarborough Fair.ogg"
},
{
"name": "Beatles_please_me.ogg",
"timestamp": "2002-08-22T14:34:00Z",
"url": "https://upload.wikimedia.org/wikipedia/en/e/ee/Beatles_please_me.ogg",
"descriptionurl": "https://en.wikipedia.org/wiki/File:Beatles_please_me.ogg",
"descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=74826",
"ns": 6,
"title": "File:Beatles please me.ogg"
}
]
}
}
</syntaxhighlight>

<translate>
=== Example 6: Generators === 


Use generators if you want to get data about a set of pages.


For example, to get data about pages in a certain category, instead of querying <tvar name=1><code>list=categorymembers</code></tvar> and then querying again with <tvar name=2><code>pageids</code></tvar> set to all the returned pages, combine the two API calls into one by using <tvar name=3><code>generator=categorymembers</code></tvar>.


When using a list module as a generator, you don't need to specify the pages.


However, for a property module, you should [[<tvar name=1>#Specifying pages</tvar>|specify the pages]] which the generator will work on.


For example, to load all pages that are linked to from the main page, use <tvar name=1><code>generator=links&titles=Main%20Page</code></tvar>.


Parameters passed to a generator must be prefixed with a <code>g</code>. For instance, when using <code>generator=backlinks</code>, use <code>gbllimit</code> instead of <code>bllimit</code>.


The sample query below gets links and categories for the first three pages in the main namespace starting with "Ba".
</translate>

<translate>
==== GET request ==== 
</translate>
categories
|p6=format=json
|p7=formatversion=2
}}
<translate>
==== Response ==== 
</translate>
<syntaxhighlight lang="json">
{
"continue": {
"plcontinue": "14977970|0|Kirkwall_Ba_game",
"continue": "||categories"
},
"query": {
"pages": [
{
"pageid": 98178,
"ns": 0,
"title": "Ba",
"links": [
{
"ns": 0,
"title": "BA"
},
{
"ns": 4,
"title": "Wikipedia:Mainspace"
},
{
"ns": 4,
"title": "Wikipedia:Naming conventions (capitalization)"
},
{
"ns": 4,
"title": "Wikipedia:Protection policy"
},
{
"ns": 4,
"title": "Wikipedia:Redirect"
},
{
"ns": 10,
"title": "Template:R from miscapitalisation"
},
{
"ns": 10,
"title": "Template:R from modification"
},
{
"ns": 10,
"title": "Template:R to disambiguation page"
},
{
"ns": 14,
"title": "Category:Redirects from ambiguous terms"
},
{
"ns": 14,
"title": "Category:Redirects from other capitalisations"
}
],
"categories": [
{
"ns": 14,
"title": "Category:Redirects from ambiguous terms"
},
{
"ns": 14,
"title": "Category:Redirects from other capitalisations"
},
{
"ns": 14,
"title": "Category:Unprintworthy redirects"
}
]
},
{
"pageid": 14977970,
"ns": 0,
"title": "Ba'"
},
{
"pageid": 33351890,
"ns": 0,
"title": "Ba'Al Shem Tov"
}
]
}
}
</syntaxhighlight>

<translate>
== Continuing queries == 
</translate>
<translate> Queries will often have more results available than are just shown in the original query.</translate>
(Often this is because a query's result has been reached.)
<translate> In these cases, queries can be continued.</translate>
<translate> More detailed information on continuing queries can be at <tvar name=1></tvar>.</translate>

<translate>
== Possible warnings == 
</translate>
{| class="wikitable"
|+
! <translate> Warning message</translate>
! <translate> Cause</translate>
|-
| <translate> No support for special pages has been implemented.</translate>
| <translate> Thrown if a title in the Special: or Media: namespace is given. The pages in these namespaces cannot be queried.</translate>
|-
|
| <translate> Thrown if the <tvar name=1><code>redirect</code></tvar> parameter is used in a query that specifies pages using <tvar name=2><code>revids</code></tvar>.</translate>
|}

<translate>
== Parameter history == 
</translate>
* v1.34: <translate> Introduced <tvar name=1><code>exportschema</code></tvar></translate>
* v1.24: <translate> Introduced <tvar name=1><code>rawcontinue</code></tvar></translate> <translate> (note: [[<tvar name=1>Special:MyLanguage/API:Raw query continue</tvar>|raw continuation]] was the default behavior until v1.26)</translate>
* v1.21: <translate> Introduced <tvar name=1><code>continue</code></tvar></translate>

<translate>
== Additional notes == 
</translate>
* <translate> Specifying titles through <tvar name=1><code>titles</code></tvar> or <tvar name=2><code>pageids</code></tvar> is limited to 50 titles per query, or 500 for those with the <tvar name=3><code>apihighlimits</code></tvar> right.</translate>
* <translate> Use multiple query modules together to get what you need in one request, e.g. <tvar name=1><code>prop=info|revisions&list=backlinks|embeddedin|allimages&meta=userinfo</code></tvar>.</translate>
* <translate> Generators always pass page titles to the query module.</translate> <translate> Unlike lists (which may include additional data by default), generators should not output any information themselves, unless when explicitly requested via the generator module's query parameters.</translate>

<translate>
== Resolving redirects == 
</translate>
<translate> Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title.</translate>
<translate> When present, they will always contain <tvar name=1><code>from</code></tvar> and <tvar name=2><code>to</code></tvar> attributes and may contain a <tvar name=3><code>tofragment</code></tvar> attribute for those redirects that point to specific sections.</translate>

<translate> Both normalization and redirection may take place.</translate>
<translate> In the case of multiple redirects, all redirects will be resolved, and in case of a circular redirect, there might not be a page in the 'pages' section (see [[<tvar name=1>#circular_redirects</tvar>|an example request]]).</translate>
<translate> Redirect resolution cannot be used in combination with the <tvar name=1><code>revids=</code></tvar> parameter or with a generator generating revids; doing that will produce a [[<tvar name=2>#Possible warnings</tvar>|warning]] and will not resolve redirects for the specified revids.</translate>

<translate>

The examples below show how the <tvar name=1><code>redirects</code></tvar> parameter works.
</translate>

{{ApiEx
| desc=<translate> Using "<tvar name=1>redirects</tvar>" parameter.</translate> <translate> "<tvar name=1>Main page</tvar>" is a redirect to "<tvar name=2>Main Page</tvar>"</translate>
| p1=action=query
| p2=titles=Main%20page
| p3=redirects
| p4=format=json
| p5=formatversion=2
| result=<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"redirects": [
{
"from": "Main page",
"to": "Main Page"
}
],
"pages": [
{
"pageid": 15580374,
"ns": 0,
"title": "Main Page"
}
]
}
}
</syntaxhighlight>
}}
{{ApiEx
| desc=<translate> Same request but without the "<tvar name=1>redirects</tvar>" parameter.</translate>
| p1=action=query
| p2=titles=Main%20page
| p3=format=json
| p4=formatversion=2
| result=<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"pages": [
{
"pageid": 217225,
"ns": 0,
"title": "Main page"
}
]
}
}
</syntaxhighlight>
}}
{{ApiEx
| desc=<translate> Without "<tvar name=1>redirects</tvar>" you may want to use <tvar name=2>prop=info</tvar> to obtain redirect status.</translate>
| p1=action=query
| p2=titles=Main%20page
| p3=prop=info
| p4=formatversion=2
| result=<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"pages": [
{
"pageid": 217225,
"ns": 0,
"title": "Main page",
"contentmodel": "wikitext",
"pagelanguage": "en",
"pagelanguagehtmlcode": "en",
"pagelanguagedir": "ltr",
"touched": "2017-12-17T02:02:05Z",
"lastrevid": 777924062,
"length": 170,
"redirect": true
}
]
}
}
</syntaxhighlight>
}}
{{ApiEx
| desc=<translate> Request with a section link.</translate> <translate> "<tvar name=1>Wikipedia:!--</tvar>" is a redirect to "<tvar name=2>Wikipedia:Manual of Style#Invisible comments</tvar>"</translate>
| p1=action=query
| p2=titles=Wikipedia:!--
| p3=redirects
| p4=format=json
| p5=formatversion=2
| result=<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"redirects": [
{
"from": "Wikipedia:!--",
"to": "Wikipedia:Manual of Style",
"tofragment": "Invisible comments"
}
],
"pages": [
{
"pageid": 33697,
"ns": 4,
"title": "Wikipedia:Manual of Style"
}
]
}
}
</syntaxhighlight>
}}
<translate> Here is a case of a circular redirect: <tvar name=1>Page1 → Page2 → Page3 → Page1</tvar>.</translate> <translate> Also, in this example a non-normalized name <tvar name=1>'page1'</tvar> is used.</translate>
|p1=action=query
|p2=titles=page1
|p3=redirects
|p4=format=json
|p5=formatversion=2
|result=<syntaxhighlight lang="json">
{
"batchcomplete": true,
"query": {
"normalized": [
{
"fromencoded": false,
"from": "page1",
"to": "Page1"
}
],
"redirects": [
{
"from": "Page1",
"to": "Page2"
},
{
"from": "Page2",
"to": "Page3"
},
{
"from": "Page3",
"to": "Page1"
}
],
"pages": [
{
"ns": 0,
"title": "Page1",
"missing": true
}
]
}
}
</syntaxhighlight>}}

<translate>

== See also == 
</translate>
* - <translate> The quick start guide.</translate>
* - <translate> Contains information on how to use the <tvar name=1><code>rawcontinue</code></tvar> parameter.</translate>

----
''Sample content adapted from [[mediawikiwiki:API:Query]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

API/Main page

2026-07-25T17:02:13Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

#REDIRECT [[API:Action API]]

----
''Sample content adapted from [[mediawikiwiki:API:Main_page]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Purge

2026-07-25T17:02:13Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />
<translate> '''Purging''' forces MediaWiki to clear the cached version of a given page, forcing the page to be redisplayed from its source or scripts to restart.</translate>
<translate> It is used to ensure that recent changes are made immediately visible.</translate>

<translate> One way to purge a MediaWiki page is to click a page's <tvar name=1></tvar> tab, then in your browser's location field delete just the word <tvar name=2><code>history</code></tvar> off the end of the URL, type <tvar name=3><code>purge</code></tvar> (after the <tvar name=4><code>=</code></tvar>) on the end of the URL, and hit <tvar name=5></tvar>.</translate>
<translate> Your URL should look something like one of the ones below.</translate>

<translate>
==Examples== 


* To purge a page, add <tvar name=purge><code>?action=purge</code></tvar> to the URL of the page you are viewing.</translate> <translate> For example:</translate>

: <code><nowiki>http://example.org/wiki/Main_Page</nowiki>'''?action=purge'''</code>

<translate>

* If the URL has other parameters in its query string, add the purge action to the query string with an ampersand (<tvar name=1>&</tvar>).</translate> <translate> For example:</translate>

: <code><nowiki>http://example.org/wiki/index.php?title=Main_Page</nowiki>'''&action=purge'''</code>

<translate>
== Requests must be confirmed== 
</translate>
<translate> Purge requests made via POST are automatically filled.</translate>
<translate> Users making purge requests via a query string will be presented with a confirmation form.</translate><ref>[[gerrit:304157]]</ref>
<translate> This form must be submitted before the purge request will be completed.</translate>
<translate> This behavior is a precaution to keep web spiders from accidentally purging pages when following links.</translate>

<translate>
==Purge and image thumbnails== 


If purge is run on an image description page, the cached thumbnails for the image will be purged.

==Categories== 
</translate>

<translate>

If purge is run on a category with less than 5000 members, the category will be recounted from scratch (<tvar name=1>[[phab:T85696|T85696]]</tvar>).

==Null edits== 
</translate>

<translate> Purging will only update the rendering of the page, it won't update the link tables.</translate>
<translate> These tables control lists that the page is listed in (for example, pages listed on category pages, <tvar name=1>[[Special:Whatlinkshere]]</tvar>, along with several other <tvar name=2><code>query</code></tvar> special pages).</translate>
<translate> In order to force an update of the link tables, you can do what is called a '''null edit''' (or '''purge edit''').</translate>
<translate> Click on <tvar name=1><code></code></tvar> and save without changing anything.</translate>
<translate> No entry in the page's history will appear, but all link tables and other derived data should be refreshed.</translate>

<translate> An alternative way to update the links table is to use the API's <tvar name=purge></tvar> module with the <tvar name=force><code>forcelinkupdate</code></tvar> option.</translate>
<translate> This however may not update other derived data, such as the search index or resource loader module cache.</translate>

{{Note|1=<translate> This option only applies to the API.</translate> <translate> Adding <tvar name=1><code>forcelinkupdate</code></tvar> to an <tvar name=2><code>index.php</code></tvar> URL has no effect.</translate>}}

'' which are created automatically to represent loggable actions in the page history.</translate> <translate> Dummy revisions are sometimes called "null revisions", but that should be avoided to prevent confusion.</translate>}}

<translate>
==See also== 
</translate>
* - <translate> a command-line [[<tvar name=1>Special:MyLanguage/Manual:Maintenance scripts</tvar>|maintenance script]] that allows batch purging of articles.</translate>
*
*
*
*
* [[gerrit:q/c2ce6a1b,n,z|Require POST in ?action=purge]]
*

<translate>
==References== 
</translate>
<references/>

[[Category:Cache|Cache]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Purge]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Importing XML dumps

2026-07-25T17:02:12Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate> This page describes methods to '''import XML dumps'''.</translate>
<translate> XML Dumps contain the content of a wiki (wiki pages with all their revisions), without the site-related data.</translate>
<translate> A XML dump does not create a full backup of the wiki database, the dump does not contain user accounts, images, edit logs, etc.</translate>

<translate> The <tvar name=1>[[Special:Export]]</tvar> page of any MediaWiki site, including any Wikimedia site and Wikipedia, creates an XML file (content dump).</translate>
<translate> See [[<tvar name=2>m:Special:MyLanguage/Data dumps</tvar>|meta:Data dumps]] and <tvar name=3></tvar>.</translate>
<translate> XML files are explained more on [[<tvar name=4>Special:MyLanguage/Help:Export#Export format</tvar>|Help:Export]].</translate>

<translate>
==How to import?== 


There are several methods for importing these XML dumps.

===Using Special:Import=== 


<tvar name=1>[[Special:Import]]</tvar> can be used by wiki users with <tvar name=2><code>import</code></tvar> permission (by default this is users in the <tvar name=3><code>sysop</code></tvar> group) to import a small number of pages (about 100 should be safe).


''Trying to import large dumps this way may result in timeouts or connection failures''.
</translate>

* <translate> See <tvar name=1></tvar> for a basic description of how the importing process works.</translate><ref><translate> See <tvar name=1></tvar> for a C# code sample that manipulates an XML import file.</translate></ref>

<translate> You are asked to give an interwiki prefix.</translate>
<translate> For instance, if you exported from the English Wikipedia, you have to type 'en'.</translate>
<translate> XML importing requires the <tvar name="1"><code>import</code></tvar> and <tvar name="2"><code>importupload</code></tvar> permissions.</translate>
<translate> See <tvar name=1></tvar>.</translate>

<translate>
=== Large XML uploads === 


Large XML uploads might be rejected because they exceed the PHP upload limit set in the <tvar name="1"><code>php.ini</code></tvar> file.
</translate>

<syntaxhighlight lang="ini">
; <translate nowrap> Maximum allowed size for uploaded files.</translate>
upload_max_filesize = 20M
</syntaxhighlight>
<translate>

Try changing these four settings in <tvar name="1"><code>php.ini</code></tvar>:
</translate>
<syntaxhighlight lang="ini">
; <translate nowrap> Maximum size of POST data that PHP will accept.</translate>
post_max_size = 20M

max_execution_time = 1000 ; <translate nowrap> Maximum execution time of each script, in seconds</translate>
max_input_time = 2000 ; <translate nowrap> Maximum amount of time each script may spend parsing request data</translate>

; <translate nowrap> Default timeout for socket based streams (seconds)</translate>
default_socket_timeout = 2000
</syntaxhighlight>

<translate>
===Using <tvar name=1>importDump.php</tvar>, if you have shell access=== 
</translate>
:<translate> ''Recommended method for general use, but slow for very big data sets.''</translate>
: <translate> ''See: <tvar name=1></tvar>, including tips on how to use it for large wikis.''</translate>

<translate>
===Using <tvar name=1>importTextFiles.php</tvar> maintenance Script=== 
</translate>

<translate> If you have a lot of content converted from another source (several word processor files, content from another wiki, etc), you may have several files that you would like to import into your wiki.</translate>
<translate> In MediaWiki 1.27 and later, you can use the <tvar name=2></tvar> maintenance script.</translate>

<translate>

You can also use the <tvar name=2></tvar> maintenance script for this purpose.
</translate>

===rebuildall.php===
<translate> For large XML dumps, you can run <tvar name=1><code>[[Special:MyLanguage/Manual:rebuildall.php|rebuildall.php]]</code></tvar>, but, it will take a ''long'' time, because it has to parse all pages.</translate>
<translate> This is not recommended for large data sets.</translate>

<translate>
=== Using pywikibot, <tvar name=1>pagefromfile.py</tvar> and Nokogiri === 
</translate>
<translate> <tvar name=1></tvar> is a collection of tools written in python that automate work on Wikipedia or other MediaWiki sites.</translate>
<translate> Once installed on your computer, you can use the specific tool <tvar name=3></tvar> which lets you upload a wiki file on Wikipedia or MediaWiki sites.</translate>
<translate> The xml file created by <tvar name=1>dumpBackup.php</tvar> can be transformed into a wiki file suitable to be processed by <tvar name=2>pagefromfile.py</tvar> using a simple script similar to the following (here the program will transform all xml files which are on the current directory which is needed if your MediaWiki site is a family):</translate>

<translate>
==== On Python ==== 
</translate>
<syntaxhighlight lang="python">
from pathlib import Path
from lxml import etree
import re
from pywikibot import Link, Site

""" The exported XML preserves local namespace names. To import into a project in another language,
you need to convert them to canonical names. Otherwise the pages will be imported as originals
without recognizing their namespace.
XML contains namespace numbers, but mapping them can be problematic. Because they can differ between projects.
For example, in ru.wikisource NS Page is number 104, while in uk.wikisource it is 252.
To solve these, the Link() class from pywikibot is used.

The Link() required the language code and family of project. XML does not contain these as separate
values. Instead, they are in another format, like `enwikisource` or 'commonswiki', which needs to be parsed.
"""

xml_folder = 'PATH_TO_XML_DUMP'
for xml_file in Path(xml_folder).glob('*.xml'):
root = etree.parse(xml_file).getroot()
ns = {'': root.nsmap[None]} # xml namespace

# Parsing language code and family of the project
dbname = root.find('.//siteinfo/dbname', ns).text
m = re.search(r'^(\w+?)(wiki|wikisource|wikiquote|wikinews|wikibooks)$', dbname)
if m:
site = Site(code=m.group(1), fam=m.group(2))
elif 'commons' in dbname:
site = Site('commons')
elif 'mediawikiwiki' in dbname:
site = Site('mediawiki')
else:
print("Site didn't recognized.")
break

wiki = []
for page in root.findall('.//page', ns):
title_source = page.find('title', ns).text
title = Link(title_source, site).ns_title().replace(' ', '_')
revision_id = page.find('.//revision/id', ns).text
print(f'{title}, revision id: {revision_id}')
text = page.find('.//revision/text', ns).text
wiki.append("\n'''%s'''\n%s\n" % (title, text))
Path(f'out_{xml_file.stem}.wiki').write_text('\n'.join(wiki))
</syntaxhighlight>

<translate>
==== On Ruby ==== 
</translate>

<syntaxhighlight lang="ruby">
# -*- coding: utf-8 -*-
# dumpxml2wiki.rb

require 'rubygems'
require 'nokogiri'

# <translate nowrap> This program <tvar name=1>dumpxml2wiki</tvar> reads MediaWiki xml files dumped by <tvar name=2>dumpBackup.php</tvar> on the current directory and transforms them into wiki files which can then be modified and uploaded again by <tvar name=3>pywikipediabot</tvar> using <tvar name=4>pagefromfile.py</tvar> on a MediaWiki family site.</translate>
# <translate nowrap> The text of each page is searched with xpath and its title is added on the first line as an html comment: this is required by <tvar name=1>pagefromfile.py</tvar>.</translate>
#
Dir.glob("*.xml").each do |filename|
input = Nokogiri::XML(File.new(filename), nil, 'UTF-8')

puts filename.to_s # prints the name of each .xml file

File.open("out_" + filename + ".wiki", 'w') {|f|
input.xpath("//xmlns:text").each {|n|
pptitle = n.parent.parent.at_css "title" # searching for the title
title = pptitle.content
f.puts "\n" << n.content << "\n"
}
}
end
</syntaxhighlight>

<translate>

For example, here is an excerpt of a wiki file output by the command 'ruby dumpxml2wiki.rb' (two pages can then be uploaded by pagefromfile.py, a Template and a second page which is a redirect):
</translate>

<syntaxhighlight lang="html4strict">
<includeonly>Tłumaczenie</includeonly>

#REDIRECT[[badania demograficzne]]
<noinclude>
[[Category:Termin wielojęzycznego słownika demograficznego (pierwsze wydanie)|ilościowa demografia]]
[[Category:Termin wielojęzycznego słownika demograficznego (pierwsze wydanie) (redirect)]]
[[Category:10]]</noinclude>

</syntaxhighlight>

<translate> The program accesses each xml file, extracts the texts within <tvar name=1><nowiki><text> </text></nowiki></tvar> markups of each page, searches the corresponding title as a parent and enclosed it with the paired <nowiki> </nowiki> commands used by 'pagefromfile' to create or update a page.</translate>
<translate> The name of the page is in an html comment and separated by three quotes on the same first start line.</translate>
<translate> Please notice that the name of the page can be written in Unicode.</translate>
<translate> Sometimes it is important that the page starts directly with the command, like for a <tvar name=2><nowiki>#REDIRECT</nowiki></tvar>; thus the comment giving the name of the page must be ''after'' the command but still on the first line.</translate>

<translate>

Please remark that the xml dump files produced by <tvar name=1>dumpBackup.php</tvar> are prefixed by a namespace:
</translate>

<syntaxhighlight lang="html4strict"><mediawiki xmlns="http://www.mediawiki.org/xml/export-0.4/"></syntaxhighlight>

<translate>

In order to access the text node using Nokogiri, you need to prefix your path with 'xmlns':
</translate>

<syntaxhighlight lang="html4strict">input.xpath("//xmlns:text")</syntaxhighlight>

<translate>

Nokogiri is an HTML, XML, SAX, & Reader parser with the ability to search documents via XPath or CSS3 selectors from the last generation of XML parsers using Ruby.


Example of the use of 'pagefromfile' to upload the output wiki text file:
</translate>

<syntaxhighlight lang="bash">
python pagefromfile.py -file:out_filename.wiki -summary:"Reason for changes" -lang:pl -putthrottle:01
</syntaxhighlight>

<translate>

=== How to import logs? === 


Exporting and importing logs with the standard MediaWiki scripts often proves very hard; an alternative for import is the script <tvar name=1><code>pages_logging.py</code></tvar> in the [<tvar name=2>https://github.com/glimmerphoenix/WikiDAT</tvar> WikiDAT tool], as [[<tvar name=3>mailarchive:xmldatadumps-l/2013-July/000876.html</tvar>|suggested by Felipe Ortega]].

== Troubleshooting == 

=== Merging histories, revision conflict, edit summaries, and other complications === 
</translate>
<translate> When importing a page with history information, if the user name already exists in the target project, change the user name in the XML file to avoid confusion.</translate>
<translate> If the user name is new to the target project, the contributions will still be available, but no account will be created automatically.</translate>

<translate> When a page is referenced through a link or a URL, generic namespace names are converted automatically.</translate>
<translate> If the prefix is not a recognized namespace name, the page will default to the main namespace.</translate>
<translate> However, prefixes like <tvar name=1><code>mw:</code></tvar> might be ignored on projects that use them for interwiki linking.</translate>
<translate> In such cases, it might be beneficial to change the prefix to "Project:" in the XML file before importing.</translate>

<translate> If a page with the same name already exists, importing revisions will combine their histories.</translate>
<translate> Adding a revision between two existing ones can make the next user's changes appear different.</translate>
<translate> To see the actual change, compare the two original revisions, not the inserted one.</translate>
<translate> So, only insert revisions to properly rebuild the page history.</translate>

<translate> A revision won't be imported if there's already a revision with the same date and time.</translate>
<translate> This usually happens if it's been imported before, either to the current, a previous wiki, or both, possibly from a third site.</translate>

<translate> An edit summary might reference or link to another page, which can be confusing if the page being linked to has not been imported, even though the referencing page has been.</translate>

<translate> The edit summary doesn't automatically indicate whether the page has been imported, but in the case of an upload import, you can add this information to the edit summaries in the XML file before the import.</translate>
<translate> This can help prevent confusion. When modifying the XML file with find/replace, keep in mind that adding text to the edit summaries requires differentiating between edits with and without an edit summary.</translate>
<translate> If there are multiple comment tags in the XML file, only the last set will be applied.</translate>

<translate>
=== Interwikis === 
</translate>
</tvar> linking.</translate>
|1=
}}
<translate> For example, ones with a prefix of 'Meta:' would conflict with the interwiki prefix <tvar name=2><code>meta:</code></tvar> which by default links to <tvar name=3><nowiki>https://meta.wikimedia.org</nowiki></tvar>.</translate>

<translate>

You can do any of the following.
</translate>

*<translate> Remove the prefix from the <tvar name=2></tvar> table.</translate> <translate> This will preserve page titles, but prevent interwiki linking through that prefix.</translate>
*:<translate> Example: you will preserve page titles 'Meta:Blah blah' but will not be able to use the prefix 'meta:' to link to meta.wikimedia.org (although it will be possible through a different prefix).</translate>
*:<translate> How to do it: before importing the dump, run the query <tvar name=1><code>DELETE FROM interwiki WHERE iw_prefix='prefix'</code></tvar> (note: do not include the colon in the <code>prefix</code>).</translate> <translate> Alternatively, if you have [[<tvar name=2>Special:MyLanguage/Manual:Guide to setting up interwiki linking</tvar>|enabled editing the interwiki table]], you can simply go to <tvar name=3>[[Special:Interwiki]]</tvar> and click the 'Delete' link on the right side of the row belonging to that prefix.</translate>
*<translate> Replace the unwanted prefix in the XML file with "Project:" before importing. This will preserve the functionality of the prefix as an interlink, but will replace the prefix in the page titles with the name of the wiki where they're imported into, and might be quite a pain to do on large dumps.</translate>
*:<translate> Example: replace all 'Meta:' with 'Project:' in the XML file. MediaWiki will then replace 'Project:' with the name of your wiki during importing.</translate>

<translate>
==See also== 
</translate>
*
* [[meta:Special:MyLanguage/Data dumps/Other tools|meta:Data dumps/Other tools]]
*
* – <translate> May come in handy if you are doing massive imports</translate>
* – <translate> Settings that may need to be changed if you are doing massive imports</translate>
* – <translate> for importing images.</translate>
*
*

<translate>
==References== 
</translate>
<references/>

[[Category:Import/Export|Import/Export]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Importing_XML_dumps]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Job queue

2026-07-25T17:02:12Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>
<translate> The '''job queue''' is designed to hold many short tasks using [[w:batch processing|batch processing]].</translate>
It is commonly used to perform long-running tasks asynchronously, although a synchronous mode is available, too.

<translate>
== Set up == 
</translate>
<translate> It is recommended that you schedule the running of jobs completely in the background, via the command line.</translate>
If you do not have access to the command line but your hosting plan comes with a web control panel, it may well include a cronjob scheduler.

<translate> By default, jobs are run at the end of a web request. Disable this default behaviour by setting <tvar name=1></tvar> to <tvar name=2><code>0</code></tvar>.</translate>

{{note|1=<translate> You should run <tvar name=1><code>runJobs.php</code></tvar> as the same user as the web server runs as, to ensure that permissions to the filesystem are correctly accounted for if jobs touch uploaded files.</translate>}}

<translate>
=== Cron === 


You could use [[w:Cron|cron]] to run the jobs every hour. For instance, add the following to your crontab file:
</translate>

<syntaxhighlight lang="bash">
0 * * * * /usr/bin/php /var/www/wiki/maintenance/runJobs.php --maxtime=3600 > /var/log/runJobs.log 2>&1
</syntaxhighlight>

<translate>

Using Cron makes it easy to get started, but can make email notifications and cascading template feel slow (to wait up to an hour). Consider using one of the below approaches to set up a continuous job runner instead.

=== Continuous service === 


If you have shell access and the possibility to create init scripts, you can create a simple service to run jobs as they become available, and also throttle them to prevent the job runner from monopolising the CPU resources of the server:


Create a bash script, for example at <tvar name=1><code>/usr/local/bin/mwjobrunner</code></tvar>:

==== Create script ==== 
</translate>
<syntaxhighlight lang="bash">
#!/bin/bash
# <translate nowrap> Put the MediaWiki installation path on the line below</translate>
MW_INSTALL_PATH="/home/www/www.mywikisite.example/mediawiki"
RUN_JOBS="$MW_INSTALL_PATH/maintenance/runJobs.php --maxtime=3600"
echo <translate nowrap> Starting job service...</translate>
# <translate nowrap> Wait a minute after the server starts up to give other processes time to get started</translate>
sleep 60
echo <translate nowrap> Started.</translate>
while true; do
# <translate nowrap> Job types that need to be run ASAP no matter how many of them are in the queue</translate>
# <translate nowrap> Those jobs should be very "cheap" to run</translate>
php $RUN_JOBS --type="enotifNotify"
# <translate nowrap> Everything else, limit the number of jobs on each batch</translate>
# <translate nowrap> The <tvar name=1>--wait</tvar> parameter will pause the execution here until new jobs are added, to avoid running the loop without anything to do</translate>
php $RUN_JOBS --wait --maxjobs=20
# <translate nowrap> Wait some seconds to let the CPU do other things, like handling web requests, etc</translate>
echo <translate nowrap> Waiting for 10 seconds...</translate>
sleep 10
done
</syntaxhighlight>

<translate>

Depending on how fast the server is and the load it handles, you can adapt the number of jobs to run on each cycle and the number of seconds to wait on each cycle.


Make the script executable (<tvar name=1><code>chmod 755</code></tvar>).

==== Create service ==== 
</translate>
<translate> If using systemd, create a new service unit by creating the file <tvar name=1><code>/etc/systemd/system/mw-jobqueue.service</code></tvar>.</translate>
<translate> Change the <tvar name=1><code>User</code></tvar> parameter to the user that runs PHP on your web server:</translate>

<syntaxhighlight lang="ini">
[Unit]
Description=MediaWiki Job runner

[Service]
ExecStart=/usr/local/bin/mwjobrunner
Nice=10
ProtectSystem=full
User=php-fpm
OOMScoreAdjust=200
StandardOutput=journal

[Install]
WantedBy=multi-user.target
</syntaxhighlight>

<translate> Enable it and start it with those commands:</translate>

<syntaxhighlight lang="bash">
sudo systemctl enable mw-jobqueue
sudo systemctl start mw-jobqueue
sudo systemctl status mw-jobqueue
</syntaxhighlight>

<translate>
== Job execution on page requests == 
</translate>
<translate> By default, at the end of each web request, one job is taken from the job queue and executed.</translate>
<translate> This behaviour is controlled by the <tvar name=JobRunRate></tvar> configuration variable.</translate>
<translate> Setting this variable to <tvar name=1><code>1</code></tvar>, will run a job on each request.</translate>
<translate> Setting this variable to <tvar name=1><code>0</code></tvar> will disable the execution of jobs during web requests completely, so that you can instead run <tvar name=runJobs></tvar> manually or periodically from the command line.</translate>

<translate> When enabled, jobs will be executed by opening a socket and making an internal HTTP request to an unlisted [[<tvar name=man>Special:MyLanguage/Manual:Special pages</tvar>|special page]]: <tvar name=1>Special:RunJobs</tvar>.</translate>
<translate> See also the [[<tvar name=1>#Asynchronous</tvar>|asynchronous section]].</translate>

<translate>
=== Performance issue === 
</translate>
<translate> If the performance burden of running jobs on every web request is too great but you are unable to run jobs from the command line, you can reduce <tvar name=JobRunRate></tvar> to a number between <tvar name=1><code>1</code></tvar> and <tvar name=2><code>0</code></tvar>.</translate>
<translate> This means a job will execute ''on average'' every <tvar name=code><code>1 / $wgJobRunRate</code></tvar> requests.</translate>

<syntaxhighlight lang="php">
$wgJobRunRate = 0.01;
</syntaxhighlight>

<translate>
=== Manual usage === 
</translate>
<translate> There is also a way to empty the job queue manually, for example after changing a template that's present on many pages.</translate>
<translate> Simply run the <tvar name=RunJobs><code></code></tvar> maintenance script.</translate>
<translate> For example:</translate>

<syntaxhighlight lang="bash">
/path-to-my-wiki/maintenance$ php ./runJobs.php
</syntaxhighlight>

<translate>
== Abandoned jobs == 


A job can fail for some reasons. To understand why, you have to inspect the related log file.


In any case, if a job fails <tvar name=1>3</tvar> times (so if the system has done that number of attempts), the job is then considered "abandoned" and it's not executed again.


Relevant source code:
</translate>

https://doc.wikimedia.org/mediawiki-core/master/php/JobQueue_8php_source.html#l00085

<translate>

An abandoned job is:
</translate>

* <translate> not executed anymore from <tvar name=1></tvar></translate>
* <translate> not counted from <tvar name=1></tvar></translate>
* <translate> not automatically removed from the database</translate>
* <translate> but are included in the count of <tvar name=2>[[#Statistics|the statistics API module]]</tvar></translate>

<translate>
== Job examples == 

=== Updating links tables when a template changes === 
</translate>
<translate> When a template changes, MediaWiki adds a job to the job queue for each article transcluding that template.</translate>
<translate> Each job is a command to read an article, expand any templates, and update the link table accordingly.</translate>
<translate> Previously, the host articles would remain outdated until either their parser cache expires or until a user edits the article.</translate>

<translate>
=== HTML cache invalidation === 


A wider class of operations can result in invalidation of the HTML cache for a large number of pages:


*Changing an image (all the thumbnails have to be re-rendered, and their sizes recalculated)</translate>
<translate>

*Deleting a page (all the links to it from other pages need to change from blue to red)</translate>
<translate>

*Creating or undeleting a page (like above, but from red to blue)</translate>
<translate>

*Changing a template (all the pages that transclude the template need updating)
</translate>

<translate> Except for template changes, these operations do not invalidate the links tables, but they do invalidate the HTML cache of all pages linking to that page, or using that image.</translate>
<translate> Invalidating the cache of a page is a short operation; it only requires updating a single database field and sending a multicast packet to clear the caches.</translate>
<translate> But if there are more than about 1000 to do, it takes a long time. By default, one job is added per '''300''' operations (see <tvar name=1></tvar>)</translate>

<translate> Note, however, that even if purging the cache of a page is a short operation, reparsing a complex page that is not in the cache may be expensive, especially if a highly used template is edited and causes lots of pages to be purged in a short period of time and your wiki has lots of concurrent visitors loading a wide spread of pages.</translate>
<translate> This can be mitigated by reducing the number of pages purged in a short period of time, by reducing <tvar name=1></tvar> to a small number (20, for example) and also set <tvar name=2></tvar> for <tvar name=3><code>htmlCacheUpdate</code></tvar> to a low number (5, for example).</translate>

<translate>
=== Audio and video transcoding === 


When using <tvar name=1></tvar> to process local uploads of audio and video files, the job queue is used to run the potentially very slow creation of derivative transcodes at various resolutions/formats.


These are '''not suitable''' for running on web requests -- you will need a background runner.


It's recommended to set up separate runners for the <tvar name=1><code>webVideoTranscode</code></tvar> and <tvar name=2><code>webVideoTranscodePrioritized</code></tvar> job types if possible. These two queues process different subsets of files -- the first for high resolution HD videos, and the second for lower-resolution videos and audio files which process more quickly.

== Typical values == 
</translate>
<translate> During a period of low load, the job queue might be zero.</translate>
<translate> At Wikimedia, the job queue is, in practice, almost never zero.</translate>
<translate> In off-peak hours, it might be a few hundred to a thousand.</translate>
<translate> During a busy day, it might be a few million, but it can quickly fluctuate by 10% or more.</translate>
<sup>[https://brionv.com/log/2008/04/22/so-whats-in-the-job-queue-anyway/]</sup>

<translate>
== Statistics == 


The value of the job queue can be retrieved from <tvar name=1></tvar>:
</translate>

<translate> The number of jobs returned in the API result may be slightly inaccurate when using MySQL, which estimates the number of jobs in the database.</translate>
<translate> This number can fluctuate based on the number of jobs that have recently been added or deleted.</translate>
<translate> For other databases that do not support fast result-size estimation, the actual number of jobs is given.</translate>

<translate>
== For developers and maintainers == 
</translate>
*

<translate>
=== Code stewardship === 
</translate>

<translate>
== History == 

=== Asynchronous === 


The configuration variable <tvar name=RunJobsAsync></tvar> has been added to force the execution of jobs synchronously, in scenarios where making an internal HTTP request for job execution is not wanted.
</translate>

<translate> When running jobs asynchronously, it will open an internal HTTP connection for handling the execution of jobs, and will return the contents of the page immediately to the client without waiting for the job to complete.</translate>
<translate> Otherwise, the job will be executed in the same process and the client will have to wait until the job is completed.</translate>
<translate> When the job does not run asynchronously, if a fatal error occurs during job execution, it will propagate to the client, aborting the load of the page.</translate>

<translate> Note that even if $wgRunJobsAsync is set to true, if PHP can't open a socket to make the internal HTTP request, it will fall back to the synchronous job execution.</translate>
<translate> However, there are a variety of situations where this internal request may fail, and jobs won't be run, without falling back to the synchronous job execution.</translate>
<translate> Starting with MediaWiki 1.28.1 and 1.27.2, $wgRunJobsAsync now defaults to false.</translate>

<translate>
=== Deferred updates === 
</translate>
<translate> The ''deferred updates'' mechanism allows the execution of code to be scheduled for the end of the request, after all content has been sent to the browser.</translate>
<translate> This is similar to queuing a job, except that it runs immediately instead of upto several minutes/hours in the future.</translate>

<translate> <tvar name=1><code>DeferredUpdates</code></tvar> was introduced in MediaWiki 1.23 and received major changes during MediaWiki 1.27 and 1.28.</translate>
<translate> The goal of this mechanism is speed up the web responses by doing less work, as well as to prioritise some work that would previously be a job to run as soon as possible after the end of the response.</translate>

<translate> A deferrable update can implement <tvar name=1><code>EnqueueableDataUpdate</code></tvar> in order to be queueable as a Job as well.</translate>
<translate> This is used by <tvar name=1><code>RefreshSecondaryDataUpdate</code></tvar> in core, for example, which means if the update fails for any reason, MediaWiki will fallback to queuing as a job and try again later as to fulfil the contract in question.</translate>

<translate>
=== Changes in MediaWiki 1.22 === 
</translate>
<translate> In <tvar name=mw></tvar>, the job queue execution on each page request was changed (<tvar name=gerrit></tvar>) so, instead of executing the job inside the same PHP process that's rendering the page, a new PHP CLI command is spawned to execute <tvar name=runJobs></tvar> in the background.</translate>
<translate> It will only work if <tvar name=PhpCli></tvar> is set to an actual path or safe mode is off, otherwise, the old method will be used.</translate>

<translate>

This new execution method could cause some problems:


* If <tvar name=PhpCli></tvar> is set to an incompatible version of PHP (e.g.: an outdated version) jobs may fail to run (fixed in 1.23).</translate>
<translate>

* PHP <tvar name=1><code>open_basedir</code></tvar> restrictions are in effect, and <tvar name=PhpCli></tvar> is disallowed (<tvar name=task></tvar>, fixed in 1.23).</translate>
<translate>

* Performance: even if the job queue is empty, the new PHP process is started anyway (<tvar name=task></tvar>, fixed in 1.23).</translate>
<translate>

* Sometimes the spawning PHP process cause the server or only the CLI process to hang due to <tvar name=1>stdout</tvar> and <tvar name=2>stderr</tvar> descriptors not properly redirected (<tvar name=task></tvar>, fixed in 1.22)</translate>
<translate>

* It does not work for shared code (wiki farms), because it doesn't pass additional required parameters to <tvar name=1>runJobs.php</tvar> to identify the wiki that's running the job (<tvar name=task></tvar>, fixed in 1.23)</translate>
<translate>

* Normal shell limits like <tvar name=1>, , </tvar> are enforced on the <tvar name=2>runJobs.php</tvar> process that's being executed in the background.
</translate>

<translate> There's no way to revert to the old on-request job queue handling, besides setting <tvar name=PhpCli></tvar> to <tvar name=1><code>false</code></tvar>, for example, which may cause other problems (<tvar name=task></tvar>).</translate>
<translate> It can be disabled completely by setting <tvar name=code> 0;}}</tvar>, but jobs will no longer run on page requests, and you must explicitly run <tvar name=1>runJobs.php</tvar> to periodically run pending jobs.</translate>

<translate>
=== Changes in MediaWiki 1.23 === 


In MediaWiki 1.23, the 1.22 execution method is abandoned, and jobs are triggered by MediaWiki making an HTTP connection to itself.


It was first designed as an [[<tvar name=man>Special:MyLanguage/Manual:API</tvar>|API]] entry point (<tvar name=gerrit1></tvar>) but later changed to be the unlisted special page <tvar name=1>[[Special:RunJobs]]</tvar> (<tvar name=gerrit2></tvar>).


While it solves various bugs introduced in 1.22, it still requires loading a lot of PHP classes in memory on a new process to execute a job, and also makes a new HTTP request that the server must handle.

=== Changes in MediaWiki 1.27 === 


In MediaWiki 1.25 and MediaWiki 1.26, use of <tvar name=1></tvar> would sometimes cause jobs not to get run if the wiki has custom <tvar name=2></tvar> configuration. This was fixed in MediaWiki 1.27.
</translate>

<translate>
=== Changes in MediaWiki 1.28 === 


Between MediaWiki 1.23 and MediaWiki 1.27, use of <tvar name=1></tvar> would cause jobs not to get run on if MediaWiki requests are for a server name or protocol that does not match the currently configured server name one (e.g. when supporting both HTTP and HTTPS, or when MediaWiki is behind a reverse proxy that redirects to HTTPS). This was fixed in MediaWiki 1.28.
</translate>

<translate>
=== Changes in MediaWiki 1.29 === 


In MediaWiki 1.27.0 to 1.27.3 and 1.28.0 to 1.28.2, when <tvar name=1></tvar> is set to a value greater than 0, an error like the one below may appear in error logs, or on the page:
</translate>

<pre>
PHP Notice: JobQueueGroup::__destruct: 1 buffered job(s) never inserted
</pre>

<translate> As a result of this error, certain updates may fail in some cases, like category members not being updated on category pages, or recent changes displaying edits of deleted pages - even if you manually run <tvar name=runJobs></tvar> to clear the job queue.</translate>
<translate> It has been reported as a bug (<tvar name=bug></tvar>) and was solved in 1.27.4 and 1.28.3.</translate>

=== Changes in MediaWiki 1.17 ===
<translate> Up to MediaWiki 1.16, the job queue value was shown on <tvar name=1>[[Special:Statistics]]</tvar>.</translate>
<translate> Since 1.17 (<tvar name=rev>[[rev:75272]]</tvar>) it's been removed, and can be seen now with <tvar name=api></tvar>:</translate>

=== MediaWiki 1.6 ===
<translate>

In 2009 ([[<tvar name=1>Special:MyLanguage/Release notes/1.6</tvar>|MediaWiki 1.6]]) the '''job queue''' was introduced to perform long-running tasks asynchronously.

== See also == 
</translate>
*
*
*
*
*

[[Category:Job queue| ]]
[[Category:Installation]]
[[Category:MediaWiki concepts]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Job_queue]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Extensions

2026-07-25T17:02:11Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate>

An '''extension''' lets you customise how MediaWiki looks and works.
</translate>

* <translate> System administrators can [[<tvar name=1>#Installing an extension</tvar>|install]] (or remove) extensions on the MediaWiki installations that they manage.</translate>
* <translate> Developers can [[<tvar name=1>#Developing extensions</tvar>|write new extensions]] or contribute to existing extensions.</translate>

{{Note|inline=0|type=info
|1=<translate> While some extensions are maintained by MediaWiki developers, others are developed by third parties and may be unmaintained.</translate> <translate> As a result, many extensions may contain bugs—including, in some cases, security vulnerabilities.</translate> <translate> Not all extensions are compatible with every version of MediaWiki, and they may not function reliably when used together.</translate>

<translate> Use extensions at your own risk, particularly those tagged as insecure.</translate> <translate> If an extension requires patches to the core software, make sure to back up your database beforehand to minimize the risk of breaking your wiki.</translate>
}}

<translate>
== Selecting extensions == 

=== Bundled extensions === 


Several extensions are as standard.
</translate>

<translate> These extensions should generally be of high utility, perform efficiently, be stable, be well-written, and have no known major security issues.</translate>
<translate> They should also be compatible with the latest versions of MediaWiki, and with each other (i.e. one extension shouldn't block the functions of another).</translate>
<translate> A bundled extension may have a dependency on one or more other extensions, as long as those are also bundled.</translate>

<translate> Site admins get these automatically when installing or upgrading MediaWiki.</translate>
<translate> When upgrading MediaWiki, any extension upgrades will be automatically applied as well.</translate>
<translate> Site admins may choose to uninstall any of these, if they wish.</translate>

<translate> There are open, ongoing discussions about which extensions should be part of this group.</translate>
<translate> You can .</translate>
<translate> Extensions will be bundled once the developers reach a consensus to do so.</translate>

<translate>

An extension may be removed from bundling if its functionality is merged into , it is replaced by an alternative, or in the unlikely event of any unsolvable major security vulnerabilities being discovered.

=== Browsing extensions === 


Browse <tvar name=1></tvar>, or <tvar name=2></tvar> to see the full range of extensions that are available.

=== Checking installed extensions === 
</translate>
<translate> Which extensions are active on an instance of MediaWiki can be checked by accessing the <tvar name=1>[[Special:Version]]</tvar> page, and scrolling down to the heading ''Installed extensions'' (anchor <tvar name=2><code>#mw-version-ext</code></tvar>).</translate>
<translate> For example, [[<tvar name=1>Special:Version#mw-version-ext</tvar>|these extensions]] are installed on this wiki, and [[<tvar name=2>W:Special:Version#mw-version-ext</tvar>|these extensions]] are active in the English Wikipedia.</translate>

<translate>
=== Popular extensions === 
</translate>
<translate> <tvar name="1"></tvar> counts wikis that extensions are installed on.</translate>
<translate> This represents actual installations and not just downloads (i.e. it queries the wiki's APIs), but it is also (as of 2023) not completely up-to-date.</translate>
<translate> It also doesn't count installations on private wikis.</translate>

<translate>
== Installing an extension == 
</translate>
: ''<translate> For further guidance, see also <tvar name=1></tvar></translate>''

<translate> MediaWiki is ready to accept extensions just after [[<tvar name=man>Special:MyLanguage/Manual:Installation</tvar>|installation]] is finished.</translate>
<translate> To add an extension follow these steps:</translate>

# '''<translate> Before you start</translate>'''
#: <translate> Many extensions provide instructions designed for installation using Unix commands.</translate> <translate> You require shell access (SSH) to enter these commands listed on the extension help pages.</translate>
# '''<translate> Download your extension</translate>'''
#: <translate> [[<tvar name=special>Special:ExtensionDistributor</tvar>|Extension Distributor]] helps you to select and download most of the popular extensions.</translate>
#: <translate> Extensions are usually distributed as modular packages.</translate> <translate> They generally go in their own subdirectory of <tvar name=IP><code>/extensions/</code></tvar>.</translate> <translate> A list of extensions stored in the Wikimedia [[<tvar name=gerrit>Special:MyLanguage/Gerrit</tvar>|Git repository]] is located at <tvar name=extensions>[[phab:diffusion/MEXT/browse/master/|git:mediawiki/extensions]]</tvar>.</translate> <translate> Some extensions [[<tvar name=cat>Special:MyLanguage/Category:Extensions which host their code in-wiki</tvar>|don't use version control]] and are not recommended.</translate>
#: <translate> Some extensions are also available in [[<tvar name=1>Special:MyLanguage/Software bundles</tvar>|bundles]], <tvar name=composer></tvar> or [[<tvar name=2>Special:MyLanguage/Comparison of extensions in distributions</tvar>|package repositories]].</translate>
#: <translate> It's recommended to read the <tvar name=1>README</tvar> file before installation.</translate> <translate> It usually contains important info about configuration.</translate>
# '''<translate> Install your extension</translate>'''
#: <translate> At the end of the <tvar name=LocalSettings><code></code></tvar> file, add:</translate>
#: <syntaxhighlight lang="php">
wfLoadExtension( 'ExtensionName' );
</syntaxhighlight>
#: <translate> This line forces the PHP interpreter to read the extension file, and thereby make it accessible to MediaWiki.</translate>
#: <translate> Some extensions can conflict with maintenance scripts, for example if they directly access <tvar name=1><code>$_SERVER</code></tvar> (not recommended).</translate> <translate> In this case, they can be wrapped in the conditional so maintenance scripts can still run.</translate>
#: <syntaxhighlight lang="php">
if ( !$wgCommandLineMode ) {
wfLoadExtension ( 'ExtensionName' );
}
</syntaxhighlight>
#: <translate> The maintenance script <tvar name=ImportDump></tvar> will fail for any extension which requires customised namespaces which is ''included'' inside the conditional above such as <tvar name=1></tvar>, <tvar name=2></tvar>.</translate>

:
: {{Note|1=<translate> While this installation procedure is sufficient for most extensions, some require a different installation procedure.</translate> <translate> Check your extension's documentation for details.</translate>}}
: {{Note|1=<translate> If you want to alter configuration variables in <tvar name=1><code>LocalSettings.php</code></tvar>, you have to do this typically '''after''' including the extension.</translate> <translate> Otherwise defaults defined in the extension will overwrite your settings.</translate>}}

<translate>
=== Upgrading an extension === 
</translate>
<translate> Some extensions require to be updated whenever you update MediaWiki, while others work with multiple versions.</translate>
<translate> To upgrade to a new version of an extension:</translate>

# <translate> Download the new version of the extension</translate>
# <translate> Replace all the extension files in the <tvar name=1><code>extensions/ExtensionName</code></tvar> directory with the new files.</translate> <translate> Do not remove the extension configuration present in <tvar name=1><code>LocalSettings.php</code></tvar></translate>
# <translate> If the extension requires changes to the MediaWiki database, you will need to run the <tvar name=1></tvar> maintenance script.</translate> <translate> Most extensions will mention if this script needs to be run or not.</translate> <translate> (Perform backup of your data before executing the script).</translate> <translate> If you don't have command line access, you can also use the [[<tvar name=man>Special:MyLanguage/Manual:Upgrading#Web_updater</tvar>|web updater]].</translate>

{{Note|1=<translate> These instructions cover 99% of extensions.</translate> <translate> If the specific extension you are upgrading has instructions that differ from these, you should probably follow the specific extension's instructions</translate>}}

<translate>
=== Uninstalling an extension === 


Remove the line from <tvar name=1><code>LocalSettings.php</code></tvar> with the extension name to uninstall it:
</translate>

<syntaxhighlight lang="php">
wfLoadExtension( 'ExtensionName' );
</syntaxhighlight>

<translate>

* You must also remove any lines pertaining to the configuration of the extension.

== Developing extensions == 
</translate>
<translate> MediaWiki core provides several ways for extensions to change the behavior and appearance of a wiki.</translate>
<translate> Various give extensions flexibility to add features and functionality, such as displaying a special page or defining an API module.</translate>
<translate> To get started, see the .</translate>
<translate> Before writing a new extension, consider contributing to an or helping with an .</translate>

<translate> Users can also make a general request on Phabricator, and hope that your good idea is picked up by a developer.</translate>
<translate> See <tvar name=1>https://phabricator.wikimedia.org/tag/mediawiki-extension-requests/</tvar></translate>

<translate>
== See also == 
</translate>

*
*
*
* – <translate> Information about translating extensions.</translate>
* [[Special:ExtensionDistributor]] – <translate> Includes a list of the 15 most downloaded extensions in Wikimedia version control</translate>
* [https://extloc.toolforge.org/ extloc] – <translate> Where are MediaWiki extensions deployed in Wikimedia production?</translate>
* [[API:Siteinfo#Extensions]]
*
*
*
*

[[Category:Customization techniques|Customization techniques]]
[[Category:Extension creation]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Extensions]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/User rights

2026-07-25T17:02:11Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>
<translate> '''User rights''' are permissions (such as the ability to edit pages or to block users) that can be assigned to different '''user groups'''.</translate>
<translate> MediaWiki ships with a default set of user rights and user groups, but these can be customized.</translate>
<translate> This page explains the default rights and groups, and how to customize them.</translate>

<translate>

For information about how to add and remove individual wiki users from groups, see <tvar name=1></tvar> and <tvar name=2></tvar>.

== Changing group permissions == 
</translate>
<translate> A default MediaWiki installation assigns certain rights to default groups (see table at [[<tvar name=1>#List of permissions</tvar>|#List of permissions]]).</translate>
<translate> You can change the default rights by editing the <tvar name=1></tvar> array in <tvar name=2></tvar> with the following syntax:</translate>

<syntaxhighlight lang="php" copy>
$wgGroupPermissions['group']['right'] = true /* <translate nowrap> or <tvar name=1>false</tvar></translate> */;
</syntaxhighlight>
</tvar> will be set in <tvar name=2><code>includes/DefaultSettings.php</code></tvar>, but it is ''not'' present in <tvar name=3><code>LocalSettings.php</code></tvar>.</translate> <translate> You will then need to add it in that file.</translate>
}}

<translate> If a member has multiple groups, they get all the permissions from each of the groups they are in.</translate>
<translate> All users, including anonymous users, are in the <tvar name=1><code>*</code></tvar> group; all registered users are in the <tvar name=2><code>user</code></tvar> group.</translate>
<translate> In addition to the default groups, you can arbitrarily create new groups using the same array.</translate>

<translate>
=== Examples === 


This example will disable viewing of all pages not listed in <tvar name=1></tvar>, then re-enable for registered users only:
</translate>

<syntaxhighlight lang="php" copy>
$wgGroupPermissions['*']['read'] = false;
# <translate nowrap> The following line is not actually necessary, since it's in the defaults. Setting '*' to false doesn't disable rights for groups that have the right separately set to true!</translate>
$wgGroupPermissions['user']['read'] = true;
</syntaxhighlight>

<translate>

This example will disable editing of all pages, then re-enable for users with [[<tvar name=1>Special:MyLanguage/Manual:$wgEmailAuthentication</tvar>|confirmed email addresses]] only:
</translate>

<syntaxhighlight lang="php" copy>
# <translate nowrap> Disable for everyone.</translate>
$wgGroupPermissions['*']['edit'] = false;
# <translate nowrap> Disable for users, too: by default 'user' is allowed to edit, even if '*' is not.</translate>
$wgGroupPermissions['user']['edit'] = false;

# <translate nowrap> Make it so users with confirmed email addresses are in the group.</translate>
$wgAutopromote['emailconfirmed'] = APCOND_EMAILCONFIRMED;
# <translate nowrap> Hide group from user list.</translate>
$wgImplicitGroups[] = 'emailconfirmed';
# <translate nowrap> Finally, set it to true for the desired group.</translate>
$wgGroupPermissions['emailconfirmed']['edit'] = true;
</syntaxhighlight>

<translate>
== Creating a new group and assigning permissions to it == 
</translate>
<translate> A custom group can be created by simply assigning rights to it via [ ]</code></tvar>|''group-name''}} where ''group-name'' is the actual name of the group.</translate>
<translate> From MW 1.12, you can create your own groups into which users are automatically promoted (as with <tvar name=1><code>autoconfirmed</code></tvar>) using <tvar name=AutoPromote></tvar>.</translate>

<translate>

In addition to assigning permissions, you should create these three wiki pages with suitable content (see also the examples below):
</translate>

* <translate> (content: <code>Name of the group</code>)</translate>
* <translate> (content: <code>Name of a member of the group</code>)</translate>
* <translate> (content: <code>Name of the group page</code>)</translate>

<translate> By default, bureaucrats can add users to, or remove them from, any group.</translate>
<translate> However, if you are using <tvar name=1></tvar> and <tvar name=2></tvar>, you may need to customize those instead.</translate>

<translate>
=== Examples === 


This example will create an arbitrary <tvar name=1><code>projectmember</code></tvar> group that can block users and delete pages, and whose edits are hidden by default in the recent changes log:
</translate>

<syntaxhighlight lang="php" copy>
$wgGroupPermissions['projectmember']['bot'] = true;
$wgGroupPermissions['projectmember']['block'] = true;
$wgGroupPermissions['projectmember']['delete'] = true;
</syntaxhighlight>

</code></tvar> or <tvar name=2><code></code></tvar> instead of <tvar name=3><code></code></tvar>.</translate> <translate> Moreover it is recommended to only use lowercase letters to create a group.</translate>}}

<translate>

In this example, you would probably also want to create these pages:
</translate>

* <translate> (content: <code>Project members</code>)</translate>
* <translate> (content: <code>Project member</code>)</translate>
* <translate> (content: <code>Project:Project Members</code>)</translate>

<translate>

This will ensure that the group will be referred to as "Project members" throughout the interface, a member will be referred to as a "Project member", and overviews will link the group name to .
</translate>

<translate> This example disables write access (page editing and creation) by default, creates a group named <tvar name=1><code>writer</code></tvar>, and grants it write access.</translate>
<translate> Users can be manually added to this group via <tvar name=UserRights>[[Special:UserRights]]</tvar>:</translate>

<syntaxhighlight lang="php" copy>
$wgGroupPermissions['*']['edit'] = false;
$wgGroupPermissions['*']['createpage'] = false;
$wgGroupPermissions['user']['edit'] = false;
$wgGroupPermissions['user']['createpage'] = false;
$wgGroupPermissions['writer']['edit'] = true;
$wgGroupPermissions['writer']['createpage'] = true;
</syntaxhighlight>

<translate>

In this example, you would probably also want to create these pages:
</translate>

* <translate> (content: <code>Writers</code>)</translate>
* <translate> (content: <code>Writer</code>)</translate>
* <translate> (content: <code>Project:Write</code>)</translate>

<translate>
== List of permissions == 
</translate>
<translate> The following user rights are available in the latest version of MediaWiki.</translate>
<translate> If you are using an older version, look at <tvar name=1>[[Special:Version]]</tvar> on your wiki and see if your version is covered in the "Versions" column.</translate>

{| class="wikitable sortable"
|-
! | <translate> Right</translate>
! | <translate> Description</translate>
! | <translate> User groups that have this right by default</translate>
! | <translate> Versions</translate>
|-style="text-align:center"
| colspan="4"|''''''
|-
|style="vertical-align:top"|read
| – <translate> when set to <tvar name=1></tvar>, override for specific pages with <tvar name=WhitelistRead></tvar></translate>
----

| *, user
| [[rev:9367|1.5+]]
|-style="text-align:center"
| colspan="4"|''''''
|-
|applychangetags
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|1.25+
|-
|autocreateaccount
| - <translate> a more limited version of <tvar name=1><code>createaccount</code></tvar></translate>
|—
|1.27+
|-
|createaccount
| – <translate> register / registration</translate>
|*, sysop
|[[rev:9367|1.5+]]
|-
|createpage
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|*, user
|[[rev:11973|1.6+]]
|-
|createpreviouslyrenamedaccount
| – requires the <code>createaccount</code> right
|sysop
|[[gerrit:1271055|1.47+]]
|-
|createtalk
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|*, user
|[[rev:11973|1.6+]]
|-
|createwithcontentmodel
| – requires the <code>createpage</code> right
|user
|[[gerrit:1222750|1.46+]]
|-
|delete-redirect
| <translate> (note that this is not needed if the group already has the <tvar name=1><code>delete</code></tvar> right)</translate>
|—
|[[gerrit:559622|1.36+]]
|-
|edit
| – <translate> requires the <tvar name=1><code>read</code></tvar> right</translate>
|*, user
|[[rev:9632|1.5+]]
|-
|editsemiprotected
| – <translate> without cascading protection</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|autoconfirmed, bot, sysop
|1.22+
|-
|editprotected
| – <translate> without cascading protection</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:32164|1.13+]]
|-
|minoredit
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|[[rev:12359|1.6+]]
|-
|move
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user, sysop
|[[rev:9367|1.5+]]
|-
|move-categorypages
| – <translate> requires the <tvar name=1><code>move</code></tvar> right</translate>
|user, sysop
|[[gerrit:111096|1.25+]]
|-
|move-rootuserpages
| – <translate> requires the <tvar name=1><code>move</code></tvar> right</translate>
|user, sysop
|[[rev:41961|1.14+]]
|-
|move-subpages
| – <translate> requires the <tvar name=1><code>move</code></tvar> right</translate>
|user, sysop
|[[rev:35213|1.13+]]
|-
|movefile
| – <translate> requires the <tvar name=1><code>move</code></tvar> right as well</translate>
|user, sysop
|[[rev:45276|1.14+]]
|-
|reupload
| – <translate> requires the <tvar name=1><code>upload</code></tvar> right</translate>
|user, sysop
|[[rev:10906|1.6+]]
|-
|reupload-own
| – <translate> requires the <tvar name=1><code>upload</code></tvar> right (note that this is not needed if the group already has the <tvar name=reupload><code>reupload</code></tvar> right)</translate>
|—
|[[rev:21943|1.11+]]
|-
|reupload-shared
| – <translate> (if one is set up) with local files</translate> <translate> (requires the <tvar name=1><code>upload</code></tvar> right)</translate>
|user, sysop
|[[rev:10906|1.6+]]
|-
|sendemail
|
|user
|[[rev:56962|1.16+]]
|-
|upload
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right and <tvar name=2></tvar> to be <tvar name=3></tvar></translate>
|user, sysop
|[[rev:9499|1.5+]]
|-
|upload_by_url
| – <translate> requires the <tvar name=1><code>upload</code></tvar> right</translate> <translate> (Prior to 1.20 it was given to sysops)</translate>
|—
|[[rev:16162|1.8+]]
|-style="text-align:center"
| colspan="4"|''''''
|-
|autopatrol
| <translate> Modifies certain actions performed by the permission holder, automatically marking them as </translate> – <translate> Depends on <tvar name=1>|UseRCPatrol|UseNPPatrol|UseFilePatrol}}</tvar></translate>
|bot, sysop
|[[rev:18496|1.9+]]
|-
|bigdelete
| (<translate> as determined by <tvar name=1></tvar></translate>) – <translate> requires the <tvar name=1><code>delete</code></tvar> right</translate>
|sysop
|[[rev:29872|1.12+]]
|-
|block
| – <translate> Block options include preventing editing and registering new accounts, and autoblocking other users on the same IP address</translate>
|sysop
|[[rev:9367|1.5+]]
|-
|blockemail
| – <translate> allows preventing use of the <tvar name=1>[[Special:Emailuser]]</tvar> interface when blocking</translate> – <translate> requires the <tvar name=1><code>block</code></tvar> right</translate>
|sysop
|[[rev:22827|1.11+]]
|-
|browsearchive
| – <translate> through <tvar name=1>[[Special:Undelete]]</tvar></translate> – <translate> requires the <tvar name=1><code>deletedhistory</code></tvar> right</translate>
|sysop
|[[rev:32456|1.13+]]
|-
|changetags
| – <translate> currently unused by extensions</translate>
|user
|1.25+
|-
|delete
|<br /><translate> allows the deletion or undeletion of pages</translate><br /><translate> allows the deletion of pages</translate> <translate> (for undeletions, there is now the <tvar name=1><code>undelete</code></tvar> right, see below)</translate>
|sysop
|[[rev:9367|1.5+]]
|-
|deletedhistory
|
|sysop
|[[rev:12241|1.6+]]
|-
|deletedtext
| – <translate> requires the <tvar name=1><code>deletedhistory</code></tvar> right</translate>
|sysop
|1.16+
|-
|deletelogentry
| – <translate> allows deleting/undeleting information (action text, summary, user who made the action) of specific log entries – requires the <tvar name=1><code>deleterevision</code></tvar> right</translate>
|suppress
|[[gerrit:12889|1.20+]]
|-
|deleterevision
| – <translate> allows deleting/undeleting information (revision text, edit summary, user who made the edit) of specific revisions</translate> (<translate> Split into <tvar name=1><code>deleterevision</code></tvar> and <tvar name=2><code>deletelogentry</code></tvar> in 1.20</translate>)
|suppress
|[[rev:13224|1.6+]]
|-
|editcontentmodel
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|[[gerrit:176201|1.23.7+]]
|-
|editinterface
| – <translate> contains [[<tvar name=man>Special:MyLanguage/Manual:Interface</tvar>|interface messages]].</translate> <translate> For editing sitewide CSS/JSON/JS, there are now segregate rights, see below.</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop, interface-admin
|[[rev:9367|1.5+]]
|-
|editmyoptions
|
|*
|[[gerrit:67876|1.22+]]
|-
|editmyprivateinfo
| – <translate> also hides the "Change Password", but not other ways to change the password</translate> – <translate> requires the <tvar name=1><code>viewmyprivateinfo</code></tvar> right</translate>
|*
|[[gerrit:67876|1.22+]]
|-
|editmyusercss
| – <translate> prior to 1.31 it was assigned to everyone (i.e. <tvar name=1><code>*</code></tvar>) (note that this is not needed if the group already has the <tvar name=editusercss><code>editusercss</code></tvar> right)</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|[[gerrit:67874|1.22+]]
|-
|editmyuserjs
| – <translate> prior to 1.31 it was assigned to everyone (i.e. <tvar name=1><code>*</code></tvar>) (note that this is not needed if the group already has the <tvar name=edituserjs><code>edituserjs</code></tvar> right)</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|[[gerrit:67874|1.22+]]
|-
|editmyuserjsredirect
| <translate> (note that this is not needed if the group already has the <tvar name=edituserjs><code>edituserjs</code></tvar> right)</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|—
|[[gerrit:502667|1.34+]]
|-
|editmyuserjson
| <translate> (note that this is not needed if the group already has the <tvar name=edituserjson><code>edituserjson</code></tvar> right)</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|user
|[[gerrit:408940|1.31+]]
|-
|editmywatchlist
| – <translate> requires the <tvar name=1><code>viewmywatchlist</code></tvar> right</translate>
|user
|[[gerrit:67875|1.22+]]
|-
|editsitecss
| – <translate> requires the <tvar name=1><code>editinterface</code></tvar> right</translate>
|interface-admin
|[[gerrit:421121|1.32+]]
|-
|editsitejs
| – <translate> requires the <tvar name=1><code>editinterface</code></tvar> right</translate>
|interface-admin
|[[gerrit:421121|1.32+]]
|-
|editsitejson
| – <translate> requires the <tvar name=1><code>editinterface</code></tvar> right</translate>
|sysop, interface-admin
|[[gerrit:421121|1.32+]]
|-
|editusercss
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|interface-admin
|[[rev:54153|1.16+]]
|-
|edituserjs
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|interface-admin
|[[rev:54153|1.16+]]
|-
|edituserjson
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop, interface-admin
|[[gerrit:408940|1.31+]]
|-
|hideuser
| – <translate> Only users with 1000 edits or less can be suppressed by default</translate> – <translate> requires the <tvar name=1><code>block</code></tvar> right</translate>
<translate> Use <tvar name=HideUserContribLimit></tvar> to disable.</translate>
|suppress
|[[rev:20446|1.10+]]
|-
|ignore-restricted-groups
| – <translate> Only applies to groups the user would be otherwise able to change, based on <tvar name=1><code>userrights</code></tvar> right and the contents of <tvar name=2></tvar>.</translate>
|—
|[[gerrit:1200077|1.46+]]
|-
|markbotedits
| – <translate> see <tvar name=1></tvar></translate> – <translate> requires the <tvar name=1><code>rollback</code></tvar> right</translate>
|sysop
|[[rev:27658|1.12+]]
|-
|mergehistory
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:27823|1.12+]]
|-
|pagelang
| – <translate> <tvar name=1></tvar> must be <tvar name=2></tvar></translate>
|—
|[[gerrit:135312|1.24+]]
|-
|patrol
| <translate> Mark certain actions as </translate> – <translate> depends on <tvar name=1>|UseRCPatrol|UseNPPatrol|UseFilePatrol}}</tvar></translate>
|sysop
|[[rev:9367|1.5+]]
|-
|patrolmarks
| (<translate> note that this is not needed if the group already has the <tvar name=1><code>patrol</code></tvar> right</translate>)
|—
|[[rev:54153|1.16+]]
|-
|protect
| – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:9367|1.5+]]
|-
|rollback
|[[Special:MyLanguage/Manual:Rollback|MyLanguage/Manual:Rollback]] – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:9367|1.5+]]
|-
|suppressionlog
|
|suppress
|[[rev:13224|1.6+]]
|-
|suppressrevision
| – '''<translate> Prior to <tvar name=1>[[rev:35303|1.13]]</tvar> this right was named <tvar name=2><code>hiderevision</code></tvar></translate>''' – <translate> requires the <tvar name=1><code>deleterevision</code></tvar> right</translate>
|suppress
|[[rev:13224|1.6+]]
|-
|unblockself
| – <translate> Without it, an administrator that has the capability to block cannot unblock themselves if blocked by another administrator</translate>
|sysop
|[[rev:64228|1.17+]]
|-
|undelete
| – <translate> requires the <tvar name=1><code>deletedhistory</code></tvar> right</translate>
|sysop
|[[rev:28151|1.12+]]
|-
|userrights
| – <translate> allows the assignment or removal of all(*) groups to any user.</translate><br />
<small><translate> (*)With <tvar name=AddGroups></tvar> and <tvar name=RemoveGroups></tvar> you can set the possibility to add/remove certain groups instead of all</translate></small>
|bureaucrat
|[[rev:9367|1.5+]]
|-
|userrights-interwiki
| – <translate> requires the <tvar name=1><code>userrights</code></tvar> right</translate>
|—
|[[rev:28650|1.12+]]
|-
|viewmyprivateinfo
|
|*
|[[gerrit:67876|1.22+]]
|-
|viewmywatchlist
|
|user
|[[gerrit:67875|1.22+]]
|-
|viewsuppressed
| – <translate> i.e. a more narrow alternative to <tvar name=1><code>suppressrevision</code></tvar> (note that this is not needed if the group already has the <tvar name=2><code>suppressrevision</code></tvar> right)</translate>
|suppress
|[[gerrit:139277|1.24+]]
|-style="text-align:center"
| colspan="4"|''''''
|-
|deletechangetags
| – <translate> currently unused by extensions</translate>
|sysop
|[[gerrit:286282|1.28+]]
|-
|import
| – <translate> "transwiki"</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:9498|1.5+]]
|-
|importupload
| – <translate> This right was called <tvar name=1><code>importraw</code></tvar> in and before version 1.5</translate> – <translate> requires the <tvar name=1><code>edit</code></tvar> right</translate>
|sysop
|[[rev:9499|1.5+]]
|-
|managechangetags
| – <translate> currently unused by extensions</translate>
|sysop
|1.25+
|-
|renameuser
| (<translate> formerly was part of the Renameuser extension</translate>)
|bureaucrat
|1.40+
|-
|siteadmin
| – <translate> which blocks all interactions with the web site except viewing.</translate> (''<translate> not available by default</translate>'')
|—
|[[rev:9367|1.5+]]
|-
|unwatchedpages
| – <translate> lists pages that no user has watchlisted</translate>
|sysop
|[[rev:12196|1.6+]]
|-style="text-align:center"
| colspan="4"|''''''
|-
|apihighlimits
|
|bot, sysop
|[[rev:27949|1.12+]]
|-
|autoconfirmed
| – <translate> used for the <tvar name=1><code>autoconfirmed</code></tvar> group; see the other table below for more information</translate> <translate> (note that this is not needed if the group already has the <tvar name=2><code>noratelimit</code></tvar> right)</translate>
|autoconfirmed, bot, sysop
|[[rev:12207|1.6+]]
|-
|bot
| – <translate> edits and logged actions are hidden from recent changes, can optionally be viewed</translate>
|bot
|[[rev:9367|1.5+]]
|-
|ipblock-exempt
|
|sysop
|[[rev:18904|1.9+]]
|-
|nominornewtalk
| – <translate> requires the <tvar name=1><code>minoredit</code></tvar> right</translate>
|bot
|[[rev:17281|1.9+]]
|-
|noratelimit
| – <translate> not affected by [[<tvar name=1>Special:MyLanguage/Manual:$wgRateLimits</tvar>|rate limits]] (''prior to the introduction of this right, the configuration variable <tvar name=RateLimitsExcludedGroups></tvar> was used for this purpose'')</translate>
|sysop, bureaucrat
|[[rev:35908|1.13+]]
|-
|override-export-depth
|<br /><small><translate> With this right, you can define the depth of linked pages at <tvar name=link1>[[Special:Export]]</tvar>. Otherwise, the value of <tvar name=link2></tvar>, which is 0 by default, will be used.</translate></small>
|—
|1.15+
|-
|suppressredirect
| – <translate> requires the <tvar name=1><code>move</code></tvar> right</translate>
|bot, sysop
|[[rev:27774|1.12+]]
|}
{{Note|1=<translate> Although these permissions all control separate things, sometimes to perform certain actions you need multiple permissions.</translate> <translate> For example allowing people to edit but not read pages doesn't make sense, since in order to edit a page you must first be able to read it (Assuming no pages are allowlisted).</translate> <translate> Allowing uploads but not editing does not make sense, since in order to upload an image you must implicitly create an image description page, etc.</translate>}}

<translate>
== Predefined groups == 
</translate>
<translate> The following groups are available in the latest version of MediaWiki.</translate>
<translate> If you are using an older version then some of these may not be implemented.</translate>

{|class="wikitable"
|-
! | <translate> Group</translate>
! | <translate> Description</translate>
! | <translate> Default rights</translate>
! | <translate> Versions</translate>
|-
| *
| <translate> All users (including anonymous).</translate>
|createaccount, createpage, createtalk, edit, editmyoptions, editmyprivateinfo, read, viewmyprivateinfo
|[[rev:9367|1.5+]]
|-
|temp
| <translate> Temporary user accounts (<tvar name=1>[[phab:T330816|T330816]]</tvar>)</translate>
| <translate> Similar to <tvar name=1><code>*</code></tvar> group</translate>
|1.41+
|-
|user
| <translate> Registered accounts.</translate> <translate> Does ''not'' include temporary accounts.</translate>
|applychangetags, changetags, createpage, createtalk, createwithcontentmodel, edit, editcontentmodel, editmyusercss, editmyuserjs, editmyuserjson, editmywatchlist, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, purge, read, reupload, reupload-shared, sendemail, upload, viewmywatchlist
|1.13+
|-
|autoconfirmed
| <translate> Registered accounts at least as old as <tvar name=AutoConfirmAge></tvar> and having at least as many edits as <tvar name=AutoConfirmCount></tvar>.</translate>
|autoconfirmed, editsemiprotected
|[[rev:12207|1.6+]]
|-
|bot
| <translate> Accounts with the ''bot'' right (intended for automated scripts).</translate>
|autoconfirmed, autopatrol, apihighlimits, bot, editsemiprotected, nominornewtalk, suppressredirect
|[[rev:9367|1.5+]]
|-
|sysop
| <translate> Users who by default can delete and restore pages, block and unblock users, etc.</translate>
|apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, browsearchive, createaccount, createpreviouslyrenamedaccount, delete, deletedhistory, deletedtext, editinterface, editprotected, editsemiprotected, editsitejson, edituserjson, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, move, move-categorypages, move-rootuserpages, move-subpages, movefile, noratelimit, patrol, protect, reupload, reupload-shared, rollback, suppressredirect, unblockself, undelete, unwatchedpages, upload
|[[rev:9367|1.5+]]
|-
|interface-admin
| <translate> Users who can edit sitewide CSS and JavaScript.</translate>
|editinterface, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson
|1.32+
|-
|bureaucrat
| <translate> Users who can change the rights of other users by default and therefore have full access of the entire wiki.</translate>
|noratelimit, renameuser, userrights
|[[rev:9367|1.5+]]
|-
|suppress
|
|deletelogentry, deleterevision, hideuser, suppressionlog, suppressrevision, viewsuppressed
|1.13+
|}

<translate>
=== Removing predefined groups === 
</translate>
<translate> MediaWiki out of the box comes with a number of predefined groups.</translate>
<translate> Most of these groups can be removed by unsetting the according array keys, among them [ ]</span></tvar>|''group-name''}}.</translate>
<translate> For details, see below.</translate>

<translate>
==== Example ==== 
</translate>
<translate> This example will eliminate the <tvar name=1><code>bureaucrat</code></tvar> group entirely.</translate>
<translate> It is necessary to ensure that all six of these variables are unset for any group that one wishes to remove from being listed at <tvar name=List>[[Special:ListGroupRights]]</tvar>; however, merely unsetting <tvar name=1><code>$wgGroupPermissions</code></tvar> will suffice to remove it from <tvar name=UserRights>[[Special:UserRights]]</tvar>.</translate>

<syntaxhighlight lang="php" copy>
unset( $wgGroupPermissions['bureaucrat'] );
unset( $wgRevokePermissions['bureaucrat'] );
unset( $wgAddGroups['bureaucrat'] );
unset( $wgRemoveGroups['bureaucrat'] );
unset( $wgGroupsAddToSelf['bureaucrat'] );
unset( $wgGroupsRemoveFromSelf['bureaucrat'] );
</syntaxhighlight>

<translate> This code will not work if any extension that modifies the default rights for the <tvar name=2><code>bureaucrat</code></tvar> group, such as <tvar name=1></tvar>, is installed.</translate>

<translate> More broadly, to disable a user group created by an extension, the above code needs to run after all extensions have been registered.</translate>
<translate> This used to be possible by registering an extension function in <tvar name=1><code>LocalSettings.php</code></tvar>:</translate>

<syntaxhighlight lang="php" copy>
$wgExtensionFunctions[] = function() use ( &$wgGroupPermissions ) {
unset( $wgGroupPermissions['oversight'] );
unset( $wgGroupPermissions['flow-bot'] );
};
</syntaxhighlight>

<translate>

However, this '''no longer works reliably''' due to <tvar name=1>[[phab:T275334|T275334]]</tvar>.</translate>

{{Note|type=warn|1=
'''<translate> Note on the group called <tvar name=1><code>user</code></tvar></translate>'''

<translate> With the above mechanism, you can remove the groups <tvar name=2></tvar>, which - if used - can be assigned through the usual [[<tvar name=1>Special:MyLanguage/Help:User rights and groups</tvar>|user permission system]].</translate>
<translate> However, it is currently impossible to remove the <tvar name=1><code>user</code></tvar> group.</translate>
<translate> This group is ''not'' assigned through the usual permission system.</translate>
<translate> Instead, every registered user automatically is a member of that group.</translate>
<translate> This is hardcoded in MediaWiki and currently cannot be changed easily.</translate>
}}

<translate>
== Default rights == 


The default rights are defined in <tvar name=1></tvar>.
</translate>

* {{git file|project=mediawiki/core|branch=HEAD|file=includes/MainConfigSchema.php|text=<translate> Default values in the current alpha version (HEAD, version <tvar name=1></tvar>)</translate>}}
* |file=includes/MainConfigSchema.php|text=<translate> Default values in the latest stable version (branch <tvar name=1></tvar>, version <tvar name=2></tvar>)</translate>}}
<translate>

* Additional rights: you should be able to list all the permissions available on your wiki by running <tvar name=1></tvar>.

=== Adding new rights === 
</translate>
''<translate> Information for coders only follows.</translate>''

<translate> If you're adding a new right in core, for instance to [[<tvar name=2>Special:MyLanguage/Manual:Special pages</tvar>|control a new special page]], you are ''required'' to add it to the list of available rights in <tvar name=User></tvar>, <tvar name=1></tvar> ([<tvar name=url>https://gerrit.wikimedia.org/r/c/mediawiki/core/+/559622/9/includes/Permissions/PermissionManager.php</tvar> example]).</translate>
<translate> If you're , you instead need to use <tvar name=2></tvar>, or preferably define the right in <tvar name=3></tvar>.</translate>

<translate>

You probably also want to assign it to some user group by editing <tvar name=GroupPermissions></tvar> described above.


If you want this right to be accessible to external applications by <tvar name=OAuth></tvar> or by [[<tvar name=1>Special:MyLanguage/Manual:Bot passwords</tvar>|bot passwords]], then you will need to add it to a grant by editing <tvar name=GrantPermissions></tvar>.
</translate>

<syntaxhighlight lang="php" copy>
// <translate nowrap> create projectmember-powers right</translate>
$wgAvailableRights[] = 'projectmember-powers';

// <translate nowrap> add projectmember-powers to the projectmember-group</translate>
$wgGroupPermissions['projectmember']['projectmember-powers'] = true;

// <translate nowrap> add projectmember-powers to the 'basic' grant so we can use our projectmember powers over an API request</translate>
$wgGrantPermissions['basic']['projectmember-powers'] = true;
</syntaxhighlight>

<translate> You also need to add and interface messages to <tvar name=3>languages/i18n/en.json</tvar> (with documentation in <tvar name=4>qqq.json</tvar>).</translate>
<translate> The <tvar name=1><code>right-*</code></tvar> messages can be seen on <tvar name=2>[[Special:ListGroupRights]]</tvar> and the <tvar name=3><code>action-*</code></tvar> messages are used in a sentence like "You do not have permission to ...".</translate>

<translate>

== See also == 
</translate>
* [[Special:ListGroupRights]] – <translate> Links to this help page and might contain not yet documented rights</translate>
* – <translate> Help page describing use of the <tvar name=1>Special:Userrights</tvar> interface (for bureaucrats)</translate>
* – <translate> Information about managing and the assignment of user groups.</translate>
*
*
* |AddGroups|RemoveGroups}}
* – <translate> Examples</translate>
*
* – <translate> Many extensions relating to user rights</translate>

[[Category:Special Pages]]
[[Category:Permission]]

----
''Sample content adapted from [[mediawikiwiki:Manual:User_rights]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Short URL

2026-07-25T17:02:10Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>
</tvar>.</translate>}}

<translate> '''Short URLs''' or '''URL Rewrites''' hide php file extensions from the page address.</translate>
<translate> Please take a few minutes to devise a stable URL structure for your website before getting started, to reduce problems later.</translate>

<translate>
== Introduction == 

=== Goal === 


The default MediaWiki installation path looks like this:
</translate>

: <code>/var/www/html/mediawiki</code> ''<translate> (installed as root user)</translate>''
: <code>/home/johndoe/public_html/mediawiki</code> ''<translate> (installed with a shared hosting provider)</translate>''

<translate>

MediaWiki's default page addresses looks like these examples:
</translate>

: <code><nowiki>https://example.org/w/index.php/Page_title</nowiki></code> ''<translate> (recent versions of MediaWiki, without [[w:Common Gateway Interface|CGI]] support)</translate>''
: <code><nowiki>https://example.org/w/index.php?title=Page_title</nowiki></code> ''<translate> (recent versions of MediaWiki, with CGI support)</translate>''

<translate>

Using the methods outlined on this page, we can configure something like this:
</translate>

: <code><nowiki>https://example.org/wiki/Page_title</nowiki></code> <translate> This is the most common configuration, same as on Wikipedia, though not the default because it requires server-side modifications</translate>
: <code><nowiki>https://example.org/view/Page_title</nowiki></code>
: <code><nowiki>https://wiki.example.org/view/Page_title</nowiki></code>
: <code><nowiki>https://example.org/Page_title</nowiki></code>
: <code><nowiki>https://wiki.example.org/Page_title</nowiki></code>

<translate> Some people do not recommend the last two configurations.</translate>
<translate> See <tvar name=1></tvar> for potential problems and solutions.</translate>

<translate>
=== Advantages & disadvantages === 


* '''Advantage''': Short URLs hide some technical details from end-users, which can be desirable for site owners. Among other things, this means they can be kept stable when the underlying software changes.</translate> <translate> (See above for the difference between MediaWiki's default URL structure with CGI enabled vs without.)</translate> <translate> They are also easier to read, remember, and manipulate for visitors.</translate> <translate> Additionally, short URLs offer an advantage over the default URLs for [[w:Search engine optimization|Search engine optimization]], as URLs containing <tvar name=1><code>?</code></tvar> can be treated less favorably by search engines when calculating page rank.</translate>
<translate>

* '''Disadvantage''': Requires configuration, so, depending on the hosting environment you are using, it might be difficult to recreate.</translate> <translate> However, as every widely used webserver is capable of being configured to use short URLs, most paid web hosting services should support this feature. Any host that doesn't offer you this feature is not worth your money.</translate>

<translate>
== Guides == 
</translate>
<translate> Our official guides for short URL configuration for different web servers.</translate>
<translate> Pick your web server's configuration from this list.</translate>
<translate> If you don't know what server software you are using, then it is most likely Apache.</translate>

* (<translate> or</translate> LiteSpeed)
*
*

<translate>
== Other how-to mini-guides == 
</translate>
{{note|text=<translate> These guides are old and are almost entirely bad advice.</translate> <translate> These will eventually be deleted one by one as our official guides above are created for different webservers.</translate>}}
<translate> Anyone is welcome to create a how-to solution page and list it below.</translate>
<translate> Please use a sensible name for the page, one that fits in with the below names.</translate>
<translate> When each unique solution has its own page, readers can skip complexity they do not want.</translate>
<translate> Keep it simple, readable, short, with a separate page per separate solution.</translate>

<translate>

'''To help others find out which Short URL methods really work, after trying each method please edit the page and increase the "worked" or "didn't_work" numbers for that guide and make a brief (or long, your choice) description on what went wrong by clicking the link on your number.'''

=== URL like - example.com/wiki/Page_title === 
</translate>

</tvar> are defined.</translate>}}

<translate>
==== Root access ==== 
</translate>
<translate> These methods require that you have access to the server configuration.</translate>
<translate> If you are on a shared host, you most likely don't.</translate>
<translate> In this case you will be required to use a method that requires "no root access".</translate>
<translate> You can jump directly to the [<tvar name=url>https://shorturls.redwerks.org/</tvar> MediaWiki ShortURL Builder tool] and follow the on-screen instructions.</translate>
<translate> Select "I don't have root access" after entering your wiki's URL.</translate>

<translate>

(for Apache guidance, see the link in the [[<tvar name=guides>#Guides</tvar>|Guides]] section).
</translate>

<translate>
=== URL like - example.com/Page_title === 
</translate>

<translate>

How to create <code>example.com/Page_title</code> URLs:
</translate>

{{guide |name=Page title - nginx, Root Access, PHP as a CGI module |show=<translate nowrap> Page title - nginx, Root Access, PHP as a CGI module</translate> |worked=6 |didn't_work=}}
{{guide |name=Page title -- Windows & Apache without 403 on Special Pages |show=<translate nowrap> Page title -- Windows & Apache without 403 on Special Pages</translate> |worked=3 |didn't_work=}}

<translate>
=== URL like - wiki.example.com/Page_title === 
</translate>

<translate>

How to create <code>wiki.example.com/Page_title</code> URLs:
</translate>

<translate>
== Troubleshooting == 

=== Ampersand (<tvar name=1>&</tvar>) problem === 
</translate>
<translate> The ampersand problem shows up when you have page titles with symbols in them (such as <tvar name=1></tvar>) which, despite being correctly encoded in the link, are not being passed correctly from <tvar name=2>mod_rewrite</tvar> to the script.</translate>
<translate> This manifests in 404 page-not-found errors, because the title gets cut off at the special character.</translate>
<translate> For example, clicking on a link to "John & Maria's page" gets a 404, because MediaWiki is looking for a page named "John ".</translate>

<translate> This is because ampersands in long-form names are treated as [[w:Query string|query string]] separators, and would never reach the PHP [[w:Run time (program lifecycle phase)|runtime environment]].</translate>
<translate> This is caused by an old and problematic <tvar name=1>mod_rewrite</tvar> bug.</translate><ref><translate> [<tvar name=url>https://bz.apache.org/bugzilla/show_bug.cgi?id=34602</tvar> Bugzilla <tvar name=1>mod_rewrite</tvar> for ampersand bug], partially resolved for some users, but only after 13 years</translate></ref>

<translate>

'''Solution:'''
</translate>

<translate> This issue is caused by the <tvar name=1><code>?title=$1</code></tvar> portion of rewrite rules like <tvar name=2><code>/index.php?title=$1</code></tvar> which is completely unnecessary and harmful.</translate>
<translate> MediaWiki parses paths directly from the <tvar name=1>REQUEST_URI</tvar>, so rewrite everything to <tvar name=2>/index.php</tvar>.</translate>

<translate>
=== Purging cache === 


If you notice that your changes to <tvar name=1><code></code></tvar> in <tvar name=2><code>LocalSettings.php</code></tvar> are not being reflected in <tvar name=3><code>example.com/wiki/Main_Page</code></tvar>, it may be due to MediaWiki's caching of the links according to previous settings.


Go to <tvar name=1><code>example.com/wiki/Main_Page?action=purge</code></tvar> to force MediaWiki to regenerate the cached links.


Also you can:
</translate>

# <translate> execute the MySQL query <tvar name=1><code>TRUNCATE objectcache;</code></tvar>, or</translate>
# <translate> Ensure <tvar name=2></tvar> is updated (if <tvar name=3></tvar> is enabled, all you have to do is edit <tvar name=1></tvar> to purge it)</translate>

<translate>
== Redirect visitor of your domain to your wiki == 


Our official guides for short url configuration include recommendations on how to point the root of your site to your wiki using your short url config.


For example our [[<tvar name=1>Special:MyLanguage/Manual:Short URL/Apache</tvar>|Apache guide]] recommends using this to point your site root to your wiki:
</translate>

<syntaxhighlight lang="apache">
RewriteRule ^/*$ %{DOCUMENT_ROOT}/w/index.php [L]
</syntaxhighlight>

<translate> Note that we do '''not''' recommend doing a HTTP redirect to your wiki path or main page directly.</translate>
<translate> As redirecting to the main page directly will hard-code variable parts of your wiki's page setup into your server config.</translate>
<translate> And redirecting to the wiki path will result in two redirects.</translate>
<translate> Simply rewrite the root path to MediaWiki and it will take care of the 301 redirect to the main page itself.</translate>

<translate>

If using VirtualHosts, place the rewrite rules into the virtual host declaration!

== Moving a wiki from <tvar name=1>/wiki</tvar> to <tvar name=2>/w</tvar> == 
</translate>
<translate> A common beginner's mistake is to install MediaWiki itself (the source code, not the short URL) in <tvar name=1><code>/wiki</code></tvar> instead of <tvar name=2><code>/w</code></tvar>.</translate>
<translate> Once installed they would realize the mistake when trying to configure Short URLs (which would become difficult as the virtual path then conflicts with the real path).</translate>

<translate>

There is a manual for [[<tvar name=1>Special:MyLanguage/Manual:Moving a wiki</tvar>|moving a wiki]] in general, however that is too complicated if all you need is to change the installation directory (and stay on the same server, same database and same hostname).


Here is what you have to do:


* Backup <tvar name=1><code>LocalSettings.php</code></tvar> and any other config files you may have created (such as your <tvar name=2><code>.htaccess</code></tvar>).</translate>
<translate>

* Rename the installation directory of MediaWiki on your server from <tvar name=1><code>/wiki</code></tvar> to <tvar name=2><code>/w</code></tvar>.</translate>
<translate>

* Set <tvar name=1><code></code></tvar> in <tvar name=2><code>LocalSettings.php</code></tvar> to <tvar name=3><code>"/w"</code></tvar> and remove (or comment out) any definition of <tvar name=4><code>$wgArticlePath</code></tvar> (this variable will be changed again when setting up Short URLs, further on)</translate>
<translate>

* At this point your wiki should be working normally at <tvar name=1><code>example.org/w</code></tvar></translate>
<translate>

* Now go through [[<tvar name=guides>#Guides</tvar>|the regular guide]] to set up short URLs</translate>
<translate>

* Perform a few tests on your wiki to make sure nothing is broken.</translate> <translate> Edit a page, visit a few different pages, etc.</translate> <translate> If anything seems abnormal, revert the changes by restoring your backup of <tvar name=1><code>LocalSettings.php</code></tvar> and other relevant files you might have changed during configuration of short URLs and rename your folder back to <tvar name=2><code>/wiki</code></tvar>.</translate>

<translate> '''Note for shared hosting users:''' Many shared hosting plans offer an application manager to automatically Install, Update and Backup applications such as MediaWiki.</translate>
<translate> If your plan has this and if you want to keep using these features, you should contact their tech support and let them know you just manually changed your MediaWiki installation directory.</translate>

<translate>
== Tricks == 
</translate>

<translate>
== See also == 


*[[w:Common Gateway Interface#Workarounds for scripting languages|Explanation of what CGI modules are]]
</translate>
* - <translate> configuration setting that defines whether to use 'pretty' URLs or not</translate>
<translate>

*[[<tvar name=1>Special:MyLanguage/Manual:Wiki in site root directory</tvar>|Notes on placing your wiki installation in site root directory]]</translate>
* - <translate> configuration setting that you can use to define 'pretty' URLs for other actions, like edit or history</translate>
<translate>

* [[<tvar name=1>Special:MyLanguage/Requests for comment/Clean up URLs</tvar>|Clean up URLs RFC]] - proposes "cleaner URLs for editing, previewing skins, etc."

== External links == 


*[<tvar name=url>https://httpd.apache.org/docs/current/mod/mod_rewrite.html</tvar> Apache Module <tvar name=1>mod_rewrite</tvar>] - rewrite requested URLs on the fly</translate>
<translate>

*[<tvar name=url>https://shorturls.redwerks.org/</tvar> MediaWiki Short URL Builder Tool] - ''A tool that can automatically generate a short url configuration more reliably than the configurations in these manual pages.''</translate>
<translate>

* [<tvar name=url>https://www.nngroup.com/articles/url-as-ui/</tvar> URL as UI] by [[w:Jakob Nielsen (usability consultant)|Jakob Nielsen]] on the importance of persistent, usable URLs.

== References == 
</translate>
<references/>


[[Category:Configure|Configure]]
[[Category:Wiki page URLs|Wiki page URLs]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Short_URL]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Upgrading

2026-07-25T17:02:10Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>
|left|right}}}}
<translate>
== Basic overview == 

=== File transfer === 


Choose a method for transferring files:


* [[w:Wget|wget]]</translate>
<translate>

* Secure copy with [<tvar name=url>https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html</tvar> SCP] or [[w:WinSCP|WinSCP]]</translate>
<translate>

* [[w:SSH File Transfer Protocol|SSH File Transfer Protocol]] (SFTP)</translate>
<translate>

* Using a [[w:File Transfer Protocol|FTP]] client.</translate>
<translate>

* The hosting company might provide a file manager interface via the web browser; check with your provider.</translate>
<translate>

* Some other method.</translate> <translate> There is a list of these at [[w:Comparison of file transfer protocols|Comparison of file transfer protocols]]</translate>

<translate>
===Preliminary=== 


Read |file=UPGRADE</tvar>|text=the UPGRADE text file included in MediaWiki}}.
</translate>

# <translate> Check the requirements</translate>
# <translate> Read the <tvar name=1>RELEASE-NOTES</tvar> file</translate>
# <translate> Read the <tvar name=1>UPGRADE</tvar> file</translate>
# <translate> Back up existing files and the database</translate>
# <translate> Unpack the new files</translate>
# <translate> Upgrade extensions</translate>
# <translate> Run the update script to check the database</translate>
# <translate> Test the update</translate>
# <translate> Remove leftovers from old installations</translate>

<translate>
== Check requirements == 
</translate>

<translate>

MediaWiki <tvar name=ver></tvar> requires:
</translate>

* '''PHP '''+
<translate>

* One of the following:
</translate>
** '''MariaDB '''+
** '''MySQL '''+
** '''PostgreSQL '''+
** '''SQLite '''+

<translate>

If you are using PostgreSQL, please also read <tvar name=upgrading></tvar>.


For more information, please read the <tvar name=req></tvar> and <tvar name=compat></tvar>.

== Read the release notes == 
</translate>
<translate> Within the distribution tarball, or within the files checked out/exported from [[<tvar name=gerrit>Special:MyLanguage/Gerrit</tvar>|Git]], there are a number of files with capitalized filenames, one of which contains the <tvar name=relnotes>'''|file=RELEASE-NOTES-|text=RELEASE-NOTES}}'''</tvar> ([[<tvar name=1>Special:MyLanguage/Release notes</tvar>|wiki]]).</translate>
<translate> Now's the time to open it up and find out what's been changed in this release.</translate>
<translate> You should also read the instructions in the <tvar name=1>UPGRADE</tvar> file.</translate>

<translate>
== Clear pending jobs == 
</translate>
<translate> For performance reasons, some actions in the database are delayed, and are managed by the [[<tvar name=man>Special:MyLanguage/Manual:Job queue</tvar>|job queue]].</translate>
<translate> Those jobs are stored in database and contain parameters with information about actions it should perform.</translate>
<translate> It's strongly recommended to run those pending jobs before upgrading the wiki, to avoid them failing in case the parameter specification of those jobs change on the new version.</translate>
<translate> Use <tvar name=runJobs></tvar> to run all pending jobs and clear the queue before performing the upgrade.</translate>

<translate>
== Back up existing files and the database == 


:''Full instructions: <tvar name=1></tvar>''


While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update the database schema, '''make a full [[<tvar name=backup>Special:MyLanguage/Manual:Backing up a wiki</tvar>|backup]]''' of the wiki, including both the database and the files:


* the wiki's content, from the database, (make sure you get the character set specified correctly, first check <tvar name=1><code>LocalSettings.php</code></tvar>). It may be a good idea to create an XML dump in addition to the SQL database dump.
</translate>
:* <translate> MySQL, both SQL dump and XML dump are for use with the <tvar name=1><code>mysql</code></tvar> command:</translate>
mysqldump --user='''''wikidb_user''''' --password='''''wikidb_userpassword''''' '''''wikidb''''' > '''''file.sql'''''
mysqldump --user='''''wikidb_user''''' --password='''''wikidb_userpassword''''' '''''wikidb''''' --xml > '''''file.xml'''''
:* <translate> PostgreSQL, database dump for use with <tvar name=1><code>pg_restore</code></tvar> command:</translate>
pg_dump --create -Fc '''''wikidb''''' > '''''file.db.dump'''''
:* <translate> SQLite, you use a MediaWiki script for making a backup:</translate>
php '''''wikifolder'''''/maintenance/run.php SqliteMaintenance --backup-to '''''file'''''
<translate>

* images and other media files (the contents of the <tvar name=1><code>images</code></tvar> directory, custom logo <tvar name=2>/skins/common/images/wiki.png</tvar>)</translate>
<translate>

* configuration files, e.g. <tvar name=1><code>LocalSettings.php</code></tvar> and <tvar name=2><code>.htaccess</code></tvar> (if present)</translate>
<translate>

* MediaWiki's program files, including all skins and extensions, especially if you modified them.

== Unpack the new files == 

=== Using a tarball package === 


You can put the new files into place using FTP or the command line. Use the command line, if you have access to it! Using the command line will be much faster than having to upload each single one of the thousands of files via FTP.
</translate>

{{Note|1=<translate> You should put the decompressed tarball in a new and empty folder on your server. If you instead extract the new version directly on top of your old version, rather than in a new directory, you should follow the instructions described in [[<tvar name=1>#Back up existing files and the database</tvar>|Back up existing files and the database]]: otherwise, if you've made any customizations you may erase them in a way that leaves you with no reference to re-apply them from.</translate> <translate> Extracting a tarball over top of your live copy of MediaWiki can also leave behind files from the old version of MediaWiki which may interfere with the upgraded code.</translate> <translate> It's recommended that you unpack the new files into a new directory, and then apply customizations to the new directory (restoring <tvar name=1><code>LocalSettings.php</code></tvar>, images folder, extensions, and other customizations like custom skins).</translate>}}

<translate>
==== FTP or graphical ==== 


If you cannot access the command line on your server, download the MediaWiki tarball to your local computer and use <tvar name=7zip>[http://www.7-zip.org/download.html 7zip]</tvar> to extract the tarball on your local PC.


After you extracted the files locally, use your favorite FTP client software to upload directories and files to the server.

==== cPanel File Manager ==== 
</translate>
<translate> cPanel is a popular interface provided by many web hosts.</translate>
<translate> This method is efficient because the files are uncompressed on the server itself.</translate>

* <translate> Navigate to the directory that holds your wiki folder.</translate>
* <translate> Upload the <tvar name=1>mediawiki-1.xx.x.tar.gz</tvar> file.</translate> <translate> You may need to hit "Reload" to see it.</translate>
* <translate> Extract the <tvar name=1>mediawiki-1.xx.x.tar.gz</tvar> file.</translate> <translate> Reload again.</translate>
* <translate> Confirm that the <tvar name=1>mediawiki-1.xx.x</tvar> folder is present.</translate>
* <translate> Delete the tar.gz file.</translate>
* <translate> Copy all necessary skins, extensions, image folders, customizations, and the <tvar name=1><code>LocalSettings.php</code></tvar> into the new folder.</translate> <translate> (See below.)</translate>
* <translate> When you are ready to run <tvar name=1>update.php</tvar>, rename your old wiki folder and your new wiki folder.</translate> <translate> (e.g. "w" becomes "w1.34" and then "mediawiki1.35.0" becomes "w".)</translate> <translate> This step is easily reversible if you run into problems.</translate>

<translate>
==== Command line ==== 
</translate>
<translate> You may need to run the command as <code>sudo</code> if you don't have full write permissions to the wiki install directories under your current user.</translate>
<translate> When untarring a tarball package normally a new directory for the new wiki version will be created and you will have to copy the old configuration files and images directory from your old installation directory:</translate>

<code class="mw-code mw-highlight plainlinks" style="display:block"> /path/to/your/new/installation/
wget https://releases.wikimedia.org/mediawiki//mediawiki-.tar.gz
tar xvzf mediawiki-.tar.gz
rm mediawiki-.tar.gz
</code>

<translate>

(Open)Solaris users should use <kbd>gtar</kbd>, or:
</translate>

$ gzip -dc mediawiki-.tar.gz | tar xf -

<translate>
===Other files=== 


After extracting the tarball, you should copy or move some files and folders from the old installation directory to the new one:
</translate>
* <code>LocalSettings.php</code> - <translate> contains your old configuration settings.</translate>
<translate>

* The <tvar name=code-img><code>images</code></tvar> (or <tvar name=code-upl><code>uploads</code></tvar> in older versions) directory, which contains all the uploaded files to the wiki, unless you have chosen a different upload directory, and change the ownership and permissions. <tvar name=chmod><code>find ./images -type d -exec chmod 755 {} \;</code></tvar> and <tvar name=chgrp><code>chgrp -R apache images</code></tvar> (e.g. if your web user is ''apache'').</translate>
<translate>

* Some extensions in the <tvar name=dir><code>extensions</code></tvar> directory. You should always get updated extensions; old extensions aren't guaranteed to work with a newer version of MediaWiki.</translate>
<translate>

* In case you use a [[<tvar name=logo>Special:MyLanguage/Manual:$wgLogo</tvar>|custom logo]] this file also needs to be restored from backup. Before 1.24 the logo is usually in <tvar name=dir1><code>skins/common/images/</code></tvar>. After 1.24 the logo is usually in <tvar name=dir2><code>resources/assets/</code></tvar> or <tvar name=dir3><code>images/</code></tvar> if that's what you chose to use.</translate> <translate> Then add to <tvar name=1><code>LocalSettings.php</code></tvar> e.g. <tvar name=logo2><syntaxhighlight lang=php inline>$wgLogo = "$wgScriptPath/images/logo.png";</syntaxhighlight></tvar></translate>
<translate>

* For 1.35 you may need to restore the logos from <tvar name=1></tvar>.</translate> <translate> Then add to <tvar name=2><code>LocalSettings.php</code></tvar> e.g. <tvar name=3><syntaxhighlight lang=php inline>$wgLogos = [ '1x' => "path/to/1x_version.png", '2x' => "path/to/2x_version.png", 'svg' => "path/to/svg_version.svg" ];</syntaxhighlight></tvar></translate>
<translate>

* Custom skins from within the <tvar name=skins-dir><code>skins</code></tvar> directory.</translate>
<translate>

* Any modifications made to the old installation files or extensions.</translate>
<translate>

* Any .htaccess file (if you're using Apache and you've defined any rules in them).
</translate>

<translate> Once done, make this new folder the published folder on the web server, or rename the old installation directory and then rename the new one to match the old name.</translate>
<translate> Change ownership and group of everything so the web server has access to the files.</translate>

<translate>
=== Using Git === 


If using <tvar name=git></tvar>, export the files into a clean location, and then copy the old customized files into the new location as described in the previous section.
</translate>

<translate> You will also need to install some external PHP libraries using Composer or a provided collection maintained for the Wikimedia wiki farm.</translate>
<translate> More details on installing and updating external libraries can be found in the [[<tvar name=download>Download_from_Git#Fetch_external_libraries</tvar>|Git download documentation]].</translate>

<translate>
=== Using patch === 
</translate>
<translate> A small patch file is usually made available for a minor version upgrade.</translate>
<translate> You'll need to download [[w:patch (Unix)|patch]] to use this.</translate>
<translate> Manually download and extract the patch file from [<tvar name=dumps>https://releases.wikimedia.org/mediawiki/</tvar> the dumps site] or follow the directions with wget below.</translate>
<translate> Patches are incremental, you can '''not ''' skip a version.</translate>

# <translate> <kbd>cd</kbd> to your main MediaWiki directory (the one with <tvar name=1><code>LocalSettings.php</code></tvar>).</translate>
# <translate> Download the patch file and <kbd>gunzip</kbd> it.</translate>
# <translate> Use <tvar name=patch><code>patch -p1 --dry-run</code></tvar> to check what will be changed (''e.g.'', <tvar name=patch2><code>patch -p1 --dry-run -i ''mediawiki-x.xx.x.patch''</code></tvar>)</translate>
# <translate> If all is well, run <kbd>patch</kbd> again without <tvar name=dry><code>--dry-run</code></tvar>.</translate>
# <translate> Check your Special:Version and you should see the new version number in place.</translate>

<translate>
=== Files remaining that may cause errors === 


If you unpacked over the old installation directory, some old files can cause problems with the new version.

== Upgrade extensions == 


Certain extensions have been updated in order to work with the new version of MediaWiki. Be sure to upgrade to the latest versions of such extensions. You might need to perform manual updates to custom extensions.


Different [[<tvar name=tar>Special:MyLanguage/tarballs</tvar>|tarballs]] include some subsets of extensions and have versioning which helps you upgrade choosing the right one for your MediaWiki core release.


[[<tvar name=special>Special:ExtensionDistributor</tvar>|Extension Distributor]] works well for most people who want a snapshot of extensions that will work with their supported versions of MediaWiki.
</translate>

<translate> If you want a lot of extensions then [[<tvar name=download>Special:MyLanguage/Download from Git</tvar>|downloading from Git]] is probably best.</translate>
<translate> If you don't have Git but you want to upgrade a lot of extensions, you might consider using [[MwExtUpgrader|mwExtUpgrader]].</translate>

<translate>
== Adapt your <tvar name=1><code>LocalSettings.php</code></tvar> == 


If you use the same <tvar name=localsettings><code>LocalSettings.php</code></tvar> from the old version, you may need to adapt it to how new versions handle it:

=== Skin registration === 
</translate>

<translate>

Since MediaWiki 1.24, bundled skins like Vector, Monobook, Modern and CologneBlue are no longer part of MediaWiki core, and they need to be registered explicitly in <tvar name=localsettings><code>LocalSettings.php</code></tvar> to use them, otherwise MediaWiki will warn that you don't have installed skins.


This is what you need to add to <tvar name=localsettings><code>LocalSettings.php</code></tvar> when upgrading from versions older than 1.24 and want to have available one of those skins:
</translate>

<syntaxhighlight lang="php">
wfLoadSkin( 'Vector' );
wfLoadSkin( 'MonoBook' );
wfLoadSkin( 'Modern' );
wfLoadSkin( 'CologneBlue' );
</syntaxhighlight>

<translate>

Other skins may still not be adapted to the new [[<tvar name=skinreg>Special:MyLanguage/Manual:Extension registration</tvar>|skin registration]] system, so refer to the documentation page about each skin to see how to register it properly in case of problems.

=== Extension registration === 
</translate>

<translate>

Since MediaWiki 1.25, extensions use a new [[<tvar name=extreg>Special:MyLanguage/Manual:Extension registration</tvar>|extension registration]] system.


Previously your <tvar name=1><code>LocalSettings.php</code></tvar> would include something like:
</translate>

<syntaxhighlight lang="php">
require_once "$IP/extensions/Cite/Cite.php";
require_once "$IP/extensions/Gadgets/Gadgets.php";
require_once "$IP/extensions/ImageMap/ImageMap.php";
require_once "$IP/extensions/InputBox/InputBox.php";
require_once "$IP/extensions/Nuke/Nuke.php";
require_once "$IP/extensions/ParserFunctions/ParserFunctions.php";
require_once "$IP/extensions/Poem/Poem.php";
require_once "$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php";
require_once "$IP/extensions/WikiEditor/WikiEditor.php";
</syntaxhighlight>

<translate>

This can be converted to:
</translate>

<syntaxhighlight lang="php">
wfLoadExtension( 'Cite' );
wfLoadExtension( 'Gadgets' );
wfLoadExtension( 'ImageMap' );
wfLoadExtension( 'InputBox' );
wfLoadExtension( 'Nuke' );
wfLoadExtension( 'ParserFunctions' );
wfLoadExtension( 'Poem' );
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
wfLoadExtension( 'WikiEditor' );
</syntaxhighlight>

<translate> Extensions are being adapted to use the new extension registration system.</translate>
<translate> Extensions that are not adapted should use the old way of installing them.</translate>
<translate> Refer to the installation instructions on the extension's page for more information.</translate>

<translate>
=== Remove <tvar name=1>DefaultSettings.php</tvar> line (if necessary) === 
</translate>

<translate> Older versions of MediaWiki automatically generated a line in <tvar name=1>LocalSettings.php</tvar> calling <tvar name=2></tvar>.</translate>
<translate> As of Version 1.38, this line is deprecated and does not work with many extensions.</translate>
<translate> It needs to be removed.</translate>

<translate> Delete the following line:</translate>
<syntaxhighlight lang="php">
require_once( "$IP/includes/DefaultSettings.php" );
</syntaxhighlight>

<translate>
===Remove RenameUser from <tvar name=1>LocalSettings.php</tvar>=== 
</translate>

<translate> If you are upgrading to 1.40 or above, <tvar name=1></tvar> has been merged into core.</translate>
<translate> If present, this line must be deleted from <tvar name=1>LocalSettings.php</tvar> or the update will fail.</translate>

<syntaxhighlight lang="php">
wfLoadExtension( 'Renameuser' );
</syntaxhighlight>

<translate>
===Remove Interwiki from <tvar name=1>LocalSettings.php</tvar>=== 
</translate>

<translate> If you are upgrading to 1.44 or above, <tvar name=1></tvar> has been merged into core.</translate>
<translate> If present, this line must be deleted from <tvar name=1>LocalSettings.php</tvar>.</translate>

<syntaxhighlight lang="php">
wfLoadExtension( 'Interwiki' );
</syntaxhighlight>

<translate>

Please be sure to check for some Interwiki settings that have been removed or renamed.

=== Other variables === 
</translate>
<translate> Some variables may be obsolete or even removed.</translate>
<translate> Having them in <tvar name=localsettings><code>LocalSettings.php</code></tvar> '''usually''' won't have any effect.</translate>
<translate> New variables may be added in newer versions, or some existing variables changed their type.</translate>
<translate> We usually try to use sane defaults for them, and in case of type change, be backward compatible.</translate>
<translate> In any case, take a look at the release notes to see those changes.</translate>

<translate>
== Run the update script == 
</translate>

<translate>

You can upgrade the MediaWiki database in two ways: Either from the command line or from the web browser. If you have shell access to your server, upgrading from the command line is recommended, since this reduces the risk of the upgrade process being interrupted by a timeout or connection reset.


The script will also notify you if any of MediaWiki core's PHP dependencies are out of date.

=== Command line === 
</translate>
<translate> Access the command line of your server or an SSH shell or similar. You can access the command line by connecting to your server via SSH.</translate>
<translate> Current versions of all major operating systems (including Windows 10 and 11) contain a command-line [[w:OpenSSH|OpenSSH]] client either by default or as an installable feature.</translate>
<translate> If the local PC you are working on runs Microsoft Windows, you may want to (or, if it's 8.1 or older, have to) install <tvar name=putty>[https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html PuTTY]</tvar>, which features a wizard-like interface (or a similar tool).</translate>
<translate> From the command line or the Shell, execute the [[<tvar name=script>Special:MyLanguage/Manual:update.php</tvar>|update script]]:</translate>

$ php maintenance/run.php update

$ php maintenance/update.php

<translate> On a Linux server if you get an error, try performing the same command as root (by using the <tvar name=1><kbd>sudo</kbd></tvar> command).</translate>
<translate> Note for simple installations on Windows (e.g. with <tvar name=xampp></tvar>):</translate>
<translate> First make sure that your web server (such as Apache) and your database (such as MySQL) are running.</translate>
<translate> Then run <tvar name=1><code>update.php</code></tvar>: right-click it, select Open With, and browse to <tvar name=2>PHP.exe</tvar>.</translate>
<translate> The resulting command prompt window will likely autoclose when the schema upgrade completes.</translate>

<translate>

MediaWiki will inspect the existing schema and update it to work with the new code, adding tables and columns as needed.</translate>

{{Note|1=<translate> If you use a [[<tvar name=shared-db>Special:MyLanguage/Manual:Shared database</tvar>|Shared database]], you should pass the <tvar name=doshared><code>--doshared</code></tvar> parameter if you want the shared tables to be updated. Otherwise, they won't be touched by the update script.</translate>}}

<translate>
==== What to do if it says "MediaWiki requires PHP x.y.z or higher; you are using PHP x.w.v" ==== 


See {{<tvar name=1>ll|Manual:Common errors and symptoms#MediaWiki requires PHP 7.4.3 or higher; you are using PHP 7.3.17</tvar>|Manual:Common errors and symptoms#MediaWiki requires PHP 7.4.3 or higher; you are using PHP 7.3.17}}

==== What to do if php update.php fails to do anything, resulting in a quick pause and then return to command prompt ==== 


This can be caused by a malfunctioning extension or skin.


* Check that all extensions and skins called for in <tvar name=1>LocalSettings.php</tvar> are present</translate>
<translate>

* Check that extensions are using the correct registration method (<tvar name=1>wfLoadExtension</tvar> vs. <tvar name=2>require_once</tvar>)</translate>
<translate>

* Comment out the first half of the extensions in <tvar name=1>LocalSettings.php</tvar>.</translate> <translate> If this causes <tvar name=1>update.php</tvar> to work, uncomment half of that half (so 1/4 of the extensions).</translate> <translate> If this does NOT cause <tvar name=1>update.php</tvar> to work, uncomment the first half but comment out the second half, and then comment out half of the second half, etc.</translate> <translate> Repeat until <tvar name=1>update.php</tvar> works to find the one that is failing.</translate>

<translate>
==== What to do in case of "ALTER command denied to user" error (or similar) ==== 


In case the scripts abort with a message similar to:
</translate>

<pre>
Error: 1142 ALTER command denied to user 'wiki'@'localhost' for table 'mytable' (localhost)
ERROR: must be the owner of the mytable relation
</pre>

<translate>

This means that you should check that you have defined <tvar name=1></tvar> and <tvar name=2></tvar> in your <tvar name=3></tvar> file (in the main directory). These are the user and password needed by this script in order to access to the database.
</translate>

<translate> In some cases, an old $wgDBmwschema variable (for Postgres) seems to be read for the table name to update instead of $wgDBname, even when MySQL is used.</translate>
<translate> If this is the case, just get rid of the <tvar name=1><code>$wgDBmwschema</code></tvar> definition in <tvar name=2><code>LocalSettings.php</code></tvar>.</translate>

<translate>
====What to do in case of 'register_argc_argv is set to false' error==== 


You may encounter the error:
</translate>

<pre style="overflow:auto;">
Cannot get command line arguments, register_argc_argv is set to false
</pre>

# <translate> Go to <tvar name=1>~/maintenance</tvar>.</translate> <translate> Either edit an existing <tvar name=2>php.ini</tvar> file, or create one.</translate>
# <translate> Add a line as follows:</translate>

<pre style="overflow:auto;">
register_argc_argv=true
</pre>

# <translate> Re-run <tvar name=1><code>php update.php</code></tvar></translate>

<translate>
===Web browser=== 
</translate>

<translate>

: ''See also <tvar name=update></tvar>''


If your database is already big and in high production usage, then you should not be using the Web updater, e.g. because the update process will time out when the ''maximum_execution_time'' is reached. In that case you should use [[update.php]] from the command-line interface (not from the web). What exactly is "too big" depends on your server (e.g. on its performance, the load and on how long the maximum execution time of PHP allows the script to run). If your wiki is too big for the web updater and your hosting provider does not allow command-line access, then you need to migrate your wiki to another hosting account, preferably to one that does have shell access.
</translate>

# <translate> Always [[<tvar name=1>Special:MyLanguage/Manual:Backing up a wiki</tvar>|back up]] before performing database maintenance.</translate>
# <translate> Navigate your web browser to <tvar name=1><code>'''/mw-config/index.php'''</code></tvar>.</translate> <translate> For example, if your wiki is at <tvar name=1><code><nowiki>http://example.org/w/index.php</nowiki></code></tvar>, then navigate to <tvar name=2><code><nowiki>http://example.org/w/mw-config/index.php</nowiki></code></tvar>.</translate>
# <translate> Select your language and click continue.</translate>
# <translate> The existing installation should be detected. Follow the instructions on the screen to upgrade it.<br/>If asked for the "upgrade key", open your <tvar name=localsettings></tvar> file and look for the key assigned to <tvar name=upgkey></tvar>.</translate>

<translate>

It might happen that the web-updater does not seem to work: Instead of seeing the initial language selection screen, you might see an empty wiki page, possibly with some error message. In this case it is most likely that your web server uses Rewrite Rules (most likely for [[<tvar name=shorturl>Special:MyLanguage/Manual:Short URL</tvar>|short URLs]]), which do not show you the updater at ''mw-config/'', but a wiki page at ''Mw-config/'', with capital "M". In this case, rename the ''.htaccess'' file for the time of the update. Then you should be able to access the web-updater.</translate>

{{Warning|1=<translate> If you use this method, make sure to '''change the name of the .htaccess file back''' after running the upgrade script! Otherwise, short URLs and possibly other stuff will be broken!</translate>}}

<translate>
== Test the update == 


Once the upgrade has been completed, browse to the wiki and check that the following operations work as expected:


* Viewing pages
* Editing pages
* Uploading a file
* Visit <tvar name=version>[[Special:Version]]</tvar> and check that the version shown is correct and that the extensions are present.

== Remove leftovers from old installations == 
</translate>
<translate> If you have copied your previous installation to another folder on the server, be sure to remove it or make it completely inaccessible from the web.</translate>
<translate> It is very important to not leave old installations accessible from the web, since it completely defeats the purpose of upgrading, and leaves your server open to attacks.</translate>

<translate>
== Frequently asked questions == 
</translate>
<section begin=FAQ />
<translate>
===How hard is it to upgrade?=== 


If the only file you have modified is <tvar name=localsettings></tvar>, and you are upgrading from 1.5 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially hours for wikis with millions of pages, but for a more typical size of a few thousand pages, it is usually done in seconds.
</translate>

<translate> Minor upgrades, within the same major version, say from <tvar name=1>.0</tvar> to <tvar name=2></tvar>, do not require any schema changes at all.</translate>
<translate> You can just update the files. The database needs no update, hence it is not necessary to run the updater script.</translate>

<translate>

Upgrading from 1.4 or earlier is potentially complicated because support for character sets other than UTF-8 was dropped, and the schema for storing bulk text changed. Please read the relevant section in the <code>UPGRADE</code> file.


Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten. Tools such as <tvar name=diff>[http://www.gnu.org/software/diffutils/diffutils.html diff]</tvar>, <tvar name=patch>[http://www.gnu.org/software/patch/ patch]</tvar>, <tvar name=meld>[http://meldmerge.org/ Meld]</tvar> or <tvar name=winmerge>[http://winmerge.org/ WinMerge]</tvar> may be useful. There is also potential for trouble if you are using unmaintained extensions. Upgrade your extensions at the same time as you upgrade MediaWiki.


If you have modified the skin or use a custom skin, you very likely will have to adjust it to work again with the new version of MediaWiki.
</translate>

{{Tip|1=<translate> Instead of patching your "global" CSS and JS (JavaScript) files every time, you can simply add the code to your MediaWiki:Common.js and MediaWiki:Common.css pages. As these are part of the database which will be reused when you upgrade, you will not have to patch the MediaWiki core files any more.</translate>}}

<translate>
===How do I upgrade from a really old version? In one step, or in several steps?=== 
</translate>

<translate> It depends: If you are '''upgrading from MediaWiki 1.4 or older''', you should upgrade to MediaWiki 1.5 first.</translate>
<translate> If you are upgrading from a Latin-1 wiki, use upgrade1_5.php (found in MediaWiki 1.5) to convert the relevant parts of the database to UTF-8 (<tvar name=latin></tvar> needs to be set to true in your <tvar name=localsettings></tvar> for this to work).</translate>
<translate> Next, run <tvar name=1><code>update.php</code></tvar>, and then set the <tvar name=2></tvar> option in <tvar name=3><code>LocalSettings.php</code></tvar> to the encoding previously used by the wiki (e.g. windows-1252).</translate>
<translate> This is basically how Wikipedia and other Wikimedia Foundation sites were upgraded from MediaWiki 1.4 to 1.5 – see some [[<tvar name=4>wikitech:Obsolete:1.5 upgrade</tvar>|related notes at Wikitech]].</translate>
<translate> You may need to upgrade to MediaWiki 1.4 before running the upgrade1.5 script.</translate>
<translate> If you want to make a database dump (e.g. MySQL) of your Latin-1 wiki, make sure the type of the <tvar name=1><code>old_text</code></tvar> field in the <tvar name=2></tvar> table is <tvar name=3><code>mediumblob</code></tvar>, not <tvar name=4><code>mediumtext</code></tvar>, to avoid character encoding issues.</translate>

<translate> If you are '''upgrading from MediaWiki 1.5 or newer''' to '''1.35''', you can upgrade in one step.</translate>
<translate> The vast majority of reports, as well as automated testing, indicated that doing it in one step works just fine.</translate>
<translate> If you have trouble believing this, read [[<tvar name=mail>mailarchive:mediawiki-l/2008-October/028975.html</tvar>|this mailing list post]].</translate>
<translate> However, please note that when you update from old versions, chances that you will encounter PHP errors are bigger than when you upgrade from the version directly previous to the new version.</translate>
<translate> You would have received these errors anyway, had you not skipped versions, but the errors would have been associated with each individual update.</translate>
<translate> Instead, if you update several versions at once, you'll get the same set of errors all at the same time.</translate>
<translate> This will make the upgrade more difficult, but do not forget that you did not have the trouble of updating to the intermediate versions, which you skipped!</translate>

<translate> If you are '''upgrading to MediaWiki 1.36''' or later, only upgrades from the last two LTS releases are supported (<tvar name=1>[[phab:T259771]]</tvar>).</translate>
<translate> This will mean that for very old versions, that you first upgrade to MediaWiki 1.35 and then upgrade to 1.43, and then (if you want to upgrade to a non-LTS version) upgrade to <tvar name=1></tvar>.</translate>

<translate>
===Should I back up first?=== 


Short answer: Yes.


Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration.
</translate>

<translate> An upgrade failure may leave your database in an inconsistent state, in between two versions.</translate>
<translate> A PHP or MySQL error might happen during upgrade leaving your database partly upgraded.</translate>
<translate> In such situations it may be possible to somehow fix this problem with much manual work.</translate>
<translate> However, it will be ''way easier'' to just put a database backup from before running update.php in place and to continue with that.</translate>
<translate> Otherwise you might have hours of - needless - work.</translate>

<translate> Recovery is often complex.</translate>
<translate> Volunteers on the support forums are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption.</translate>
<translate> A better outcome is if you can revert to your backup, and then [[<tvar name=1>phab:maniphest/task/create/</tvar>|report the bug against the corresponding MediaWiki project]] in the upgrade process which caused the corruption.</translate>

<translate>
===Can I keep my <tvar name=1><code>LocalSettings.php</code></tvar>?=== 
</translate>
<translate> Yes, but you may have to make some minor changes. The format of <tvar name=1></tvar> is largely backward compatible.</translate>
<translate> Changes which break <tvar name=1>LocalSettings.php</tvar> compatibility will be documented in the "configuration changes" section of the [[<tvar name=2>Special:MyLanguage/Release notes</tvar>|release notes]].</translate>

<translate>
===Can my wiki stay online while it is upgrading?=== 


Generally yes, however if you upgrade via Git, Git may temporarily (for a few seconds) break it.


If you are upgrading between minor releases of MediaWiki, all you need to do is update the source files.


Note: the following assumes you have command line access. If you are upgrading between major releases of MediaWiki, the preferred procedure is as follows:
</translate>

# <translate> Unpack the new version of MediaWiki into a new directory</translate>
# <translate> Prepare that new directory: copy your current <tvar name=1><code>LocalSettings.php</code></tvar> from the old directory, copy any installed extensions and custom skins (if any).</translate> <translate> Check <tvar name=1></tvar> and <tvar name=2></tvar> settings in <tvar name=3><code>LocalSettings.php</code></tvar> and if necessary copy logo file from the old directory to the new directory.</translate>
# <translate> In the release notes for the new version, see if any changes need to be made to <tvar name=1><code>LocalSettings.php</code></tvar>.</translate>
# <translate> In the old directory, edit <tvar name=1>LocalSettings.php</tvar> and insert the following code.</translate> <translate> This will place the database in read-only mode for regular wiki activity, without restricting your own update actions.</translate> <translate> Users will see the message provided if they attempt an edit during the upgrade process:</translate><br /><div class="mw-highlight mw-highlight-lang-php"><div class="mw-code">$adminTask = ( === || ( ) );<br /> = $adminTask ? : '|class=s1}};</div></div>
# <translate> Run the [[<tvar name=upg>Special:MyLanguage/Manual:Upgrading#Command_line_2</tvar>|update script]] or the web updater in the new directory.</translate>
# <translate> Copy the images from the images sub-directory from the old directory to the new directory.</translate>
# <translate> Swap the old directory and the new directory.</translate> <translate> (This will make the database writable again, because <tvar name=1></tvar> was only set in the old directory's <tvar name=2>LocalSettings.php</tvar>.)</translate>

<translate>
===Why upgrade?=== 
</translate>
:''<translate> Subscribe to <tvar name=announce>[[mail:mediawiki-announce|mediawiki-announce]]</tvar> to be notified of new releases.</translate>''

<translate>

Recent releases receive security fixes to keep your wiki and your host safe from vandals, while old releases don't (see <tvar name=lifecycle></tvar>).


New major releases come with new features, which you might want to use: see the [[<tvar name=1>Special:MyLanguage/Release notes</tvar>|release notes]] for details.
</translate>
<section end=FAQ />

<translate>
== See also == 


* Greg Sabino Mullane's Blog post provides some [<tvar name=sabino>https://www.endpointdev.com/blog/2014/10/mediawiki-minor-upgrade-with-patches/</tvar> more detail about point release upgrades].</translate>
<translate>

* [[<tvar name=1>Special:MyLanguage/Communication</tvar>|Help and Support]] if you need help or something went wrong
</translate>
*
*
*
*
* – <translate> if you don't have a successful backup</translate>
*

[[Category:MediaWiki administration|MediaWiki administration]]
[[Category:MediaWiki for site admins]]
[[Category:MediaWiki development|Upgrading to *]]
[[Category:Upgrading|Upgrading to *]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Upgrading]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Config script

2026-07-25T17:02:09Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate> After downloading and extracting MediaWiki on your web server, complete the basic setup by running the configuration script. This script allows you to tell MediaWiki the information it needs in order to get the wiki up and running.</translate>
<translate> The following steps describe how to complete basic setup:</translate>

<translate>
== Running the MediaWiki configuration script in the web browser == 
</translate>
[[File:MediaWiki_1.38.2_Config_script_2.png|thumb||left|right}}|250px|<translate> MediaWiki 1.38 web installer</translate>]]
<translate> In the following examples, it is assumed that your website is located at <tvar name=1><code><nowiki>http://www.example.com/</nowiki></code></tvar>.</translate>
<translate> The physical location on your server depends on your web server software configuration.</translate>
<translate> Adjust the examples as needed.</translate>

# <translate> Open a web browser and browse to the website address or path that you configured for MediaWiki in the web server software.</translate>
# <translate> You will see the version of MediaWiki which you extracted and a link to "Please set up the wiki first."</translate> <translate> Click on the link to begin the configuration script.</translate><br/><translate> For reference (in case you want to go there directly), this is located in MediaWiki's <tvar name=1><code>mw-config</code></tvar> directory (so using the example above you would go to <tvar name=2><code><nowiki>http://www.example.com/mw-config/</nowiki></code></tvar>, or on a local machine <tvar name=localhost><code><nowiki>http://localhost/mw-config/</nowiki></code></tvar>).</translate>
# <translate> After selecting the language, the configuration script performs some environmental checks.</translate>
# <translate> Follow the instructions on the pages to connect to the database, create the MediaWiki administrator account, and to set further settings such as the logo or skin.</translate></code></tvar> stores the database user's ''password in plain text'', it is strongly suggested that you create a wiki specific database account (i.e. not root).</translate>}}
# <translate> The script will populate the database and write a configuration file.</translate>
# <translate> After the configuration script has finished, download the generated configuration file <tvar name=1><code></code></tvar> and place the file in the base directory of your MediaWiki installation.</translate>
<translate> <tvar name=1><code></code></tvar> contains all the information needed by MediaWiki to run.</translate>
{{Note|type=warning|1=<translate> Set stringent file permissions which system users can read and write the <tvar name=1><code>LocalSettings.php</code></tvar> file.</translate><br/><translate> For example, set <code>[[w:chmod|chmod 600]]</code> and <code>[[w:chown|chown]] <webserver owner></code> (Owner read and write, no other permissions).</translate>}}

<translate>

Your wiki should now be ready to use. Browse to the address that you installed MediaWiki to.


Continue with more advanced configuration on <tvar name=1></tvar>.

== Command-line alternative == 


Alternatively, you can run a command-line installer instead of the configuration script in the web browser.


There are several installers available which you can use based on your needs:
</translate>

* <code>php ./maintenance/run.php </code> – <translate> Creates a new <tvar name=1><code>LocalSettings.php</code></tvar> using CLI parameters.</translate>
* <code>php ./maintenance/run.php </code> – <translate> Uses an existing <tvar name=1><code>LocalSettings.php</code></tvar> file to retrieve configuration.</translate> <translate> Useful for wiki farms and docker setups.</translate>

[[Category:Installation|Installation]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Config_script]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Manual/Installation guide

2026-07-25T17:02:09Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

#REDIRECT [[Manual:Installing MediaWiki]]

----
''Sample content adapted from [[mediawikiwiki:Manual:Installation_guide]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Searching

2026-07-25T17:02:08Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

</tvar>.</translate>}}
<translate>

The quickest way to find information in <tvar name=1></tvar> is to look it up directly. On every page there is a '''<tvar name=search>}}</tvar>''' box.
</translate>

<translate> Enter keywords and phrases and press ''Enter'' or ''Return'' or click the magnifying glass icon (or Search or Go button when using other skins).</translate>
<translate> If a page has the same title as what you entered, you jump straight to that page.</translate>
<translate> Otherwise, it searches all pages on the wiki (with some restrictions, see below), and presents a list of articles that matched your search terms, or a message informing you that no page has all the key words and phrases.</translate>

<translate>
== How it works == 


* It searches all pages on the wiki with some restrictions.</translate>
<translate>

* The article content is searched in its raw (wikitext) form - i.e., it searches the text that appears in the edit box when you click "<tvar name=edit>}}</tvar>", not the rendered page.</translate> <translate> This means that content coming from an included template will not be picked up, but the target of piped links will be.</translate>
<translate>

* The search functionality can be considered to operate on '''whole words''', separated by spaces or other punctuation marks.</translate> <translate> So if your search term includes the word 'book', the results will not include pages that only have the word 'books' or 'booklet'.</translate> <translate> And if your search term includes the term 'inter', the results will not include pages that only have the word 'international', but they may include pages that have the term 'inter-national'.</translate>
<translate>

* The results will only include pages that contain '''all''' the words in your search.</translate>
* <translate> You can search for all words that begin with a prefix by adding <tvar name=1><code>*</code></tvar> at the end of a word in your query.</translate> <translate> For example, <tvar name=1><code>book*</code></tvar> will return results for <tvar name=2><code>book</code></tvar> and <tvar name=3><code>book'''s'''</code></tvar>.</translate>
<translate>

* You can search for a phrase using double quotes.</translate> <translate> A phrase can be considered to consist of '''whole words''', so the phrase 'Prime Minister' will '''not''' be found by a search for "ime Min", but it '''will''' be found by a search for "Prime Minister".</translate>

<translate>
== Restricting the search == 


If you click the <tvar name=search><code></code></tvar> button without filling in anything, you will be taken to <tvar name=1><code>Special:Search</code></tvar> which gives you extra searching options (also available from any search results list).


You may find it useful to restrict a search to pages within a particular [[<tvar name=help-ns>Special:MyLanguage/Help:Namespaces</tvar>|namespace]] e.g., only search within the <tvar name=ns2></tvar> pages. Check the namespaces you require for this search.

== See also == 
</translate>
*
*
*
*
* <translate> Alternative backends:</translate>
**
*

__NOTOC__

[[Category:Help|Searching]]
[[Category:Search|Searching]]

----
''Sample content adapted from [[mediawikiwiki:Help:Searching]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Watchlist

2026-07-25T17:02:08Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />

<translate> Your '''watchlist''' is a display for [[<tvar name=1>Special:MyLanguage/Help:Tracking changes</tvar>|tracking changes]], similar to the <tvar name=rc>}}</tvar> display, but limited to showing changes only across your set of "watched" pages.</translate>
<translate> You can see your watchlist by following the "<tvar name=watchlist>''''</tvar>" link in your account menu (on the top right).</translate>
<translate> This feature is only available to users who have registered and logged in.</translate>

<translate>
== Add pages to watchlist == 
</translate>
<translate> Before you see anything interesting here, you have to actually add some pages to your watchlist.</translate>
<translate> Do so by navigating to a page that interests you, and click the star icon <tvar name=star>[[File:OOjs_UI_icon_star.svg|16px|link=|class=skin-invert|]]</tvar> (or the <tvar name=watch><code></code></tvar> tab).</translate>

<translate>

A page already in your watchlist will be marked with a star <tvar name=star>[[File:OOjs_UI_icon_unStar.svg|16px|link=|class=skin-invert|]]</tvar> (or an <tvar name=watch><code></code></tvar> tab).


If you want to remove pages from your watchlist, click on the star icon <tvar name=star>[[File:OOjs_UI_icon_unStar.svg|16px|link=|class=skin-invert|]]</tvar> (or the <tvar name=watch><code></code></tvar> tab).

=== Watchlist expiry === 
</translate>
<translate> You can optionally select to watch a page for a temporary period of time.</translate>
<translate> Once the watch period has expired, the page will be automatically removed from your watchlist.</translate>
<translate> You can update the watch period at any time, including switching from temporary to permanent status.</translate>
<translate> Temporarily watched pages are usually represented by a half star (as opposed to a full star, which represents permanently watched pages).</translate>
<translate> For documentation on how to use the feature, please visit <tvar name=1></tvar>.</translate>

<translate>
== Why a watchlist == 
</translate>
<translate> The watchlist feature is mainly useful on a very busy wiki where the <tvar name=rc><code></code></tvar> display becomes too overwhelming with many changes you don't want to follow.</translate>
<translate> On a typical low traffic wiki, you can normally see all of the editing activity across the whole wiki without feeling overwhelmed.</translate>
<translate> On a more busy wiki you will find that many edits are taking place on pages which you personally find less interesting.</translate>
<translate> To help track changes which are more interesting, start !</translate>

<translate> Typically you would watch pages related to your interest areas, and also pages where you care most about the content.</translate>
<translate> If you make a significant edit to a page, you might want to watch the page (so you know when there are any follow-up edits).</translate>
<translate> Note that there is a also a checkbox on the edit screen ("<tvar name=watch>''''</tvar>") for this purpose.</translate>

<translate> Your watchlist is personal.</translate>
<translate> You can watch any page you want.</translate>
<translate> That choice will remain private.</translate>

<translate>
== Use your watchlist == 
</translate>
<translate> On the watchlist page, some page names appear in bold.</translate>
<translate> This indicates whether or not you have visited the page to see the change.</translate>
<translate> It's a bit like read/unread emails in an email inbox.</translate>
<translate> The <tvar name=rc></tvar> page will also have some new bold highlighting, but for a different reason.</translate>
<translate> Here bold is indicating edits to pages on your watchlist.</translate>

<translate>

[[<tvar name=1>Special:MyLanguage/Help:New_filters_for_edit_review</tvar>|You can combine different kinds of filters]] to display the results you want.
</translate>

<translate> To improve the filtering, you can also add private labels to your watchlist pages.</translate>
<translate> See <tvar name=1></tvar> for more information about this feature.</translate>

<translate>
== Email notifications == 
</translate>
<translate> According to the relevant <tvar name=1></tvar>, changes to pages you watch may also be notified to you by email.</translate>
<translate> The main preference for this is <tvar name=1><code></code></tvar>.</translate>

<translate>

After receiving an email notification for a page, you have to visit the page while logged in if you want to be notified of further changes to the same page.
</translate>


<translate>
==Watchlist feed with token== 


You can set up an RSS or Atom feed of your watchlist that is accessible even when logged out:</translate>

<translate>

* Get your watchlist token from <tvar name=2>[[Special:Preferences#mw-prefsection-watchlist-tokenwatchlist]]</tvar></translate>
<translate>

* Your watchlist RSS feed can be found at <tvar name=url><span class="plainlinks">https:/api.php?action=feedwatchlist&wlowner=USERNAME&wltoken=TOKEN</span></tvar>, where USERNAME is your username without the ''User:'' prefix and TOKEN is the watchlist token.</translate>
<translate>

* If you would prefer an Atom feed rather than an RSS one, add "<tvar name=1><code>&feedformat=atom</code></tvar>" to the URL of your feed.</translate>
<translate>

* To further customise your watchlist feed add different parameters to the URL, see <tvar name=1></tvar>.

== See also == 
</translate>
*
* <translate> [[w:Wikipedia:Syndication|Wikipedia:Syndication]] - about RSS and Atom feeds</translate>

[[Category:Help|Watchlist]]
[[Category:Watchlist]]

----
''Sample content adapted from [[mediawikiwiki:Help:Watchlist]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Tables

2026-07-25T17:02:07Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

:<translate> ''Tables'' redirects here; for information about database table structure, see <tvar name=1></tvar>.</translate>

<translate> '''Tables''' may be created in wiki pages.</translate>
<translate> As a general rule, it is best to avoid using a table unless you need one.</translate>
<translate> Table markup often complicates page editing.</translate><ref>
<translate> Tables can be created using either HTML table elements directly, or using wikicode formatting to define the table.</translate>
<translate> HTML table elements and their use are well described on various web pages and will not be discussed here.</translate>
<translate> The benefit of wikicode is that the table is constructed of character symbols which tend to make it easier to perceive the table structure in the article editing view compared to HTML table elements.</translate>
</ref>

<translate>
== Wiki table markup summary == 
</translate>
{| class="wikitable" style="width:60%"
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>{|</nowiki>
|style="padding:5px"| <translate> '''table start''', ''required''</translate>
|-
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>|+</nowiki>
|style="padding:5px"| <translate> table '''caption''', ''optional;'' only between '''table start''' and '''table row'''</translate>
|-
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>|-</nowiki>
|style="padding:5px"| <translate> '''table row''', ''optional on first row''—wiki engine assumes the first row</translate>
|-
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>!</nowiki>
|style="padding:5px"| <translate> '''table header''' cell, ''optional.''</translate> <translate> Consecutive '''table header''' cells may be added on same line separated by double marks (<code>!!</code>) or start on new lines, each with its own single mark (<code>!</code>).</translate>
|-
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>|</nowiki>
|style="padding:5px"| <translate> '''table data''' cell, ''optional''.</translate> <translate> Consecutive '''table data''' cells may be added on same line separated by double marks (<code><nowiki>||</nowiki></code>) or start on new lines, each with its own single mark (<code><nowiki>|</nowiki></code>).</translate>
|-
|style="padding:10px; white-space:nowrap; font-size:large"| <nowiki>|}</nowiki>
|style="padding:5px"| <translate> '''table end''', ''required''</translate>
|}

* <translate> The above marks must '''start on a new line''' except the double <tvar name=1><code>||</code></tvar> and <tvar name=2><code>!!</code></tvar> for optionally adding consecutive cells to a line. However, blank spaces at the beginning of a line are ignored.</translate>
*'''<translate> HTML attributes.</translate>''' <translate> Each mark, except table end, optionally accepts one or more HTML attributes.</translate> <translate> Attributes must be on the same line as the mark.</translate> <translate> Separate attributes from each other with a single space.</translate>
** <translate> Cells and caption (<tvar name=1><code>|</code></tvar> or <tvar name=2><code>||</code></tvar>, <tvar name=3><code>!</code></tvar> or <tvar name=4><code>!!</code></tvar>, and <tvar name=5><code>|+</code></tvar>) hold content.</translate> <translate> So separate any attributes from content with a single pipe (<code>|</code>).</translate> <translate> Cell content may follow on same line or on following lines.</translate>
** <translate> Table and row marks (<tvar name=1><code><nowiki>{|</nowiki></code></tvar> and <tvar name=2><code>|-</code></tvar>) do not directly hold content.</translate> <translate> Do ''not'' add pipe (<code>|</code>) after their optional attributes.</translate> <translate> If you erroneously add a pipe after attributes for the table mark or row mark the parser will delete it ''and'' your final attribute if it was touching the erroneous pipe!</translate>
* <translate> '''Content''' may (a) follow its cell mark on the same line after any optional HTML attributes or (b) on lines below the cell mark.</translate> <translate> Content that uses wiki markup that itself needs to start on a new line, such as lists, headings, or nested tables, must be on its own new line.</translate>
** <translate> '''Pipe character as content.'''</translate> <translate> To insert a pipe (<tvar name=1><code>|</code></tvar>) character into a table, use the <tvar name=2><syntaxhighlight lang=html inline><nowiki>|</nowiki></syntaxhighlight></tvar> escaping markup.</translate>

<translate>

==Basics== 

=== Create a table with editor toolbar === 
</translate>
<translate> In wikitext editor, place the caret where you want to insert a table.</translate>
<translate> Then, in the toolbar, press <tvar name=1><code></code></tvar>, then choose <tvar name=2><span style="white-space: nowrap;">[[File:OOjs UI icon table.svg|class=skin-invert-image]] </span></tvar> button.</translate>
<translate> A dialog opens.</translate>

<translate> From the dialog, you can choose whether to enable a table header row, to stylize the table with border and to make the table [[<tvar name=1>Special:MyLanguage/Help:Sortable tables</tvar>|sortable]].</translate>
<translate> A preview example is displayed.</translate>
<translate> You can also set row and column counts you need. Then, press <tvar name=1><code></code></tvar> button.</translate>

<translate>

By default, the following code is generated:
</translate>
<div style="display:flex">
<div style="width:45%; border:1px solid black; padding:0.5em">
<h5 style="text-align:center"><translate> Wikicode:</translate></h5>
{<nowiki/>| class="wikitable" style="margin:auto"
|+
|-
! !! !!
|-
| || ||
|-
| || ||
|-
| || ||
|}
</div>
<div style="width:45%; border:1px solid black; padding:0.5em; margin-left:2ex">
<h5 style="text-align:center; margin-bottom:1em"><translate> Result:</translate></h5>
{| class="wikitable" style="margin:auto"
|+
|-
! !! !!
|-
| || ||
|-
| || ||
|-
| || ||
|}
</div>
</div>

<translate>
=== Minimal syntax === 


The following table lacks borders and good spacing but shows the simplest wiki markup table structure.
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
|style="padding:5px"|
<pre>
{|
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}
</pre>
|style="padding:5px"|
{|
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}
|}

<translate> The cells in the same row can be listed on one line separated by <code>||</code> (two pipe symbols).</translate>
<translate> If the text in the cell should contain a line break, use <tvar name=br></tvar> instead.</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
|style="padding:5px"|
<pre>
{|
| <translate nowrap> Orange</translate> || <translate nowrap> Apple</translate> || <translate nowrap> more</translate>
|-
| <translate nowrap> Bread</translate> || <translate nowrap> Pie</translate> || <translate nowrap> more</translate>
|-
| <translate nowrap> Butter</translate> || <translate nowrap> Ice<br/>cream</translate> || <translate nowrap> and<br/>more</translate>
|}
</pre>
|style="padding:5px"|
{|
| <translate> Orange</translate> || <translate> Apple</translate> || <translate> more</translate>
|-
| <translate> Bread</translate> || <translate> Pie</translate> || <translate> more</translate>
|-
| <translate> Butter</translate> || <translate> Ice<br/>cream</translate> || <translate> and<br/>more</translate>
|}
|}

<translate>

Extra spaces within cells in the wiki markup, as in the wiki markup below, do not affect the actual table rendering.
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{|
| <translate nowrap> Orange</translate> || <translate nowrap> Apple</translate> || <translate nowrap> more</translate>
|-
| <translate nowrap> Bread</translate> || <translate nowrap> Pie</translate> || <translate nowrap> more</translate>
|-
| <translate nowrap> Butter</translate> || <translate nowrap> Ice cream</translate> || <translate nowrap> and more</translate>
|}
</pre>
| style="padding: 5px;"|
{|
| <translate> Orange</translate> || <translate> Apple</translate> || <translate> more</translate>
|-
| <translate> Bread</translate> || <translate> Pie</translate> || <translate> more</translate>
|-
| <translate> Butter</translate> || <translate> Ice cream</translate> || <translate> and more</translate>
|}
|}

<translate>

You can have longer text or more complex wiki syntax inside table cells, too:
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{|
|Lorem ipsum dolor sit amet,
consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt
ut labore et dolore magna aliquyam erat,
sed diam voluptua.

At vero eos et accusam et justo duo dolores
et ea rebum. Stet clita kasd gubergren,
no sea takimata sanctus est Lorem ipsum
dolor sit amet.
|
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
</pre>
| style="padding: 5px;"|
{|
|Lorem ipsum dolor sit amet,
consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt
ut labore et dolore magna aliquyam erat,
sed diam voluptua.

At vero eos et accusam et justo duo dolores
et ea rebum. Stet clita kasd gubergren,
no sea takimata sanctus est Lorem ipsum
dolor sit amet.
|
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
|}

<translate>
=== Table headers === 
</translate>
<translate> Table headers can be created by using "<tvar name="1"><code>!</code></tvar>" (exclamation mark) instead of "<tvar name="2"><code>|</code></tvar>" (pipe symbol).</translate>
<translate> Headers usually show up bold and centered by default.</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{|
!style="text-align:left"| <translate nowrap> Item</translate>
! <translate nowrap> Amount</translate>
! <translate nowrap> Cost</translate>
|-
| <translate nowrap> Orange</translate>
|10
|7.00
|-
| <translate nowrap> Bread</translate>
|4
|3.00
|-
| <translate nowrap> Butter</translate>
|1
|5.00
|-
! <translate nowrap> Total</translate>
|
|15.00
|}
</pre>
| style="padding: 5px;"|
{|
! style="text-align:left;"| <translate> Item</translate>
! <translate> Amount</translate>
! <translate> Cost</translate>
|-
| <translate> Orange</translate>
|10
|7.00
|-
| <translate> Bread</translate>
|4
|3.00
|-
| <translate> Butter</translate>
|1
|5.00
|-
! <translate> Total</translate>
|
|15.00
|}
|}

{{note|1=<translate> When using attributes as in the heading 'Item' a vertical bar '<tvar name=1><nowiki>|</nowiki></tvar>' is used for separation.</translate> <translate> Not an exclamation character '!'.</translate>}}

<translate>
===Caption=== 


A '''table caption''' can be added to the top of any table as follows.
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{|
|+<translate nowrap> Food complements</translate>
|-
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}
</pre>
| style="padding: 5px;"|
{|
|+ <translate> Food complements</translate>
|-
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}
|}

=== class="wikitable" ===
<translate>

Basic styling (light gray background, borders, padding and align left) can be achieved by adding class="wikitable".
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
|+<translate nowrap> Food complements</translate>
|-
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
|+ <translate> Food complements</translate>
|-
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}
|}

<translate>
===HTML colspan and rowspan=== 


You can use HTML '''colspan''' and '''rowspan''' attributes on cells for advanced layout.
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
!colspan="6"| <translate nowrap> Shopping List</translate>
|-
|rowspan="2"| <translate nowrap> Bread & Butter</translate>
| <translate nowrap> Pie</translate>
| <translate nowrap> Buns</translate>
| <translate nowrap> Danish</translate>
|colspan="2"| <translate nowrap> Croissant</translate>
|-
| <translate nowrap> Cheese</translate>
|colspan="2"| <translate nowrap> Ice cream</translate>
| <translate nowrap> Butter</translate>
| <translate nowrap> Yogurt</translate>
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
!colspan="6"| <translate> Shopping List</translate>
|-
|rowspan="2"| <translate> Bread & Butter</translate>
| <translate> Pie</translate>
| <translate> Buns</translate>
| <translate> Danish</translate>
|colspan="2"| <translate> Croissant</translate>
|-
| <translate> Cheese</translate>
|colspan="2"| <translate> Ice cream</translate>
| <translate> Butter</translate>
| <translate> Yogurt</translate>
|}
|}

<translate>
=== Note about large tables (noresize class) === 
</translate>
<translate> The use of the wrapping <tvar name=1><code>div.noresize</code></tvar> will ensure your table is optimized for mobile and is extremely important for large tables e.g. tables with more than 4 columns or large columns.</translate>
<translate> Failure to use this element will cause your content to overlap UI elements e.g. the Vector 2022 sidebar or to break mobile display.</translate>
<translate> This will cause the table to have a horizontal scroll bar when the table is too big for the content.</translate>

<translate>

You type:
</translate>

<pre>
<div class="noresize">
{| class="wikitable"
! colspan="6" |Shopping List
|-
| rowspan="2" |Areallyreallyreallyreallylongstringwillcauseyourtableto
| Pie
| Buns
| Danish
| colspan="2" |Croissantsmaycausetexttoincreasethesizeofyourcolumnsoitbreaksoutofthecontent area if you do not wrap the table with noresize.
|-
| Cheese
| colspan="2" |Ice cream
| Butter
| Yogurt
|}
</div>
</pre>

<translate>

You get:</translate>
<div class="noresize">
{| class="wikitable"
! colspan="6" |Shopping List
|-
| rowspan="2" |Areallyreallyreallyreallylongstringwillcauseyourtableto
| Pie
| Buns
| Danish
| colspan="2" |Croissantsmaycausetexttoincreasethesizeofyourcolumnsoitbreaksoutofthecontent area if you do not wrap the table with noresize.
|-
| Cheese
| colspan="2" |Ice cream
| Butter
| Yogurt
|}
</div>

<translate>
== HTML attributes == 
</translate>
<translate> You can add '''HTML attributes''' to tables.</translate>
<translate> For the authoritative source on HTML attributes, see [<tvar name=url>https://www.w3.org/TR/html401/struct/tables.html</tvar> the W3C's HTML Specification page on tables].</translate>

<translate>
=== Attributes on tables === 


Placing attributes after the table start tag (<tvar name="1"><code>{|</code></tvar>) applies attributes to the entire table.</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable" style="text-align: center; color: green;"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|12,333.00
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|500.00
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|1.00
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable" style="text-align: center; color: green;"
| <translate> Orange</translate>
| <translate> Apple</translate>
|12,333.00
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|500.00
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|1.00
|}
|}

<translate>
=== Attributes on cells === 
</translate>
<translate> You can put attributes on individual '''cells'''.</translate>
<translate> For example, numbers may look better aligned right.</translate>

{| style="width:100%"
! style="width: 50%;"| <translate> You type</translate>
! style="width: 50%;"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
| style="text-align:right;" | 12,333.00
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
| style="text-align:right;" | 500.00
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
| style="text-align:right;" | 1.00
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
| <translate> Orange</translate>
| <translate> Apple</translate>
| style="text-align:right;" | 12,333.00
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
| style="text-align:right;" | 500.00
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
| style="text-align:right;" | 1.00
|}
|}

<translate> You can also use '''cell''' attributes when you are listing multiple '''cells''' on a single line.</translate>
<translate> Note that the '''cells''' are separated by <tvar name="1"><code>||</code></tvar>, and within each '''cell''' the attribute(s) and value are separated by <tvar name="2"><code>|</code></tvar>.</translate>

{| style="width:100%"
! style="width: 50%;"| <translate> You type</translate>
! style="width: 50%;"| <translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
| <translate nowrap> Orange</translate> || <translate nowrap> Apple</translate> || style="text-align:right;" | 12,333.00
|-
| <translate nowrap> Bread</translate> || <translate nowrap> Pie</translate> || style="text-align:right;" | 500.00
|-
| <translate nowrap> Butter</translate> || <translate nowrap> Ice cream</translate> || style="text-align:right;" | 1.00
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
| <translate> Orange</translate> || <translate> Apple</translate> || style="text-align:right;" | 12,333.00
|-
| <translate> Bread</translate> || <translate> Pie</translate> || style="text-align:right;" | 500.00
|-
| <translate> Butter</translate> || <translate> Ice cream</translate> || style="text-align:right;" | 1.00
|}
|}

<translate>
===Attributes on rows=== 


You can put attributes on individual '''rows''', too.
</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
| style="text-align:right;"| 12,333.00
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
| style="text-align:right;"| 500.00
|- style="font-style: italic; color: green;"
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
| style="text-align:right;"| 1.00
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
| <translate> Orange</translate>
| <translate> Apple</translate>
| style="text-align:right;"| 12,333.00
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
| style="text-align:right;"| 500.00
|- style="font-style: italic; color: green;"
| <translate> Butter</translate>
| <translate> Ice cream</translate>
| style="text-align:right;"| 1.00
|}
|}

<translate>
===Attributes on caption and headers=== 


Attributes can be added to the caption and headers as follows.
</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
|+ style="caption-side:bottom; color:#e76700;"|<translate nowrap> ''Food complements''</translate>
|-
!style="color:green"| <translate nowrap> Fruits</translate>
!style="color:red"| <translate nowrap> Fats</translate>
|-
| <translate nowrap> Orange</translate>
| <translate nowrap> Butter</translate>
|-
| <translate nowrap> Pear</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Apple</translate>
| <translate nowrap> Ice cream</translate>
|}
</pre>
|style="padding:5px"|
{| class="wikitable"
|+ style="caption-side:bottom; color:#e76700;"|<translate> ''Food complements''</translate>
|-
!style="color:green"| <translate> Fruits</translate>
!style="color:red"| <translate> Fats</translate>
|-
| <translate> Orange</translate>
| <translate> Butter</translate>
|-
| <translate> Pear</translate>
| <translate> Pie</translate>
|-
| <translate> Apple</translate>
| <translate> Ice cream</translate>
|}
|}

<translate>
===Border width=== 


If "border-width:" has only one number, it is for all four border sides:
</translate>

{| style="width:100%"
|-
! style="width:50%" | <translate> You type</translate>
! style="width:50%" | <translate> You get</translate>
|-
| style="padding: 5px;" |
<pre>
{|style="border-style: solid; border-width: 20px"
|
<translate nowrap> Hello</translate>
|}
</pre>
| style="padding: 20px;"|
{|style="border-style: solid; border-width: 20px"
|
<translate> Hello</translate>
|}
|}

<translate>

If "border-width:" has more than one number, the four numbers are for '''top, right, bottom, left (REMEMBER clockwise order <tvar name=clockwise>↑→↓←</tvar>)''':
</translate>

{| style="width:100%"
|-
! style="width:50%" | <translate> You type</translate>
! style="width:50%" | <translate> You get</translate>
|-
| style="padding: 5px;" |
<pre>
{|style="border-style: solid; border-width: 10px 20px 100px 0"
|
<translate nowrap> Hello</translate>
|}
</pre>
| style="padding: 20px;"|
{|style="border-style: solid; border-width: 10px 20px 100px 0"
|
<translate> Hello</translate>
|}
|}

<translate>

:When there are fewer than 4 values :
</translate>
:* <translate> three values i.e. <tvar name=3val><code>top</code>, <code>right</code>, <code>bottom</code></tvar>: then the default value for <tvar name=left><code>left</code></tvar> is the one of <tvar name=right><code>right</code></tvar> (second value). Width is then the same on left and right side.</translate>
:* <translate> two values i.e. <tvar name=2val><code>top</code>, <code>right</code></tvar>: then the default value for <tvar name=bottom><code>bottom</code></tvar> is the one of <tvar name=top><code>top</code></tvar> (first value), and <tvar name=left><code>left</code></tvar> by default is assigned the value of <tvar name=right><code>right</code></tvar> (second value). Width on top is then the same as on bottom; width on left is the same as on right.</translate>
:* <translate> one value i.e. <tvar name=1val><code>top</code></tvar>: then the default value for <tvar name=right><code>right</code></tvar> is the one of <tvar name=top><code>top</code></tvar> and it is the same for <tvar name=bottom><code>bottom</code></tvar> and <tvar name=left><code>left</code></tvar>. The fourth width are the same and build a regular border. This is a writing shortcut.</translate>

<translate>

Another method to define the widths of the four sides of a cell is to use ''"border-left", "border-right", "border-top" and "border-bottom"'':
</translate>
<div style="width: 100%; overflow:auto;">
{| style="width:100%"
|-
! style="width:50%" | <translate> You type</translate>
! style="width:50%" | <translate> You get</translate>
|-
| style="padding: 5px;" |
<pre>
{|style="border-left:solid 10px black;border-right:solid 20px black;border-top:solid 30px black;border-bottom:solid 40px black; margin:auto"
|
<translate nowrap> Hello</translate>
|}
</pre>
| style="padding: 20px;"|
{|style="border-left:solid 10px black;border-right:solid 20px black;border-top:solid 30px black;border-bottom:solid 40px black; margin:auto"
|
<translate> Hello</translate>
|}
|}
</div>

{{Note|1=<nowiki/>
<translate> The HTML attributes (such as "width=", "border=", "cellspacing=", "cellpadding=") do not need any length unit (the pixel unit is assumed).</translate>
<translate> They are also invalid in HTML 5.</translate>

<translate> "Cellpadding" is for setting the space between the cell wall and the cell content.</translate><ref>
[https://developer.mozilla.org/Web/HTML/Reference/Elements/table#cellpadding HTML table cellpadding Attribute]
</ref>

<translate>

The CSS style properties (which override the HTML attributes) require an explicit length unit (if the value is not 0) such as "px" for the pixel.</translate>
}}

<translate>
===With HTML attributes and CSS styles=== 


<tvar name="1"></tvar> style attributes can be added with or without other HTML attributes.
</translate>

{| style="width:100%"
!style="width:50%"| <translate> You type</translate>
!style="width:50%"| <translate> You get</translate>
|-
|style="padding:5px"|
<pre>
{| class="wikitable" style="color:green; background-color:#ffffcc;" cellpadding="10"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}
</pre>
|style="padding:5px"|
{| class="wikitable" style="color:green; background-color:#ffffcc;" cellpadding="10"
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}
|}

<translate>
===Padding=== 
</translate>
<translate> It represents the internal margin between the contents and the border of the cell.</translate>
{| style="width:100%;"
! style="width: 50%;"| <translate> You type</translate>
! style="width: 50%;"| <translate> You get</translate>
|-style="vertical-align:top"
| style="padding:10px" |
<pre>
{|class=wikitable
| style="padding: 10px" | <translate nowrap> Example of <tvar name=1>style="padding:10px"</tvar></translate>
|-
| style="padding: 50px" | <translate nowrap> Example of <tvar name=1>style="padding:50px"</tvar></translate><br/><br/><translate nowrap> Specify the padding on '''EACH CELL'''</translate>
|-
| style="padding:100px" | <translate nowrap> Example of <tvar name=1>style="padding:100px"</tvar></translate>
|}
</pre>
|
{|class=wikitable
| style="padding: 10px" | <translate> Example of <tvar name=1>style="padding:10px"</tvar></translate>
|-
| style="padding: 50px" | <translate> Example of <tvar name=1>style="padding:50px"</tvar></translate><br/><br/><translate> Specify the padding on '''EACH CELL'''</translate>
|-
| style="padding:100px" | <translate> Example of <tvar name=1>style="padding:100px"</tvar></translate>
|}
|}

<translate>
===Column width=== 


'''Column width''' can be added as follows.


You type:
</translate>

<pre>
{| class="wikitable" style="width: 85%;"
| colspan="2" | <translate nowrap> This column width is 85% of the screen width</translate>
|-
| style="width: 30%"| <translate nowrap> '''This column is 30% counted from 85% of the screen width'''</translate>
| style="width: 70%"| <translate nowrap> '''This column is 70% counted from 85% of the screen width'''</translate>
|}
</pre>

<translate>

You get:</translate>
{| class="wikitable" style="width: 85%;"
| colspan="2" | <translate> This column width is 85% of the screen width</translate>
|-
| style="width: 30%"| <translate> '''This column is 30% counted from 85% of the screen width'''</translate>
| style="width: 70%"| <translate> '''This column is 70% counted from 85% of the screen width'''</translate>
|}

<translate>
===Accessibility of table header cells=== 
</translate>
<translate> Table header cells do not explicitly specify which table data cells they apply to (those on their right on the same row, or those below them on the same column).</translate>
<translate> When the table is rendered in a visual 2D environment, this is usually easy to infer.</translate>

<translate> However when tables are rendered on non-visual media, you can help the browser to determine which table header cell applies to the description of any selected cell (in order to repeat its content in some accessibility helper) using a scope="row" or scope="col" attribute on table header cells.</translate>
<translate> In most cases with simple tables, you'll use scope="col" on all header cells of the first row, and scope="row" on the first cell of the following rows:</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
|-
! scope="col"| <translate nowrap> Item</translate>
! scope="col"| <translate nowrap> Quantity</translate>
! scope="col"| <translate nowrap> Price</translate>
|-
! scope="row"| <translate nowrap> Bread</translate>
| 0.3 kg
| $0.65
|-
! scope="row"| <translate nowrap> Butter</translate>
| 0.125 kg
| $1.25
|-
! scope="row" colspan="2"| <translate nowrap> Total</translate>
| $1.90
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
|-
! scope="col"| <translate> Item</translate>
! scope="col"| <translate> Quantity</translate>
! scope="col"| <translate> Price</translate>
|-
! scope="row"| <translate> Bread</translate>
| 0.3 kg
| $0.65
|-
! scope="row"| <translate> Butter</translate>
| 0.125 kg
| $1.25
|-
! scope="row" colspan="2"| <translate> Total</translate>
| $1.90
|}
|}

<translate>
== Alignment == 

=== Table alignment === 
</translate>
<translate> Table alignment is achieved by using CSS.</translate>
<translate> The table alignment is controlled by margins.</translate>
<translate> A fixed margin on one side will make the table to be aligned to that side, if on the opposite side the margin is defined as ''auto''.</translate>
<translate> To have a table center aligned, you should set both margins to ''auto''</translate>

<translate>

For example, a right-aligned table:
</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable" style="margin-left: auto; margin-right: 0px;"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.
</pre>
| style="padding: 5px;"|
{| class="wikitable" style="margin-left: auto; margin-right: 0px;"
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.
|}

<translate>

And a center-aligned table:
</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable" style="margin: auto;"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.
</pre>
| style="padding: 5px;"|
{| class="wikitable" style="margin: auto;"
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.
|}

<translate>
=== Table floating around text === 
</translate>
<translate> If you align a table to the right or the left side of the page, the text that comes after the table starts at the end of it, leaving an empty space around the table.</translate>
<translate> You can make the text to be wrapped around the table by making the table to ''float'' around the text instead of just aligning it.</translate>
<translate> This can be achieved using the <tvar name="1"><code>float</code></tvar> CSS attribute, which can specify whether the table floats to the right side or to the left.</translate>
<translate> When using ''float'', margins don't control table alignment and can be used to specify the margin between the table and the surrounding text.</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable" style="float:right; margin-left: 10px;"
| <translate nowrap> Orange</translate>
| <translate nowrap> Apple</translate>
|-
| <translate nowrap> Bread</translate>
| <translate nowrap> Pie</translate>
|-
| <translate nowrap> Butter</translate>
| <translate nowrap> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat. Duis autem vel eum iriure dolor
in hendrerit in vulputate velit esse molestie consequat,
vel illum dolore eu feugiat nulla facilisis at vero
eros et accumsan et iusto odio dignissim qui blandit
praesent luptatum zzril delenit augue duis dolore te
feugait nulla facilisi.
</pre>
| style="padding: 5px;"|
{| class="wikitable" style="float:right; margin-left: 10px;"
| <translate> Orange</translate>
| <translate> Apple</translate>
|-
| <translate> Bread</translate>
| <translate> Pie</translate>
|-
| <translate> Butter</translate>
| <translate> Ice cream</translate>
|}

Lorem ipsum dolor sit amet, consectetuer adipiscing
elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi
enim ad minim veniam, quis nostrud exerci tation
ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat. Duis autem vel eum iriure dolor
in hendrerit in vulputate velit esse molestie consequat,
vel illum dolore eu feugiat nulla facilisis at vero
eros et accumsan et iusto odio dignissim qui blandit
praesent luptatum zzril delenit augue duis dolore te
feugait nulla facilisi.
|}

<translate>
=== Cell contents alignment === 
</translate>
<translate> The alignment of cell contents can be controlled with 2 different CSS properties: <tvar name="1"><code>text-align</code></tvar> and <tvar name="2"><code>vertical-align</code></tvar>.</translate>
<translate> <tvar name="1"><code>text-align</code></tvar> can be specified at the table, row or individual cells, while <tvar name="2"><code>vertical-align</code></tvar> only can be specified at individual rows or cells.</translate>

{| style="width:100%"
! style="width: 50%;"|<translate> You type</translate>
! style="width: 50%;"|<translate> You get</translate>
|-
| style="padding: 5px;"|
<pre>
{| class="wikitable"
|- style="vertical-align:top;"
| style="height:100px; width:100px; text-align:left;" | A
| style="height:100px; width:100px; text-align:center;" | B
| style="height:100px; width:100px; text-align:right;" | C
|- style="vertical-align:middle;"
| style="height:100px; width:100px; text-align:left;" | D
| style="height:100px; width:100px; text-align:center;" | E
| style="height:100px; width:100px; text-align:right;" | F
|- style="vertical-align:bottom;"
| style="height:100px; width:100px; text-align:left;" | G
| style="height:100px; width:100px; text-align:center;" | H
| style="height:100px; width:100px; text-align:right;" | I
|}
</pre>
| style="padding: 5px;"|
{| class="wikitable"
|- style="vertical-align:top;"
| style="height:100px; width:100px; text-align:left;" | A
| style="height:100px; width:100px; text-align:center;" | B
| style="height:100px; width:100px; text-align:right;" | C
|- style="vertical-align:middle;"
| style="height:100px; width:100px; text-align:left;" | D
| style="height:100px; width:100px; text-align:center;" | E
| style="height:100px; width:100px; text-align:right;" | F
|- style="vertical-align:bottom;"
| style="height:100px; width:100px; text-align:left;" | G
| style="height:100px; width:100px; text-align:center;" | H
| style="height:100px; width:100px; text-align:right;" | I
|}
|}

<translate>
==Caveats== 

===Negative numbers=== 
</translate>
<translate> If you start a cell on a new line with a negative number with a minus sign (or a parameter that evaluates to a negative number), your table can get broken, because the characters <tvar name="1"><code>|-</code></tvar> will be parsed as the wiki markup for table row, not table cell.</translate>
<translate> To avoid this, insert a space before the value (<tvar name="1"><code>| -6</code></tvar>) or use in-line cell markup (<tvar name="2"><code>|| -6</code></tvar>).</translate>

<translate>
===CSS vs attributes=== 


Table borders specified through CSS rather than the border attribute will render incorrectly in a small subset of text browsers.

===Common attributes for columns, column groups and row groups=== 
</translate>
<translate> The MediaWiki syntax for tables currently offers no support for specifying common attributes for columns (with the HTML element <tvar name=col></tvar>), column groups (HTML element <tvar name=colgroup></tvar>) and row groups (HTML elements <tvar name=thead></tvar>, <tvar name=tbody></tvar> and <tvar name=tfoot></tvar>).</translate>
<translate> Those standard HTML elements are not accepted even in their HTML or XHTML syntax.</translate>

<translate>

All the rows and cells (header or data) of the table are rendered within a single implicit row group (HTML element <tvar name=1></tvar>) without any attributes or styles.

== Tables and the Visual Editor (VE) == 
</translate>
:''<translate> See also:</translate> ''

<translate> See <tvar name=1>[[Phab: T108245]]: "Fully support basic table editing in the visual editor"</tvar>.</translate>
<translate> See the list of tasks. Finished tasks are <s>struck</s>. It can be difficult to figure out from the technical language there what exactly has been improved, or what features have been added. Please add explanatory info below.</translate>

<translate>
=== Can now move or delete columns and rows === 
</translate>
<translate> Click on a column or row header.</translate>
<translate> Then click on the arrow.</translate>
<translate> From the popup menu click on "Move" or "Delete".</translate>

<translate>
=== Insert blank row or column === 


From the same popup menu click on "Insert".

=== Copy table from web page to Visual Editor === 
</translate>
<translate> It is possible to copy and paste a table from a web page directly into the [[w:WP:Visual Editor|Visual Editor]] (VE).</translate>
<translate> To do so safely, use a sandbox and check the table for proper coding in wikitext source mode and proper display in the Visual Editor and in preview mode.</translate>

<translate>
== Helping tools == 


* [<tvar name=url>https://excel2wiki.toolforge.org/</tvar> Excel2Wiki] allows you to copy a spreadsheet from Excel, Apache OpenOffice, LibreOffice, or Gnumeric to convert it into wikicode table.

==See also== 


* [[<tvar name=1>Special:MyLanguage/Help:Sorting#Sorting rows of a table</tvar>|Sorting rows of a table]]</translate>
<translate>

* [[w:Help:Tables]]</translate>
<translate>

* [<tvar name="url">http://www.tablesgenerator.com/mediawiki_tables</tvar> A visual tool that helps generate tables]

==Notes== 
</translate>
<references/>

[[Category:Help|Tables]]

----
''Sample content adapted from [[mediawikiwiki:Help:Tables]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Images

2026-07-25T17:02:06Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate> This page explains the '''image''' syntax when editing the wiki.</translate>
<translate> You or another user must usually [[<tvar name=1>Special:MyLanguage/Help:Managing files</tvar>|upload an image]] before you can use it on a page.</translate>

<translate> Images that are stored on a MediaWiki server are usually rendered by using the <tvar name=1><code>File:</code></tvar> namespace prefix (but the legacy <tvar name=2><code>Image:</code></tvar> namespace prefix is still supported as a synonym) as the target of a MediaWiki link.</translate>
<translate> The alternate <tvar name=media><code>Media:</code></tvar> namespace prefix is also usable to reference the original media file content (for rendering or downloading it separately, out of any MediaWiki page).</translate>

<translate>
== Requisites == 
</translate>
<translate> Before using images in your page, the system administrator of your wiki must have [[<tvar name=uploads>Special:MyLanguage/Manual:Configuring file uploads</tvar>|enabled file uploads]] and a user has to [[<tvar name=managing>Special:MyLanguage/Help:Managing files</tvar>|upload the file]].</translate>
<translate> System administrators may also set the wiki to accept files from [[<tvar name=image>Special:MyLanguage/Manual:Image Administration#Foreign Repositories</tvar>|foreign repositories]], such as the [<tvar name=url>http://commons.wikimedia.org/wiki/Main_Page</tvar> Wikimedia Commons].</translate>
<translate> For server side image resizing it is necessary to have a scaler configured (such as GD2, ImageMagick, etc.).</translate>

<translate>
== Supported media types for images == 


The following file formats are supported by default:
</translate>

* <code>.jpg</code> <translate> or</translate> <code>.jpeg</code> – <translate> bitmap image compressed in the standard JPEG format (this lossy format is most suitable for photographs).</translate>
* <code>.png</code> – <translate> bitmap image in the ''[[w:Portable Network Graphics|Portable Network Graphics]]'' format (specified by the ''W3 Consortium'').</translate>
* <code>.gif</code> – <translate> bitmap image in the legacy ''Graphics Interchange Format''.</translate>
* <code>.webp</code> – <translate> [[w:WebP|WebP]] supports both lossy and lossless compression while reducing image size by up to 45%.</translate>

<translate>

Other formats used on Wikimedia, and commonly enabled elsewhere (these may require extra set-up beyond what is enabled by default):
</translate>

* <code>.svg</code> – <translate> scalable image in the ''Scalable Vector Graphics'' format (specified by the ''W3 Consortium'').</translate> <translate> See [[<tvar name=1>Special:MyLanguage/Manual:Image Administration#SVG</tvar>|Manual:Image Administration#SVG]].</translate>
* <code>.tiff</code> – <translate> Tagged image format.</translate> <translate> Often used for high-resolution archival photographs.</translate> <translate> Often used with <tvar name=1></tvar>.</translate>
* <code>.ogg</code>, <code>.oga</code>, <code>.ogv</code> – <translate> Ogg multimedia (audio or video).</translate> <translate> Not an image format, but treated similarly.</translate> <translate> Often used with <tvar name=1></tvar></translate>
* <code>.pdf</code> – <translate> multipaged documents in the ''Portable Document Format'' (initially specified by ''Adobe'').</translate> <translate> Often used in conjunction with <tvar name=1></tvar></translate>
* <code>.djvu</code> – <translate> multipaged bitmap documents in the ''DejaVu'' format (most often, scans of books).</translate> <translate> See <tvar name=1></tvar></translate>
<translate>

*: Only a single page of a <tvar name=1><code>.pdf</code></tvar> or <tvar name=2><code>.djvu</code></tvar> file is shown at one time.


Other media types may be supported, but it may not be possible to display them inline.

== Rendering a single image == 

=== Syntax === 


The full syntax for displaying an image is:
</translate>
<nowiki>[[</nowiki>File:<translate> ''filename.extension''</translate>|<translate> ''options''</translate>|<translate> ''caption''</translate><nowiki>]]</nowiki>

<translate>

where ''options'' can be empty or containing one or more of the following lower-case words, separated by pipes ('''|'''):
</translate>

* <translate> ''[[<tvar name=1>#Format</tvar>|Format]]'' option: '''border''', and one of '''frameless''', '''frame''' (or '''framed'''), or '''thumb''' (or '''thumbnail''').</translate> <translate> <tvar name=1>'''border'''</tvar> can be used in combination with <tvar name=2>'''frameless'''</tvar> but will be ignored if used with one of the other options.</translate>
*: <translate> Controls how the rendered image is formatted and embedded in the rest of the page.</translate>
* <translate> ''[[<tvar name=1>#Size and frame</tvar>|Resizing]]'' option: one of</translate>
** <translate> ''{width}'''''px''' – Resizes the image to fit within the given maximum width in pixels, without restricting its height.</translate> (<translate> Only whole-number pixel values are supported.</translate> <translate> A space character between the width value and "px" is permitted.</translate>)
** <translate> '''x'''''{height}'''''px''' – Resizes the image to fit within the given maximum height in pixels, without restricting its width.</translate> <translate> Only whole-number pixel values are supported.</translate> <translate> A space character between the height value and "px" is permitted.</translate>
** <translate> ''{width}'''''x'''''{height}'''''px''' – Resizes the image to fit within the given width and height in pixels.</translate> <translate> Only whole-number pixel values are supported.</translate> <translate> A space character between the width value and "px" is permitted.</translate>
** '''upright''' – <translate> Resizes an image to a multiple of the user's thumbnail size preferences (see <tvar name=1><code></code></tvar>) – or the default thumbnail size, for logged-out users or logged-in users who have not changed their preferences – to fit within reasonable dimensions.</translate> <translate> This option is often useful for images whose height is larger than their width.</translate> <translate> Requires either <tvar name=1>'''thumb'''</tvar> or <tvar name=2>'''frameless'''</tvar>.</translate> <translate> Setting <tvar name=1><code>|upright=1.0|</code></tvar> will display the image at the user's default image width.</translate> <translate> <tvar name=1><code>|upright=2.0|</code></tvar> will display the image at double the user's default width.</translate>
*: <translate> The image will always retain its aspect ratio.</translate>
*: <translate> Images in non-scalable media types can be reduced in size, but not increased; e.g., bitmap images cannot be scaled up.</translate>
*: <translate> The <tvar name=1><code>upright</code></tvar> setting does not require an equals sign, i.e. <tvar name=2><code>|upright 2.0|</code></tvar> works the same as <code>|upright=2.0|</code>.</translate>
*: <translate> When used without a value or an equals sign (e.g., <tvar name=1><code>|upright|</code></tvar>), defaults to <tvar name=2><code>|upright=0.75|</code></tvar> (although <tvar name=3><code>|upright=|</code></tvar> is the same as <tvar name=4><code>|upright=1.0|</code></tvar>)</translate>
*: <translate> The default maximum size depends on the ''format'' and the internal image dimensions (according to its media type).</translate>
* <translate> ''[[<tvar name=1>#Horizontal alignment</tvar>|Horizontal alignment]]'' option: one of '''left''', '''right''', '''center''', '''none'''.</translate> <translate> If multiple of these options are present, only the first one will be used</translate>
*: <translate> Controls the horizontal alignment (and inline/block or floating styles) of the image within a text (no default value).</translate>
* <translate> ''[[<tvar name=1>#Vertical alignment</tvar>|Vertical alignment]] option'': one of '''baseline''', '''sub''', '''super''', '''top''', '''text-top''', '''middle''', '''bottom''', '''text-bottom'''</translate>
*: <translate> Controls the vertical alignment of a non-floating inline image with the text before or after the image, and in the same block (the default vertical alignment is '''middle''').</translate>
* <translate> ''[[<tvar name=1>#Altering the default link target</tvar>|Link]] option'': one of</translate>
** <translate> '''<tvar name=1>link</tvar>='''''{target}'' – Allows to change the target (to an arbitrary page title, or URL) of the generated link, activable on the rendered image surface; e.g. <tvar name=code><code><nowiki>[[File:Example.jpg|20px|link=http://www.wikipedia.org]]</nowiki></code></tvar> renders as <tvar name=code2>[[File:Example.jpg|20px|link=http://www.wikipedia.org]]</tvar> (external link), or <tvar name=code3><code><nowiki>[[File:Example.jpg|20px|link=MediaWiki]]</nowiki></code></tvar> renders as <tvar name=code4>[[File:Example.jpg|20px|link=MediaWiki]]</tvar> (internal link).</translate>
** <translate> '''<tvar name=2>link</tvar>=''' (with an empty value) – (<tvar name=1>[[rev:41727|MediaWiki 1.14+]]</tvar>) Displays an image without any activable link; e.g. <tvar name=code1><code><nowiki>[[File:Example.jpg|20px|link=]]</nowiki></code></tvar> renders as <tvar name=code2>[[File:Example.jpg|20px|link=]]</tvar>.</translate>
*: <translate> If there is a space character between <tvar name=1><code>link</code></tvar> and the equals sign, the link statement will be treated as a caption.</translate>
*: <translate> Including some HTML character equivalents, like <tvar name=1><code>%22</code></tvar> for <tvar name=2><code>"</code></tvar>, can cause the link statement to be treated as a caption (see <tvar name=3>[[phabricator:T306216]]</tvar>).</translate>

*: <translate> '''!''' for MW 1.24 and lower: If you set <code>|link=|</code> (empty), then no <code>title</code> will be rendered. (See [[phabricator:T23454]].)</translate>
* <translate> Other specific options:</translate>
** <translate> '''<tvar name=2>alt</tvar>='''''{alternative text}'' – (<tvar name=1>[[rev:41837|MediaWiki 1.14+]]</tvar>) Defines the alternative text (maps to the HTML attribute <code>alt="..."</code> of the generated <tvar name=3></tvar> element) of an image that will be rendered if either the referenced image cannot be downloaded and embedded, or if the support media must use the alternative description text (e.g. when using a Braille reader or with accessibility options set by the user in its browser).</translate>
*: <translate> If there is a space character between <tvar name=1><code>alt</code></tvar> and the equals sign, the alt statement will be treated as a caption.</translate>
** '''page='''''{number}'' – <translate> Renders the specified page number (currently only applicable when showing a .djvu or .pdf file).</translate>
** '''thumbtime='''''{number}'' – <translate> Renders a thumbnail from the video at the specified timestamp in seconds or MM:SS or HH:MM:SS format (only applicable when showing a video file).</translate>
** '''start='''''{number}'' – <translate> When video playback is started it will start at the specified timestamp in seconds or MM:SS or HH:MM:SS format (only applicable when showing a video file).</translate>
** '''muted''' – <translate> When media playback is started, audio will be muted.</translate>
** '''loop''' – <translate> Media will loop continuously. (only applies to audio and video)</translate>
** '''lossy='''''{false}'' – () <translate> For using PNG instead of JPG thumbnails for Tiff images</translate>
** '''class='''''{html class}'' – (MediaWiki 1.20+) <translate> Defines classes (maps to the HTML attribute <tvar name=3><code>class="..."</code></tvar> of the generated <tvar name=1></tvar> element wrapped around the <tvar name=4></tvar> element).</translate></ref> <translate> Previously the class was applied directly to the <tvar name=1></tvar> element.</translate><ref> media option is now applied to the wrapper|<translate> The <tvar name=1>class</tvar> media option is now applied to the wrapper</translate>}}</ref>}}
** '''lang='''''{language code}'' – (MediaWiki 1.22+) <translate> For SVG files containing [http://www.w3.org/TR/SVG/struct.html#SwitchElement <switch>] statements varying on a ''systemLanguage'' attribute, selects what language to render the file in.</translate> <translate> The default is the page language (defaults to project default language on most projects).</translate>

<translate> If a parameter does not match any of the other possibilities, it is assumed to be the caption text.</translate>
<translate> If more than one non-parameter string is present, the final non-parameter string will be used as the caption.</translate>
<translate> Caption text shows below the image in '''thumb''' and '''frame''' formats, or as tooltip text in any other format.</translate>
<translate> Caption text displayed in the '''thumb''' and '''frame''' formats may contain wiki links and other formatting.</translate>
<translate> MediaWiki extensions can add additional options.</translate>

<translate>

If 'alt' is not specified and a caption is provided, the alternative text will be created automatically from the caption, stripped of formatting, except when in ''thumb'' or ''frame'' mode since the caption is already readable by screen readers in that case.

=== Thumbnail sizes === 


File thumbnails are stored in discrete sizes. If a page specifies a thumbnail size that's not among the [[<tvar name=1>Special:MyLanguage/common thumbnail sizes</tvar>|common thumbnail sizes]] (20px, 40px, 60px, 120px, 250px, 330px, 500px, 960px, 1280px, 1920px, 3840px), then MediaWiki will pick the closest larger thumbnail size but will tell the browser to downscale it to the requested size. In these cases, nothing will change visually but users might load slightly larger images. If it doesn't matter which thumbnail size is used in a page, please pick one of the standard sizes to avoid the extra in-browser down-scaling step.

=== Format === 


The following table shows the effect of all available formats.
</translate>

<div class="noresize">
{|class="wikitable plainlinks"
|-
! <translate> Description</translate>
! <translate> You type</translate>
! <translate> You get</translate>

{{Help:Images/frame|frame=frameless|ex=<translate> '''frameless''', like thumbnail, respect user preferences for image width, but without border and no right float</translate>|float=no|inline=yes|render caption=no}}

|}
</div>
<translate> When the height of an image in thumbnail is bigger than its width (i.e. in portrait orientation rather than landscape) and you find it too large, you may try the option <code>upright=N</code>, where N is the image's aspect ratio (its width divided by its height, defaulting to 0.75).</translate>
<translate> The alternative is to specify the desired maximum height (in pixels) explicitly.</translate>

<translate>

Note that by writing <code>thumb={filename}</code>, you can use a different image for the thumbnail.

=== Size and frame === 


Among different formats, the effect of the size parameter may be different, as shown below.


* For how it appears when its size is not specified, see [[<tvar name=1>#Format</tvar>|Format]] section above.</translate>
<translate>

* When the format is not specified, or only <code>border</code>ed, the size can be both reduced and enlarged to any specified size.</translate>
<translate>

* In the examples below, the original size of the image is 400×267 pixels.</translate>
<translate>

* An image with <tvar name=1><code>frame</code></tvar> always '''ignores''' the size specification; the original image will be reduced if it exceeds the maximum size defined in user preferences, and the page information will display a Linter error.</translate>
<translate>

* The size of an image with <tvar name=1><code>thumb</code></tvar> or <tvar name=2><code>frameless</code></tvar> can be reduced, but cannot be enlarged beyond the original size of the image.
</translate>

<div class="noresize">
{|class="wikitable"
|-
! <translate> Format</translate>
! <translate> Reduced</translate>
! <translate> Enlarged</translate>

|}
</div>

<translate>
=== Horizontal alignment === 


Note that when using the <code>frame</code> or <code>thumb[nail]</code> formats, the default horizontal alignment will be ''right'' for left-to-right languages, and ''left'' for right-to-left languages.
</translate>

{|class="wikitable"
|-
! <translate> Description</translate>
! <translate> You type</translate>
! <translate> You get</translate>

|}

<translate>
=== Vertical alignment === 
</translate>
<translate> The vertical alignment options take effect only if the image '''is''' rendered as an inline element and '''is not''' floating.</translate>
<translate> They alter the way the inlined image will be vertically aligned with the text present in the same block before and/or after this image on the same rendered row.</translate>

<translate>

Note that the rendered line of text where inline images are inserted (and the lines of text rendered after the current one) may be moved down (this will increase the line-height conditionally by additional line spacing, just as it may occur with spans of text with variable font sizes, or with superscripts and subscripts) to allow the image height to be fully displayed with this alignment constraint.
</translate>

<div class="mw-collapsible mw-collapsed">
<div class="mw-collapsible-toggle toccolours" style="float:none;text-align:center">''''''</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html4strict">
<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''top:''' [[File:Example.jpg|20px|top]] [[File:Example.jpg|40px|top]] [[File:Example.jpg|100px|top]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''text-top:''' [[File:Example.jpg|20px|text-top]] [[File:Example.jpg|40px|text-top]] [[File:Example.jpg|100px|text-top]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
<sup>super:</sup> [[File:Example.jpg|20px|super]] [[File:Example.jpg|40px|super]] [[File:Example.jpg|100px|super]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''baseline:''' [[File:Example.jpg|20px|baseline]] [[File:Example.jpg|40px|baseline]] [[File:Example.jpg|100px|baseline]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
<sub>'''sub:'''</sub> [[File:Example.jpg|20px|sub]] [[File:Example.jpg|40px|sub]] [[File:Example.jpg|100px|sub]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''default:''' [[File:Example.jpg|20px]][[File:Example.jpg|40px]] [[File:Example.jpg|100px]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''middle:''' [[File:Example.jpg|20px|middle]] [[File:Example.jpg|40px|middle]] [[File:Example.jpg|100px|middle]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''text-bottom:''' [[File:Example.jpg|20px|text-bottom]] [[File:Example.jpg|40px|text-bottom]] [[File:Example.jpg|100px|text-bottom]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''bottom:'' [[File:Example.jpg|20px|bottom]] [[File:Example.jpg|40px|bottom]] [[File:Example.jpg|100px|bottom]]
<del>text</del></u></span></p>
</syntaxhighlight></div></div>

<translate>

To show the alignment result more clearly, the text spans are overlined and underlined, the font-size is increased to 200%, and the paragraph block is outlined with a thin border; additionally images of different sizes are aligned:
</translate>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''top:''' [[File:Example.jpg|20px|top]] [[File:Example.jpg|40px|top]] [[File:Example.jpg|100px|top]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''text-top:''' [[File:Example.jpg|20px|text-top]] [[File:Example.jpg|40px|text-top]] [[File:Example.jpg|100px|text-top]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
<sup>'''super:'''</sup> [[File:Example.jpg|20px|super]] [[File:Example.jpg|40px|super]] [[File:Example.jpg|100px|super]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''baseline:''' [[File:Example.jpg|20px|baseline]] [[File:Example.jpg|40px|baseline]] [[File:Example.jpg|100px|baseline]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
<sub>'''sub:'''</sub> [[File:Example.jpg|20px|sub]] [[File:Example.jpg|40px|sub]] [[File:Example.jpg|100px|sub]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''default:''' [[File:Example.jpg|20px]] [[File:Example.jpg|40px]] [[File:Example.jpg|100px]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''middle:''' [[File:Example.jpg|20px|middle]] [[File:Example.jpg|40px|middle]] [[File:Example.jpg|100px|middle]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''text-bottom:''' [[File:Example.jpg|20px|text-bottom]] [[File:Example.jpg|40px|text-bottom]] [[File:Example.jpg|100px|text-bottom]]
<del>text</del></u></span></p>

<p style="border:1px solid #AAA;padding:0;font-size:150%;line-height:2">
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
'''bottom:''' [[File:Example.jpg|20px|bottom]] [[File:Example.jpg|40px|bottom]] [[File:Example.jpg|100px|bottom]]
<del>text</del></u></span></p>

<translate>

Notes:
</translate>

# <translate> The "middle" vertical alignment position of the image (which is also the default) usually refers to the middle between the x-height and the baseline of the text (on which the vertical middle of the image will be aligned, and on which usually the text may be overstroke), but not to the middle of the line-height of the font-height that refers to the space between the "text-top" and "text-bottom" positions ; the font-height excludes:</translate>
#* <translate> the additional line separation spacing normally divided equally into two line-margins (here 0.5em, according to line-height set to 200%) above and below the font-height).</translate>
#* <translate> the additional line spacing which may be added by superscripts and subscripts.</translate>
# <translate> However, if the image height causes its top or bottom position to go above or below the normal full line-height of text, the middle position will be adjusted after the increasing the top and/or bottom line-margins so that the image can fit and align properly, and all images (including those with smaller heights) will be vertically centered on the adjusted middle position (for computing the effective line-height, the text of each rendered row with the larger font-height will be considered).</translate>
# <translate> The "text-top" and "text-bottom" alignment positions also excludes the extra line spacing added by superscripts and subscripts, but not the additional line-spacing defined by the line-height.</translate>
# <translate> The "top" and "bottom" alignment positions take into account all these extra line spacings (including superscripts and subscripts, if they are present in a rendered line span).</translate> <translate> When the image alignment constrains the image to grow above or below the normal line-spacing, and the image is not absolutely positioned, the image will cause the "top" and "bottom" positions to be adjusted (just like superscripts and subscripts), so the effective line-height between rendered lines of text will be higher.</translate>
# <translate> The "underline", "overline" and "overstrike" text-decoration positions should be somewhere within these two limits and ''may'' depend on the type and height of fonts used (the superscript and subscript styles may be taken into account in some browsers, but usually these styles are ignored and the position of these decorations may not be adjusted); so these decorations normally don't affect the vertical position of images, relatively to the text.</translate>

<translate>
=== Stopping the text flow === 
</translate>
<translate> On occasion it is desirable to stop text (or other inline non-floating images) from flowing around a floating image.</translate>
<translate> Depending on the web browser's screen resolution and such, text flow on the right side of an image may cause a section header (for instance, <nowiki>== My Header ==</nowiki>) to appear to the right of the image, instead of below it, as a user may expect.</translate>
<translate> The text flow can be stopped by placing <tvar name=code2><syntaxhighlight lang=html inline><div style="clear: both"></div></syntaxhighlight></tvar> before the text that should start below the floating image.</translate>
<translate> (This may also be done without an empty line by wrapping the section with the floating images with <tvar name=code><syntaxhighlight lang=html inline><div style="overflow: hidden">…</div></syntaxhighlight></tvar>, which clears all floats inside the <code>div</code> element.)</translate>

<translate> All images rendered as blocks (including non-floating '''center'''ed images, '''left'''- or '''right'''-floating images, as well as '''framed''' or '''thumbnail'''ed floating images) are implicitly breaking the surrounding lines of text (terminating the current block of text before the image, and creating a new paragraph for the text after them).</translate>
<translate> They will then stack vertically along their left or right alignment margin (or along the center line between these margins for '''center'''ed images).</translate>

<translate>
=== Altering the default link target === 
</translate>
<translate> The following table shows how to alter the link target (whose default is the image ) or how to remove it.</translate>
<translate> Changing the link does not alter the format described in the previous sections.</translate>

<div class="noresize">
{|class="wikitable plainlinks"
|-
! <translate> Description</translate>
! <translate> You type</translate>
! <translate> You get</translate>

|}
</div>

{{warning|1=
: <translate> The licencing requirements on your wiki may not allow you to remove all links to the description page that displays the required authors attributions, the copyrights statements, the applicable licencing terms, or a more complete description of the rendered image (including its history of modifications).</translate>
: <translate> If you change or remove the target link of an image, you will then have to provide somewhere else on your page an explicit link to this description page, or to display the copyright and author statement and a link to the applicable licence, if they are different from the elements applicable to the embedding page itself.</translate>
: <translate> Your wiki policy may restrict the use of the alternate link parameter, or may even enforce a prohibition of alternate link parameters for embedded media files (in which case, the link parameter will be ignored), or may only accept them after validation by authorized users or administrators.</translate>
}}

<translate>
== Rendering a gallery of images == 

=== Gallery syntax === 
</translate>
<translate> It's easy to make a gallery of thumbnails with the <tvar name=gallery></tvar> tag.</translate>
<translate> The syntax is:</translate>

<syntaxhighlight lang=wikitext>
<gallery>
File:file_name.ext|caption|alt=alt language
File:file_name.ext|caption|alt=alt language
{...}
</gallery>
</syntaxhighlight>

<translate>

Note that the image code is not enclosed in brackets when enclosed in gallery tags.
</translate>

<translate> Captions are optional, and may contain wiki links or other formatting.</translate>
</tvar> for details.</translate>}}
<translate> Some of the parameters controlling thumb output can also be used here, specifically the ones that modify the file (as opposed to ones that control where in the page the image falls).</translate>
<translate> For example, with multi-paged media like pdfs, you can use code like <tvar name=1><code>page=4</code></tvar> and with videos you can use <tvar name=2><code>thumbtime=10</code></tvar>.</translate>

<translate> The <tvar name=file><code>File:</code></tvar> prefix can be omitted.</translate>
<translate> However, it is helpful to include it as an aid for quickly locating image specifiers in the wikitext (for example, when cleaning up page layout).</translate>

<translate>

If the image links to an external site, the caption must come ''before'' the link parameter or the caption will not render.


For example:
</translate>

<syntaxhighlight lang="wikitext">
<gallery>
File:Example.jpg|<translate nowrap> Item 1</translate>
File:Example.jpg|<translate nowrap> a link to <tvar name=1>[[Help:Contents]]</tvar></translate>
File:Example.jpg
File:Example.jpg|alt=<translate nowrap> An example image. It has flowers</translate>
File:Example.jpg|''<translate nowrap> italic caption</translate>''
File:Example.jpg|link=https://example.com|<translate nowrap> This text will not render because an external link came first</translate>
File:Example.jpg|<translate nowrap> Links to external website</translate>|link=https://example.com
File:Example.jpg|link=w:Main_Page|<translate nowrap> Internal link</translate>
Example.jpg|on page ""
File:Using Firefox.pdf|page=72
</gallery>
</syntaxhighlight>

<translate>

is formatted as:
</translate>

<gallery>
File:Example.jpg|<translate> Item 1</translate>
File:Example.jpg|<translate> a link to <tvar name=1>[[Help:Contents]]</tvar></translate>
File:Example.jpg
File:Example.jpg|alt=<translate> An example image. It has flowers</translate>
File:Example.jpg|''<translate> italic caption</translate>''
File:Example.jpg|link=https://example.com|<translate> This text will not render because an external link came first</translate>
File:Example.jpg|<translate> Links to external website</translate>|link=https://example.com
File:Example.jpg|link=w:Main_Page|<translate> Internal link</translate>
Example.jpg|on page ""
File:Using Firefox.pdf|page=72
</gallery>

<translate>
=== <tvar name=1>mode</tvar> parameter === 
</translate>

<translate>

Starting in MediaWiki version 1.22 a <tvar name=1><code>mode</code></tvar> parameter is available, taking options as follows:


* <tvar name=1><code>traditional</code></tvar> is the original gallery type used by MediaWiki.</translate>
<translate>

* <tvar name=1><code>nolines</code></tvar> is similar to <tvar name=2><code>traditional</code></tvar>, but with no border lines.</translate>
<translate>

* <tvar name=1><code>packed</code></tvar> causes images to have the same height but different widths, with little space between the images.</translate> <translate> The rows in this [[w:Responsive web design|responsive]] mode organize themselves according to the width of the screen regardless of default gallery settings.</translate>
<translate>

* <tvar name=1><code>packed-overlay</code></tvar> shows the caption overlaid on the image, in a semi-transparent white box.</translate>
<translate>

* <tvar name=1><code>packed-hover</code></tvar> is similar to <tvar name=2><code>packed-overlay</code></tvar>, but with the caption and box only showing up on hover.</translate>
* <translate> <tvar name=1><code>slideshow</code></tvar> creates a slideshow of the images.</translate>

<translate>

For example:
</translate>

<syntaxhighlight lang="wikitext">
<gallery mode="packed-hover">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
File:Pterois volitans Manado-e.jpg|''[[commons:Pterois volitans|Pterois volitans]]'' (Red Lionfish)
File:Macropodus opercularis - front (aka).jpg|''[[commons:Macropodus opercularis|Macropodus opercularis]]'' (Paradise fish)
File:Canthigaster valentini 1.jpg|''[[commons:Canthigaster valentini|Canthigaster valentini]]'' (Valentinni's sharpnose puffer)
File:Flughahn.jpg|[[File:POTY ribbon 2007.svg|25px]] ''[[commons:Dactylopterus volitans|Dactylopterus volitans]]'' (Flying gurnard)
File:Fishmarket 01.jpg|''[[commons:Semicossyphus pulcher|Semicossyphus pulcher]]'' (California Sheephead)
File:Pseudorasbora parva(edited version).jpg|''[[commons:Category:Pseudorasbora parva|Pseudorasbora parva]]'' (Topmouth gudgeon)
File:MC Rotfeuerfisch.jpg|''[[commons:Category:Pterois antennata|Pterois antennata]]'' (Antennata Lionfish)
File:Cleaning station konan.jpg|''[[commons:Novaculichthys taeniourus|Novaculichthys taeniourus]]''
File:Synchiropus splendidus 2 Luc Viatour.jpg|''[[commons:Synchiropus splendidus|Synchiropus splendidus]]'' (Mandarin fish)
File:Psetta maxima Luc Viatour.jpg|''[[commons:Psetta maxima|Psetta maxima]]'' (Turbot)
File:Australian blenny.jpg|''[[commons:Category:Ecsenius|Ecsenius axelrodi]]''
</gallery>
</syntaxhighlight>

<translate>

Gives (mode: <tvar name=hover><code>packed-hover</code></tvar>):
</translate>

<gallery mode="packed-hover">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
File:Pterois volitans Manado-e.jpg|''[[commons:Pterois volitans|Pterois volitans]]'' (Red Lionfish)
File:Macropodus opercularis - front (aka).jpg|''[[commons:Macropodus opercularis|Macropodus opercularis]]'' (Paradise fish)
File:Canthigaster valentini 1.jpg|''[[commons:Canthigaster valentini|Canthigaster valentini]]'' (Valentinni's sharpnose puffer)
File:Flughahn.jpg|[[File:POTY ribbon 2007.svg|25px]] ''[[commons:Dactylopterus volitans|Dactylopterus volitans]]'' (Flying gurnard)
File:California Sheephead (Semicossyphus pulcher) at Ensenada's fishmarket.jpg|''[[commons:Semicossyphus pulcher|Semicossyphus pulcher]]'' (California Sheephead)
File:Pseudorasbora parva(edited version).jpg|''[[commons:Category:Pseudorasbora parva|Pseudorasbora parva]]'' (Topmouth gudgeon)
File:MC Rotfeuerfisch.jpg|''[[commons:Category:Pterois antennata|Pterois antennata]]'' (Antennata Lionfish)
File:Cleaning station konan.jpg|''[[commons:Novaculichthys taeniourus|Novaculichthys taeniourus]]''
File:Synchiropus splendidus 2 Luc Viatour.jpg|''[[commons:Synchiropus splendidus|Synchiropus splendidus]]'' (Mandarin fish)
File:Psetta maxima Luc Viatour.jpg|''[[commons:Psetta maxima|Psetta maxima]]'' (Turbot)
File:Australian blenny.jpg|''[[commons:Category:Ecsenius|Ecsenius axelrodi]]''
</gallery>

<translate>

Examples of the other modes:
</translate>

<code>mode="traditional"</code>
<gallery mode="traditional">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
</gallery>

<code>mode="nolines"</code>
<gallery mode="nolines">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
</gallery>

<code>mode="packed"</code>
<gallery mode="packed">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
</gallery>

<code>mode="packed-overlay"</code>
<gallery mode="packed-overlay">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
</gallery>

<code>mode="packed-hover"</code>
<gallery mode="packed-hover">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
</gallery>

<code id="slideshow-demo">mode="slideshow"</code>
<gallery mode="slideshow">
File:Astronotus_ocellatus.jpg|''[[commons:Astronotus ocellatus|Astronotus ocellatus]]'' (Oscar)
File:Salmonlarvakils.jpg|''[[commons:Salmo salar|Salmo salar]]'' (Salmon Larva)
File:Georgia Aquarium - Giant Grouper.jpg|''[[commons:Epinephelus lanceolatus|Epinephelus lanceolatus]]'' (Giant grouper)
File:Pterois volitans Manado-e.jpg|''[[commons:Pterois volitans|Pterois volitans]]'' (Red Lionfish)
File:Macropodus opercularis - front (aka).jpg|''[[commons:Macropodus opercularis|Macropodus opercularis]]'' (Paradise fish)
File:Canthigaster valentini 1.jpg|''[[commons:Canthigaster valentini|Canthigaster valentini]]'' (Valentinni's sharpnose puffer)
File:Flughahn.jpg|[[File:POTY ribbon 2007.svg|25px]] ''[[commons:Dactylopterus volitans|Dactylopterus volitans]]'' (Flying gurnard)
File:California Sheephead (Semicossyphus pulcher) at Ensenada's fishmarket.jpg|''[[commons:Semicossyphus pulcher|Semicossyphus pulcher]]'' (California Sheephead)
File:Pseudorasbora parva(edited version).jpg|''[[commons:Category:Pseudorasbora parva|Pseudorasbora parva]]'' (Topmouth gudgeon)
File:MC Rotfeuerfisch.jpg|''[[commons:Category:Pterois antennata|Pterois antennata]]'' (Antennata Lionfish)
File:Cleaning station konan.jpg|''[[commons:Novaculichthys taeniourus|Novaculichthys taeniourus]]''
File:Synchiropus splendidus 2 Luc Viatour.jpg|''[[commons:Synchiropus splendidus|Synchiropus splendidus]]'' (Mandarin fish)
File:Psetta maxima Luc Viatour.jpg|''[[commons:Psetta maxima|Psetta maxima]]'' (Turbot)
File:Australian blenny.jpg|''[[commons:Category:Ecsenius|Ecsenius axelrodi]]''
</gallery>

<translate>

=== Optional gallery attributes === 


The gallery tag itself takes several additional parameters, specified as attribute name-value pairs:
</translate>

<syntaxhighlight lang=html>
<gallery {parameters}>
{images}
</gallery>
</syntaxhighlight>

<translate>

* <code>caption="{caption}"</code>: (caption text between double quotes for more than one word) sets a caption centered atop the gallery. Only plain text may be used in the caption; formatting, templates and the like will not work.</translate>
<translate>

* <code>widths={width}</code>: sets the (max) widths of the images in pixels; the [[<tvar name=options>Special:MyLanguage/Manual:$wgGalleryOptions</tvar>|default value]] is 120px.</translate> <translate> (It has no effect if mode is set to one of the following: <tvar name=1>packed, packed-overlay, packed-hover, slideshow</tvar>.)</translate> ''<translate> Note the plural: width'''s'''</translate>''.
<translate>

* <code>heights={heights}</code>: sets the (max) heights of the images in pixels; the default value is 120px.</translate> <translate> (It has no effect if mode is set to <tvar name=1>slideshow</tvar>.)</translate>
<translate>

* <code>perrow={integer}</code>: sets the number of images per row.</translate> <translate> (It has no effect if mode is set to one of the following: <tvar name=1>packed, packed-overlay, packed-hover, slideshow</tvar>.)</translate> <translate> The default is <tvar name=1><code>perrow=0</code></tvar> which automatically adjusts the number of images per row based on width of screen.</translate>
<translate>

* <code>showfilename={anything}</code>: Show the filenames of the images in the individual captions for each image (1.17+).</translate>
<translate>

* <code>mode={traditional|nolines|packed|packed-hover|packed-overlay|slideshow}</code>: See section above (1.22+; 1.28+ for "slideshow").</translate>
<translate>

* <code>showthumbnails</code>: For "slideshow" mode only, display the strip with image thumbnails below the slideshow by default (1.29+).
</translate>
* <translate> Any html attribute allowed on a <tvar name=1><code><ul></code></tvar> tag (e.g. <tvar name=2><code>id</code></tvar>, <tvar name=3><code>title</code></tvar>, <tvar name=4><code>class</code></tvar>)</translate>

{{note|1=<translate> In packed (and related) modes, the widths parameter has no effect; instead, the heights parameter determines the minimum height of the images.</translate> <translate> Packed modes adjust the width of images to ensure that each row is of equal length, except when a row contains too few images to achieve this without excessively enlarging the images.</translate>}}

<translate>

; Example 1


Syntax:
</translate>

<syntaxhighlight lang=html>
<gallery widths=300 heights=200>
File:Example.jpg|Lorem ipsum
File:Example.jpg|Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut
</gallery>
</syntaxhighlight>

<translate>

Result:
</translate>

<gallery widths="300" heights="200">
File:Example.jpg|Lorem ipsum
File:Example.jpg|Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut
</gallery>

<translate>

; Example 2


Syntax:
</translate>

<syntaxhighlight lang=html>
<gallery widths=60 heights=60 perrow=7 caption="<translate nowrap> sunflowers are groovy</translate>">
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
</gallery>
</syntaxhighlight>

<translate>

Result:
</translate>

<gallery widths="60" heights="60" perrow="7" caption="">
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
</gallery>

<translate>
=== Gallery tag === 
</translate>
You can also use <code></nowiki>}}</code> magic word (tag) for generating gallery.
This is especially useful if you are going to templatize the gallery.
Example:

<syntaxhighlight lang="wikitext" style="margin-left:25px">
}}
}}</syntaxhighlight>

or, more advanced:

<syntaxhighlight lang="wikitext" style="margin-left:25px">
}}
File:}}
|widths=}
|perrow=}
}}</syntaxhighlight>

(by [[Help talk:Templates#Gallery In a Template|Hamilton Abreu]])

<translate>

== Row of images that will wrap to browser width == 
</translate>
<translate> One way that works for a row of images with varying widths is not to use "thumb" or "left" or "none".</translate>
<translate> If "thumb" is not used (and thus no captions) a row of images will wrap to the browser width.</translate>
<translate> If necessary, narrow the browser window to see the images wrap to the next row.</translate>

<pre>
[[File:Example.jpg|220px]]
[[File:Example.jpg|100px]]
[[File:Example.jpg|150px]]
[[File:Example.jpg|250px]]
[[File:Example.jpg|200px]]
[[File:Example.jpg|50px]]
[[File:Example.jpg|220px]]
[[File:Example.jpg|175px]]
</pre>

[[File:Example.jpg|220px]]
[[File:Example.jpg|100px]]
[[File:Example.jpg|150px]]
[[File:Example.jpg|250px]]
[[File:Example.jpg|200px]]
[[File:Example.jpg|50px]]
[[File:Example.jpg|220px]]
[[File:Example.jpg|175px]]

<translate>

'''To wrap images of varying widths with captions''' it is necessary to use div HTML for an unordered list. Along with <tvar name="code"><code>style="display: inline-block;"</code></tvar>. For more info and ideas see: [<tvar name=1>https://www.sitepoint.com/give-floats-the-flick-in-css-layouts/</tvar> Give Floats the Flick in CSS Layouts].
</translate>

<syntaxhighlight lang="html">
<div><ul>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|220px|Caption 1]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|100px|Caption 2]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|150px|Caption 3]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|250px|Caption 4]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|200px|Caption 5]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|50px|Caption 6]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|220px|Caption 7]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|175px|Caption 8]] </li>
</ul></div>
</syntaxhighlight>

<div><ul>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|220px|Caption 1]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|100px|Caption 2]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|150px|Caption 3]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|250px|Caption 4]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|200px|Caption 5]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|50px|Caption 6]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|220px|Caption 7]] </li>
<li style="display: inline-block;"> [[File:Example.jpg|thumb|none|175px|Caption 8]] </li>
</ul></div>

<translate> To '''align the top edge of images''' add the vertical-align command</translate>

<syntaxhighlight lang="html">
<div><ul>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|220px|Caption 1]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|100px|Caption 2]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|150px|Caption 3]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|250px|Caption 4]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|200px|Caption 5]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|50px|Caption 6]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|220px|Caption 7]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|175px|Caption 8]] </li>
</ul></div>
</syntaxhighlight>

<div><ul>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|220px|Caption 1]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|100px|Caption 2]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|150px|Caption 3]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|250px|Caption 4]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|200px|Caption 5]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|50px|Caption 6]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|220px|Caption 7]] </li>
<li style="display: inline-block; vertical-align: top;"> [[File:Example.jpg|thumb|none|175px|Caption 8]] </li>
</ul></div>

<translate> Some wiki farms do not have all gallery options (such as "widths").</translate>
<translate> Also, sometimes one wants varying widths for images in a row.</translate>
<translate> Outside of a gallery, or the div HTML, it is impossible to have individual captions for images in a row of images that will wrap to the browser width.</translate>
<translate> Try it and see. Nothing else using wikitext works correctly. Images will either overlap stuff on the right, or force a horizontal scroll bar.</translate>

<translate> Using a left float ("left") for some images, combined with "none" for some of the images, will not work consistently either, especially if there is also a right sidebar of images.</translate>
<translate> Weird things will occur.</translate>
<translate> At narrower browser or screen widths an image out of the row may appear far down the page after the end of the right sidebar of images.</translate>

<translate>
== Link behavior == 
</translate>
<translate> By default an image links to its file description page.</translate>
<translate> The "link=" option modifies this behavior to link to another page or website, or to turn off the image's linking behavior.</translate>

<translate> Alternatively, you can create a text link to a file description page or to the file itself.</translate>
<translate> See <tvar name=1></tvar>.</translate>

<translate>
=== Display image, link it to another page or website === 


Use the "link=" option to link an image to another page or website:


Clicking on the below image will take you to [[MediaWiki]]:
</translate>

<nowiki>[[File:MediaWiki-2020-logo.svg|50px|link=MediaWiki]]</nowiki>

[[File:MediaWiki-2020-logo.svg|50px|link=MediaWiki]]

<translate>

Clicking on the below image will take you to ''example.com'':
</translate>

<nowiki>[[File:MediaWiki-2020-logo.svg|50px|link=http://example.com]]</nowiki>

[[File:MediaWiki-2020-logo.svg|50px|link=http://example.com]]

<translate>
=== Display image, turn off link === 


Use the "link=" option with no value assigned to turn the link off entirely; the below image is not a link:
</translate>

<nowiki>[[File:MediaWiki-2020-logo.svg|50px|link=]]</nowiki>

[[File:MediaWiki-2020-logo.svg|50px|link=]]

<translate>
=== Link to an image === 


Add <tvar name="colon"><code>:</code></tvar> as a prefix to the link you need to create.
</translate>

<nowiki>[[:File:MediaWiki-2020-logo.svg]]</nowiki>
[[:File:MediaWiki-2020-logo.svg]]
<nowiki>[[:File:MediaWiki-2020-logo.svg|Wiki]]</nowiki>
[[:File:MediaWiki-2020-logo.svg|Wiki]]

<translate>
=== Directly linking to an image === 
</translate>
<translate> The above examples link to the image's description page.</translate>
<translate> To directly link to an image, the pseudo-namespace <tvar name=1><code>Media:</code></tvar> can be used on MediaWiki pages:</translate>

<syntaxhighlight lang="wikitext">
[[Media:MediaWiki-2020-logo.svg]]
</syntaxhighlight>
[[Media:MediaWiki-2020-logo.svg]]

<translate>
====Direct links from external sites==== 
</translate>
<translate> Another possibility is to use the <tvar name=1>[[Special:Redirect/file]]</tvar> page (or its alias <tvar name=2>[[Special:Filepath]]</tvar>).</translate>
<translate> Unlike the above example, you can link to it from external websites as well as from MediaWiki pages.</translate>

<syntaxhighlight lang="wikitext">
[[Special:Redirect/file/Wikipedia.png]]
</syntaxhighlight>

<translate> The parameters <code>height</code> and <code>width</code> can also be added to return a specific size of the image.</translate>
<translate> The image aspect ratio is always preserved.</translate>

<nowiki>https://www.mediawiki.org/w/index.php?title=Special:Redirect/file/Wikipedia.png&width=100&height=100</nowiki>

<translate>
====Obtaining the full URL of an image==== 


To obtain the full path of an image (without going through redirects as shown above), some <tvar name=1></tvar> can be used.
</translate>

<nowiki></nowiki>

<translate> Becomes:</translate>

:

<translate> In the event that this is used from a template where the <code>File:</code> namespace needs to be removed, <tvar name=1><code><nowiki></nowiki></code></tvar> can do so:</translate>

<nowiki>}}</nowiki>

<translate> Becomes:</translate>

:}}

<translate>
== Files at other websites == 
</translate>
<translate> You can link to an external file available online using the same syntax used for linking to an external web page.</translate>
<translate> With these syntaxes, the image will not be rendered, but only the text of the link to this image will be displayed.</translate>

<syntaxhighlight lang="wikitext">[http://url.for/some/image.png]</syntaxhighlight>

<translate>

Or with a different displayed text:
</translate>

<syntaxhighlight lang="wikitext">[http://url.for/some/image.png <translate nowrap> link text here</translate>]</syntaxhighlight>

<translate>

Additional MediaWiki markup or HTML/CSS formatting (for inline elements) is permitted in this displayed text (except for embedded links that would break the surrounding link):
</translate>

<syntaxhighlight lang="wikitext">[http://www.example.com/some/image.png <translate nowrap> Example '''<del>rich</del>''' ''<ins>link text</ins>'' here.</translate>]</syntaxhighlight>

<translate>

which renders as:</translate> [http://www.example.com/some/image.png <translate> Example '''<del>rich</del>''' ''<ins>link text</ins>'' here.</translate>]

<translate>

If it is enabled on your wiki (see <tvar name=AllowExternalImages></tvar>), you can also embed external images. To do that, simply insert the image's URL:
</translate>
<pre>http://url.for/some/image.png</pre>
<translate>

Embedded images can be resized by the CSS <tvar name=transform><code>transform</code></tvar> property. They also may be formatted by surrounding MediaWiki markup or HTML/CSS code.


If this wiki option is not enabled, the image will not be embedded but rendered as a textual link to the external site, just like above, unless the site's <tvar name=AllowExternalImagesFrom></tvar> has a value.


It is also possible to use <tvar name=1></tvar> or other to load files from other wikis, which are treated as if they were local images.

== See also == 


*[[w:Wikipedia:Extended image syntax|Wikipedia:Extended image syntax]]
*[[w:Category:Wikipedia image help|Category:Wikipedia image help]]
*[[w:Wikipedia:Picture tutorial|Wikipedia:Picture tutorial]]
*[[w:Help:Gallery tag]]
</translate>
*
*[[phab:T113101]] – <translate> responsive issues</translate>
* <translate> [[<tvar name=1>Special:MyLanguage/Extension:PageImages#Can I exclude certain page images?</tvar>|Extension:PageImages#Can I exclude certain page images?]]</translate>

<translate>
== References == 
</translate>
<references/>

[[Category:Help|Images]]

----
''Sample content adapted from [[mediawikiwiki:Help:Images]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Templates

2026-07-25T17:02:05Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate> If you have standard texts you want to include on several pages, the MediaWiki '''template''' feature comes into play.</translate>
<translate> Unlike and , there is no central repository for templates.</translate>
<translate> Templates can be newly written or, to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.</translate>

<translate>
== Basic usage == 
</translate>
<translate> Templates are standard wiki pages whose content is designed to be '''[[<tvar name=1>Special:MyLanguage/Transclusion</tvar>|transcluded]]''' (embedded) inside other pages.</translate>
<translate> Templates follow a convention that the name is prefixed with "<tvar name=4><code>Template:</code></tvar>", assigning it to the [[<tvar name=2>Special:MyLanguage/Help:Namespaces</tvar>|template namespace]]; besides this, you can [[<tvar name=3>Special:MyLanguage/Help:Starting a new page</tvar>|create them like any other wiki page]].</translate>

<translate>

To transclude a template, you use double opening & closing curly brackets </nowiki></code></tvar>|template name}}.


The simplest use of templates is as follows: Create a page called <tvar name=1><code>Template:Welcome</code></tvar> with the content below:
</translate>

<translate> Hello! Welcome to the wiki.</translate>

<translate>

You have created your first template! Now, insert the code below in a new page:
</translate>

<nowiki></nowiki>

<translate>

When the new page is viewed, the text "Hello! Welcome to the wiki." will appear instead of <tvar name=1><code><nowiki></nowiki></code></tvar>. The template content is '''transcluded''' into the other page, i.e., it is integrated in the page.


You can then insert <tvar name=1><code><nowiki></nowiki></code></tvar> at any point of any page where you wish to welcome someone. Suppose it is used in 100 pages. If you then change the template contents to:
</translate>

<translate> Hi there! Welcome to this wonderful wiki.</translate>

<translate>

And revisit any of the 100 pages where the template was used, you'll see the new text instead of the original one. In this way, you have changed the content of 100 pages without editing them, because the template is transcluded into these pages.


This is the basic mechanism. There are several additional features of transclusion that enrich this mechanism and make templates very useful.
</translate>

<translate>
== Ways to invoke a template == 


Templates can be used in other pages in these ways:


* <code><nowiki></nowiki></code> – As described above, this text (commonly referred to as a "template call") will be ''dynamically'' replaced by the content of the page titled Template:Name (a process called "transclusion") every time the page with the template call is '''loaded''' (i.e., viewed by a reader of the wiki).</translate> <translate> Because the template call remains in the pages's source, any subsequent change to Template:Name will be seen on the page containing the template call.</translate> <translate> Also, the page will be listed among those that "link to" the template.</translate>
<translate>

* <code><nowiki></nowiki></code> – When this type of template call is used, it will be replaced by a ''static copy'' of the content of Template:Name as of the time the page containing the template call is '''saved'''.</translate> <translate> That is, a copy of the contents of Template:Name will be ''substituted'' for the template call.</translate> <translate> No link is maintained between the page and the template, so each can be edited further without affecting the other.</translate> <translate> In effect, there is little difference between substituting the content in this way and simply typing it into the page's source "manually".</translate> <translate> See <tvar name=1></tvar> for more information.</translate>
<translate>

* </nowiki></code></tvar>|Name}} – This was introduced to allow for recursive substitution in cases where templates contain calls to other templates or parser functions.</translate> <translate> See <tvar name=1></tvar> for more information.</translate>
<translate>

* </nowiki></code></tvar>|Name}} – This displays the template content as raw wiki syntax (the way <tvar name=1></tvar> does) when the page containing it is viewed.</translate> <translate> For example, <tvar name="1"><code><nowiki></nowiki></code></tvar> displays:</translate>

|Template:Thankyou/|Template:Thankyou}}}}

<translate>

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:
</translate>

* <translate> <code><nowiki></nowiki></code> transcludes the page titled Template:Pagename (equivalent to <code><nowiki></nowiki></code>)</translate>
* <translate> <code><nowiki></nowiki></code> transcludes the page titled Talk:Pagename</translate>
* <translate> <code><nowiki></nowiki></code> transcludes the page titled Pagename (i.e., in the main namespace)</translate>
** <translate> <code><nowiki></nowiki></code> substitutes the contents of the page titled Pagename</translate>

<translate>

If the specified namespace doesn't exist, the full title is assumed to be a template:


* <tvar name=1><code><nowiki></nowiki></code></tvar> transcludes <tvar name=2>Template:Foo:Bar</tvar>
</translate>

<translate> Regardless of what syntax is used, the name of the template can be relative to the current page</translate>
/$2</code></tvar> is called on page <tvar name="2">$1</tvar>, it will transclude the page <tvar name="3">$1/$2</tvar>.</translate>
|1=<translate> foo</translate>
|2=<translate> bar</translate>
}}

<translate> It can also be generated dynamically. </translate>
$1 }}</code></tvar> calls <tvar name="2">Template:$1</tvar> and interprets the result as the name of another template to call.</translate>
|1=<translate> foo</translate>
}}

<translate>
== Parameters == 


To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.


Suppose you wish to insert a little thank you note in the [[<tvar name=1>Special:MyLanguage/Help:Talk pages</tvar>|talk page]] of other users, such as:




The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is for any user to be able to thank any other user, for any reason whatsoever.
</translate>

<translate> So that the note will look similar everywhere it is used, you can define a template called <tvar name=tmpl></tvar>, for example.</translate>
<translate> Although the note should look similar whenever a user thanks another user, its specific contents (i.e., the reason and the signature) will be different.</translate>
<translate> For that reason, you should pass them as parameters.</translate>
<translate> If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:</translate>

<syntaxhighlight lang="wikitext">
<translate nowrap>
'''A little thank you...'''
for }.
Hugs, }</translate>
</syntaxhighlight>

<translate>

Notice the use of <tvar name=1><code><nowiki>}</nowiki></code></tvar> and <tvar name=2><code><nowiki>}</nowiki></code></tvar>. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by '''three''' braces: <tvar name=braces><code><nowiki>}</nowiki></code></tvar>. This is different from normal template name usage.


When using the template on a page, you fill in the parameter values, separated by a "pipe" character (<tvar name=pipe><code>|</code></tvar>). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

=== Anonymous parameters === 


To pass in anonymous parameters, list the values of those parameters sequentially:
</translate>

<translate> <nowiki></nowiki></translate>

<translate>

In this case, the <code><nowiki></nowiki></code> template receives parameters <code><nowiki>}=all your effort</nowiki></code> and <code><nowiki>}=Me</nowiki></code>, producing:




The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:
</translate>

<translate> <nowiki></nowiki></translate>

<translate>

would produce this result:



</translate>

}</nowiki></code></tvar>, etc.) works ''only'' with anonymous parameters.</translate> <translate> Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.</translate>}}

{{note|1=<translate> If an equal sign appears inside the argument to an anonymous template parameter, that parameter may be misinterpreted as a [[<tvar name=1>#Named parameters</tvar>|named parameter]] (which is explained below in this document) treating the text before the equal sign as the parameter name and the text after it as the argument value.</translate> <translate> This is a common problem when you need to include an external link, or an HTML element with attributes (see <tvar name=1></tvar>).</translate> <translate> The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.</translate>}}

<translate>
=== Numbered parameters === 


To pass in parameters by number, identify each parameter when passing it:
</translate>

<translate> <nowiki></nowiki></translate>

<translate>

This time, template <code><nowiki></nowiki></code> receives parameters <code><nowiki>}=your friendship</nowiki></code> and <code><nowiki>}=Me</nowiki></code>, though they have been supplied in inverse order, and produces:



</translate>

'''<translate> Examples:</translate>'''

<pre><translate nowrap> </translate></pre>

<translate> produces:</translate>

<translate> </translate>

<translate>
=== Named parameters === 


The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:
</translate>

<syntaxhighlight lang="wikitext"><translate nowrap>
'''A little thank you...'''
for }.
Hugs, }</translate></syntaxhighlight>

<translate>

Within the template, we use <code><nowiki>}</nowiki></code> and <code><nowiki>}</nowiki></code> to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:
</translate>

<translate> <nowiki></nowiki></translate>

<translate>

In this case, template <code><nowiki></nowiki></code> receives parameters <code><nowiki>}=being who you are</nowiki></code> and <code><nowiki>}=Me</nowiki></code> and produces:




Named parameters are '''case-sensitive''', so:


<pre><nowiki></nowiki></pre>


produces:




The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.


Spaces and newlines are automatically stripped from the start and end of named parameter names and values, but are preserved in unnamed parameters.

=== Mixing named and unnamed parameters === 
</translate>
<translate> If the template supports it, both kinds of parameters can be used in one call.</translate>
<translate> The template contents would be changed to:</translate>

<syntaxhighlight lang="wikitext">'''A little thank you...'''
for }}}}.
Hugs, }}}}</syntaxhighlight>

$1signature=$2<nowiki>}}</nowiki></code></tvar> results in:</translate>
|1=<translate> supporting both parameter types</translate>
|2=<translate> Me</translate>
}}

<translate> Be careful when doing this, because it can result in conterintuitive results as unnamed parameter counts are based only on the unnamed parameters, not the named parameters.</translate>
$1reason=$2<nowiki>}}</nowiki></code></tvar> results in:</translate>
|1=<translate> Me</translate>
|2=<translate> supporting both parameter types</translate>
}}

<translate> The template is coded to prefer the named parameter for the reason over the unnamed parameter, resulting in the "Me" being lost and no signature being given.</translate>
<translate> This results in a default value of <tvar name=1>}</tvar> being shown, as explained below.</translate>

reason=$1$2<nowiki>}}</nowiki></code></tvar> results in:</translate>
|1=<translate> supporting both parameter types</translate>
|2=<translate> Me</translate>
}}

<translate> Even though "Me" is the second parameter, it is the first ''unnamed'' parameter, and so it is assigned to <tvar name=1><nowiki>}</nowiki></tvar> and <tvar name=2><nowiki>}</nowiki></tvar> is left unassigned.</translate>

<translate>
=== Default values === 
</translate>

<translate>

If you transclude a template that expects parameters, but do not provide their arguments, in this way:
</translate>

<translate> <nowiki></nowiki></translate>

<translate>

in the numbered parameters example above you would get the following:
</translate>

<translate>

Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define ''default'' values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:
</translate>

<syntaxhighlight lang=moin>
<translate nowrap>
'''A little thank you...'''
for }.
Hugs, }</translate>
</syntaxhighlight>

<translate>

then <code><nowiki>}</nowiki></code> defines that if no argument is provided for parameter <code>}</code>, then the value <code>everything</code> will be used. Similarly, <code><nowiki>}</nowiki></code>, defaults parameter <code>}</code> to value <code>Me</code>. Now, transcluding the template again without passing any argument results in the following:
</translate>


<translate>


</translate>

</nowiki></code></tvar> or <tvar name=2><code><nowiki></nowiki></code></tvar>, the <tvar name=5><code>foo</code></tvar> template considers the <tvar name=3><code>bar</code></tvar> parameter to be <tvar name=4><code>""</code></tvar>.</translate> <translate> This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.</translate>
}}
{{note|1=<translate> If you need to treat an empty string the same way as a missing parameter, you can use a conditional operator through an extension like [[<tvar name=1>Special:MyLanguage/Extension:ParserFunctions</tvar>|ParserFunctions]].</translate> <translate> For instance, <tvar name=1><code><nowiki>}|}|undefined}}</nowiki></code></tvar> returns undefined if the parameter is either undefined or empty, while <tvar name=2><code><nowiki>}</nowiki></code></tvar> does so only if the parameter is undefined.</translate>
}}

<translate> Default values are often used to specify alternate names of parameters.</translate>
<translate> For example, if you have <tvar name=1><code><nowiki>} }}}</nowiki></code></tvar>, the template will first look for a parameter named "<tvar name=2>a</tvar>".</translate>
<translate> If it is not set, it will use the parameter named "<tvar name=1>b</tvar>".</translate>
<translate> If neither "<tvar name=1>a</tvar>" nor "<tvar name=2>b</tvar>" is set, it will output nothing.</translate>

<translate>
=== Passing parameters to other templates === 
</translate>
<translate> If raw parameter syntax is generated by the above template call, and then passed through to another template, it is '''not''' interpreted as a parameter.</translate>
<translate> This means that <tvar name=1></tvar>, which just calls <tvar name=2></tvar> with no parameters, does not work:</translate> →

<translate> You instead need to explicitly pass the parameter to the other template, i.e if <tvar name=1></tvar> contains</translate>
<syntaxhighlight lang="wikitext">
}|}}}
</syntaxhighlight>
<translate> then works properly:</translate>
→

<translate>

This example does not [[<tvar name=1>#Empty vs undefined parameters</tvar>|preserve emptiness vs. undefinedness in parameter values]] – you would need more complicated syntax if you wanted to do that.

=== Empty vs undefined parameters === 
</translate>
<translate> The <tvar name=1><code>}}t2demo}} }}</code></tvar> (refer to <tvar name="2"></tvar> ), with a double pipe, sets the first parameter to an '''empty''' string instead of leaving it undefined.</translate>
<translate> It produces the output <tvar name=1><code>start--middle- a -end</code></tvar>, similar to how <tvar name=2><code>}}t2demo}}1=}}2= }}</code></tvar> results in <tvar name=3><code>}}</code></tvar>.</translate>
<translate> On the other hand, explicitly setting the parameter "2" to "a," results in the first unnamed parameter being left '''undefined''':</translate>

<translate>

<tvar name="1"><code>}}t2demo}}2= }}</code></tvar> results in <tvar name="2">}}</tvar>


If the second parameter should not be trimmed, it must be unnamed.


Therefore, you can assign an empty string to the first parameter, but you cannot leave it undefined.

==== Making emptiness and undefinedness equivalent ==== 


Good template coding practices result in passing an empty string to a parameter working the same as not assigning any value.
This makes things easier and more consistent.


For example, using <tvar name="1"><code>p=</code></tvar> can show that a template has a parameter "p" that doesn't have a value yet.


To make an empty string and an undefined value equivalent, use the following approaches:
</translate>
* <translate> Use <tvar name="1"><code><nowiki>}</nowiki></code></tvar> exclusively instead of <tvar name="2"><code>}</code></tvar> or <tvar name="3"><code>}</code></tvar> where "q" is a non-empty value.</translate>
* <translate> Use conditional checks like <tvar name="1"><code><nowiki>}|..}..|..}}</nowiki></code></tvar>, to ensure <tvar name="2"><code>}</code></tvar> is only used when it has a value.</translate>

<translate> If for some reason you want to treat undefined parameters differently from empty parameters or any other possible value you can compare the same parameter twice with different defaults, i.e <tvar name=1><code><nowiki>}|}|parameter is defined|parameter is undefined}}</nowiki></code></tvar>.</translate>

<translate>
=== Using equals signs in unnamed parameters === 
</translate>
<translate> Unnamed parameters can include equals signs, but this must be done indirectly.</translate>
<translate> Here are some methods using <tvar name="1">[[template:T1demo]]</tvar>:</translate>

; <translate> Default Value for Undefined Parameter</translate>
<translate> Assign a default value to an undefined parameter:</translate>
<code><nowiki>}}}</nowiki></code>
<translate> This renders as:</translate> <code>}}}</code>.

; <translate> Using the <tvar name="1"><code><nowiki></nowiki></code></tvar> parser function</translate>

<translate> Use a parser function that safely includes an equals sign:</translate>
<code><nowiki>b }}</nowiki></code>
<translate> This renders as:</translate> <code>b }}</code>.

; <translate> HTML Entities</translate>
<translate> Replace the equals sign with an HTML entity for display:</translate>
<code><nowiki></nowiki></code>
<translate> This renders as:</translate> <code></code>.

<translate>

This renders correctly without affecting the other parameters.

=== Handling unmatched curly and square brackets === 


Unmatched curly brackets (<tvar name=1><code><nowiki></code></tvar>) or square brackets (<tvar name=3><code><nowiki>[[</nowiki></code></tvar>, <tvar name="4"><code>]]</code></tvar>) must be inside nowiki tags or use HTML entities:
</translate>

* <translate> Rendering curly brackets have two options:</translate>
** <translate> Use <tvar name="1"><code><nowiki><nowiki>{{</nowiki></nowiki></code></tvar> or <tvar name="2"><code>&#123;</code></tvar> for <tvar name="3"><code>{</code></tvar></translate>
** <translate> Use <tvar name="1"><code><nowiki><nowiki>}}</nowiki></nowiki></code></tvar> or <tvar name="2"><code>&#125;</code></tvar> for <tvar name="3"><code>}</code></tvar>.</translate>
* <translate> Use <tvar name="1"><code>&#91;</code></tvar> for <tvar name="2"><code>[</code></tvar> and <tvar name="3"><code>&#93;</code></tvar> for <tvar name="4"><code>]</code></tvar>.</translate>

<translate>

Below are some examples:
</translate>

; <translate> Unmatched curly brackets</translate>
<code><nowiki></nowiki> }}</nowiki></code>
<translate> This correctly renders the braces without breaking the template.</translate>

; <translate> Unmatched square brackets</translate>
<code><nowiki></nowiki></code>
<translate> This correctly renders the braces without breaking the template.</translate>

<translate> This renders as:</translate>
<code></code>

<translate>

Unmatched pairs not placed in nowiki tags either prevent template expansion or are taken as closing braces for the template call.


Below are some examples:
</translate>

<code><nowiki></nowiki></code>

<translate>

This will not expand correctly because of unmatched brackets.


The correct use:
</translate>

<code><nowiki></nowiki></code>

<translate> This renders as:</translate>
<code></code>

<translate>
==== Template-generated brackets ==== 
</translate>
<translate> An alternate technique for passing arguments with unmatched brackets is to wrap them in another template.</translate>
<translate> In that situation, (which exists with <tvar name=1></tvar> and <tvar name=2>)</tvar> on this wiki), the unmatched brackets will be rendered literally, and not decoded as another template call.</translate>
<translate> For example:</translate>
<syntaxhighlight lang="wikitext">
t1demo}}
</syntaxhighlight>
<translate> results in:</translate>
t1demo}}

<translate> When [[<tvar name=1>Special:MyLanguage/Help:Substitution</tvar>|substituting]] a template, template inclusions are parsed once when the subst happens (with the same caveats explained above) and then a second time when rendering the resulting wikitext.</translate>
<translate> For example:</translate>
<syntaxhighlight lang="wikitext">
t1demo|foo}}
</syntaxhighlight>
<translate> will expand on save to:</translate>
<syntaxhighlight lang="wikitext">

</syntaxhighlight>
<translate> which will then render as:</translate>

<translate> If the wikitext generated via the first subst itself includes "subst:" syntax it will not be processed on the same save, but may be on the next save.</translate>
<translate> This technique may be used to implement [[<tvar name=1>Special:MyLanguage/Manual:Recursive conversion of wikitext</tvar>|recursive substitutions]] that take multiple saves to evaluate.</translate>

<translate>
=== Using pipes in parameter values === 
</translate>
<translate> A parameter value cannot contain a pipe character (<tvar name=1>|</tvar>), because it would be interpreted as the end of that parameter and the start of the next parameter.</translate>
<translate> This can be worked around by using the <tvar name=2><code><nowiki></nowiki></code></tvar>, or the HTML entity <tvar name=3>&124;</tvar>.</translate>
<translate> The two methods of doing this have slightly different behavior, which can be relevant in some corner cases like when a template is producing [[<tvar name=1>Special:MyLanguage/Help:Tables</tvar>|wikitable]] syntax.</translate>

<translate> Example:</translate>
<code><nowiki></nowiki></code>
<translate> produces:</translate>

<translate> The "<tvar name=1>def</tvar>" doesn't display because it is treated as part of another unnamed parameter, which the template does not use.</translate>

<code><nowiki>def}}</nowiki></code>
<translate> produces:</translate>
def}}

<translate> The "<tvar name=1>def</tvar>" displays properly.</translate>

<code><nowiki></nowiki></code>
<translate> produces:</translate>

<translate>

The "<tvar name=1>def</tvar>" displays properly again.

=== Formatting template calls using extra parameters === 


Since templates ignore parameters they are passed but do not handle specifically, they can be used as a way of a adding extra whitespace or unused content to the template call.


For example:
</translate>

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

<translate> is equivalent to, assuming the template doesn't recognize SPACEN as a parameter name:</translate>

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

<translate>

It is also possible to use the same name for each spacer (often the empty string), but this will populate <tvar name=1>[[:Category:Pages using duplicate arguments in template calls]]</tvar>, which many wikis prefer to keep empty to catch instances of user error.


This can be used to make the template render in a way similar to its output, like showing each row of [[w:Template:Chess position]] on its own like to make the wikitext also look like a chessboard.

== Tracking parameter usage == 
</translate>

<translate>

It may be wise for a template to add a link or category to a page if a certain parameter or combination of parameters is used, to make if possible to easily determine what pages are using a given parameter, and thus what the impacts of changing that parameter in the template would be.

== Evaluation process == 
</translate>

<translate> Generally speaking, template parameters are substituted into the template after tokenization, but as is.</translate>
<translate> They are not evaluated until they are used.</translate>

<translate> This has a few consequences:</translate>

# <translate> If you have a <tvar name=1><code>Template:Start</code></tvar> containing <tvar name=2><code><nowiki></nowiki></code></tvar>, and put <tvar name=5><code><nowiki></nowiki></code></tvar> on a page, ''mytemplate'' isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates.</translate> <translate> You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.</translate>
# '''<translate> Dead-code elimination:</translate>''' <translate> If you make a template call like <tvar name=1><code><nowiki> }}</nowiki></code></tvar>, and <code>Template:Foo</code> does not contain <tvar name=2><nowiki>}</nowiki></tvar>, then the <tvar name=3><code>DISPLAYTITLE</code></tvar> is not used, since it is only evaluated when needed, and there is no parameter to substitute it into, so it is never evaluated.</translate> <translate> This usually comes into play when using <tvar name=3></tvar>, and can be especially noticed when used in combination with the <tvar name=2><code><nowiki>int:</nowiki></code></tvar> magic word that varies by user language.</translate> <translate> This isn't perfect, and in some cases even if the result of expanding a template is not used (because it is part of an if statement condition, for example), the process of evaluating it can still have [[w:Side effect (computer science)|side effects]].</translate> <translate> For example, any produced or other templates used will still be added to <tvar name=2>[[Special:WhatLinksHere]]</tvar> even if they are not displayed.</translate>

<translate> Template parameters are [[w:pass by value|pass by value]], which means a template cannot modify its arguments.</translate>
<translate> Parameters are treated as [[w:Associative array|associative array]], and parameter names are evaluated before parameter values.</translate>
<translate> If the same parameter name is given more than once (either as named or unnamed), only the last instance is used, and the page is added to <tvar name=1>[[:Category:Pages using duplicate arguments in template calls]]</tvar>.</translate>

<translate> Template calls starting with the magic word <tvar name=1><code>subst:</code></tvar> or <tvar name=2><code>safesubst:</code></tvar> are evaluated in a separate first pass that only happens at save time, along with <tvar name=3><nowiki>~~~~</nowiki></tvar> and links using the [[<tvar name=4>Special:MyLanguage/pipe trick</tvar>|pipe trick]].</translate>
<translate> If they cannot be evaluated during the first pass, <tvar name=1><code>subst:</code></tvar> calls are ignored, and <tvar name=2><code>safesubst:</code></tvar> are treated as if a normal template.</translate>

<translate> Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker".</translate>
<translate> This means you cannot manipulate the results with parser functions like <tvar name=1>padleft:</tvar> or similar functions from extensions, as they see the strip marker instead of the result of the parser function.</translate>

<translate>
=== Recursion in templates === 
</translate>
<translate> Including a template in itself won't throw MediaWiki into infinite recursion.</translate>
<translate> MediaWiki will stop the recursion with the template's name in bold.</translate>
<translate> For example, if the content of Template:Aaaa is <tvar name=code><code>a <nowiki></nowiki> z</code></tvar>, it'll display "<tvar name=result>a a <span class="error">Template loop detected: '''Template:Aaaa'''</span> z z</tvar>".</translate>

<translate> This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments.</translate>
<translate> In this forbidden example <tvar name=1><code>template:d</code></tvar> can either be called <tvar name=2><code><nowiki></nowiki></code></tvar> or <tvar name=3><code><nowiki></nowiki></code></tvar>.</translate>
<translate> If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.</translate>

<syntaxhighlight lang="wikitext">
}|}|0|4}}|m=}|4|2}}|d=}|6|2}}}}|}}
</syntaxhighlight>

<translate> If <tvar name=1><code>template:d</code></tvar> is modified to recurse into <tvar name=2><code>template:d/2</code></tvar> and <tvar name=3><code>template:d/2</code></tvar> is an ''identical manual copy'' of <tvar name=4><code>template:d</code></tvar> this idiom works fine as the self-recursion safeguard operates dynamically and not statically.</translate>

<translate> A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing.</translate>
<translate> That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.</translate>

<translate> If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case.</translate>
<translate> If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.</translate>

<translate>
=== Tables in parameters === 


Since the pipe character (<tvar name=1><code>|</code></tvar>) and equality sign (<tvar name=2><code>=</code></tvar>) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:
</translate>

* <translate> the built-in <tvar name="2"><code><nowiki></nowiki></code></tvar> provides an "escaped" version of <tvar name="3"><code>|</code></tvar> since MediaWiki 1.24</translate>
* <translate> the built-in magic word <tvar name="1"><code><nowiki></nowiki></code></tvar> provides an "escaped" version of <tvar name="2"><code>=</code></tvar> since MediaWiki 1.39</translate>

<translate> Before the introduction of these magic words, many wikis used templates to accomplish the same things.</translate>
<translate> On such a wiki, the magic words take precendence over the same-named templates.</translate>

<translate>
====Example table==== 
</translate>

{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}

'''<translate> Table code:</translate>'''

<syntaxhighlight lang=wikitext>
{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}
</syntaxhighlight>

'''<translate> Escaped table code:</translate>'''

<syntaxhighlight lang=wikitext>
classwikitable
!A!!B!!C
-
A1B1C1
-
A2B2C2
}
</syntaxhighlight>

<translate> Note that the first left-brace (<tvar name="1"><code>{</code></tvar>) is interpreted as a literal left-brace character because it is immediately followed by the <tvar name="2"><code><nowiki></nowiki></code></tvar> magic word.</translate>
<translate> Similarly, the last right-brace (<tvar name="1"><code>}</code></tvar>) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word.</translate>
<translate> However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:</translate>

* <translate> the template call <tvar name="1"><code><nowiki></nowiki></code></tvar> might provide an "escaped" version of <tvar name="2"><code>{</code></tvar></translate>
* <translate> the template call <tvar name="1"><code><nowiki></nowiki></code></tvar> might provide an "escaped" version of <tvar name="2"><code>}</code></tvar></translate>

<translate> Some wikis go even further and provide other convenience templates like <tvar name="1"> (<code><nowiki>{|</nowiki></code>), (<code>|}</code>), (<code>||</code>)</tvar>.</translate>
<translate> On such a wiki, the code can be simplified a bit to this form:</translate>

<syntaxhighlight lang=wikitext>
classwikitable
!A!!B!!C
-
A1B1C1
-
A2B2C2

</syntaxhighlight>

<translate>
== Controlling template inclusion == 
</translate>
<translate> By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page.</translate>
<translate> The template's page when viewed directly appears exactly as the template would render without any parameters.</translate>
<translate> If the template requires parameters to function properly, this will result in raw wikitext syntax or errors as a result of them being missing.</translate>
<translate> For example:</translate>

* <translate> If a parameter has no default value, it shows as the literal text <tvar name="1"><nowiki>}</nowiki></tvar>, indicating the template needs a parameter.</translate>
* <translate> If a parameter has an empty default value (it is written as <tvar name="1"><nowiki>}</nowiki></tvar>), it displays nothing, which achieves the intended effect but lacks clarity for self-documentation.</translate> }</nowiki></code></tvar> could clarify a parameter's role, especially for templates involving images.</translate>
|1=<translate> image</translate>
}}
* <translate> If a parameter without a default is passed to the <tvar name="1"><code>#expr</code></tvar> parser function, it results in an error message: "Expression error: unrecognized punctuation character '{'."</translate>
* <translate> If a template creates a table, it's helpful for the template page to show the table's structure rather than the wikitext used to make it.</translate> <translate> To do this, the table syntax isn't enclosed in tags, and each table element includes both <tvar name="1"></tvar> and <tvar name="2"></tvar> parts where needed.</translate>

<translate>

However, you can control which parts of a template will be seen and included by the use of the <tvar name=noinclude></tvar>, <tvar name=includeonly></tvar> and <tvar name=onlyinclude></tvar> tags.


Anything between <tvar name=noinclude_start></tvar> and <tvar name=noinclude_end></tvar> will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:


* [[<tvar name=1>Special:MyLanguage/Help:Categories</tvar>|Category]] links when categorizing the template itself</translate>
<translate>

* [[<tvar name=1>Special:MyLanguage/Help:Links#Interlanguage links</tvar>|interlanguage links]] to similar templates in other languages</translate>
<translate>

* Explanatory text about how to use the template.</translate> <translate> It's a common pattern on some wikis to use a template like <tvar name="1"></tvar> to transclude the documentation from a subpage of the template.</translate> <translate> For example, <tvar name="1">[[Template:Void]]</tvar> is documented at <tvar name="2">[[Template:Void/doc]]</tvar>.</translate>

<translate>

Likewise, anything between <tvar name=includeonly_start></tvar> and <tvar name=includeonly_end></tvar> will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:


* [[<tvar name=1>Special:MyLanguage/Help:Categories</tvar>|Categorizing]] pages which include the template.</translate> <translate> '''Note:''' when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the .</translate> <translate> To force the re-categorization of a particular page, open that page for editing and save it without changes.</translate>
<translate>

* Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.
</translate>

<translate> Everything outside <tvar name=noinclude></tvar> and <tvar name=includeonly></tvar> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page.</translate>
<translate> The focus is on what is inside these two tags.</translate>

<translate> Everything outside <tvar name=onlyinclude></tvar> tags is discarded in the transclusion.</translate>
<translate> Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude.</translate>
<translate> The focus is only on what is inside this tag.</translate>

<translate> For example, if a page like [[<tvar name=1>Special:MyLanguage/Help:Templates/onlyinclude demo</tvar>|Help:Templates/onlyinclude demo]] has the wikitext:</translate>

<syntaxhighlight lang="wikitext">
abc<onlyinclude>def</onlyinclude>ghi<includeonly>jkl</includeonly>
</syntaxhighlight>

<translate>

The result of transcluding it is <tvar name=1></tvar>.


Nesting of these tags is also possible.
</translate>

<translate> The three partial transclusion tags enable all possible combinations of what is processed and rendered.</translate>
<translate> Comments also fill a role.</translate>
<translate> Inclusion tags are respected when using <tvar name="1"><code><nowiki></nowiki></code></tvar>, but they are '''not''' respected when using <tvar name="2"><code><nowiki></nowiki></code></tvar> as that displays the raw wikitext without any processing.</translate>

<translate>
== Section transclusion == 


To transclude different sections of a template on different pages, you can wrap the content in onlyinclude tags and use an if statement on parameters to select which section.


Consider "<tvar name=1>Template:Example</tvar>" with this wikitext:
</translate>

<syntaxhighlight lang="wikitext">
== Section 1 ==
}|1|
Content of section one.
}}
}|2|
== Section 2 ==
Content of section two.
}}
</syntaxhighlight>

<translate>

This will render both sections on the example page itself, and allow other pages to transclude the first section with <tvar name=1><code><nowiki></nowiki></code></tvar> and the second section with <tvar name=2><code><nowiki></nowiki></code></tvar>.


Another approach is to use literal parameter syntax instead:
</translate>

<syntaxhighlight lang="wikitext">
}
}
</syntaxhighlight>

<translate> Transclude the first section with <tvar name=1><code><nowiki></nowiki></code></tvar> and the second section with <tvar name=2><code><nowiki></nowiki></code></tvar>.</translate>
<translate> If neither parameter is used, then both sections will display.</translate>

<translate>

A third approach is to use <tvar name=1></tvar>.

== Organizing templates == 


For templates to be effective, users need to find them, and find out how to use them.


To find them, users can:
</translate>

# <translate> Click <tvar name=special><code></code></tvar> > <tvar name=all><code></code></tvar></translate>
# <translate> In the <tvar name=ns><code></code></tvar> list, choose '''Template''' and click <tvar name=submit><code></code></tvar>.</translate>

<translate>

To give usage information, include an example like this one on the template page:


<pre><nowiki>
<noinclude>
== Usage ==
Welcome users:

</noinclude>
</nowiki></pre>


Then, an editor can simply copy and paste the example to use the template.
</translate>

<translate> While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled <tvar name=1><code></code></tvar> (also named <tvar name=2><code></code></tvar>, or <tvar name=3><code></code></tvar> depending on the context).</translate>
<translate> This list provides a convenient link to the template's page, as well as information about its protection status.</translate>
<translate> Redirected templates are shown in italics, with the redirect target added as a separate list item.</translate>

<translate>
== Linking to a template == 


A template page can be linked to like any other wiki page. For example, the link <tvar name=navbarlink>[[Template:Navbar]]</tvar> is generated using the wikicode <tvar name=navbarcode><code><nowiki>[[Template:Navbar]]</nowiki></code></tvar>.
</translate>

<translate> On many wikis, <tvar name=1>[[Template:Tl]]</tvar> can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion.</translate>
<translate> For example, the code <tvar name=2><code><nowiki></nowiki></code></tvar> may be used to create the link <tvar name=3></tvar>.</translate>

<translate> This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages.</translate>
<translate> The same effect can be achieved by using <tvar name=1><code><nowiki></nowiki></code></tvar>, but the <tvar name=2><code></code></tvar> approach involves much less typing.</translate>
<translate> On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element or as monospace type.</translate>
<translate> If not (as on this wiki), another similarly named template may do so.</translate>
<translate> See, for example, the [[<tvar name=1>Template:Tl#See also</tvar>|"See also" section of our Template:Tl documentation]].</translate>

<translate>
== Template naming == 


The name of a template is case-sensitive excluding the first character.
</translate>

<translate> You make [[<tvar name=1>Special:MyLanguage/Help:Redirect</tvar>|redirects]] for alternate capitalizations.</translate>
<translate> For example, if a template is named "<tvar name=1>AdminAbbr</tvar>", you can create a redirect named "<tvar name=2>Adminabbr</tvar>".</translate>
<translate> This way, the template can be called with either <tvar name=1><code><nowiki></nowiki></code></tvar> or <tvar name=2><code><nowiki></nowiki></code></tvar>.</translate>
<translate> If an editor prefers a mix of upper and lower case for clarity, they can use functions like [[<tvar name=1>Special:MyLanguage/Help:Parser_function#LC</tvar>|lc]] or [[<tvar name=2>Special:MyLanguage/Help:Parser_function#UC</tvar>|uc]].</translate>
<translate> For instance, instead of <tvar name=1><code><nowiki></nowiki></code></tvar>, they could use <tvar name=2><code><nowiki> }}</nowiki></code></tvar></translate>

<translate>

Because template names are interpreted in the same way to the names of other pages, underscores are replaced with spaces, and any text after a number sign (what would be a [[<tvar name=1>Special:MyLanguage/Help:Links#Anchors</tvar>|anchor]] in a standard link) is ignored.


An underscore <tvar name=1><code>_</code></tvar> can be alternative to a blank space.

== Possible uses of templates == 
</translate>
<translate> Templates can be used for any situation in which one wants two or more pages to contain identical or similar content that is edited together rather than independently.</translate>
<translate> They can be used to:</translate>

* <translate> Provide structured elements on many pages, like [[w:WP:Infoboxes|infoboxes]], [[w:WP:Template index|maintenance templates]], [[w:Template:navbox|navigational boxes]], etc.</translate>
* <translate> Perform calculations used as a programming tool on various pages, like [[w:Template:Sum]].</translate>
* <translate> Build composite pages that display the content of multiple existing pages together, like [[w:WP:Village pump (all)]] which includes content from each section of the village pump.</translate> <translate> The content of these pages can either be shown individually, or together, but the revision history, watchlist, etc. will only pick up changes to the transcluded pages and the raw wikitext of the composite page itself, not implicit changes to the composite page.</translate>
* <translate> Share some content between a few related pages.</translate> <translate> For example, the list at [[<tvar name=1>Special:MyLanguage/Help:Preferences#Beta features</tvar>|Help:Preferences#Beta features]] is duplicated at [[<tvar name=2>Special:MyLanguage/Beta Features#Current Beta Features</tvar>|Beta Features#Current Beta Features]].</translate> <translate> While on <tvar name=2>MediaWiki.org</tvar> that is built using <tvar name=1></tvar> instead, it could have been done using a template.</translate>
* <translate> Store content referenced multiple times on the same page, so it only has to be written and calculated once.</translate> <translate> For example [[w:Template:Cite Monumentenregister/URL]] is called twice by [[w:Template:Cite Monumentenregister]] in two different places, and using another template means the URL pattern only has to be written once in the base template.</translate>
* <translate> Use templates as a programming element to generate a loop: if Template:A calls Template:B 10 times with different parameters, then that crudely simulates a for loop.</translate> <translate> If Template:B calls Template:C 10 times, then you have a nested loop of 100 calls of Template:C.</translate> <translate> But keep in mind that it is easy to run into the [[<tvar name=1>Special:MyLanguage/Manual:Template limits</tvar>|template limits]] when using templates as advanced programming constructs, and using <tvar name=2></tvar> is generally clearer and easier to follow.</translate>

<translate>
== Copying from one wiki to another == 
</translate>
<translate> It is possible, if to transclude templates from other wikis.</translate>
<translate> This configuration setting is disabled on Wikimedia wikis.</translate>
<translate> Otherwise, you need to manually copy the template and its dependencies from the source wiki to the destination wiki to use it.</translate>

<translate> Templates often require [[<tvar name=1>Special:MyLanguage/Manual:Interface/Stylesheets</tvar>|CSS]] or other templates, so users frequently have trouble copying templates from one wiki to another.</translate>
<translate> The steps below should work for most templates.</translate>

<translate>
=== MediaWiki code === 


If you have import rights (specifically <tvar name=1><code>importupload</code></tvar>) on the new wiki:
</translate>

# <translate> Go to <tvar name=export>[[Special:Export]]</tvar> on the original wiki, and download an <tvar name=1>.xml</tvar> file with the complete history of all necessary templates, as follows:</translate>
#* <translate> Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters – if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.</translate>
#* <translate> Select the box <tvar name=export><code></code></tvar>.</translate>
#* <translate> Select the box <tvar name=export2><code></code></tvar>.</translate>
#* <translate> Click <tvar name=1><code></code></tvar>.</translate>
# <translate> Go to [[Special:Import]] on the new wiki and upload the <tvar name=1>.xml</tvar> file.</translate>

<translate>

If you don't have import rights on the new wiki:
</translate>

# <translate> Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext</translate>
# <translate> On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.</translate>
# <translate> Back in the original wiki at the edit window, below the edit box, look at the list of <tvar name=1><code></code></tvar>.</translate> <translate> For each template listed follow these instructions.</translate> <translate> Also do that for any template used by any of these templates, and so on.</translate>

<translate> This will copy the entire code necessary, and will suffice for some templates.</translate>
<translate> Note that only page elements parsed in rendering the page get exported, consequently documentation subpages are not exported as part of this process.</translate>
<translate> If it doesn't work also check for red links listed under <tvar name=1><code></code></tvar>, below the edit box.</translate>
<translate> If there are any repeat the above steps for these as well and also copy the code in the modules.</translate>

<translate>

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

=== Extensions === 
</translate>
<translate> An extension often used in templates is ParserFunctions.</translate>
<translate> Visit page <tvar name=1></tvar> and check if any of the functions listed there are used in the templates you've copied.</translate>
<translate> If so, you have to install the <tvar name=1></tvar> extension.</translate>
<translate> To install it, you'll need system admin access to the server of your MediaWiki installation.</translate>

<translate> Another dependency that may be used in templates, especially those on Wikipedia, is [[w:Lua (programming language)|Lua]]. Having <tvar name=1><code><nowiki></nowiki></code></tvar> in template code is a good sign for it.</translate>
<translate> In case it's used, you need to install the <tvar name=1></tvar> extension and system admin access is required too.</translate>
<translate> See that page for more instructions about installing and using the extension.</translate>

<translate>
=== CSS and JavaScript code === 


Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.
</translate>

# <translate> Look for the use of CSS classes (text like <tvar name=1><code>class="foobar"</code></tvar>) in the template text.</translate> <translate> If those classes appear in <tvar name=1><code>MediaWiki:Common.css</code></tvar> or <tvar name=2><code>MediaWiki:Vector.css</code></tvar> on the original wiki, copy those classes to <tvar name=1><code>MediaWiki:Common.css</code></tvar> on the new wiki and check if the template is now fine.</translate>
# <translate> If the copied template is still not working as expected, check if there is code in <tvar name=1><code>MediaWiki:Common.js</code></tvar> or <tvar name=2><code>MediaWiki:Vector.js</code></tvar> on the original wiki.</translate> <translate> If so, you can try copying it to <tvar name=1><code>MediaWiki:Common.js</code></tvar> on the new wiki.</translate> <translate> Normally, it is a good idea to only copy code from trusted sources, and browse the code to identify and select the relevant parts.</translate> <translate> You may find comments that can serve as clues to identify the functionality of each part.</translate>

<translate>
== Redirection == 
</translate>
<translate> If a page uses a [[<tvar name=1>Special:MyLanguage/Help:Redirect</tvar>|redirect]] as a template, the redirect is resolved before processing the template and the target is used instead.</translate>
<translate> This won't work if the target doesn't exist (a broken redirect), or is itself a redirect (a double redirect).</translate>

<translate> A page that just includes another page as a template might look like a redirect, but there are several differences between them:</translate>

* <translate> The header of the result displays the title of the page it came from.</translate>
* <translate> No "Redirected from" message is shown.</translate>
* <translate> Buttons like edit, watch, talk, history, "what links here," and "last modified" point to the referring page.</translate> <translate> To access the target page, use a section edit link and navigate from there.</translate>
* <translate> Unless '''includeonly''' and/or '''noinclude tags''' are used, the referring page shares the same categories as the target page.</translate>
* <translate> "Double redirects" work when one or both are this type of pseudo-redirect.</translate>

{{Note|type=reminder|text=<translate> Embedding works on pages that support [[<tvar name=1>Special:MyLanguage/Help:Redirects</tvar>|redirects]] and doesn't work on pages without it.</translate>}}

<translate>
== Parser functions == 
</translate>

<translate> MediaWiki also supports [[<tvar name=1>Special:MyLanguage/Help:Parser functions</tvar>|parser functions]], which function similarly to templates but follow slightly different syntax:</translate>

* <translate> Parser functions utilize a "<tvar name=1>:</tvar>" instead of the initial "<tvar name=2>|</tvar>".</translate>
* <translate> An edit page does not display parser functions used on that page.</translate>
* <translate> There is no "What links here" feature for parser functions to identify the pages where they are utilized.</translate>
* <translate> Parser functions templates do not generally accept named parameters, so equal signs generally have no special significance.</translate> <translate> For example:</translate>
: <code><nowiki></nowiki></code> gives <code>x=abc</code>

<translate>
== See also == 

=== General template usage === 
</translate>
*
* [[Help:Substitution]]
* [[w:Help:Template|w:Help:Template]]
* – <translate> describes even more advanced techniques such as dynamic template calls and variable parameter names</translate>
*  – <translate> on the use of multiple instances of the same template on a page.</translate>
*

<translate>
=== Special constructs used in templates === 
</translate>
* – <translate> fancy stuff you may find in some templates</translate>
* – <translate> additional fancy control functions such as <tvar name=if>#if</tvar> and <tvar name=switch>#switch</tvar></translate>
* – <translate> guidance on using parser functions in templates</translate>
*
*
*

<translate>
=== Other relevant information === 
</translate>
*
* – <translate> a template special use case example</translate>
*
*
* – <translate> Using templates as the starting text of a page</translate>
* – <translate> embedding pages from [[<tvar name=ns>Special:MyLanguage/Help:Namespaces</tvar>|namespaces]] other than <code>Template:</code></translate>
*
*
* [[Special:Mostlinkedtemplates]] – <translate> shows the templates with the most uses</translate>
* [[Special:Unusedtemplates]] – <translate> shows templates with no uses (although they may be substituted)</translate>
*  – <translate> using templates from other wikis</translate>
* [[w:Wikipedia:Template namespace]]
* [[w:WP:Anatomy of a template]]
* [[w:Wikipedia:Transclusion costs and benefits]]
* [[Manual:Parser.php]]
*  – <translate> for previewing your changes to a template as it renders elsewhere</translate>
*

<translate>
== External links == 
</translate>
* [https://dev.miraheze.org/wiki/Miraheze_Developers_Wiki <translate> Miraheze template repository</translate>] – <translate> MediaWiki templates intended for general use.</translate>

[[Category:Help|Templates]]
[[Category:Templates]]
[[Category:MediaWiki for site admins]]

----
''Sample content adapted from [[mediawikiwiki:Help:Templates]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Categories

2026-07-25T17:02:05Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />

<translate>

Categories, a software feature of MediaWiki, provide automatic indexes that are useful as tables of contents.


You can categorise pages and files by adding one or more '''Category''' tags to the content text. These tags create links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.

== Summary == 


Each of the pages in the '''Category''' [[<tvar name=ns>Special:MyLanguage/Help:Namespaces</tvar>|namespace]] represents a so-called '''category''', a grouping of related pages, and contains an index for the pages of its category. For example, this page belongs to "<tvar name=cat></tvar>". If you open the category page, you will see a link to this page there.


When a page belongs to one or more categories, these categories appear at the bottom of the page (or in the upper-right corner, depending on the [[<tvar name=1>Special:MyLanguage/Help:Preferences</tvar>|skin]] being used).


The category pages themselves contain 2 parts:


* at their beginning, an optional part may contain text that can be edited, like any other page,
* at their end, an ever present, automatically generated, alphabetical list of all pages in that category, in the form of links. In fact, in the Unicode sort order.


To assign a category to a page, simply add the link "<nowiki>[[</nowiki>Category:''Category name'']]" to the page's wikitext. The usual place to add it is at the bottom of the page.


To link a category page within a page as a normal wiki link (without adding the page to the category), prefix the link name with a colon. For example:


A new category can be [[<tvar name=1>Special:MyLanguage/Help:Starting a new page</tvar>|created]] before assigning any page to it, in the same way as any other regular page.


Individual wikis may have their own top-level categories, such as [[w:Category:Contents|Category:Contents]] on Wikipedia.


For a complete list of all categories which have at least one page, see <tvar name=1>[[Special:Categories]]</tvar>.


For a complete list of all created/edited categories, including the ones that don't have any pages, see <tvar name=1>[[Special:Allpages/Category:]]</tvar> (note the colon at the end).

==Adding a page to a category== 


To add a page or uploaded file to a category, simply edit the page and add the following text (where '''''Name''''' is the name of the category you want to add it to).
</translate>

<nowiki>[[</nowiki>:'''''<translate> Name</translate>''''']]

<translate> Any number of <tvar name=2></tvar> tags may be added to the page and the page will be listed in all of them.</translate>
<translate> <tvar name=2></tvar> tags, along with placed in the sidebar, are usually added at the very bottom of the page for the convenience of other editors.</translate>

<translate>

On a categorised page, categories are displayed in the <tvar name=1><code>:</code></tvar> box strictly in the order they appear in the wikitext.
</translate>

<translate> (At least in MediaWiki 1.18.2) if a category is a subcategory of more than one parent, both hierarchies will be listed, but the tagged category will be stripped off all but one of these.</translate>
<translate> This creates the potential for what appear to be duplicate entries if a category with multiple parents ''and'' one of its parents are both tagged on a page.</translate>
<translate> For example suppose Maryanne is a subcategory of both Mary and Anne.</translate>
<translate> If a page tags categories Maryanne and Anne then the Category breadcrumbs will show</translate>

Anne
Anne
Mary -> Maryanne

<translate>

"Anne" appears to be duplicated, but what is meant is
</translate>

Anne
Anne -> Maryanne
Mary -> Maryanne

<translate>

This is a bug, and has been reported in <tvar name=1>[[phab:T35614]]</tvar>.

===Sort key=== 
</translate>
<translate> By default, a page is sorted within a category under the first letter of its name — ''without the namespace''.</translate>
<translate> Also, MediaWiki groups accented characters separately from their unaccented version, so pages starting by À, Á, Ä, will be listed under separate headings, instead of under heading A.</translate>
<translate> (If you have shell access, these defaults can be changed using <tvar name=CategoryCollation></tvar>.)</translate>

<translate>

A ''sort key'' specifies under which letter heading, and where in the category list, the page will appear.


There are two ways in which you can customise the category sortkey:
</translate>

* <translate> Generically, for all categories, by adding the <tvar name=1></tvar> magic word on the page.</translate>
* <translate> On an individual 'per category' basis, by placing the value inside the tag after a pipe character.</translate> <translate> For example, the tag below will add the page under heading <tvar name=1><code>S</code></tvar>.</translate>
<nowiki>[[</nowiki>:'''''<translate> Name</translate>'''''|'''''<translate> Sort</translate>''''']]

<translate> Whether or not sort keys are case-sensitive depends on your configuration settings.</translate>
<translate> The order of the sections within a category follows the Unicode sort order. The sort key does not change the page title displayed in the category.</translate>

<translate>

Spaces and other characters are perfectly valid.

==Creating a category page== 


Categories exist even if their page has not been created, but these categories are isolated from others and serve little purpose for organisation or navigation.


A category is created by creating a page in the '''''Category:''''' namespace. A category page can be created the same way as other wiki pages (see <tvar name=help></tvar>); just add "<tvar name=code><code>:</code></tvar>" before the page title.


To avoid extra work, try searching within your wiki before creating a new category. The list of all categories can be found in <tvar name=1><code></code></tvar> in the "<tvar name=2>}}</tvar>" box of the [[<tvar name=3>Special:MyLanguage/Help:Navigation#Sidebar</tvar>|sidebar]].

==Managing the category hierarchy== 


Categories may belong to other categories in a hierarchy. Since category pages are much like any other page, a <tvar name=1></tvar> tag may be added to the bottom of a category page.


It is a good idea to organise all categories into a hierarchy with a single top level category. The category structure can take the form of a tree with separate branches, but more often will have a graph structure. Generally, there should be a contiguous chain of parent-child links between each category and the top level category.

=== Category tree === 
</translate>

<translate>

Since MediaWiki 1.31, <tvar name=1></tvar> extension is packaged by default, allowing <tvar name=2>[[Special:CategoryTree]]</tvar> and <tvar name=3></tvar> to provide a tree-like structure display for the categories.

==Hidden categories== 


The categories that a page is in are normally listed at the bottom of the page. In MediaWiki 1.13+, a category can be hidden from this list by adding the [[<tvar name=1>Special:MyLanguage/Help:Magic words</tvar>|magic word]] "<tvar name=2><code><nowiki>__HIDDENCAT__</nowiki></code></tvar>" to the category page.


Users can choose to see hidden categories in a separate <tvar name=1><code></code></tvar> list, by checking <tvar name=2><code></code></tvar> in the <tvar name=3><code></code></tvar> section of <tvar name=4>[[Special:Preferences]]</tvar>.
</translate>

<translate> Hidden categories are automatically added to <tvar name=1>[[:Category:]]</tvar>.</translate>
<translate> This category is specified in the system message <tvar name=1>[[MediaWiki:Hidden-category-category]]</tvar>.</translate>

<translate>
==Linking to a category== 


To create a link to a category, use a leading colon before the category name (without this colon, the current page would be added to the category):
</translate>

:<code><nowiki>[[</nowiki>::Help]]</code> → '''[[::Help]]'''

<translate>

To change the link text, write the text inside the link tag after a pipe:
</translate>

:<code><nowiki>[[</nowiki>::Help|<translate> Help category</translate>]]</code> → '''[[::Help|<translate> Help category</translate>]]'''

<translate>

[[<tvar name=1>Special:MyLanguage/Help:Redirects</tvar>|Redirect pages]] that redirect to categories must also use the colon, otherwise they will be added to the category instead of redirecting.

== Categories and templates (transcluded pages) == 


If you add <tvar name=1><syntaxhighlight lang="wikitext" inline>[[Category:Cats]]</syntaxhighlight></tvar> inside a template (a transcluded page), ''both'' the template and pages which transclude this template will be categorised in <tvar name=2>Cats</tvar>.


If you want ''only the template'' to be categorised, you should ensure to write category marker inside <tvar name=1><code></code></tvar> tags.


If you want ''only the pages which use the template'' to be categorised, but not the template itself, you should ensure to write category marker inside <tvar name=1><code></code></tvar> tags.
</translate>

<translate> Due to caching issues, editing categories applied through templates may take a while to be visible everywhere.</translate>
<translate> You can perform a [[<tvar name=1>Special:MyLanguage/Manual:Null edit</tvar>|null edit]] on a page to update immediately its categories.</translate>

<translate>
==Redirecting a category== 
</translate>
<translate> Like any other pages (templates, files, etc), category pages can be redirected to other normal or category pages.</translate>
<translate> However, '''unlike''' templates, files, and regular content pages, when you ''use'' a category, redirects will ''not'' apply (<tvar name=1>[[phab:T5311]]</tvar>).</translate>
<translate> For example:</translate>

{| class="wikitable"
! <translate> Premise</translate>
! <translate> What you write</translate>
! <translate> Result (categorization)</translate>
! <translate> Result (link behavior)</translate>
|-
| <translate> <tvar name=1><code>Category:A</code></tvar> redirects to <tvar name=2><code>Category:B</code></tvar></translate>
| <code><nowiki>[[Category:A]]</nowiki></code>
| <translate> The page is added to <tvar name=1><code>Category:A</code></tvar></translate>
| <translate> Visitors cannot access the category page (it immediately redirects to <tvar name=1><code>Category:B</code></tvar>)</translate>
|-
| <translate> <tvar name=1><code>Category:A</code></tvar> redirects to <tvar name=2><code>Category:B</code></tvar></translate>
| <code><nowiki>[[Category:B]]</nowiki></code>
| <translate> The page is added to <tvar name=1><code>Category:B</code></tvar></translate>
| <translate> Visitors can access it via <tvar name=1><code>Category:B</code></tvar> or <tvar name=2><code>Category:A</code></tvar> (normal redirect behavior)</translate>
|-
| <translate> <tvar name=1><code>Category:A</code></tvar> redirects to <tvar name=2><code>Category:B</code></tvar></translate>
| <code><nowiki>[[:Category:A]]</nowiki></code>
| <translate> The page is not categorized</translate>
| <translate> A direct link to <tvar name=1><code>Category:A</code></tvar> is created; normal redirect behavior applies on click</translate>
|-
| <translate> <tvar name=1><code>Category:A</code></tvar> redirects to <tvar name=2><code>Category:B</code></tvar></translate>
| <code><nowiki>[[:Category:B]]</nowiki></code>
| <translate> The page is not categorized</translate>
| <translate> A direct link to <tvar name=1><code>Category:B</code></tvar> is created; it behaves as expected</translate>
|}

<translate>

Because this behavior may be confusing, some Wikimedia sites use a "category redirect" template to mark redirected categories, allowing manual or automated cleanup of pages categorised there.

==Tracking categories== 
</translate>
<translate> Certain syntax issues, such as a broken image link, or too many expensive parser functions, can cause a page to be added to a tracking category.</translate>
<translate> Also, extensions may add pages to tracking categories, for example <tvar name=1></tvar>.</translate>
<translate> See <tvar name=1></tvar> for details.</translate>

<translate>
== Renaming a category == 


If you move a category, since [[<tvar name=1>#Redirecting a category</tvar>|redirect will not work for categorising]], all category tags will be wrong, so you have to fix them.

==See also== 
</translate>
*
* <translate> <tvar name=UseCategoryBrowser></tvar> - if this is set to true, under the first list each category is listed again, [[w:breadcrumb (navigation)|breadcrumb]]-style, with all its parent categories, sorted alphabetically.</translate>

[[Category:Help|Categories]]
[[Category:Category]]

----
''Sample content adapted from [[mediawikiwiki:Help:Categories]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Links

2026-07-25T17:02:04Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages/>

<translate>

Links are used to reference pages within MediaWiki, other wikis, or external websites.


There are five types of hypertext links in MediaWiki:
</translate>

# <translate> '''[[<tvar name=internal>#Internal links</tvar>|Internal links]]''' to other pages in the same wiki (commonly called "wikilinks")</translate>
# <translate> '''[[<tvar name=external>#External links</tvar>|External links]]''' to pages at other websites</translate>
# <translate> '''[[<tvar name=external2>#External links to internal pages</tvar>|External links to internal pages]]''' in the same wiki</translate>
# <translate> '''[[<tvar name=interwiki>#Interwiki links</tvar>|Interwiki links]]''' to other websites using special prefixes registered in advance</translate>
# <translate> '''[[<tvar name=interlang>#Interlanguage links</tvar>|Interlanguage links]]''' to other wikis registered as different language versions of the current wiki</translate>

<translate>

Please note that this list does not include [[<tvar name=1>Special:MyLanguage/Help:Categories</tvar>|category links]] and [[<tvar name=2>Special:MyLanguage/Help:Images</tvar>|file links]], which are used to place pages into categories and display images or other media files, respectively.
</translate>
__TOC__

<translate>
== Internal links == 
</translate>
<translate> To [[<tvar name=1>Special:MyLanguage/Help:Editing pages</tvar>|create]] a so-called internal link to a page on the same wiki (a "wikilink"), use double square brackets wiki markup, .</translate>
<translate> When you preview or save your changes, you will see a link that can be followed to the target page.</translate>
<translate> If the page exists, the link is displayed in blue (like the word "create" in the first sentence of this paragraph); if the page does not exist, the link appears red (so the link is actually rendered ).</translate>
<translate> Note that the colors could be different if the color scheme of the wiki has been changed from the default.</translate>
<translate> Following such a "redlink" to a missing page (whether or not it is actually red) will usually enable the user to create the page.</translate>

<translate>

To markup any arbitrary string of text (not necessarily a page title) as a link, use a "vertical bar" or "pipe" character, like this: $1<nowiki>]]</nowiki></code></tvar>|category links}} results in the link .
</translate>

<translate> The first letter of the link target is usually not case-sensitive (unless the wiki is configured otherwise), meaning links can be capitalized or not (so [[How to contribute]] and [[how to contribute]] are equivalent).</translate>
<translate> However, the case of every ''subsequent'' letter must match the target page exactly (so [[How to contribute]] and [[How To Contribute]] are ''not'' equivalent).</translate>
<translate> Spaces in the page title may be represented as underscores (so [[How to contribute]] and [[How_to_contribute]] are again equivalent), but using underscores in links will make them visible in the page text (but this can be prevented by using a "pipe").</translate>

<translate> If the page title you are linking to is that of the page you are editing, the result is not a hyperlink at all but simply bold text (for example, on this page the markup <tvar name=1><code><nowiki>[[</nowiki>]]</code></tvar> gives the result <tvar name=2>[[]]</tvar>).</translate>
<translate> If you're trying to create a wikilink to the current page, you probably want to link to a specific ''section'' or to an ''anchor'' within the page; see the examples below.</translate>

<translate>

MediaWiki uses the <tvar name=1></tvar> table to keep track of internal wikilinks.
</translate>

<translate> Unlike external links, internal links do not support the use of URL query parameters.</translate>
<translate> The addition of HTML attributes is not supported by either internal or external links.</translate>

{| border="1" class="wikitable"
! <translate> Name</translate>/<translate> Description</translate>
! <translate> Syntax</translate>
! <translate> Result</translate>

|-
| <translate> Internal link</translate>
|<syntaxhighlight lang="mediawiki">
[[Main Page]]

[[Help:Contents]]

[[Extension:DynamicPageList (Wikimedia)]]
</syntaxhighlight>
|
[[Main Page]]

[[Help:Contents]]

[[Extension:DynamicPageList (Wikimedia)]]

|-
| <translate> Piped link</translate>
|
<syntaxhighlight lang="mediawiki">[[Help:Editing pages|editing help]]</syntaxhighlight>

<translate> Links to a section/anchor within the target page.</translate>
<syntaxhighlight lang="mediawiki">[[Help:Editing pages#Preview|previewing]]</syntaxhighlight>

<translate> Piped link to an anchor on the same page</translate>
<syntaxhighlight lang="mediawiki">[[#See also|different text]]</syntaxhighlight>

<translate> See also [[<tvar name=meta>Special:MyLanguage/Help:Links#Piped links</tvar>|Help:Piped link]].</translate>
|
[[Help:Editing pages|editing help]]

[[Help:Editing pages#Preview|previewing]]

[[#See also|different text]]
|-
| <translate> [[w:Help:Pipe trick|Pipe trick]]</translate>
|<syntaxhighlight lang="mediawiki">
[[Manual:Extensions|Extensions]]

[[User:John Doe|John Doe]]

[[Extension:DynamicPageList (Wikimedia)|DynamicPageList]]

[[Extension:DynamicPageList (disambiguation)|DynamicPageList]]
</syntaxhighlight>
<translate> The transformation done by the pipe trick can result in the same text for different link targets, as seen in the DynamicPageList examples.</translate>
|

[[User:John Doe|John Doe]]

[[Extension:DynamicPageList (Wikimedia)|DynamicPageList]]

[[Extension:DynamicPageList (disambiguation)|DynamicPageList]]

|-
|<span id="linktrail"></span><translate> Word-ending links</translate>
|<syntaxhighlight lang="mediawiki">
[[Help]]s

[[Help]]ing

[[Help]]ers

[[Help]]almostanylettersyoulikehere

[[Help]]BUTnotalways
</syntaxhighlight>
<translate> Follows so-called "linktrail rules" [[<tvar name=loc>Special:MyLanguage/Localisation</tvar>|localised]] per [[<tvar name=msgxx>Special:MyLanguage/MessagesXx.php</tvar>|each language]].</translate>
|
[[Help]]s

[[Help]]ing

[[Help]]ers

[[Help]]almostanylettersyoulikehere

[[Help]]BUTnotalways

|-
| <translate> Avoiding word-ending links</translate>
|<syntaxhighlight lang="mediawiki">
[[Help]]<nowiki />ful advice

[[wikipedia:GNU General Public License|GPL]]<nowiki />v3
</syntaxhighlight>
|
[[Help]]<nowiki />ful advice

[[wikipedia:GNU General Public License|GPL]]<nowiki />v3

|-
| <translate> Link to an anchor on the same page</translate>
|<syntaxhighlight lang="mediawiki">[[#See also]]</syntaxhighlight>
<translate> Anchors are provided automatically on [[<tvar name=formatting>Special:MyLanguage/Help:Formatting</tvar>|section headings]] and to the [[<tvar name=1>#top</tvar>|top]] (<tvar name=2><code><nowiki>[[#top]]</nowiki></code></tvar>) of the page.</translate>
|[[#See also]]

|-
| <translate> Setting an anchor for incoming links</translate>
|<syntaxhighlight lang=html>
<div id="Unique anchor name 1">optional text</div>

<span id="Unique anchor name 2">optional text</span>
</syntaxhighlight>

<translate> Rendered [[w:HTML element#Document body elements|block-level and inline]], respectively.</translate>
<translate> Doing this would allow for <code><nowiki>[[#Unique anchor name 1]]</nowiki></code> on the same page or <code><nowiki>[[</nowiki>#Unique anchor name 1]]</code> on a different page.</translate>
<translate> Omit the "optional text" for an invisible anchor.</translate>

<translate>

Setting an anchor in a section heading
</translate>

<syntaxhighlight lang=html>
==<span id="Alternate Section Title"></span>Section heading==
</syntaxhighlight>

<translate> Note the placement.</translate>
<translate> This must be a "span" tag, not a "div".</translate>
<translate> (Such anchors allow sections to be retitled without breaking incoming links.)</translate>

|
<div id="<translate nowrap> Unique anchor name 1</translate>"><translate> optional text</translate></div>

<span id="<translate nowrap> Unique anchor name 2</translate>"><translate> optional text</translate></span>

<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.5em; font-family: Georgia,Times,serif; margin-top: 1em; margin-bottom: 0.25em; line-height: 1.3; padding: 0; border-bottom: 1px solid #AAAAAA;"><span id="Alternate Section Title"></span>Section heading</div>
|-
| <translate> Link to an anchor at another page</translate>
|<syntaxhighlight lang=mediawiki>[[Help:Images#Supported media types for images]]</syntaxhighlight>
|[[Help:Images#Supported media types for images]]

|-
| <translate> Link to the current page's talk page</translate>
|<syntaxhighlight lang=mediawiki>[[Discussion]]</syntaxhighlight>
<translate> See also [[<tvar name=page-names>Special:MyLanguage/Help:Magic_words#Page_names</tvar>|Help:Magic words#Page names]]</translate>
|[[Discussion]]

|-
|<translate> Link to a subpage.</translate> <translate> Can only be used on pages inside a namespace where subpages are enabled.</translate>
|<syntaxhighlight lang=mediawiki>[[/example]]</syntaxhighlight>
<translate> Shortcut for <tvar name=1><syntaxhighlight lang="mediawiki" inline>[[Help:Links/example|/example]]</syntaxhighlight></tvar>.</translate> <translate> See also <tvar name=1></tvar>.</translate>
|[[Help:Links/example|/example]]

|-
| <translate> Link to a subpage without the leading slash.</translate> <translate> Can only be used on pages inside a namespace where subpages are enabled.</translate>
|<syntaxhighlight lang=mediawiki>[[/example/]]</syntaxhighlight>
<translate> Shortcut for <tvar name=1><syntaxhighlight lang="mediawiki" inline>[[Help:Links/example|example]]</syntaxhighlight></tvar>.</translate>
|[[Help:Links/example|example]]

|-
| <translate> Link to a subpage of parent page for current page.</translate> <translate> Can only be used on subpages.</translate>
|<syntaxhighlight lang=mediawiki>[[../example2]]</syntaxhighlight>
<translate> Shortcut for <tvar name=1><syntaxhighlight lang="mediawiki" inline>[[Help:Links/example2|example2]]</syntaxhighlight></tvar> if you post the link on <tvar name=2><syntaxhighlight lang="mediawiki" inline>[[Help:Links/example|example]]</syntaxhighlight></tvar> page.</translate>
|[[Help:Links/example2|example2]]

|-
| <translate> Visible link to a category page</translate>
|<syntaxhighlight lang=mediawiki>[[:Category:Help]]</syntaxhighlight>
<translate> Without the leading colon the link would not be visible and the page would instead be placed into the category; this is a very common mistake.</translate>
<translate> See also <tvar name=1></tvar>.</translate>
|[[:Category:Help]]

|-
| <translate> Visible link to an image or media file</translate>
|id="file-links"|<syntaxhighlight lang=mediawiki>
[[:File:Example.jpg]]

[[:File:Example.jpg|file label]]

[[Media:Example.jpg]]

[[Media:Example.jpg|file label]]
</syntaxhighlight>

<translate> Without the leading colon on the "File:" examples, the images would actually be displayed.</translate>
<translate> See also <tvar name=1></tvar>.</translate>

<translate>

The <tvar name=1><code>Media:</code></tvar> prefix is used to link directly to the uploaded file, rather than the file-information page.</translate>
|
[[:File:Example.jpg]]

[[:File:Example.jpg|file label]]

[[Media:Example.jpg]]

[[Media:Example.jpg|file label]]

|-
| <translate> Link to a page specific to each reader (user page, etc.)</translate>
|<syntaxhighlight lang=mediawiki>
[[Special:MyPage]]

[[Special:MyTalk]]

[[Special:Preferences]]
</syntaxhighlight>
|
[[Special:MyPage]]

[[Special:MyTalk]]

[[Special:Preferences]]

|-
| <translate> Internal link to a specific revision</translate>
|<syntaxhighlight lang=mediawiki>[[Special:PermanentLink/2393992]]</syntaxhighlight>
<translate> Revision numbers can be found in each page's [[<tvar name=h-hist>Special:MyLanguage/Help:History</tvar>|edit history]].</translate>
<translate> (It is very common to see links to specific revisions implemented as external links because it's easy to cut-and-paste an entire URL to form an external link.)</translate>
|[[Special:PermanentLink/2393992]]
|-
| <translate> Internal link to a "diff"</translate>
|<syntaxhighlight lang=mediawiki>
[[Special:Diff/2393992]]

[[Special:Diff/2390639/2393992]]
</syntaxhighlight>
<translate> The default (in the first example above) is to show the changes from the previous revision.</translate>
<translate> See also the comments in the previous item.</translate>
|
[[Special:Diff/2393992]]

[[Special:Diff/2390639/2393992]]
|-
| <translate> Redirect</translate>
|<pre>#REDIRECT [[Main Page]]</pre>
<translate> Should be the first line on the page.</translate>
<translate> See <tvar name=1></tvar>.</translate>
| [[File:Redirect arrow without text (cropped).svg]] [[Main Page]]

|}

<translate>
== External links == 
</translate>
<translate> To [[<tvar name=h-edit>Special:MyLanguage/Help:Editing pages</tvar>|create]] an external link, usually to a page at a different website, enclose the URL followed by space and the link text in single square brackets (see examples below).</translate>
<translate> When you save or preview the page, you will see a link rendered slightly differently than an internal wikilink.</translate>
<translate> It may be a different color and/or be followed by an arrow icon to show that it may lead to another site.</translate>

{| class="wikitable"
!style="width:15%"| <translate> Description</translate>
!style="width:45%"| <translate> You type</translate>
!style="width:40%"| <translate> You get</translate>

|-
| <translate> External link with specified link text</translate>
| <pre>[https://mediawiki.org MediaWiki]</pre>
| [https://mediawiki.org MediaWiki]

|-
| <translate> Numbered external link</translate>
| <pre>[https://mediawiki.org]</pre>

<translate> This is what happens if you omit the link text.</translate>
<translate> Multiple links of this type on the same page are numbered sequentially.</translate>
|[https://mediawiki.org]

|-
| <translate> Bare external link</translate>
|<pre>https://mediawiki.org</pre>
<translate> URLs beginning with "<tvar name=1><code>http://</code></tvar>" and "<tvar name=2><code>https://</code></tvar>" are automatically linked, even when no brackets are used.</translate>
|https://mediawiki.org

|-
|<span id="How to avoid auto-links"><translate> Avoiding auto-linking of URLs</translate></span>
|<syntaxhighlight lang=html><nowiki>https://mediawiki.org</nowiki></syntaxhighlight>
|<nowiki>https://mediawiki.org</nowiki>

|-
| <translate> [[w:Protocol-relative URL|Protocol-relative]] external link</translate>
|<pre>
[//en.wikipedia.org Wikipedia]

[//en.wikipedia.org //en.wikipedia.org]
</pre>
<translate> The link will be <tvar name=code1>HTTP</tvar> or <tvar name=code2>HTTPS</tvar> depending on the protocol of the page currently being viewed (which could be different for different users).</translate>
<translate> This is only supported inside of square brackets <tvar name=code3><code><nowiki>[ ]</nowiki></code></tvar>.</translate>
<translate> Using "<tvar name=code4><code>//en.wikipedia.org</code></tvar>" by itself ''does not'' result in a link.</translate>
|
[//en.wikipedia.org Wikipedia]

[//en.wikipedia.org //en.wikipedia.org]

|-
| <translate> External link to the current server</translate>
|<pre>https:///pagename</pre>
|https:///pagename

|-
| <translate> External link to other host passing the pagename</translate>
|<pre>https://google.com/search?q=</pre>

<translate> See also:</translate> ,
|https://google.com/search?q=Links

|-
| <translate> Mailto link</translate>
|<pre>[mailto:info@example.org email me]</pre>
|[mailto:info@example.org email me]

|-
| <translate> Mailto named with subject line and body</translate>
|<pre>[mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info]</pre>
|[mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info]

|-
| <translate> Custom URI</translate>
|<pre>[skype:echo123 call me]</pre>

<translate> Any URI you wish to add needs to be first declared through <tvar name=UrlProtocols></tvar>.</translate>
<translate> (This example is not enabled on mediawiki.org)</translate>
|[skype:echo123 call me]

|}

<translate>
=== Using email links === 
</translate>
<translate> Email links use <tvar name=1><code>mailto:</code></tvar> before the address.</translate>
<translate> They're written like this: (resulting in ).</translate>
<translate> If there's no name, the address is automatically numbered, like this: <tvar name=1><code><nowiki>[mailto:anyone@example.org]</nowiki></code></tvar> becomes <tvar name=2>[mailto:anyone@example.org]</tvar>.</translate>

<translate>

Addresses without square brackets won't be linked, e.g., <tvar name=1>anyone@example.com</tvar>.


You can also add a CC using (resulting in ).
</translate>

<translate> To add a subject, use:</translate>
<code><nowiki>[mailto:anyone@example.com?subject=</nowiki>Subject<nowiki>]</nowiki></code>

<translate>
=== External links to internal pages === 


To add a link to a page on the same wiki using [[w:URI scheme | URL query parameters]], you may need to use external link syntax.
</translate>

{| border="1" class="wikitable" id="You type"
! <translate> Description</translate>
! <translate> You type</translate>
! <translate> You get</translate>

|-
| <translate> External link to the current page's edit page</translate>
|<pre>
[https://www.mediawiki.org/w/index.php?title=Help:Links&action=edit <translate nowrap> Edit this page</translate>]

[|action=edit}} <translate nowrap> Edit this page</translate>]
</pre>

<translate> See also [[<tvar name=url-data>Special:MyLanguage/Help:Magic_words#URL_data</tvar>|Help:Magic_words#URL_data]] and [[<tvar name=external>#External links</tvar>|External links]] above.</translate>
|
[https://www.mediawiki.org/w/index.php?title=Help:Links&action=edit <translate> Edit this page</translate>]

[|action=edit}} <translate> Edit this page</translate>]

|-
| <translate> External link to the current page's edit page, and styled to look like an internal link</translate>
|<syntaxhighlight lang=html><span class="plainlinks">[https://www.mediawiki.org/w/index.php?title=Help:Links&action=edit Edit this page]</span></syntaxhighlight>

<translate> The [[<tvar name=1>Special:MyLanguage/Plainlinks</tvar>|plainlinks class]] can be used in cases where you want an external link to look like an internal one, by suppressing the icon that normally appears after it.</translate>
|<span class="plainlinks">[https://www.mediawiki.org/w/index.php?title=Help:Links&action=edit <translate> Edit this page</translate>]</span>
|}

<translate>
===The arrow icon === 
</translate>
<translate> Some skins add an arrow icon <tvar name=1>[[File:link-external-small-ltr-progressive.svg]]</tvar> after each external link by default.</translate>
<translate> However, this can be avoided by using <tvar name=1>class=""</tvar>.</translate>
<translate> For instance:</translate>

*<code><nowiki>[http://a a]</nowiki></code> → [http://a a]
*<code><nowiki><</nowiki>span class="plainlinks"><nowiki>[http://a a]</</nowiki>span></code> → <span class="plainlinks">[http://a a]</span>

<translate>
=== Using Linksearch === 
</translate>
<translate> <tvar name=1>[[Special:Linksearch]]</tvar> is a built-in tool that helps find pages linked to a specific URL.</translate>
<translate> By using the <tvar name=1></tvar> table, it generates a comprehensive list of page names where the link originates, along with the complete target link for each source page.</translate>
<translate> You can search in all namespaces or just one.</translate>
<translate> It supports wildcard (<tvar name=1>*</tvar>) use, so you can search by [[w:top-level domain|top-level domain]] (e.g. <tvar name=2>[http://en.wikipedia.org/wiki/Special:Linksearch?title=Special%3ALinksearch&target=*.nl]</tvar>), [[w:second-level domain|second-level domain]] (e.g. <tvar name=3>[http://en.wikipedia.org/wiki/Special:Linksearch?title=Special%3ALinksearch&target=*.ns.nl]</tvar>), etc. or refine your search by specifying parts of the URL e.g. <tvar name=4>[http://meta.wikimedia.org/wiki/Special:Linksearch?title=Special%3ALinksearch&target=en.wikipedia.org/wiki/Portal]</tvar>.</translate>

{{note|1=
* <translate> Avoid including <tvar name=1>"http://"</tvar>.</translate>
* <translate> The program might not return any results if there is a colon in the URL.</translate>
* <translate> MediaWiki page names in URLs should have underscores instead of spaces.</translate> <translate> The Linksearch function also requires underscores in URLs.</translate>
* <translate> Linksearch is sensitive to capitalization, multiple underscores, and the use of <tvar name=1><code>index.php</code></tvar>.</translate> <translate> It may not find alternative URLs even if they lead to the same target.</translate> <translate> Therefore, when creating an external link, it's best to use the canonical form of the URL.</translate> <translate> If the address bar displays a modified URL after following a link, update the URL in the link accordingly for optimal use of Linksearch.</translate>
* <translate> The list is sorted by URL, using .</translate> <translate> Note that an underscore, unlike a blank space, is alphabetically positioned between <tvar name=1><code>Z</code></tvar> and <tvar name=2><code>a</code></tvar>.</translate>
}}

<translate>
=== Using backlinks === 
</translate>
<translate> Normally, internal links within a project are easy to spot and useful for finding related pages.</translate>
<translate> But when there's a mix of internal and external links, it can be tricky to track backlinks, it necessitates the use of both "[[<tvar name=1>Special:MyLanguage/Help:What links here</tvar>|Help:What links here]]" and "<tvar name=2>[[#Linksearch|Linksearch]]</tvar>".</translate>
<translate> However, for links to specific sections or anchors, it's possible to include both an internal link and, with CSS styling using <tvar name=1><code>display=none</code></tvar> an external link to provide backlink.</translate>

<translate> External links are better than interwiki links.</translate>
<translate> With Linksearch, you can even find backlinks to specific sections or anchors.</translate>
<translate> So, combining both internal and external links while hiding the external ones <tvar name=1><code><nowiki><span style="display:none">http://...</span></nowiki></code></tvar> gives us the best of both worlds.</translate>

<translate>
=== Limitations === 
</translate>
# <translate> ''External links'' doesn't support ''Word-ending links''.</translate>
# <translate> ''External links'' doesn't count toward <tvar name=1><nowiki>Special:WhatLinksHere</nowiki></tvar> ([[<tvar name=2>Special:MyLanguage/Help:What links here</tvar>|What links here]]).</translate>

<translate>

== Interwiki links == 
</translate>
<translate> Interwiki links are internal-style links to other websites (which do not have to be wikis, despite the name).</translate>
<translate> For example, you can link to the article https://en.wikipedia.org/wiki/Sunflower by typing <code><nowiki>[[wikipedia:Sunflower]]</nowiki></code> or, on this wiki, the shorter <code><nowiki>[[w:Sunflower]]</nowiki></code>.</translate>
<translate> Both will result in a link [[wikipedia:Sunflower]].</translate>
<translate> This works because by default MediaWiki configures <code>wikipedia:</code> as an "interwiki prefix" that turns into <nowiki>https://en.wikipedia.org/wiki/</nowiki> when used inside <nowiki>[[ ]]</nowiki>.</translate>
<translate> (''It may not work if the admin of your wiki has changed the setting.'') Unlike internal links, interwiki links do not use page existence detection, so an interwiki link will appear blue even if the page does not exist on the remote wiki.</translate>

<translate>

Similar to internal page links, you can create , with alternate link label, e.g. <code><nowiki>[[wikipedia:Sunflower|big yellow flower]]</nowiki></code> is the link [[wikipedia:Sunflower|big yellow flower]] and <code><nowiki>[[wikipedia:Sunflower|]]</nowiki></code> is the link [[wikipedia:Sunflower|Sunflower]].


Basically, interwiki links are abbreviations for commonly-used longer external links. A very similar link could be created as <code><nowiki>[https://en.wikipedia.org/wiki/Sunflower big yellow flower]</nowiki></code>.
</translate>

<translate> More details are at <tvar name=2></tvar>.</translate>
<translate> Your wiki may have a <tvar name=1>[[Special:Interwiki]]</tvar> page listing the interwiki prefixes it supports; </tvar>|here is the default interwiki list}}.</translate>
<translate> You can edit the <tvar name=1></tvar> table on your site.</translate>

<translate>
=== Interlanguage links === 


If your wiki has other language versions, you may find [[<tvar name=mainill>Special:MyLanguage/Interlanguage_links</tvar>|interlanguage links]] in the [[<tvar name=sidebar>Special:MyLanguage/Help:Navigation#Sidebar</tvar>|sidebar]], just below [[<tvar name=toolbox>Special:MyLanguage/Help:Navigation#Toolbox</tvar>|toolbox]] in a section titled “<tvar name=1>}}</tvar>.”
</translate>

<translate> In wiki markup an interlanguage link looks very much like an interwiki link, but behaves similarly to a [[<tvar name=1>Special:MyLanguage/Categorylinks</tvar>|category link]] in that it is rendered in a special way.</translate>
<translate> While category links appear in a special list at the bottom of the page (usually), interlanguage links appear in a special list in the [[<tvar name=1>Special:MyLanguage/sidebar</tvar>|sidebar]] of the page (or elsewhere, depending on the wiki's configuration and the [[<tvar name=2>Special:MyLanguage/Manual:Skins</tvar>|skin]] used).</translate>

<translate> The purpose of interlanguage links is to link pages on the same topics in different languages.</translate> <translate> To create an interlanguage link, type anywhere in the page (preferably at the bottom, like category links); the language prefix is the prefix specified at your wiki for the other language version (typically the [[w:List of ISO 639-1 codes|ISO 639-1 language code]]).</translate>
<translate> The interlanguage link is unilateral, it does not point back from that page in the other language.</translate>
<translate> For that purpose, an equivalent back-link needs to be placed there as well.</translate>
<translate> It does not work like the <tvar name=1><code></code></tvar> in the languages section of Wikipedia-language versions.</translate>
<translate> But it can be used across all namespaces, including <tvar name=1><code>:</code></tvar> to point to ones other profiles in other languages.</translate>

<translate>

If you want to make the interlanguage link appear at a specific place in the content of the page rather than in the sidebar, add a colon before the language prefix:
:<code><nowiki>[[:en:Sunflower]]</nowiki></code> → '''[[:en:Sunflower]]'''


When a link is both interwiki and interlanguage, the order is '''[[wikipedia:en:Sunflower]]'''.


For more information, see <tvar name=1></tvar>.
</translate>

<translate>
== Piped links == 
</translate>
<translate> A '''piped link''' is an internal [[<tvar name=1>Special:MyLanguage/Help:Link</tvar>|link]] or [[<tvar name=2>Special:MyLanguage/Help:Interwiki linking</tvar>|interwiki link]] where the 'target page name' of the link and its 'label' are both specified.</translate>
<translate> This is useful in cases where the user wants values of 'target page name' and 'label' to be different.</translate>
<translate> This also enables linking a contextually relevant word or phrase within the text of a page rather than using the generic value "see also".</translate>
<translate> The wording does not need to match the name of the target page.</translate>
<translate> Depending on the [[<tvar name=1>Special:MyLanguage/Help:Preferences</tvar>|preferences]] set for the current user and a supported browser, you can still see the link target: when you hover your cursor over the link, the name shows up in a pop-up window and is also shown in the status bar.</translate>

<translate>

For example:
</translate>
<pre><nowiki>[[coffeehouse setup|Get Piping Hot Coffee Here!]]</nowiki></pre>
<translate> will show:</translate> [[coffeehouse setup|Get Piping Hot Coffee Here!]]

<translate> Let's take another example: <nowiki>[[help:Piped link|piped link]]</nowiki> will be displayed as [[help:Piped link|piped link]].</translate>
<translate> This can be done when context makes it clear that the page being linked to is in the help namespace.</translate>
<translate> The piped link is a better way of doing this, rather than mistakenly linking to [[piped link]] which might be a disambiguation page or not exist.</translate>

<translate> Fun Fact: The term ''piped'' refers to the use of the pipe character "<tvar name="1">|</tvar>", which in this context is used to separate the more descriptive description from the actual name of the linked page.</translate>
<translate> The Pipe character was named after an alternative use of it; see [[w:en:Pipe (computing)|Pipe (computing)]].</translate>

<translate>
===Using a redirect as an alternative=== 
</translate>
<translate> An alternative way is to use [[<tvar name=1>Special:MyLanguage/Help:Redirect</tvar>|redirect pages]].</translate>
<translate> To create <tvar name="1">[[Get Piping Hot Coffee Here!]]</tvar>, use <tvar name="2"><nowiki>[[Get Piping Hot Coffee Here!]]</nowiki></tvar> and make it redirect to [[coffeehouse setup]] (please note: unlike above, what pops up when you point at the link, depending on your browser's support, is the text that is already shown).</translate>

<translate> It is convenient if the redirect is already there or will also be of use elsewhere. However, there are a few drawbacks.</translate>

*<translate> the popup does not show the destination page</translate>
*<translate> "[[<tvar name=1>Special:MyLanguage/Help:Related changes</tvar>|Related changes]]" shows the changes in the ''redirect page'' not the redirect target</translate>
*<translate> the redirect message that is shown on the target page slightly clutters it</translate>

<translate> Using a piped link and a redirect together, it is possible to provide information in the hover box that is not the name of the linked page, for example, the value of a unit in terms of other units.</translate>
<translate> In that case, it is possible to make a page whose page name is the information that you'd like in the link title, and which redirects to the page with a more appropriate name.</translate>
<translate> For example, the page [[w:30.48 cm]] redirects to [[w:Foot (unit)]].</translate>

<translate>
===Pipe trick=== 


If the part after the <tvar name=2><code>|</code></tvar> in a piped link is left empty, it is to an abbreviated form of the page name on the left, based on the following rules:
</translate>

#<translate> Any word that is before the '''first colon (:)''', as well as the colon character itself, is removed.</translate> <translate> This word may or may not be a 'namespace' prefix (such as "Help:") or an 'interwiki' prefix (such as "commons:").</translate> <translate> If the name of the page is preceded by a colon (:), "first" refers to "first after this".</translate>
#<translate> If there is some text in the '''parentheses''' at the end, then it will be removed.</translate>
#<translate> If there are no parentheses, but there is a '''comma''' (,) character, the comma and everything after it is removed.</translate>
#<translate> Note that this does not work for '''sections/anchors''' as <tvar name="1"><code><nowiki>[[Help:Piped_link#Pipe_trick|]]</nowiki></code></tvar> outputs <tvar name="2">[[Help:Piped_link#Pipe_trick|]].</tvar></translate>

<translate>

Similar to using the three or four tildes when signing on Talk pages, and using 'subst', in a preview, the result shows up in the preview itself, but the conversion in the edit box is not shown yet. Click on the <tvar name=1><code></code></tvar> option to see the change in the wikitext.

=====Examples===== 
</translate>
* <translate> <tvar name=1><code><nowiki>[[Help:Template|]]</nowiki></code></tvar> is converted to <tvar name=2><nowiki>[[Help:Template|Template]]</nowiki></tvar>, which is shown as <tvar name=3>[[Help:Template|Template]]</tvar></translate>
* <translate> <tvar name="1"><code><nowiki>[[Music: My life|]]</nowiki></code></tvar> is converted to <tvar name="2"><nowiki>[[Music: My life| My life]]</nowiki></tvar>, which is shown as <tvar name="3">[[Music: My life| My life]]</tvar> - although "Music:" itself is not a namespace (therefore the space after the colon character is not automatically removed), however, the shortcut works anyway</translate>
* <translate> <tvar name="1"><code><nowiki>[[w:en:Pipe (computing)|]]</nowiki></code></tvar> is converted to <tvar name="2"><nowiki>[[w:en:Pipe (computing)|en:Pipe]]</nowiki></tvar>, which is shown as <tvar name="3">[[w:en:Pipe (computing)|en:Pipe]]</tvar>.</translate>
* <translate> <tvar name="1"><code><nowiki>[[commons:Boston, Massachusetts|]]</nowiki></code></tvar> is converted to <tvar name="2"><nowiki>[[commons:Boston, Massachusetts|Boston]]</nowiki></tvar>, which is shown as <tvar name="3">[[commons:Boston, Massachusetts|Boston]]</tvar>.</translate>
*<translate> <tvar name="1"><code><nowiki>[[w:}|]]</nowiki></code></tvar> ''does not'' give <tvar name="2"><nowiki>[[w:}|}]]</nowiki></tvar>, and calling the template with a value of parameter 1 gives a working link, but in the case of substitution only.</translate>
*<translate> <tvar name="1"><code><nowiki>[[w:en:|]]</nowiki></code></tvar> ''does not'' give <tvar name="2"><nowiki>[[w:en:|en:]]</nowiki></tvar> and <tvar name="3"><code><nowiki>[[m:|]]</nowiki></code></tvar> ''does not'' give <tvar name="4"><nowiki>[[m:|]]</nowiki></tvar></translate>
*<translate> <tvar name="1"><code>[[Wikipedia:Village pump (technical)#Pipe trick|]]</code></tvar> is not converted, so it does not give a working link.</translate>
{|
| <translate> This wikitext</translate>
| <translate> Produces</translate>
|-
|
<syntaxhighlight lang="wikitext">
* [[project:a (b)|a]]
* [[w:project:a (b)|project:a]]
* [[:de:project:a (b)|project:a]]
* [[wiktionary:project:a (b)|project:a]]
* [[wiktionary:de:project:a (b)|de:project:a]]
* [[wikibooks:project:a (b)|project:a]]
* [[wikiquote:project:a (b)|project:a]]
* [[wikisource:project:a (b)|project:a]]
* [[wikisource:project:a (b)#c|]]
* [[w:en:|en:]] [[w:en:|en:]]
* [[m:|m:]] [[m:|m:]]
</syntaxhighlight>
|
* [[project:a (b)|a]]
* [[w:project:a (b)|project:a]]
* [[:de:project:a (b)|project:a]]
* [[wiktionary:project:a (b)|project:a]]
* [[wiktionary:de:project:a (b)|de:project:a]]
* [[wikibooks:project:a (b)|project:a]]
* [[wikiquote:project:a (b)|project:a]]
* [[wikisource:project:a (b)|project:a]]
* [[wikisource:project:a (b)#c|]]
* [[w:en:|en:]] [[w:en:|en:]]
* [[m:|m:]] [[m:|m:]]
|}

<translate>
=====Category tag===== 


Since the sortkey syntax of the category is similar to a piped link, the pipe trick also works for category tags, even though technically, it is not useful there.

====Limitation==== 
</translate>
* <translate> <tvar name="1"><nowiki>[[Help:Lk|]]</nowiki></tvar> using <tvar name="2">[[template:tc]]</tvar> is not converted, so the result is rendered as <tvar name="3">[[Help:Lk|Lk]]</tvar> which is not as a working link.</translate> <translate> This is because like substitution, the pipe trick expansion occurs before ordinary expansion of the templates, etc.</translate> <translate> The pipe trick does not work if the linked page includes invalid characters.</translate> <translate> Therefore, while ordinarily the acceptability of the target page name is assessed after template expansion, the pipe trick expansion judges it before that.</translate> <translate> The braces are therefore considered invalid characters in the page name.</translate> <translate> Instead, a template can be used like <tvar name="1">[[template:pipe trick]]</tvar>: <tvar name="2"><nowiki>k}}</nowiki></tvar> which renders as <tvar name="3">k}}</tvar>.</translate>

<translate>
====Inverse pipe trick==== 


On page "<tvar name="1">A (c)</tvar>", <tvar name="2"><nowiki>[[|b]]</nowiki></tvar> is converted to <tvar name="3"><nowiki>[[b (c)|b]]</nowiki></tvar> automatically.


Similarly, on page "<tvar name="1">A, c</tvar>", <tvar name="2"><nowiki>[[|b]]</nowiki></tvar> is converted to <tvar name="3"><nowiki>[[b, c|b]]</nowiki></tvar> automatically.

== Anchors == 

=== Linking to an anchor === 
</translate>
<translate> Links in the format <tvar name=1><code><nowiki>[[#anchor_name]]</nowiki></code></tvar> will direct to the first matching anchor on the page, typically corresponding to the first identical section heading.</translate>

<translate> You can add an <tvar name=1><code><nowiki>[[#anchor_name]]</nowiki></code></tvar> to a link, directing it to the first matching section heading (or anchor) on the '''named''' page:</translate>

<code><nowiki>[[Help:Editing#Advanced editing]]</nowiki></code>

<code><nowiki>https://www.mediawiki.org/wiki/Help:Editing#Advanced_editing</nowiki></code>

<translate>
=== Using an automatic anchor === 
</translate>
<translate> Section headings serve as anchors, using the heading text as the anchor name.</translate>
<translate> If there are multiple sections with identical headings, each subsequent occurrence is appended with <tvar name=1>"_2", "_3"</tvar>, etc.</translate>

<translate>

The anchor <tvar name=1>[[#toc]]</tvar> links to the page's table of contents (TOC), except when there's a section already titled <tvar name=2>"toc"</tvar>.

=== A manual anchor === 
</translate>
<translate> Manually-set anchors are beneficial for linking to "unlinkable" elements such as tables (titles or cells) or sections of plain text.</translate>
<translate> For instance, in the [[<tvar name=1>#External links to internal pages</tvar>|External links to internal pages]] section above, although the column text "Description" resembles a (minor) heading, it is not.</translate>

<translate> There are several methods to set an anchor at any position:</translate>

* <translate> The "anchor" [[<tvar name=1>help:Template</tvar>|template]], if it exists on your wiki, specified as <tvar name=2></tvar>, offers a standardized method to create anchor points.</translate> <translate> Place the template where you want, using the syntax <tvar name=2><nowiki></nowiki></tvar>.</translate> <translate> For instance, <nowiki></nowiki> is placed in the "Description" column of the table below the "External links to internal pages" section.</translate> <translate> Clicking on <tvar name=1>[[#Description]]</tvar> links to that anchor point created on the table.</translate> <translate> The anchor is only visible via the source code.</translate>
* <translate> Use the generic anchor tag <tvar name=1><code><nowiki><span id="anchor_name">some text</span></nowiki></code></tvar> with optional text for visible anchors.</translate> <translate> For hidden anchors, omit the text.</translate> <translate> To point to the anchor use <tvar name=1><code><nowiki>[[#anchor_name]]</nowiki></code></tvar>.</translate>
* <translate> Avoid using manual HTML headings like <tvar name=1><code><nowiki><h2>Editing Instructions</h2></nowiki></code></tvar>.</translate> <translate> This text serves as an <tvar name=1>anchor_name</tvar>.</translate>
* <translate> In certain instances, adding an ID attribute similar to HTML within a Wiki-element is necessary.</translate> <translate> Take, for instance, the table mentioned earlier, titled [[<tvar name=1>#External links to internal pages</tvar>|External links to internal pages]]:</translate>
:<code><nowiki>
border="1" class="wikitable" id="You type"
</nowiki></code>

* <translate> A top of a page can be accessed using the reserved term <tvar name=1><code><nowiki>[[#top]]</nowiki></code></tvar>.</translate>

<translate>

See also [[<tvar name=1>Special:MyLanguage/Help:Section#Linking sections using an arbitrary id</tvar>|Help:Section#Linking sections using an arbitrary ID]].

=== Using Linksearch anchors === 


As mentioned above, if external link style is used, e.g. <tvar name=1>[https://www.mediawiki.org/wiki/Help:Section#Linking_sections_using_an_arbitrary_id]</tvar>, we can use <tvar name=2>[[Special:Linksearch]]</tvar>: <tvar name=3>[https://www.mediawiki.org/wiki/Special:LinkSearch]</tvar>.
</translate>

<translate> When using Linksearch, it's helpful to add leading zeros to numerical anchor names to prevent unintended matches.</translate>
<translate> For example, instead of searching for "1", use "01" to avoid including "10".</translate>
<translate> This practice is seen in [[w:Template:Current events header|Template:Current events header]].</translate>
<translate> Similarly, if there are anchors like "a" and "ab", using "_a" can distinguish them in search results.</translate>

<translate>
=== Using <tvar name=1>anchorencode</tvar> === 
</translate>
<translate> The <tvar name=1><code>#anchorencode</code></tvar> parser function encodes input to use as an anchor.</translate>
<translate> For example, to external link to <tvar name=1>[[#Using linksearch anchors]]</tvar> above, you would use <tvar name=2><code><nowiki>https://www.mediawiki.org/wiki/Help:Links#</nowiki></code></tvar>, which resolves to <tvar name=3>https://www.mediawiki.org/wiki/Help:Links#</tvar></translate>

<translate>
== Subpage feature == 
</translate>
<translate> MediaWiki has a [[<tvar name=1>mw:Special:MyLanguage/Help:subpages</tvar>|subpage]] feature that may or may not be active depending on the project and namespace.</translate>
<translate> If it's activated, the following rules apply; otherwise, "A/b" is simply a standalone page with that name.</translate>

<translate> A page's [[w:tree structure|tree structure]] is formed using forward slashes in page names: A/b is considered a subpage of A, making A the parent of A/b; additionally, A/b/c is a subpage of A/b; meanwhile, A/a, A/b, and A/c are categorized as sibling pages.</translate>

<translate> The subpage body automatically displays links to all parent pages without needing specific wikitext.</translate>
<translate> These links appear even if the parent page doesn't exist.</translate>
<translate> However, if any ancestor page in the sequence is missing, the chain of links will stop before that point.</translate>
<translate> Additionally, the capitalization of letters after the forward slash in the page name matters, meaning "<tvar name=1>/subpage</tvar>" and "<tvar name=2>/Subpage</tvar>" refer to different pages.</translate>

<translate>

The functions, [[<tvar name=1>Special:MyLanguage/Help:What links here</tvar>|What links here]] and [[<tvar name=2>Special:MyLanguage/Help:Related changes</tvar>|Help:Related changes]] do not consider these automatically generated links.


When the subpage feature is enabled within a namespace, any forward slash in a page's name automatically creates a subpage structure, regardless of whether it was intended or not.


You can find a list of subpages using <tvar name=1>[[Special:PrefixIndex]]</tvar>.

=== Using variables === 


When utilizing the subpage feature within namespace A on page A:B/c/d, <tvar name=1><nowiki></nowiki></tvar> shows B/c while <tvar name=2><nowiki></nowiki></tvar> shows d.

=== Using relative links === 


Within a subpage hierarchy, you can utilize the following relative links:
</translate>

* <translate> <tvar name=1><nowiki>[[../]]</nowiki></tvar> links to the parent page of the current subpage.</translate> <translate> For example, on page A/b, it takes you to page A, and on page A/b/c, it directs you to page A/b.</translate>
* <translate> <tvar name=1><nowiki>[[../../]]</nowiki></tvar> links to the grandparent page of the current subpage.</translate> <translate> For example, on page A/b/c, it points to page A.</translate>
* <translate> <tvar name=1><nowiki>[[../s]]</nowiki></tvar> links to a sibling page of the current subpage.</translate> <translate> For example, on page A/b, it leads to page A/s.</translate>
* <translate> <tvar name=1><nowiki>[[../../s]]</nowiki></tvar> links to an "uncle" page of the current subpage.</translate> <translate> For example, on page A/b/c, it points to page A/s.</translate>
* <translate> <tvar name=1><nowiki>[[/s]]</nowiki></tvar> links direct to a subpage.</translate> <translate> On page A, it functions similarly to <tvar name=1><nowiki>[[A/s]]</nowiki></tvar>.</translate> <translate> However, linking from a namespace with an enabled subpage feature to a main namespace page starting with <tvar name=1>"/"</tvar> requires a workaround: adding a colon before the page name.</translate>

<translate> Relative links remain functional even when all pages within a hierarchy are renamed to reflect a change in the root's name, even if the root becomes a child of a new parent.</translate>
<translate> Users with the appropriate permissions, such as administrators and those with the <tvar name=1><code>move-subpages</code></tvar> right, have the option to move both the main page and its subpages during a renaming process.</translate>

<translate> Learn more about subpages at [[w:Wikipedia:Subpages|Subpages]].</translate>
<translate> See examples at [[<tvar name=1>Special:MyLanguage/Help:Links/example</tvar>|Help:Links/example]] and [[<tvar name=2>Special:MyLanguage/Help:Links/example/example2</tvar>|Help:Links/example/example2]]</translate>

<translate>
=== Subpage activation === 


This feature is only enabled in namespaces specified in the <tvar name=1></tvar> configuration setting, either its [[<tvar name=2>Special:MyLanguage/Manual:$wgNamespacesWithSubpages#Default value</tvar>|default namespaces]], or any additional namespaces set in <tvar name=4></tvar>

== Character conversion == 
</translate>
<translate> The guidelines outlined in [[<tvar name=1>Special:MyLanguage/Manual:Page naming</tvar>|Manual:Page naming]] state that in wiki and interwiki links, conversions are made to [[<tvar name=2>Special:MyLanguage/Help:Special characters</tvar>|non-literal characters]] automatically.</translate>
<translate> For example,"<tvar name=1><code><nowiki>[[Manual:Page%20naming]]</nowiki></code></tvar>" will display as "<tvar name=2>[[Manual:Page naming]]</tvar>".</translate>
<translate> Conversely, external links operate oppositely; literal characters are transformed into non-literal characters.</translate>
<translate> For example, browsers typically convert "<tvar name=1>.../wiki/!</tvar>" to "<tvar name=2>.../wiki/%21</tvar>".</translate>

<translate> Applying a code like <tvar name=1>%70</tvar> to a redirect deactivates it, even though the link remains accessible from the redirect page.</translate>
<translate> To ensure a successful redirect, the redirect page displays the canonical form of the target, unlike the preview page which shows the link in its regular format.</translate>

<translate>
== Miscellaneous == 

=== Some additional effects of links === 
</translate>
*
* <translate> [[<tvar name=1>Special:MyLanguage/Help:What links here</tvar>|Backlink]]s, <tvar name=2></tvar></translate>
* <translate> When you include a space after the pipe symbol (<tvar name=1><nowiki>[[main Page| ]]</nowiki></tvar>), the outcome can vary depending on the browser.</translate> <translate> In some cases, it might only display a space (" "), without creating a clickable link.</translate> <translate> However, it's still recognized as a link by the <tvar name=1><code></code></tvar> feature.</translate>

<translate>
=== "Hover box" on links === 
</translate>
<translate> In certain web browsers, when you place the cursor over a link, a tooltip may appear, displaying the content of the link's HTML title attribute.</translate>
<translate> MediaWiki assigns different values to this attribute depending on the type of link: for internal wikilinks, it displays the '''page name''' and <tvar name=1><code></code></tvar>, if the page does not exist; for interwiki links, it displays the page name with a prefix; and for external links, it displays the URL.</translate>

<translate> The browser might also display similar information in its status bar, possibly showing which section it belongs to.</translate>

<translate> Using a <tvar name=1></tvar>, even if it isn't clicked, can help clarify acronyms (like displaying "[[<tvar name=2>m:neutral point of view</tvar>|neutral point of view]]" as <tvar name=3>[[m:neutral point of view|NPOV]]</tvar>) or adding annotations.</translate>
<translate> Hover boxes can also be created without links, you can customize the hover box content using markup like <tvar name=1><code><nowiki>[[Link title|<span title="hoverbox">Display text</span>]]</nowiki></code></tvar>.</translate>

<translate> You cannot include a title attribute directly within the href element for '''external links'''.</translate>
<translate> Nevertheless, you can achieve a similar outcome by using a span element instead, like this:</translate>
<code><nowiki>[http://www.example.com <span title="hover text on external link">www.example.com web site</span>]</nowiki></code> :<br />
[http://www.example.com <span title="hover text on external link">www.example.com web site</span>]

<translate>
=== Retrieving links from a page === 
</translate>
<translate> The [[<tvar name=1>Special:MyLanguage/API:Main page</tvar>|MediaWiki API]] allows users to retrieve all links from a page.</translate>
<translate> For example, you can utilize the API query called [[<tvar name=1>Special:MyLanguage/API:Links</tvar>|API:Links]] to achieve this.</translate>

<translate>
=== Linking to a page from an image === 
</translate>
<translate> You can utilize images to direct users to other pages.</translate>
<translate> For further details, refer to the guidance on [[<tvar name=1>Special:MyLanguage/Manual:Linked images</tvar>|utilizing an image to link to a specific page]] in the help section.</translate>

<translate>
== Limits == 


An internal wiki link is limited by maximum [[<tvar name=2>Special:MyLanguage/Manual:page title</tvar>|page title]] size.

== See also == 
</translate>
*
*
*
*
* <translate> (and the next section)</translate>
*
*
*
*
* <translate> [[w:Red Link|Red Link]]</translate>
* <translate> [[w:Wikipedia:Canonicalization|Wikipedia:Canonicalization]]</translate>
* [[Special:Mostlinked]] – <translate> Displays the number of links.</translate>
* [[Special:Lonelypages]] – <translate> A list of pages not linked to any page.</translate>

[[Category:Help|Links]]
[[Category:Link|Links]]

----
''Sample content adapted from [[mediawikiwiki:Help:Links]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Editing

2026-07-25T17:02:03Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />

<translate>

Editing can be done with the wikitext source editor, or with the visual editor.


The main parts of Wikidata have a different system of editing, without there being wikitext source text.

== Editing == 
</translate>
*
*
*
*
*
*
*
*

<translate>
=== Advanced editing === 
</translate>
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*

[[Category:Help|Editing]]
[[Category:Edit]]
[[Category:Project help]]

----
''Sample content adapted from [[mediawikiwiki:Help:Editing]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Navigation

2026-07-25T17:02:03Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />

<translate> Every page on a MediaWiki site not only has information to show you but also allows you to move to other pages.</translate>
<translate> This is called "navigation".</translate>

<translate>

To help you navigate, every page on <tvar name=1></tvar>, has three main navigation elements:
</translate>

# <translate> The [[<tvar name=1>#Sidebar</tvar>|sidebar]] gives you access to important pages in the wiki such as <tvar name=2>[[Special:MyLanguage/Help:Recent changes|}}]]</tvar> or <tvar name=3>[[Special:MyLanguage/Help:Managing files|}}]]</tvar>.</translate> <translate> MediaWiki requires you to log in before seeing all of the sidebar options.</translate>
# <translate> Links (often called [[<tvar name=tabs>#Page tabs</tvar>|tabs]]) which relate to the page currently displayed: its associated discussion page, the version history, and – most notably – the edit link.</translate>
# <translate> [[<tvar name=links>#User Links</tvar>|User links]]; as an anonymous user, you'll see a link to create an account or log in.</translate> <translate> As a logged-in user you have a collection of personal links, including ones to your user page and [[<tvar name=preferences>Special:MyLanguage/Help:Preferences</tvar>|preferences]].</translate>

<translate> In addition to the standard navigation elements that each page has, a page will have its own unique information which appears in the larger main area of the page.</translate>
<translate> Generally within this information will be [[<tvar name=help>Special:MyLanguage/Help:Links</tvar>|links]] to other pages.</translate>

<translate> This page mainly documents the MonoBook and Vector [[<tvar name=skins>Special:MyLanguage/Manual:Skins</tvar>|skins]].</translate>
<translate> Appearances may be different when using other skins.</translate>
__TOC__

<translate>
== Sidebar == 
</translate>
[[Image:Vector Sidebar.png|framed||left|right}}|<translate> Example sidebar, shown along the page</translate>]]
<translate> The sidebar is displayed on the edge of the page below the site logo (if using the MonoBook or Vector skin).</translate>
<translate> This sidebar gives you access to important pages in the wiki such as Recent Changes or Upload File.</translate>

<translate>
=== Navigation === 
</translate>
<translate> Clicking on the logo brings you back to the main page of the wiki.</translate>
<translate> The links in the navigation section just below will take you to important pages of the wiki.</translate>
<translate> These links can be configured by site administrators.</translate>

<translate>
=== Toolbox === 


The <tvar name=toolbox>}}</tvar> contains a selection of links which change depending on what type of page you are viewing.
</translate>
; <translate> On all pages (except special pages)</translate>
:* <translate> <tvar name=1><code></code></tvar> takes you to a special page that lists the pages on that wiki which contain a link to the current page.</translate> <translate> This is helpful when you are looking for pages of related information.</translate> <translate> The "<tvar name=1>}}</tvar>" information can also be useful when you are refactoring wiki pages and need to check whether links to this page are still relevant after changes in the current page.</translate>
:* <translate> The "<tvar name=rcl>}}</tvar>" tool lists all recent changes in the pages linked to from the current page.</translate> <translate> Recent changes to all relevant template pages are included in the resulting page list.</translate> <translate> The <tvar name=1><code></code></tvar> option that can be set in the user [[<tvar name=preferences>Special:MyLanguage/Help:Preferences</tvar>|preferences]] applies, among other things, to "<tvar name=rcl>}}</tvar>".</translate>
; <translate> On all pages (including special pages)</translate>
:* <translate> "<tvar name=upload>}}</tvar>" displays a special page that allows logged-in users to upload images and other files to the wiki.</translate> <translate> Uploaded files can be linked from or embedded in wiki pages.</translate> <translate> This link is not displayed if file uploading is not enabled.</translate><br />''<translate> Uploading files, viewing files on the server, including them in wiki pages and managing the uploaded files is discussed in the [[<tvar name=managing-files>Special:MyLanguage/Help:Managing files</tvar>|managing files]] section of this manual.</translate>''
:* <translate> The "<tvar name=specialpages>}}</tvar>" tool lists the MediaWiki special pages.</translate> <translate> In MediaWiki terminology, a special page is one that presents information about the Wiki and/or allows access to administration activities for the wiki.</translate> <translate> For example, a list of users registered with the wiki, statistics about the wiki such as the number of pages and number of page edits, system logs, a list of orphaned pages, and so on.</translate> <translate> The content of these special pages is generated automatically when the special page is loaded.</translate><br />''<translate> The function and use of the default special pages can be found in the [[<tvar name=h-specialpages>Special:MyLanguage/Help:Special pages</tvar>|special pages]] section of this manual.</translate>''


<translate>
== Page tabs == 
</translate>
[[Image:Vector page tabs.png|thumb|500px|<translate> Default page tabs at the top of the page</translate>]]

<translate> The page tabs are displayed at the top of the page to the right of the site logo (if using the MonoBook or Vector skin).</translate>
<translate> These tabs allow you to perform actions or view pages that are related to the current page.</translate>
<translate> The available default actions include: viewing, editing, and discussing the current page.</translate>
<translate> The specific tabs displayed on your pages depend on whether or not you are logged into the wiki and whether you have sysop (administrator) privileges on the wiki.</translate>
<translate> On special pages, only the namespace tab is displayed.</translate>

; <translate> Default for all users</translate>
:* <translate> "[[<tvar name=namespace>Special:MyLanguage/Help:Namespaces</tvar>|namespace]]" (page, help, special page, template, user page etc.)</translate>
:* "}}"
:* "}}" <translate> (may read "<tvar name=viewsource>}}</tvar>" if anonymous editing is disabled, the page is in the MediaWiki: namespace, or the page is protected)</translate>
:* "}}"
; <translate> Extra tabs for logged-in users</translate>
:* "}}"
:* "}}"
; <translate> Extra tabs for sysops</translate>
:* "}}"
:* "}}"

<translate>

Administrators can [[<tvar name=1>Special:MyLanguage/FAQ#How do I add/remove tabs throughout my wiki?</tvar>|add or remove tabs]] by using JavaScript or installing extensions, so the tabs you see may be different depending on which wiki you are using.

== User links == 
</translate>
[[Image:Vector_user_links.png|thumb|900px|center|<translate> Default user links at the top right of the page</translate>]]

<translate> The user links are displayed at the top far right of the page (if using the default Vector skin).</translate>
<translate> These tabs allow the logged-in user to view and edit their user page and wiki preferences.</translate>
<translate> Additionally, the user links allow the user to quickly access their contributions to the wiki and logout.</translate>

<translate>

For anonymous users the user links is replaced by a link to the wiki login page or, if enabled by the site administrator, a link to your IP address and your IP address's talk page.
</translate>

; "Username"
: <translate> This links to your user page which is where you can put information about yourself, store bits of information you want to remember or whatever else you fancy.</translate>
; "Talk"
: <translate> This links to your discussion page, where people can leave messages for you.</translate>
; "Preferences"
: <translate> Allows you to change your personal site preferences.</translate>
; "Watchlist"
: <translate> A list of all pages that you are watching. Pages can be added to this list by clicking "<tvar name=watch>}}</tvar>" at the top of the page.</translate>
; "Contributions"
: <translate> A list of all contributions you have made to the wiki.</translate>
; "Log out"
: <translate> Click this link to log out of the wiki.</translate>

[[Category:Help|Help]]

----
''Sample content adapted from [[mediawikiwiki:Help:Navigation]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''

Help/Contents

2026-07-25T17:02:02Z

Admin: Seed from mediawiki.org for Seekmodo connector demo

<languages />

''[[Special:MyLanguage/Communication|<translate> Ask a question about the MediaWiki software.</translate>]]''

<translate>
== Welcome to MediaWiki.org help pages == 
</translate>
{{ambox
|type=notice
|image=[[File:Codex icon help notice-blue.svg|45px|alt=|link=]]
|text= '''<translate> These help pages are about the MediaWiki software itself.</translate>''' <translate> Many MediaWiki-powered wikis link here for technical documentation.</translate> <translate> If you came here from another wiki and are looking for help with that wiki's content or community, this page may not be what you need.</translate> <translate> See <tvar name=1></tvar>.</translate>
}}

{{ContentGrid
|content =


**
*
*
*
*
*
*
}}

*
**
*
*
*
*
*
*
*
*
*
*
*
*
**
**
**
**
*
*
*
}}

- <translate> Provides an overview of many of the below features</translate>
*
*
*
*
*
*
**
*
*
*
*
*
*
*
**
**
*
*
*
*
*
*
*
**
*
*
*
*
*
*
}}

}}

*
}}

<translate>

The following features require extra permissions that are not normally granted to all wiki users.
</translate>

*
*
*
*
*
*
*
}}

}}

[[Category:Help| ]]
__NOTOC__

----
''Sample content adapted from [[mediawikiwiki:Help:Contents]] on mediawiki.org, licensed under [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].''