Manual:Параметри index.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Parameters to index.php and the translation is 44% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎čeština • ‎русский • ‎українська • ‎中文 • ‎日本語 • ‎한국어

Ця сторінка — частковий список параметрів index.php — основного сценарію програмного забезпечення MediaWiki. Більшість цих аргументів зазвичай даються як GET-параметри в URL, але також можуть передаватися як дані POST. POST насправді вимагається в деяких випадках, як-от дія очищення.

Інформація на цій сторінці неповна.[1]

Page revision or version

Параметри index.php зазвичай застосовуються та мають значення, пов'язане зі сторінкою, до якої вони застосовуються. Сторінку (чи її версію) можна зазначити, набравши один або більше наступних параметрів: https://en.wikipedia.org/w/index.php?title=Ferengi&curid=177126&diff=304901009&oldid=304764764

Назва Опис
title Заголовок сторінки. Це може бути вікі-сторінка чи спеціальна сторінка, залежно від інших параметрів. Для вимкнення спеціальної сторінки у своїй конфігурації вікі можна використати хук SpecialPage_initList.
curid Ідентифікатор вікі-сторінки; перекриває значення заголовку.

Деякі дії (такі, як перегляд і редагування) також працюють на конкретній версії сторінки. Така версія ідентифікується двома наступними параметрами, дозволяючи упущення заголовку й ідентифікатора сторінки.

Назва Опис
oldid Ідентифікатор версії
direction Замість версії, даної oldid, використовуйте:
  • direction=prev: the one preceding it
  • direction=next: the one following it

Дії

The following is a list of values for the action parameter.

Деякі з цих дій можна вмикати / вимикати, використовуючи виділене налаштування конфігурації в LocalSettings.php. Де доступні, ці локальні налаштування перелічені.[2]

Name Функція Приклад
view Перегляд — дія за замовчуванням; перегляд — дія, що використовується тоді, коли жодну дію не задано явно www.mediawiki.org/w/index.php?title=Project:Sandbox&action=view
print (removed in 1.18) Те саме, що й view
watch Додає сторінку до списку спостереження користувача www.mediawiki.org/w/index.php?title=Project:Sandbox&action=watch
unwatch Вилучає сторінку зі списку спостереження користувача www.mediawiki.org/w/index.php?title=Project:Sandbox&action=unwatch
delete Видаляє сторінку

За замовчуванням видалення повертає користувачеві форму підтвердження та зазначення причини.[3]

www.mediawiki.org/w/index.php?title=Project:Sandbox&action=delete
revert Скасування до попередньої версії зображення. Вимагаються наступні два інші параметри:
  • oldimage — ідентифікатор версії, до якої скасовується;
  • wpEditToken — дійсний токен редагування;
rollback Відкоти останніх редагувань, зроблені останнім дописувачем сторінки; іншими словами, відновлюється остання версія статті, дописувач якої не є останнім. Редагування позначається незначним і використовується його опис за замовчуванням.[4]

Вимагаються наступні два інші параметри:

  • from — ім'я користувача, чиї редагування скасовуються
  • token — токен відкоту; використовується для запобігання ошукуванню користувачів у виконанні небажаних відкотів, шляхом слідування посиланням або натисканням кнопки на зовнішньому веб-сайті.
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=rollback&from=John&token=d7aaa6c\
protect Показує чи змінює рівні захисту сторінки:
  • За замовчуванням сценарій повертає форму, що показує поточні рівні захисту сторінки, дозволяючи користувачеві змінити їх.[5]
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=protect
unprotect Same page as protect (unprotect and protect are the same page, and do the same thing). www.mediawiki.org/w/index.php?title=Project:Sandbox&action=unprotect
markpatrolled Marks an edit as patrolled; see Help:Patrolled edit on Meta.

rcid — ідентифікатор редагування в таблиці нещодавніх змін

render Outputs the HTML rendering of the entire page content; similar to the view action, but only the unstyled article text is output, not any part of the user interface (additional toolboxes, search box, stylesheets, etc.). Увага: Для стабільнішого програмного доступу чи отримання HTML лише шматка вмісту сторінки слід використовувати API parse з параметрами page чи pageid. www.mediawiki.org/w/index.php?title=Project:Sandbox&action=render
deletetrackback (removed in 1.19) Related to TrackBack.

