Manual:Parameters to index.php/ja

From MediaWiki.org

Jump to: navigation, search

このページはMediaWikiソフトウェアのメインスクリプトであるindex.phpへのパラメータの一部のリストです。これらの多くの引数はURLにおいて通常GETパラメータとして与えられますが、POSTデータとしても渡されます。POSTは匿名ユーザのためのpurgeアクションといったいくつのケースにおいて実際に要求されます。

注意: このページの情報は完全ではありません。

フォームを投稿するクライアントはHTMLで表されるすべてのフォームパラメータを投稿します -- 静的なリストを当てにすることは将来の破損につながるかもしれません。

maxlag parameterはすべてのアクション、とりわけハイトラフィックの場合でリクエストが提供されないことを伝えることに適用されます。値は数値です; この値が低い(0ではない)ほど、提供されないリクエストをもたらすトラフィックが低くなります。ソフトウェアが複製のデータベースクラスター上で動作しているときのみ適用されます。

Contents

[edit] アクション

次の内容はactionパラメータのために許可された値のリストです。

これらのアクションの中にはLocalSettings.phpで専用のコンフィギュレーション設定を使用することによって有効/無効になるものがあります。適切な場所で、これらの設定を記述して下さい。加えて、'view'アクションを除いて、$wgDisabledActionsに追加するでアクションは無効にできます。デフォルトの$wgDisabledActionsの値は空です。配列を使用するアクションの無効はアクションごとの設定より優先されます。例えば、無効にされたアクションの配列の中に'info'がある場合、$wgAllowPageInfoがtrueに設定されているとしてもinfoページを見ることはできません。

加えて、検索が有効でsearchパラメータが提供されている場合(空白ではない)すべてのアクションは無視され検索が実行されます。

view 
デフォルトのアクションです; アクションが明示的に与えられない時に使用されます
watch
ページをユーザのウォッチリストに追加します
unwatch 
ユーザのウォッチリストからページを除去します;
delete 
ページを削除します:
  • デフォルトでは、ユーザのために削除と確認して理由を指定するためにフォームを返します;
  • 正しいedit tokenwpEditTokenの値として渡される場合、削除はPOSTリクエスト上で実行されます; ユーザが削除を確認するときに起きます;
  • 削除の理由は引数wpReasonの値として渡されます; この文字列は削除ログ(logging tablelog_commentフィールド)に記録されます。
  • 画像の単独のバージョンを削除するときも削除が実行されます; パラメータodlimagewpEditTokenへの正しい編集トークンに渡されるidバージョンが求められます; この場合、リクエストはGET経由でも渡されます;
revert 
画像の以前のバージョンへの差し戻し; 2つの他のパラメータが要求されます:
  • oldimage、差し戻しするバージョンのid;
  • wpEditTokenは妥当な編集トークンです;
rollback 
ページの最後の編集者によって最後の編集をロールバックします; 言い換えると、最後の編集ではない記事の最後のバージョンをリストアします; 編集は細部の編集としてマークされデフォルトの編集要約が使用されます
  • fromは差し戻しされた編集のユーザ名です
  • tokenはロールバックトークンです; リンクに追跡するもしくは外部のウェブサイトにあるボタンをクリックすることで望まないロールバックをユーザが実行することを防止するために使用されます
  • オプションのsummary引数が渡される場合、デフォルトの値の代わりにその値が編集の要約として使用されます
  • オプションのbot引数が渡される場合、編集はbotのものとしてマークされます(編集はrecentchanges table)でrc_bot=1とマークされます)
protext 
ページの保護レベルを表示するもしくは変更します:
  • デフォルトでは、ページの現在の保護レベルを表示するフォームを返し、ユーザがページの保護レベルを変更することを許可します;
  • リクエストがPOSTで、妥当な値編集トークンがwpEditTokenとして渡される場合、これらのレベルはmwProtect-level-editmwProtect-level-moveの値に変更されます。mwProtect-cascadeも渡され、カスケーディングプロテクションが適用される場合(すべてのトランスクルードされたページが同じ保護レベルに設定されます)mwProtect-reasonパラメータはページログに記録される保護もしくは保護の解除のために理由を加えます
  • より一般的には、制限されるアクションは$wgRestrictionTypes配列でリスト表示されたものです; この配列はarray('edit','move')に初期化され、LocalSettings.phpで変更することが出来ます; protectionアクションは配列でそれぞれのアクションのためにmwProtect-level-$actionパラメータを受け取ります;
