手册:index.php的参数
本页面是index.php ,即MediaWiki软件自身提供的主要脚本,所接受的部分参数的列表。 大多数参数在URL中一般给定为GET参数,不过也可以传作POST数据。 部分情况下POST请求是必需的,比如刷新操作。一些扩展可以提供额外的参数。
页面修订或版本
index.php的参数通常适用,并且具有与它们所应用的页面相关的含义。 可以通过键入以下一个或多个参数来指定页面(或其版本): https://en.wikipedia.org/w/index.php?title=Ferengi&curid=177126&diff=304901009&oldid=304764764
名称 | 描述 |
---|---|
title | 页面标题。 它可以是wiki页面或特殊页面,具体取决于其他参数。 要禁用wiki配置中的特殊页面,可以使用SpecialPage_initList 钩子。 |
curid | wiki页面的id;覆盖title的值。 |
某些操作(如查看和编辑)也适用于页面的特定修订。这样的修订由以下两个参数标识,允许省略页面的标题和id。
名称 | 描述 |
---|---|
oldid | 修订的ID |
direction | 可使用以下内容代替oldid 给出的修订:
|
操作
以下是action
参数值的列表。
其中一些操作可以通过在LocalSettings.php
中使用专用配置设置来启用/禁用。在可用的情况下,会列出这些本地设置。[2]
Name | 函数 | 示例 |
---|---|---|
view | 查看是默认操作;查看是在没有明确给定操作时使用的一个操作 | www.mediawiki.org/w/index.php?title=Project:Sandbox&action=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 | 删除页面
默认情况下,delete会返回一个表单,供用户确认删除并指定原因。[3] |
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=delete |
revert | 还原到“图像”的早期版本。需要以下两个其他参数:
|
|
rollback | 回退页面的最后一个编辑者所做的最后一次编辑;换句话说,它恢复了不由最后一个编辑者作出的最后一个版本。该编辑标记为次要编辑,并使用默认的编辑摘要。[4]
需要以下两个其他参数:
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=rollback&from=John&token=d7aaa6c\ |
protect | 显示或更改页面的保护级别:
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=protect |
unprotect | 与保护相同的页面(取消保护和保护是相同的页面,执行相同的操作)。 | www.mediawiki.org/w/index.php?title=Project:Sandbox&action=unprotect |
markpatrolled | 将编辑标记为已巡逻;请参阅Meta上的Help:巡逻编辑。
|
|
render | 输出整个页面内容的HTML呈现;类似于view 操作,但只输出未格式化的文章文本,而不输出用户界面的任何部分(附加的工具箱、搜索框、样式表等)。
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=render |
purge | 清除页面的缓存,强制从其源代码重新显示页面。
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=purge |
edit | 以编辑形式显示页面。“edit ”执行的操作与$submit几乎相同
The editor shown depends on the user preferences. See Editor. |
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=edit |
submit | When viewed directly (HTTP GET), shows the editor, like "edit".
When viewing by submitting a form (HTTP POST), performs various actions related to changing the page (see #What to do below for more details):
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&action=submit |
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 | 在历史记录页面上单击“比较所选修订”后,查看修订之间的差异。这需要一个“diff”和/或“oldid”参数,否则它只显示页面本身。 | www.mediawiki.org/w/index.php?title=Project:Sandbox&action=historysubmit&diff=456290&oldid=456270 |
raw | 显示页面的原始内容。(参见下面的原始)将打开一个弹出窗口,询问您是否要将页面保存在index.php中。[7] | www.mediawiki.org/w/index.php?title=Project:Sandbox&action=raw |
ajax | (在1.27版本中已弃用); (在版本1.38移除) 如果启用,则调用通过$wgAjaxExportList 注册的php函数;参见手冊:Ajax 。[8] | |
credits | 显示使用用户首选项中指定的真实姓名为相关页面做出贡献的人员列表。当前在Wikimedia的wiki上禁用,但在普通MediaWiki上默认启用。 | translatewiki.net/w/i.php?title=Translating:MediaWiki&action=credits |
info | 显示有关页面的信息,例如监视列表中包含该页面的用户数、编辑数和作者数。关于其背景,请见重新实现info操作的意见征求。 | www.mediawiki.org/w/index.php?title=Project:Sandbox&action=info |
revisiondelete | 对修订文本、编辑摘要和编辑的用户名/IP地址设置可见性限制(需要deleterevision用户权限) |
用户首选项覆盖
以下参数将覆盖用户的某些首选项。其他章节中解释的其他参数包括“diffonly”、“internaledit”和“externaledit”。以下参数会影响除“render”和“raw”之外的所有操作。 Other parameters explained in other sections are "diffonly", "internaledit", and "externaledit". The below parameters affect all actions but "render" and "raw".
名称 | 功能 | 示例 |
---|---|---|
useskin | 指定皮肤 | www.mediawiki.org/w/index.php?useskin=modern |
uselang | 为UI元素指定一种语言(如“我的讨论页”链接等),即用户界面语言;这对于创建帐户特别有用,因为在那个阶段没有应用首选项设置。 | www.mediawiki.org/w/index.php?title=Special:Userlogin&type=signup&uselang=de |
variant | 为UI元素指定一个语言变体(例如在中文维基百科中使用,因为中文有变体); | |
printable | (在1.35版本中已弃用) 当设置为yes 时,页面将以适合打印的形式显示。
|
|
debug | 当设置为true (例如1 或true )时,资源加载器提供非最简的JavaScript和CSS。 见资源加载器/特性#调试模式。
|
www.mediawiki.org/w/index.php?title=Project:Sandbox&debug=true |
safemode | 启用时(例如设置为1 或true ),将不会加载用户提供的CSS和JS。 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 | 指定皮肤版本[10] | www.mediawiki.org/w/index.php?title=MediaWiki&useskinversion=2 |
查看和渲染
查看是默认操作。如果没有向URL添加其他操作,则使用action=view
。此操作显示页面、修订或同一页面或两个不同页面的两个修订之间的差异。以下是(部分)列表。
- diff
- 该参数的值标识修订;则返回另一个修订与此修订之间的差异:
- 如果
oldid
未通过,则显示本次修订与同一文章上一次修订之间的差异; - 否则,将显示
oldid/direction
给出的修订与此修订之间的差异;此参数的值可以是修订id,值prev
或next
用于标识相对于oldid/direction
给出的修订的修订,值cur
则用于标识页面的最新修订;
- 如果
- 请注意,
oldid
和diff
不需要是同一篇文章的两个修订版,可以比较两个不同页面的两个版本 - redirect
- 如果此参数的值为“no”,并且页面是重定向,则显示页面本身,而不是重定向的目标;此参数仅对
action=view
和action=render
有效,并且仅在未给定oldid
或diff
的情况下有效,因为这是唯一显示目标文章而不是重定向的情况; - rdfrom
- 当页面是从外部wiki进行重定向的结果时,此参数“告知”是哪个wiki,以便可以显示“从…重定向”行
- diffonly
- 重写用户在请求diff时是否呈现页面的偏好,例如
diffonly=yes
- search
- 如果非空(并且启用了搜索),则覆盖所有其他参数并执行搜索
以下参数仅适用于类别。
- from
- 如果页面是一个分类,则仅列出排序键等于或跟随该参数值的条目;
- 示例: https://en.wikipedia.org/w/index.php?title=Special:Log&type=upload&from=20070814233520&until=20070814233625
- 链接到2007年8月14日23:35:20至23:36:25上传的所有图像的日志
- until
- 如果页面是一个分类,则仅列出排序键位于该参数值之前的条目;仅在未传递
from
时使用;
以下参数仅适用于图像。
- page
- 多页介质中的页码;它目前只适用于DjVu和PDF文件;第一页编号为1;
历史
- limit
- 要列出的页面编辑数,最大为5000次编辑。
- dir
- 编辑历史页面的相对顺序。
- 页面编辑按递减时间戳排序。
- offset
- 使用时间戳来指定显示历史的哪一部分;
- 返回在时间戳“之前”发生的编辑;
- 示例: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&contribs=user&target=Atlgirl052005
- 显示在时间戳20090815195334“之前紧接”发生的编辑(未显示20090815195364)。
- 参数格式为yyyymmdhhmmss。 So 20090815195334 was created on August 15, 2009 [20090815] at 19:53 (UTC) and 34 seconds [195334].
- 参见Wikipedia:Complete diff and link guide。
- 示例: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&contribs=user&target=Atlgirl052005
- 如果添加了
dir=prev
,则会反过来列出所有在时间戳之后的编辑内容[11]- 示例: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&dir=prev&contribs=user&target=Atlgirl052005
- 显示在时间戳20090815195334后立即发生的编辑(未显示20090815195364)。
- 仅显示页面上第一次编辑的示例: https://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&action=history&dir=prev&limit=1
- 示例: https://en.wikipedia.org/w/index.php?title=Special:Contributions&offset=20090815195334&dir=prev&contribs=user&target=Atlgirl052005
纯文本
index.php?title=...
传递action=raw
将返回页面或修订版的源代码。出于缓存和安全原因,这通常只能通过script路径使用,即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
- 如果传递值
expand
,则页面中的模板将被展开; - ctype
- 返回原始内容时要在HTTP标头中使用的内容类型值,而不是默认的
text/x-wiki
;这只能是允许的类型之一,当前为text/x-wiki
、text/javascript
、text/css
和application/x-zope-edit
- oldid
- 要返回的特定修订的id
- direction
next
、prev
或cur
;而不是oldid指定的修订,返回其后面的修订、前面的修订或当前(最后)修订;- section
- 将输出限制为文档的特定部分或子部分。节是用非负整数指定的:节0是任何命名节之前的节,节1是第一个命名节或小节,依此类推。编号方案将节和小节视为相同。部分和子部分的列表可以通过带有api.php?action=parse&text={{:My_page}}__TOC__&prop=sections的neneneba api获得。
編輯和送出
编辑和提交操作执行的操作几乎相同。默认情况下,它们为页面返回一个“编辑页面”表单。通过传递其他参数可以获得不同的结果;某些结果(例如保存页面的新版本)只能使用POST获得。此操作采用用于指定页面或页面修订的标准参数。
影响编辑表单的选项
以下选项会对编辑表单产生影响。 (注意:“section”也会影响页面的保存方式。此外,“preload”和“preloadparams”仅适用于wikitext内容模型)
- section
- 指定文档中要预加载和编辑的节的索引;节从0开始按顺序编号;第0节是文章第一节标题之前的部分;值
new
用于将新的节追加到文档中; - preload
- 指定一个页面,如果要编辑的页面或节不存在,则使用该页面的wikitext作为编辑表单中文本区域的初始值;如果存在,则忽略预加载命令;另见手册:创建包含预加载文本的页面 ;
- preloadparams[](或preloadparams%5B%5D) 替换预加载文本中的
$1
样式参数。 例如,https://mediawiki.org/wiki/Project:Sandbox?action=edit§ion=new&preload=Manual:Creating_pages_with_preloaded_text/param_demo&preloadparams%5b%5d=first%20value&preloadparams%5b%5d=second%20value会导致Manual:Createing pages with_proaded text/param demo被预加载到编辑表单中,但$1
被“第一个值”取代,$2
被“第二个值”替代。 (在版本1.23引入) - editintro
- 在编辑表单上方呈现的现有文章或模板的标题;
- preloadtitle
- 如果是section=new,则提供"主题/标题"框的初始内容;保存前可对其进行编辑;
- 示例: https://en.wikipedia.org/w/index.php?title=User_talk:5dsddddd&action=edit§ion=new&preloadtitle=The+%5B%5BWP%3AARS%7CArticle+Rescue+Squadron%5D%5D
- 具有预加载标题和预加载的示例: https://en.wikipedia.org/wiki/User_Talk:Ikip?action=edit§ion=new&preload=Template:Article_Rescue_Squadron_ invite&preloadtitle=Invitation
- nosummary
- 當section=new時,不顯示「主旨」框。
- summary
- 它的值被用作编辑摘要,而不是默认值。
- preview
- 如果设置为
yes
或no
,则覆盖用户首选项“开始编辑时显示预览”(工單T11936); - internaledit/externaledit (在版本1.22移除)
- 覆盖外部编辑器上的用户首选项;
- mode (在版本1.22移除)
- 如果使用值
file
传递并使用外部编辑器,则此参数会影响结果页; - undo, undoafter
- 尝试撤消一系列编辑,从
undoafter
修订版到undo
版本;从技术上讲,这是通过尝试将这些编辑的反向与所有后续编辑的序列合并来实现的;这些参数的值是页面的旧修订的id;如果无法合并,则返回该修订版的常规编辑表单
该怎么办
以下选项告诉软件在提交时要做什么:保存、显示预览或显示与当前版本的差异。
- wpSave
- 此参数是在保存服务器返回的编辑表单的内容时生成的,但在提交时并没有实际使用,也不是必需的(有关要保存的必需参数,请参阅下文);
- wpPreview
- 在POST请求中设置为请求页面或节的预览,就好像保存了wpTextbox1的值一样;
- 默认情况下,返回一个带有wpTextbox1值预览的编辑表单;
- 如果传递了额外的
live
参数,则只显示值wpTextbox1的呈现,而不显示表单和其他GUI元素;这类似于节省然后用action=render
观看的结果;查看手冊:實時預覽 了解更多信息; - 参数
wpLivePreview
与wpPreview相同;因此,如果live
未通过,则返回常规预览;
- wpDiff
- 在POST请求中设置为请求一个表,该表显示页面或部分的当前版本与wpTextbox1的值被保存的版本之间的变化;
需要保存的参数
用户保存页面时需要以下参数。如果配置了编辑摘要字段,则也可能需要编辑摘要字段(见下文)。
- wpTextbox1
- 新的页面/部分内容;
- wpStarttime
- 用户何时开始编辑页面的时间戳;用于检查从该时刻到提交时间之间页面是否已被删除(在这种情况下,要求用户确认保存);
- wpRecreate
- 如果该页面在wpStarttime之后被删除,则该字段确认该页面将被保存;
- wpEdittime
- 对于新页面,它等于wpStarttime;否则,它是页面最后一次修订的时间戳;用于检查编辑冲突;
- wpEditToken
- 一个编辑令牌;这是为了避免用户被诱骗通过跟随链接或按下外部网站中的按钮来保存页面。对于未登录的用户,wpEditToken是必需的,因为phab:rSVN18112;它目前只包含字符
+\
,而不是随机字符串(请参见编辑令牌后缀)。
要保存页面,POST请求中必须包含wpStarttime
,wpEdittime
,wpTextbox1
和wpEditToken
,而不能传递wpPreview
或wpDiff
。
If the page was deleted after wpStarttime
, the boolean option wpRecreate
is also required.
可选的附加数据
如果配置了“警告空白摘要”,则编辑摘要或“忽略空白”参数可能是必需的。
- wpSummary
- 编辑摘要;
- wpMinoredit
- 如果在保存请求中设置,则编辑标记为次要;对于预览和差异,它是编辑表单中“这是一个小编辑”复选框的初始值;
- wpWatchthis
- 如果在保存请求中传递,则该页面将添加到用户的观察列表中;如果未在保存请求中传递,则该页面将从用户的监视列表中删除;对于预览或差异,这是编辑表单的“查看此页面”复选框的初始值;
- wpSection
- 指定要提交给的文档中某一节的索引;节从0开始按顺序编号;第0节是文章第一节标题之前的部分;值
new
用于将新的节追加到文档中; - wpChangeTags
- 要添加到编辑中的tags的可选逗号分隔列表。 如果提供的任何标签未激活以供手动使用,则编辑将被拒绝。
- wpAutoSummary
- 包含编辑表单中最初显示给用户的编辑摘要字段的MD5哈希值;该字段用于检查用户在提交前是否修改了该字段:如果
wpEditSummary
的MD5哈希值与该字段相同,则表示编辑摘要未被修改; - wpIgnoreBlankSummary
- 保存页面,即使用户没有修改编辑摘要,而他们应该修改;
- wpTextbox2
- 在编辑冲突的情况下,它包含生成冲突的保存请求的wpTextbox1的值;
- wpScrolltop
- 用于在加载预览时保留编辑文本框中的滚动条位置。
- redlink
- 如果用户没有编辑页面的权限,则重定向到空文章页面(例如,"维基百科没有同名文章"),而不是显示权限错误通知。 If the target page exists, ignore the
edit
parameter and display the (now-)existing page instead. This parameter is used on red links. - wpExtraQueryRedirect
- 保存URL后要修改的隐藏输入,实际编辑表单不使用。适用于小工具等。
特殊页面
大多数特殊页面都有额外的参数,特定于它们执行的功能。例如,Special:Export的参数在Manual:Parameters to Special:Export 中列出
以下URL参数为一些输入字段提供了初始值;可以在提交表单之前对其进行编辑。
- wpNewTitle
- 新標題的文字欄位。
- wpReasonList
- reason to pre-select in the dropdown.
- wpReason
- 原因的文字欄位。
- wpLeaveRedirect
- 是否勾選「留下重新導向頁面」複選框。
- wpDisableEmail
- 是否要勾選「发送电子邮件」複選框。
- wpDisableUTEdit
- 是否要勾選「编辑自己的讨论页」複選框。
- wpReason
- 預設選擇下拉式選單的項目,值應與MediaWiki:Ipbreason-dropdown中的其中一行相符。
- wpReason-other
- 自訂原因的文字欄位;需要
wpReason=other
- wpAutoBlock
- 是否要勾選「自动将此用户最后所使用的,以及后续编辑所在的所有IP地址封禁$1」複選框。
- wpWatch
- 是否要勾選「监视此用户的用户页和讨论页」複選框。
- user-reason
- 原因的文字欄位。
最大滞后参数
MediaWiki版本: | 1.10 – 1.27 |
只有当软件在已复制的数据库群集上运行时,才会使用“maxlag parametry ”。
maxlag参数使其在服务器流量高的情况下不提供请求。maxlag参数适用于所有操作。maxlag参数值是一个数字;该值越低,导致请求不被服务的流量就越低。不允许为零。
註釋
- ↑ 提交表单的客户端需要提交HTML中呈现的所有表单参数;依赖任何种类的静态列表可能会在将来导致出错。 要在安装MediaWiki时注册新操作,请参阅$wgActions 。
- ↑ 此外,使用$wgActions 变量可以禁用除“view”之外的任何操作。
此外,$wgActions 现在可用于所有操作。
此外,如果启用了搜索,并且提供了
search
参数(非空),则会忽略所有操作并执行搜索。 - ↑
如果传递了有效的编辑令牌作为
wpEditToken
的值,则在POST请求时执行删除;当用户确认删除时,就会发生这种情况。 删除原因作为参数wpReason
的值传递;该字符串记录在删除日志中(logging 表的log_comment_id
字段) 当删除图像的单个版本时,也执行删除;这需要在参数oldimage
中传递版本id,并在wpEditToken
中传递有效的编辑令牌;在这种情况下,请求也可以通过GET传递 - ↑
- 如果传递了可选的
summary
参数,则其值将用作编辑摘要,而不是默认值 - 如果传递了可选的
bot
参数,则编辑将标记为bot一(编辑在recentchanges 表中标记为rcbot=1
) bot
参数也可以用于将出现[rollback]链接的任何页面,以将&bot=1
级联到生成的所有回滚链接- 如果传递了可选的
hidediff
参数,则会显示成功消息,而不是更改的diff(这可以通过用户首选项强制执行)
- 如果传递了可选的
- ↑ 如果请求是POST请求,并且有效的编辑令牌作为
wpEditToken
传递,则这些级别将更改为mwProtect-level-edit
和mwProtect-level-move
的值;参数mwProtect-reason
给出保护或取消保护的原因,将记录在页面日志中;如果mwProtect-cascade
也通过,则应用级联保护(所有已屏蔽的页面都设置为相同的保护级别)- 更一般地说,可以限制的操作是列在$wgRestrictionTypes 数组中的操作;此数组初始化为
array('edit','move')
,并且可以在LocalSettings.php 中更改;然后,保护操作为该数组中的每个操作接受一个参数mwProtect-level-$action
- 更一般地说,可以限制的操作是列在$wgRestrictionTypes 数组中的操作;此数组初始化为
- ↑ 在rev:r31291之前,Editredlink做了与现在
action=edit&redlink=1
实现的相同的事情(请参阅下面对redlink参数的解释) - ↑ 出于安全原因,在某些版本的MediaWiki中,Raw仅在使用“主脚本访问点”时才被允许,也就是说,当使用带有
index.php?title=...
的“ugly”URL表单时 - ↑
- 要求$wgUseAjax 为真;唯一可调用的函数是数组$wgAjaxExportList 中的函数
- 附加参数:
rs
是函数名(例如,rs=wfSajaxSearch
);rsargs[]
数组是此函数的参数列表(例如,rssargs[]=abcd
将abcd
字符串传递给函数)。 - 用于调用Ajax函数的JavaScript函数
sajax_do_call
在ajax.js 中定义。
- ↑ Project:Tech News/2017#Tech News: 2017-16
- ↑ 阅读/网络/桌面改进#2020年5月:首次部署-officewiki和testwiki
- ↑ 出于性能原因,此字段的值实际上不是偏移量(要显示的第一个条目的索引)
参见
- Markup spec
- API:Main module
- Help:URL
- 函数列表
- Snippets/Load JS and CSS by URL (添加客户端处理的withJS和withCSS参数)