Ця дія вимкнена за замовчуванням у DefaultSettings.php

purge Clears the page's cache, forcing the page to be redisplayed from its source.
  • Ця дія виконується тільки, якщо запитана через запит POST; інакше показується форма підтвердження очищення (натискання кнопки OK публікує запит очищення, який потім виконується).

www.mediawiki.org/w/index.php?title=Project:Sandbox&action=purge

submit Performs various actions related to changing the page (see below for more details):
  • За замовчуванням показується сторінка у формі редагування з полем редагування.
  • Різні інші аргументи можуть використовуватися для:
  1. Зміни сторінки,
  2. попереднього перегляду нової версії сторінки, чи
  3. показу різниці з новою версією (докладніше див. розділ редагування та надсилання нижче);
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=submit
edit Shows the page in edit form, "edit" does almost the same thing as submit www.mediawiki.org/w/index.php?title=Project:Sandbox&action=edit
editredlink Те саме, що edit.[6] www.mediawiki.org/w/index.php?title=Project:Sandbox&action=editredlink
history Показує історію сторінки (Див. історію, нижче). www.mediawiki.org/w/index.php?title=Project:Sandbox&action=history
historysubmit When viewing the difference between revisions, after clicking "compare selected revisions" on the history page. This requires a "diff" and/or "oldid" parameter, otherwise it just shows the page itself. www.mediawiki.org/w/index.php?title=Project:Sandbox&action=historysubmit&diff=456290&oldid=456270
raw Shows the raw content of the page. (See Raw, below) A pop up window will open up, asking whether you would like to save the page in index.php.[7] www.mediawiki.org/w/index.php?title=Project:Sandbox&action=raw
ajax Якщо увімкнено, то викликає функцію php, зареєстровану через $wgAjaxExportList; див. Manual:Ajax.[8]
creativecommons (removed in 1.19) Вимкнено за замовчуванням через $wgEnableCreativeCommonsRdf
credits Показує список людей, котрі зробили внесок до сторінки в запитанні, використовуючи справжнє ім'я, зазначене в налаштуваннях користувача. Наразі вимкнено у wiki Вікімедіа, але увімкнено за замовчуванням у чистому MediaWiki. translatewiki.net/w/i.php?title=Translating:MediaWiki&action=credits
dublincore (removed in 1.19) Вимкнено за замовчуванням через $wgEnableDublinCoreRdf
info Показує таку інформацію про сторінку, як кількість користувачів, що мають її у своїх списках спостережень, кількість редагувань і кількість авторів. Контекст див. у Reimplement info action RfC. www.mediawiki.org/w/index.php?title=Project:Sandbox&action=info
revisiondelete Set visibility restrictions on revision text, edit summary, and editor's username/IP address (requires deleterevision user right)

Перекриття налаштування користувача

Наступні параметри перекривають деякі налаштування користувача. Інші параметри, пояснені в інших розділах, — «diffonly», «internaledit» і «externaledit». Параметри нижче впливають на всі дії, крім «render» і «raw».

Назва Функція Приклад
useskin Specify a skin www.mediawiki.org/w/index.php?useskin=modern
uselang Specify a language for the UI elements (such as the "my talk" link, etc.), i.e. the user interface language; this is especially useful for creating an account, because at that stage no preference settings apply.

Спеціальний мовний код «qqx» можна використати для відображення ідентифікаторів усіх системних повідомлень, які використовуються на сторінці.

www.mediawiki.org/w/index.php?title=Special:Userlogin&type=signup&uselang=de
variant Specify a language variant for the UI elements (this is used for example in the Chinese Wikipedia, as the Chinese language has variants);
printable When set to yes, the page is shown in a form that is suitable for printing
debug When set to true (e.g. 1 or true), the ResourceLoader serves non-minified JavaScript and CSS. See ResourceLoader/Features#Debug mode. www.mediawiki.org/w/index.php?title=Project:Sandbox&debug=true
safemode When set to true (e.g. 1 or true), personal CSS and JS will not be loaded. This includes gadgets.[9] www.mediawiki.org/w/index.php?title=MediaWiki&safemode=1