info 
  • このページをウォッチリストに登録しているユーザ数、編集回数、著者の人数などのページに関連した情報を表示します;
  • このアクションはDefaultSettings.php)の$wgAllowPageInfo変数経由でデフォルトでは無効にされています;
markpatrolled 
パトロールされた編集としてマークします; meta:Help:Patrolled editをご覧下さい;
render : ページを描写するHTMLを表示します; viewアクションと同様に、記事のテキストのみが示されますが、追加のツールボックスなどは表示されません。
deletetrackback 
...
  • トラックバックに関連します;
  • このアクションはDefaultSettings.phpにおいてデフォルトでは無効にされています
purge 
ページのキャッシュをクリアし、ソースからページを再構築することを強制します;
  • このアクションはログインユーザのために直接実行されます
  • ログインしていないユーザのために、このアクションはPOSTリクエスト経由でリクエストされた時のみに実行されます; さもなければパージングを確認するフォームが表示されます(OKボタンを押すことでパージリクエストを投稿し、そしてリクエストが実行されます)
print 
'view'と同じです;
dublincore 
...
creativecommons 
credits 
...
submit 
ページ変更に関連する様々なアクションを実行します(詳細は下記を参照):
  • デフォルトで、編集フォームを表示します;
  • ページを変更する、ページの新しいバージョンをプレビュー、もしくは新しいバージョンとの差異を表示するため様々な引数がに使用されます(詳細については下記の編集/投稿セクションをご覧下さい);
edit 
一般的にページから編集を返すために使用されます。実際には投稿とほぼ同じ機能を実行します;
history 
ページの履歴を表示します(下記を参照)
raw 
ページの生の内容を表示します(下記を参照)
ajax 
有効な場合、$wgAjaxExportList経由で登録したPHP関数を呼び出します; Manual:Ajax/jaをご覧下さい。
  • $wgUseAjaxをtrueにすることが要求されます; 呼び出し可能な関数は$wgAjaxExportList配列にあるもののみです ($wgAjaxSearch もしくは$wgAjaxWatchが設定されている場合は暗黙です)
  • 追加パラメータ: rsは関数名です(例えば rs=wfSajaxSearch); the rsargs[]配列はこの関数の引数のリストです(例えば、rsargs[]=abcdabcd文字列を関数に渡します)。
  • Ajax関数を呼び出すためのJavaScriptのsajax_do_callajax.jsで定義されたAjax関数です。

[edit] プリファレンス(オプション)のオーバーライド

次のパラメータはユーザのプリファレンス(オプション)をオーバーライドします。他のセクションで説明される他のパラメータは"diffonly"、"internaledit"、と"externaledit"です。

useskin 
skinを指定します
uselang : UI要素のために言語を指定します(例えば" my talk"リンクなど); これはアカウントを作成するために便利です、プリファレンス設定が適用するステージにおいて。例えば、http://meta.wikimedia.org/w/index.php?title=Special:Userlogin&type=signup&uselang=de を使用します; MediaWikiのバージョンの範囲から選択するために言語に関係なくuselangは一般的なパラメータとしても使用されます。w:Wikipedia:Upload[1]を参照して下さい;
variant 
UI要素のために言語バリアントを指定します(例えば中国語のWikipediaで使用されています);
printable 
yesが渡されたとき、ページは印刷に最適なフォームで表示されます;

上記の4つのパラメータは"render"と"raw"以外のすべてのアクションに影響します。

[edit] ページもしくはリビジョンを確認する

ページ(もしくはページのバージョン)は一つもしくは複数のパラメータを渡すことで指定することが出来ます:

