Manual:Parâmetros para index.php

From mediawiki.org
This page is a translated version of the page Manual:Parameters to index.php and the translation is 25% complete.
Outdated translations are marked like this.

Esta página é uma lista parcial dos parâmetros para o arquivo index.php , o script principal do software MediaWiki. A maioria destes argumentos geralmente é dada como parâmetros GET na URL, mas também podem ser passados como dados POST. POST é realmente necessário em alguns casos, como a ação de purga.

As informações contidas nesta página não estão completas.[1]

Revisão ou versão de página

Os parâmetros ao index.php geralmente aplicam-se e possuem um significado relacionado à página a qual se aplicam. A página (ou uma versão dela) pode ser especificada inserindo um ou mais dos seguintes parâmetros: https://en.wikipedia.org/w/index.php?title=Ferengi&curid=177126&diff=304901009&oldid=304764764

Nome Descrição
title O título da página. Pode ser uma página wiki ou uma página especial, dependendo de outros parâmetros. Para desativar uma página especial em sua configuração wiki, você pode usar o hook SpecialPage_initList .
curid A id da página wiki; substitui o valor do título.

Algumas ações (como ver e editar) também funcionam numa revisão em particular da página. Tal revisão é identificada pelos dois parâmetros seguintes, permitindo a omissão do título e da id da página.

Nome Descrição
oldid A id de uma revisão
direction Em vez da revisão dada por oldid, use:
  • direction=prev: o item anterior
  • direction=next: o item seguinte

Ações

A lista seguinte contém valores para o parâmetro action.

Algumas dessas ações podem ser ativadas/desativadas usando uma definição de configuração dedicada em LocalSettings.php . Onde disponíveis, essas definições locais são listadas.[2]

Name Função Exemplo
view Visualizar é a ação padrão; visualizar é a ação usada quando nenhuma ação é explicitamente fornecida www.mediawiki.org/w/index.php?title=Project:Sandbox&action=view
watch Adiciona a página na lista de páginas vigiadas do usuário www.mediawiki.org/w/index.php?title=Project:Sandbox&action=watch
unwatch Remove a página da lista de páginas vigiadas do usuário www.mediawiki.org/w/index.php?title=Project:Sandbox&action=unwatch
delete Exclui uma página

Por padrão, retorna um formulário para o usuário confirmar a exclusão e especificar uma razão.[3]

www.mediawiki.org/w/index.php?title=Project:Sandbox&action=delete
revert Reverte a uma versão antiga de uma imagem. Os seguintes parâmetros são requeridos:
  • oldimage, o ID da versão a ser revertida; e;
  • wpEditToken, um token de edição válido;
rollback Reverte as últimas edições feitas pelo último editor da página; em outras palavras, restaura à última versão do artigo cujo editor não é o último. A edição é marcada como menor e um sumário de edição padrão é usado.[4]

Os seguintes dois outros parâmetros são requeridos:

  • from é para o nome de usuário cujas edições hão de ser revertidas
  • token é o token de reversão; usado para prevenir que usuários façam uma reversão sem querer ao clicar numa ligação num site externo.
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=rollback&from=John&token=d7aaa6c\
protect Shows or changes the protection levels of a page:
  • By default, this script returns a form showing the current protection levels of the page, allowing the user to change the protection levels of the page.[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 is the id of an edit in the recentchanges table

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.).
Para um acesso programático mais estável ou para recuperar o HTML de apenas uma parte do conteúdo da página, você deve usar a API parse com page ou pageid
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=render
purge Clears the page's cache, forcing the page to be redisplayed from its source.
  • This action is performed only if requested via a POST request; otherwise, a form to confirm purging is shown (pressing the OK button posts the purge request, which is then executed).

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):
  • By default, shows the page in edit form, with edit box.
  • Various other arguments can be used to:
  1. Modificar uma página,
  2. pré-visualizar uma nova versão da página, ou
  3. show the difference with a new version (see edit and submit section below for details);
  4. If the default editor is set to VisualEditor , action=submit will force showing the source code editor. VisualEditor can be selected with veaction=edit URL parameter.
  5. The #/editor/… overlay of Extension:MobileFrontend on Skin:Minerva does not appear with action=submit. Instead, the default submission form is shown, which allows marking edits as "minor".
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 Same as edit.[6] www.mediawiki.org/w/index.php?title=Project:Sandbox&action=editredlink
history Shows the history of the page. (See history, below) 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 (obsoleto na versão 1.27); (removido na 1.38) If enabled, calls a php function registered via $wgAjaxExportList ; see Manual:Ajax .[8]
credits Shows a list of people who contributed to the page in question using the real name specified in the user's preferences. Currently disabled on Wikimedia wikis, but is enabled by default on vanilla MediaWiki. translatewiki.net/w/i.php?title=Translating:MediaWiki&action=credits
info Shows information about the page, such as the number of users having it in their watchlist, the number of edits, the number of authors. See the Reimplement info action RfC for context. 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)