View and render

Перегляд — дія за замовчуванням. Якщо жодна інша дія не додана до URL, то використовується action=view. Ця дія показує сторінку, версію чи різницю між двома версіями тієї ж або двох різних сторінок. Нижче наведено (частковий) список.

diff
значення цього параметру визначає версію, повертається різниця між іншою та цією версіями:
  • якщо oldid не передано, то показується різниця між цією та попередньою версіями тієї ж статті;
  • інакше показується різниця між версією, даною oldid/direction та цією; значення цього параметру може бути ідентифікатором версії, значеннями prev або next для визначення версії відносно даної oldid/direction, і значенням cur для визначення останньої версії сторінки;
Зверніть увагу, що oldid і diff не потребують бути двома версіями тієї ж статті, дозволяючи порівнювати дві версії двох різних сторінок
redirect
if the value of this parameter is 'no' and the page is a redirect, the page itself is shown and not the target of the redirect; this parameter has effect only on action=view and action=render and only if neither oldid nor diff is given, as this is the only case where the target article is shown instead of the redirect;
rdfrom
when the page is the result of following a redirect from an external wiki, this parameter tells which wiki that was, so that the "Redirected from ..." line can be shown
diffonly
override the user's preference on whether to render the page when a diff is requested, eg. diffonly=yes
search
if non-blank (and if searches are enabled), override all other parameters and perform a search

Наступні параметри застосовуються тільки до категорій.

from
if the page is a category, only list entries whose sortkey are equal or follows the value of this parameter;
Приклад: https://en.wikipedia.org/w/index.php?title=Special:Log&type=upload&from=20070814233520&until=20070814233525
Links to a log of all the images uploaded on August 14, 2007 from 23:35:20 until 23:36:25
until
if the page is a category, only list entries whose sortkey precedes the value of this parameter; only used if from is not passed;

Наступний параметр застосовується тільки до зображень.

page
a page number in a multi-page media; it currently only applies to DjVu and PDF files; first page is numbered 1;

Історія

limit
The number of page edits to list, the maximum is 5000 edits.
Приклад: https://en.wikipedia.org/w/index.php?title=Special:Contributions&limit=13&contribs=user&target=Atlgirl052005 - перелічує 13 редагувань на сторінку.
dir
відносний порядок сторінок історії редагувань.
редагування сторінки відсортовані за спаданням часової мітки.
offset
використовує часову мітки для визначення того, яку частину історії показувати;
Повертає редагування, які відбулися до часової мітки;
Приклад: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&contribs=user&target=Atlgirl052005
Показує редагування, які відбулися одразу перед часовою міткою 20090815195334 (20090815195334 не показується).
Формат параметру — yyyymmddhhmmss. Тому, 20090815195334 створено 15 серпня 2009 року [20090815] о 19:53 (UTC) і 34 секундах [195334].
Див. w:Wikipedia:Complete diff and link guide.
якщо додано dir=prev, то працює навпаки, перелічуючи всі редагування після часової мітки[10]
Приклад: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&dir=prev&contribs=user&target=Atlgirl052005
Показує редагування, які відбулися одразу після часової мітки 20090815195334 (20090815195334 не показується).
Example to show only the very first edit on a page: https://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&action=history&dir=prev&limit=1
feed
a feed for the changes in the history is returned; allowed values are atom and rss. Можна вимкнути з $wgFeed .
go
(застаріло — слід уникати, тому що було витіснене) go=first — перша (найранніша) показана сторінка історії

Raw

Passing action=raw returns the source code of a page or revision. For security reasons, in some versions of MediaWiki this is only allowed when using the "primary script access point", that is, when using the "ugly" URL form with index.php?title=...