title 
ページのタイトル
curid 
ページのid; タイトルの値をオーバーライドします(タイトルのパラメータが要求される、もしくはメインページで終わる)

アクション(ビューと編集)の中にはページの特定のリビジョンで動作するものもあります。リビジョンが2つの次のパラメータによって確認されます。タイトルとページのidを省略することが可能になります。

oldid 
リビジョンのid;

oldidによって与えられたリビジョンの代わりに使用します:

  • direction=prev: 前のもの
  • direction=next: 次のもの

[edit] ビューとレンダー

ビューはデフォルトのアクションです。他のアクションが渡されない場合、action=viewが明示的に想定されます。このアクションはページ、リビジョン、同じ、もしくは異なるページの2つのリビジョン間の差分を表示します。次の内容は(部分的な)引数のリスト(このアクションに影響を与える)です。

diff : このパラメータの値はリビジョンを特定します; 他のリビジョンとこのリビジョン間の差分が返されます:
  • if oldidが渡されない場合、同じ記事上のこのリビジョンと以前のリビジョン間の差分が表示されます;
  • さもなければ、oldid/directionによるリビジョンとこのリビジョン間の差分が表示されます; このパラメータの値として取り得るのは、リビジョンid、prevの値、oldid/directionによって与えられたリビジョンと関連するリビジョンを特定するnextとページの最新リビジョンを特定するcurの値です;
それらは2つの異なるページの2つのリビジョンを比較することを可能にするので、oldiddiffは同じ記事の2つのリビジョンである必要はありません。
redirect 
このパラメータの値は'no'でページはリダイレクトで、ページ自身は表示されリダイレクトのターゲットではありません; このパラメータはaction=viewにのみ効果があり、oldidもしくはdiffが与えられない場合、リダイレクトの代わりにターゲットの記事が表示される場合に当てはまる時です;
rdfrom 
ページが外部のwikiからリダイレクトを追跡した結果である時、"Redirected from ..."が表示されるようにこのパラメータはwikiがどちらにあるのか伝えます
diffonly 
diffが要求されたときにページをレンダーするかどうかについてユーザのプリファレンスを上書きします
search 
空白ではない場合(かつ検索が有効になっている)、すべての他のパラメータを上書きして検索を実行します

次のパラメータはカテゴリだけに適用されます。

from 
ページがカテゴリである場合、ソートキーが等しいもしくはこのパラメータに従うエントリーを表示します;
until 
ページがカテゴリである場合、ソートキーがこのパラメータの値を優先するエントリーをリスト表示します; fromが渡されない場合のみに使用されます;

次のパラメータは画像のみに適用されます。

page 
マルチページメディアにあるページ番号; 現在DjVuファイルのみ適用します; 最初のページは1と番号付けされます;

[edit] 履歴

limit 
リスト表示するページリビジョンの番号
dir 
履歴ページの相対的な順番です: dir=prevは履歴のもっとも初期のページが最初のページとして表示されることを意味します; 他の値は履歴の最新のページが最初に表示されることを意味します; それぞれのページ範囲内で、両方の場合でエントリーはタイムスタンプが小さい順でソートされます
offset : 表示される履歴の部分を指定するために使用されるタイムスタンプです; デフォルトの場合において最新の返されたエントリはこのタイムスタンプより優先する最新のリビジョンです; dir=prevが与えられ、他の回避方法で動作します; このフィールドの値は実際にはパフォーマンス上の理由からオフセットではありません(表示する最初のエントリーのインデックス)
feed 
指定された場合、履歴における変更のためのフィードが返されます; 許可された値はatomrssです
go 
(廃止予定) go=firstの値が渡された場合、最初の(初期の)ページの履歴が表示されます

[edit] Raw

action=rawはページもしくはリビジョンのソースコードを返します。