Substituição de preferências de usuário

The following parameters override some of the user's preferences. Other parameters explained in other sections are "diffonly", "internaledit", and "externaledit". The below parameters affect all actions but "render" and "raw".

Nome Função Exemplo
useskin Especifique uma 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.

The special language code "qqx " can be used to display the ids of all system messages used on a page.

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 (obsoleto na versão 1.35) 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 enabled (e.g. set to 1 or true), user-provided CSS and JS will not be loaded. This disables personal scripts and styles (e.g. "User:" common.js and css), and site-wide scripts and styles (e.g. "MediaWiki:Common.js" and "MediaWiki:Common.css"), and all gadgets.[9] It is possible to mark site-wide styles ("MediaWiki:Common.css") as safe via $wgAllowSiteCSSOnRestrictedPages , which permits them in safemode. www.mediawiki.org/w/index.php?title=MediaWiki&safemode=1
useskinversion Specify a skin version[10] www.mediawiki.org/w/index.php?title=MediaWiki&useskinversion=2

Visualização e renderização

View is the default action. If no other action is added to the URL, action=view is used. This action shows a page, a revision, or the difference between two revisions of the same or two different pages. Below is a (partial) list.

diff
the value of this parameter identifies a revision; the difference between another revision and this one is returned:
  • if oldid is not passed, the difference between this revision and the previous one on the same article is shown;
  • otherwise, the difference between the revision given by oldid/direction and this one is shown; the value of this parameter can be a revision id, the values prev or next to identify a revision relative to the one given by oldid/direction, and the value cur to identify the latest revision of the page;
Note that oldid and diff need not be two revisions of the same article, allowing two revisions of two different pages to be compared
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

The following parameters apply only to categories.

from
if the page is a category, only list entries whose sortkey are equal or follows the value of this parameter;
Example: https://en.wikipedia.org/w/index.php?title=Special:Log&type=upload&from=20070814233520&until=20070814233625
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;

The following parameter apply only to images.

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

Histórico

limit
The number of page edits to list, the maximum is 5000 edits.
Example: https://en.wikipedia.org/w/index.php?title=Special:Contributions&limit=13&contribs=user&target=Atlgirl052005 - lists 13 edits per page.
dir
the relative order of edit history pages.
page edits are sorted in decreasing timestamp.
offset
uses a timestamp to specify which part of the history is displayed;
Returns the edits which occurred before the timestamp;
Example: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&contribs=user&target=Atlgirl052005
Shows the edits which occurred immediately before the timestamp 20090815195334 (20090815195334 is not shown).
Parameter format is yyyymmddhhmmss. So 20090815195334 was created on August 15, 2009 [20090815] at 19:53 (UTC) and 34 seconds [195334].
See Wikipedia:Complete diff and link guide.
if dir=prev is added, it works the other way around, listing all edits after the timestamp[11]
Example: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&dir=prev&contribs=user&target=Atlgirl052005
Shows the edits which occurred immediately after the timestamp 20090815195334 (20090815195334 is not shown).
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. Can be disabled with $wgFeed .
go
(deprecated - should be avoided, because it has been superseded) go=first the first (earliest) page of history is shown