templates
if passed with value expand, templates within the page are expanded;
ctype
the content-type value to be used in the HTTP header when returning the raw content, instead of the default text/x-wiki; this can only be one of the allowed types, which currently are text/x-wiki, text/javascript, text/css, and application/x-zope-edit
maxage
the value of max-age in the Cache-Control HTTP header field to be used when returning the raw page (client cache)
smaxage
the value of s-maxage in the Cache-Control HTTP header field to be used when returning the raw page (cache-server cache)
oldid
the id of a specific revision to return
direction
either next, prev, or cur; instead of the revision specified by oldid, returns the one following it, the one preceding it, or the current (last) one;
section
Limits output to a particular section or subsections of the document. Sections are specified with non-negative integers : section 0 being the section before any named sections, section one being the first named section or subsection and so on. The numbering scheme treats sections and subsections as identical. A list of the sections and subsections can be obtained via API with api.php?action=parse&text={{:My_page}}__TOC__&prop=sections.
example

Edit and submit

The edit and submit actions perform almost the same action. By default, they return an "edit page" form for the page. Different results can be obtained by passing other arguments; some results (such as saving the new version of a page) can only be obtained using POST. This action takes the standard arguments for specifying a page or a page revision.

Options affecting the edit form

The following options produce an effect on the edit form (the first one also affects how the page is saved).

section
specifies the index of a section within a document to preload and edit; sections are numbered sequentially from 0 on; section 0 is the part of the article before the first section header; value new is used to append a new section to the document;
preload
specifies a page, of which the wikitext is used as the initial value of the textarea in the edit form if the page or section to be edited does not exist; if it exists the preload command is ignored; also see Manual:Creating pages with preloaded text;
Example: https://en.wikipedia.org/wiki/Talk:Main_Page?action=edit&section=new&preload=Project:Sandbox
preloadparams[] (or preloadparams%5B%5D)
Replace $1 style parameters in preload text. For example https://mediawiki.org/wiki/Project:Sandbox?action=edit&section=new&preload=Manual:Creating_pages_with_preloaded_text/param_demo&preloadparams%5b%5d=first%20value&preloadparams%5b%5d=second%20value would cause Manual:Creating pages with_preloaded text/param demo to be preloaded into the edit form, but with $1 replaced by first value and $2 replaced by second value. (introduced in 1.23)
editintro
title of an existing article or template to be rendered above the edit form;
preloadtitle
in the case of section=new, provides initial content of the "Subject/headline" box; it can be edited before saving;
Example: https://en.wikipedia.org/w/index.php?title=User_talk:5dsddddd&action=edit&section=new&preloadtitle=The+%5B%5BWP%3AARS%7CArticle+Rescue+Squadron%5D%5D
Example with both preloadtitle and preload: https://en.wikipedia.org/wiki/User_Talk:Ikip?action=edit&section=new&preload=Template:Article_Rescue_Squadron_ invite&preloadtitle=Invitation
nosummary
Do not show the "headline" box when doing section=new.
summary
its value is used as the edit summary in place of the default one.
preview
if set to yes or no, overrides user preference "Показувати попередній перегляд під час першого редагування" (task T11936);
internaledit/externaledit 
overrides user preference on external editors;
mode
this parameter affects the result page if passed with value file and using an external editor;
undo, undoafter
attempts to undo a sequence of edits, from the undoafter revision up to the undo revision; technically, this is done by trying to merge the inverse of these edits with the sequence of all subsequent edits; the values of these parameters are ids of old revisions of a page; if merge is not possible, a regular edit form for that revision is returned

What to do

The following options tell the software what to do when submitting: saving, showing a preview, or showing the difference with the current version.

wpSave
this argument is generated when saving the content of an edit form returned by the server, but is not actually used nor required when submitting (see below for required arguments to save);
wpPreview
set in a POST request to request a preview of the page or section as if the value of wpTextbox1 were saved;
  • by default, returns an edit form with a preview of the value of wpTextbox1;
  • if the additional live argument is passed, only the rendering of the value of wpTextbox1 is shown, not the form and the other GUI element; this is similar to the result of saving and then viewing with action=render; see Manual:Live preview for more info;
  • the argument wpLivePreview is identical to wpPreview; therefore, a regular preview is returned if live is not passed;
wpDiff
set in a POST request to request a table showing the changes between the current version of the page or section and the version as if value of wpTextbox1 were saved;