template 
expandの値で渡された場合、ページの範囲内のテンプレートが拡大されます;
ctype 
生の内容を返すときに、デフォルトのtext/x-wikiの代わりにHTTPヘッダで使用されるcontent-typeの値; これは次のタイプの一つのみを取り得ます。現在はtext/x-wikitext/javascripttext/cssapplication/x-zope-editです
maxage 
max-ageの値は名前のページを返すときにCache-Control HTTPヘッダフィールドでしようされるものです
usemsgcache 
MediaWikiの名前空間でページのみに適用します; この引数が存在する場合、メッセージの内容はデータベースではなくメッセージキャッシュから返されます
oldid 
返すための特定リビジョンのid
direction 
nextprev</co>、curのどれか; oldidによって指定されたリビジョンの代わりに、次のリビジョン、前のリビジョン、現在の(最後の)リビジョンを返します;
gen 
この引数はcssもしくはjsの値を取ります; 返される値は生成されたユーザのCSSもしくはJavaScriptです

[edit] 編集と投稿

編集と投稿アクションはほとんど同じアクションを実行します。デフォルトでは、それらはページのために"edit page"を返します。異なる結果は他の引数を渡すことで取得されます; 結果の中には(ページの新しいバージョンを保存するなど)POSTを使用してのみ取得できるものがあります。このアクションはページもしくはページリビジョンを指定するための標準的な引数を取得します。

[edit] 編集フォームに作用するオプション

次の3つのオプションは編集フォーム上の効果を生み出します(最初のものはページがどのように保存されるのかに作用します。)

section 
事前に読み込み編集するドキュメントの範囲内でセクションのインデックスを指定します; セッションは0からの連番です; セクション0は最初のセクションのヘッダの前の記事の部分です; newはドキュメントで新しいセクションを追加するために使用されます;
preload 
ページもしくはセクションが存在しない場合、編集フォームでテキストエリアの初期の値として使用されるwikitextのページを指定します; ページが場合、preloadコマンドは無視されます。 (Bug 5210の2006-03-09以降の部分を参照: これは、includeonlyタグではなくnoinclude部分とタグを含む、ソースページのほとんどすべてのwikitextをプリロードします。)
editintro 
上記のフォームでレンダーされた存在する記事もしくはテンプレートのタイトル:
internaledit/externaledit 
外部エディタ上でデフォルトのユーザのプリファレンスを上書きします。
mode 
このパラメータはfileの値で渡され、外部エディタを使用している場合に結果ページに作用します;
undo 
編集もしくは一連の編集をアンドゥーしようとします; 技術的には、これはこれらの編集の逆と一連のすべての後の編集を統合しようとすることでなされます; このパラメータの値はページの古いリビジョンのidです; 統合が可能ではない場合、そのリビジョンのために通常の編集フォームが返されます
  • デフォルトでは、アンドゥは与えられたリビジョンidを優先する編集上で試みられます;
  • if undoafterも与えられた場合、リビジョンundoafterundo間の変更がアンドゥされることが試みられます;

[edit] 何をするのか

次のオプションは投稿する時にソフトウェアが何をすればよいのかを伝えます: 保存、プレビューを表示する、もしくは現在のバージョンとの差分です。

wpSave 
サーバによって返された編集フォームの内容を保存するときにこの引数は生成されますが、投稿時に実際には使用されないもしくは要求されません(保存するtまえに要求される引数については下記を参照);
wpPreview : あたかもwpTextbox1の値が保存されたように ページもしくはセクションのプレビューをリクエストするためにPOSTリクエストを設定します;
  • デフォルトでは、wpTextbox1の値のプレビューで編集フォームを返します;
  • 追加のlive引数が渡されたとき、wpTextbox1の値のレンダリングが表示されるだけで、フォームと他のGUI要素は返されません; 保存の結果と似ており、action=renderでビューをします(ライブプレビューとアプリケーションの詳細については、en:User:Pilaf/Live Previewをご覧下さい);
  • wpLivePreviewはwpPreviewにとって理想的です; それゆえ、通常のプレビューはliveが渡されない場合に返されます;
wpDiff 
あたかもwpTextbox1が保存されたかのように、ページもしくはセクションの現在のバージョンとバージョン間の変更を表示しながら、テーブルをリクエストするPOSTリクエストに設定します;