Raw

Passar action=raw retorna o código fonte de uma página ou revisão. Por razões de cache e segurança, isto geralmente deve ser usado apenas através do script path, isto é, index.php?title=...]]. While "short urls" like /wiki/ are only meant for action=view, they unofficially tend to work for other actions as well. This is expressly discouraged for action=raw as it leads to less effective caching and bypasses automatic purging after edits.

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
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. (Note: 'section' also affects how the page is saved. Additionally, 'preload' and 'preloadparams' only work on wikitext contentmodel)

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 ;
Exemplo: 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. (introduzido na 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;
Exemplo: 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 "Mostrar a pré-visualização ao começar a editar" (tarefa T11936);
internaledit/externaledit (removido na 1.22)
overrides user preference on external editors;
mode (removido na 1.22)
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:Pré-visualização ao vivo 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 phab:rSVN18112; 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;
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. If the target page exists, ignore the edit parameter and display the (now-)existing page instead. 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.

Páginas especiais

Most special pages have additional parameters, specific to the function they perform. As an example, the parameters for Special:Export are outlined in Manual: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

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

Special:BlockIP

wpDisableEmail
whether to select the "Enviar e-mail" checkbox.
wpDisableUTEdit
whether to select the "Editar a sua própria página de discussão" 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 "Bloquear automaticamente o endereço de IP mais recente usado por este(a) usuário(a) e todos os IPs subsequentes dos quais ele(a) tentar editar, por um período de $1" checkbox.
wpWatch
whether to select the "Vigiar a página de usuário(a) e a página de discussão deste(a) usuário(a)" checkbox.

Special:UserRights

user-reason
text field with reason.

Maxlag parameter

Versões do 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.

Notas

  1. Os clientes que apresentem formulários deverão apresentar todos os parâmetros de formulário presentes no código HTML; confiar em qualquer tipo de lista estática pode levar a futuras quebras. Para registrar novas ações com uma instalação do MediaWiki, consulte $wgActions .
  2. Adicionalmente, qualquer ação que não a de visualizar pode ser desativada usando a variável $wgActions . Adicionalmente, a $wgActions está disponível para todas as ações.

    Se as buscas estão ativadas e o parâmetro search não está em branco, todas as ações são ignoradas e a busca é realizada.

  3. A exclusão é realizada por uma solicitação POST se um token de edição válido é passado como valor de wpEditToken; isso é o que acontece quando o usuário confirma a exclusão. O motivo da exclusão é passado como valor do argumento wpReason; e a cadeia de caracteres é gravada no registro de exclusão (no campo log_comment_id da tabela de logging ). A exclusão também é feita ao excluir uma única versão de uma imagem; isso requer que o ID da versão seja passado no parâmetro oldimage e um token de edição válido no wpEditToken; nesse caso, a solicitação também pode ser passada por GET.
    • se o argumento opcional summary é passado, seu valor é usado como sumário de edição em vez do padrão
    • se o argumento opcional bot é passado, a edição será marcada como de um robô (rc_bot=1 na tabela de recentchanges )
    • o argumento bot pode também ser usado em qualquer página na qual apareça a ligação de reversão, inserindo &bot=1 para todas as ligações de reversão geradas
    • se o argumento opcional hidediff é passado, o sucesso da mensagem é exibido em vez de uma dif na mudança (isso pode ser forçado nas preferências do usuário)
  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
    • additional parameters: rs is the function name (e.g., rs=wfSajaxSearch); the rsargs[] array is the list of arguments of this function (e.g., rsargs[]=abcd passes the abcd string to the function).
    • the JavaScript function sajax_do_call for calling Ajax functions is defined in ajax.js .
  6. Project:Tech News/2017#Tech News: 2017-16
  7. Reading/Web/Desktop Improvements#May 2020: First deployment - officewiki and testwiki
  8. For performance reasons, the value of this field is not actually an offset (the index of the first entry to show)

Ver também