Parameters that are needed to save

The following parameters are required when a user saves a page. The edit summary field may also be required if so configured (see below).

wpTextbox1
the new page/section content;
wpStarttime
the timestamp of when the user started editing the page; used to check whether the page has been deleted between this moment and the submission time (in this case, the user is asked to confirm saving);
wpRecreate
in case the page was deleted after wpStarttime, this field confirms that the page is to be saved;
wpEdittime
for new pages, it is equal to wpStarttime; otherwise, it is the timestamp of the last revision of the page; used to check edit conflicts;
wpEditToken
an edit token; this is used to avoid users from being tricked into saving a page by following a link or pressing a button in an external site. For non-logged-in users, wpEditToken is required since revision 18112; it currently contains only the characters +\ rather than a random string (see edit token suffix).

For the page to be saved, wpStarttime, wpEdittime, wpTextbox1 and wpEditToken are required in a POST request, and neither wpPreview nor wpDiff are passed. If the page was deleted after wpStarttime, the boolean option wpRecreate is also required.

Optional additional data

The edit summary or the "ignore blank" parameter may be mandatory if "warn on blank summaries" is configured.

wpSummary
the edit summary;
wpMinoredit
if set in a save request, the edit is marked as minor; for preview and diff, it is the initial value of "this is a minor edit" checkbox in the edit form;
wpWatchthis
if passed on a save request, the page is added to the user's watchlist; if it is not passed in a save request, the page is removed from the user's watchlist; for preview or diff, this is the initial value of the "watch this page" checkbox of the edit form;
wpSection
specify the index of a section within a document to submit to; sections are numbered sequentially from 0 on; section 0 is the part of the article before the first section header; value new is used to append a new section to the document;
wpChangeTags
an optional comma-separated list of tags to be added to the edit. If any of the provided tags are not activated for manual use, the edit will be rejected.
wpAutoSummary
contains the MD5-hashing of the edit summary field as initially presented to the user in the edit form; this field is used to check if the user has modified that field before submitting: if the MD5 hashing of the value of wpEditSummary is the same as this field, the edit summary has not been modified;
wpIgnoreBlankSummary
save page even if user has not modified the edit summary, while they were supposed to;
wpTextbox2
in case of an edit conflict, it contains the value of wpTextbox1 of the save request that generated the conflict;
safemode
some browsers are known to have problems with editing text containing Unicode characters; when a request for an edit form come from one such browser, the non-ascii characters in the initial content of the textarea are converted into the form &#xxxx; and the value safemode=1 is hidden in the form; when submitting, the safemode field indicate that the the inverse translation is to be performed; a browser is considered non-Unicode-compliant if the User-Agent HTTP header matches a regular expressions in the variable $wgBrowserBlackList;
This has nothing to do with PHP's safe_mode setting.
wpScrolltop
used to preserve the scrollbar position in the edit textbox when loading a preview.
redlink
if the user does not have permission to edit the page, redirect to the empty article page (e.g., "Wikipedia does not have an article with this exact name") instead of showing the permission error notice; this parameter is used on red links.
wpExtraQueryRedirect
hidden input to modify after save URL and is not used by actual edit form. Intended to be used by gadgets and such.

Special pages

Most special pages have additional parameters, specific to the function they perform. As an example, the parameters for Special:Export are outlined in Parameters to Special:Export

The following URL parameters provide initial values for some input fields; they can be edited before submitting the form.

Special:MovePage

wpReason
text field with reason.
wpNewTitle
text field with new title.
wpLeaveRedirect
whether to select the "Leave a redirect behind" checkbox.

Special:BlockIP

wpDisableEmail
whether to select the "Надсилання електронної пошти" checkbox.
wpDisableUTEdit
whether to select the "Редагування власної сторінки обговорення" checkbox.
wpReason
initially selected item in the drop-down box, value should match a row in the MediaWiki:Ipbreason-dropdown.
wpReason-other
text field with custom reason; require wpReason=other
wpAutoBlock
whether to select the "Автоматично блокувати IP-адреси, які використовуються цим користувачем та будь-які наступні адреси, з яких він буде редагувати" checkbox.
wpWatch
whether to select the "Додати до списку спостереження сторінку користувача і його обговорення" checkbox.