[edit] 保存される必要があるパラメータ

次のパラメータはユーザがページを保存するときに求められます。編集要約フィールドはそのように設定されたときにも要求されることがあります(下記を参照)。

wpTextbox1 
新しいページ/セクションの内容;
wpStarttime 
ユーザがページ編集を始めた時のタイムスタンプ; この瞬間と投稿時間の間にページが削除されたかどうかを確認するために使用されます(この場合、ユーザは保存をすることを確認されます)
wpRecreate 
wpStarttimeの後でページが削除された場合、このフィールドはページが保存されていることを確認します;
wpEdittime :新しいページのために、wpStarttimeと等しいです; さもなければ、ページの最後のリビジョンのタイムスタンプです; 編集の衝突を確認するために使用されます;
wpEditToken 
編集トークン; リンクを追跡するもしくは外部サイトでリンクボタンを押すことによってページを保存することからユーザを回避させるために使用されます。ログインしていないユーザのために、revision 18112以降でwpEditTokenが要求されます; 現在はランダムな文字列よりも+\の文字列のみが含まれます(edit token suffixを参照して下さい)

保存するページのために、wpStarttimewpEdittimewpTextbox1wpEditTokenがPOSTリクエストで要求され、wpPreviewもしくはwpDiffのどちらも渡されません。wpStarttimeの後でページが削除された後で、論理型のオプションであるwpRecreateも要求されます。

[edit] オプションの追加データ

編集要約もしくは"ignore blank"パラメータは"warn on blank summaries"が設定されている場合義務になることもあります。

wpSummary 
編集要約;
wpMinoredit 
保存リクエストで設定されている場合、編集は細部の編集としてマークされます; プレビューと差分のために、編集フォームに"this is a minor edit"チェックボックスが初期の値になります;
wpWatchthis 
保存リクエストに渡された場合、ページにユーザのウォッチリストが追加されます; 保存リクエストに保存されない場合、ページはユーザのウォッチリストから除去されます; プレビューもしくは差分のために、これは編集ボックスの"watch this page"チェックボックスの初期の値です;
wpSection 
投稿するドキュメントの範囲内でセクションのインデックスを指定する; セクションは0から連番の数字を付けられます; セクション0は最初のセクションヘッダの前の記事の部分です; newの値は新しいセクションをドキュメントに追加するために使用されます;
wpAutoSummary 
初期に編集フォームでユーザに表示されるものとして編集要約フィールドのMD5のハッシュを含みます; このフィールドは投稿する前にユーザが修正されたそのフィールドを持つかどうかを確認するために使用されます: wpEditSummaryの値のMD5ハッシュがこのフィールドと同じ場合、編集要約は修正されません;
wpIgnoreBlankSummary 
ユーザが編集要約を修正しなかったとしてもページを保存します;
wpTextbox2 
編集の衝突の場合、衝突を生成した保存リクエストのwpTextbox1の値を含みます;
safemode 
ブラウザの中にはユニコードの文字を含むテキスト編集で問題を抱えるものがあることが知られています; そのようなブラウザから編集フォームのためのリクエストが来た場合、テキストエリアの初期の内容にあるアスキーではない文字は&#xxxx;の形に変換され、safemode=1の値はフォームに隠されてしまいます; 投稿したとき、safemodeフィールドは逆変換が実行されることを示します。
wpScrolltop 
 ???

[edit] 特別ページ

多くの特別ページはそれらが実行する機能に特有の追加のパラメータを持ちます。例えば、Special:ExportのためのパラメータはManual:Parameters to Special:Export/jaで要点が書かれています

[edit] ユーザスクリプトのパラメータ

ユーザスペースのw:JavaScriptはGETとPOST経由で渡された追加のパラメータを取得することがあります。ユーザが独自のスクリプトもしくはLupin's Autoedit ScriptのようなグローバルなJavaScriptを使用する場合、次のパラメータは自動編集のために使用されます: autoedit、autosummary、autoclick、とautominorです。Extension:Autoeditで詳細な説明がされているものがあります。

Personal tools