Extension-specific parameters

FlaggedRevisions extension

stable
if set to 1, last stable version is shown.
stableid
like oldid except with stable image/template inclusion. Setting stableid=best will give the best version (pristine > quality > sighted > last).
filetimestamp
view the file version created at a certain date (applies only to viewing file pages)

Userscript parameters and Autoedit extension

Userspace JavaScript scripts and gadgets may interpret arbitrary parameters passed via GET or POST. If the user's or global JavaScript script include Lupin's Autoedit Script, the following parameters are used for automated editing: autoedit, autosummary, autoclick, and autominor. Some more details are given in Autoedit extension.

Maxlag parameter

Версія MediaWiki: 1.10 – 1.27

The maxlag parameter is used only if the software is running on a replicated database cluster.

The maxlag parameter makes it so a request is not served if there is high server traffic. maxlag parameter applies to all actions. maxlag parameter value is a number; the lower this value, the lower the traffic that causes the request not to be served. Zero is not allowed.

Примітки

  1. Клієнти, що надсилають форми, повинні надсилати всі її параметри, наявні в HTML; покладання на будь-який вид статичного списку може призвести до майбутньої поломки. Для реєстрації нових дій в інсталяції MediaWiki див. $wgActions .
  2. Additionally, any action except 'view' may be disabled by using the $wgActions variable. Additionally, $wgActions is available now for all actions. Additionally, if searches are enabled and the search parameter is supplied (and non-blank) then all actions are ignored and the search is performed.
  3. Видалення виконується за запитом POST, якщо дійсний токен редагування передано як значення wpEditToken; ось, що стається, коли користувач підтверджує видалення. Причина видалення передається як значення аргументу wpReason; цей рядок записується в журнал видалень (поле log_comment_id таблиці журналювання) Видалення також виконується під час видалення єдиної версії зображення; воно вимагає передати ідентифікатор версії у параметрі oldimage, а дійсний токен редагування — в wpEditToken; у цьому випадку запит також може передаватися через GET
    • якщо передано необов'язковий аргумент summary, то його значення використовується як опис редагування замість за замовчуванням
    • якщо передано необов'язковий аргумент bot, то редагування позначиться роботом (редагування позначене rc_bot=1 у таблиці нещодавніх змін)
    • аргумент bot також може використовуватися на будь-якій сторінці, де з'являється посилання [відкотити], для каскадування &bot=1 до всіх згенерованих посилань відкоту
    • якщо передано необов'язковий аргумент hidediff, то показується повідомлення про успішність замість різниці зміни (до цього можна примусити через налаштування користувача)
  4. These levels are changed to the values of mwProtect-level-edit and mwProtect-level-move if the request is a POST one and a valid edit token is passed as wpEditToken; parameter mwProtect-reason gives the reason for protection or unprotection which will be recorded in the page log; if mwProtect-cascade is also passed, cascading protection is applied (all transcluded pages are set to the same protection levels)
    • more generally, the actions that can be limited are those listed in the $wgRestrictionTypes array; this array is initialized to array('edit','move') and can be changed in LocalSettings.php; the protection action then accept a parameter mwProtect-level-$action for each action in that array
  5. For security reasons, in some versions of MediaWiki Raw is only allowed when using the "primary script access point", that is, when using the "ugly" URL form with index.php?title=...
    • requires $wgUseAjax to be true; the only callable functions are those in the array $wgAjaxExportList (implicit if $wgAjaxSearch or $wgAjaxWatch is set)
    • додаткові параметри: rs — назва функції (наприклад, rs=wfSajaxSearch); масив rsargs[] — список аргументів цієї функції (наприклад, rsargs[]=abcd передає рядок abcd у функцію).
    • функція JavaScript sajax_do_call для виклику функцій Ajax визначена в ajax.js.
  6. Project:Tech News/2017#Tech News: 2017-16
  7. З міркувань продуктивності значення цього поля не є насправді зміщенням (індекс першого показаного запису)

Див. також