URL パラメータと文書のメタデータ

MDN の Kuma Wiki プラットホームには外からアクセスする API がありません。代わりに、人間がアクセスできるリソースを機械的に扱いやすいデータに変換する手段を提供するというのが私たちのアプローチです。

URL パラメーター

すべての Kuma wiki 文書の URL が HTTP GET で取得されたりブラウザーで見られる時に役立つクエリーパラメーターオプションをサポートしています。複数のクエリーパラメーターは最初の ? の代わりに & で区切られます(マクロの例を見てください):

summary
Kuma にページの概要のみを返すよう指示します。"SEO summary"クラスでマークされたコンテンツがある場合、そのコンテンツが返されます。そのようなコンテンツがない場合、"Summary" というタイトルのあるコンテンツが返されます。そうならない場合、最初のブロックのコンテンツが返されます。
raw
Kuma にページの生コンテンツを返すよう指示し、ヘッダーやフッターなどのスキン素材がないようにします。これはテンプレートやスクリプトといったエディターを構成する手軽なものも実行しません。例えば: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?raw
macros
Kuma にページ内のテンプレートを実行するよう指示します。?raw と一緒では、これはサイトラッパーを除くすべてをレンダリングした MDN コンテンツを提供します。既定では ?raw なしです(つまり、通常のサイト表示です) ?raw がある時は既定でオフです。例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?raw&macros
nomacros
Kuma にページ内の KumaScript テンプレートを実行しないよう指示します。通常のサイト表示では ?macros が既定で "オン" になっていますが、このオプションはオフにします。例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5?nomacros
include
Kuma に "noinclude" なクラスがあるブロックを除くように言います。これはスタンドアローンなページではなく、他のページに含まれた時のような出力を得るのに便利です。よくサンプルコードなどを除きます (いつもではありませんが)。例えば、: https://developer.mozilla.org/ja/docs/XUL/Attribute/align?raw&macros&include
section=id
Kuma に指定したアンカー名のセクションのみのコンテンツを返すように指示します。例えば、:
https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters?section=params と、もっと興味深いものは https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters?raw&macros&section=params
このパラメーターは raw と一緒なときのみ動作します。つまり技術的にはバグですが、実際は問題になりません。
expand

$children ビューと連結して、サブページごとの詳細情報つきの JSON レスポンスを展開します。これは各サブページごとの $children$json の連結のように動作します。この方法は、サブページのタグについて学べます。例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children?expand

文書のメタデータリソース

Along with parameters to tweak the response of a document URL, there are also some alternate views on documents specified by URL suffix:

$toc
Tells Kuma to return only the table of contents for the page in HTML. It's returned as an ordered list (that is, <ol>). 例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$toc
$json
Tells Kuma to describe the page in a JSON object; this object is essentially the same one you would get using the KumaScript routine wiki.getPage(). 例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$json
$children
Tells Kuma to list the topic children of the page in JSON; this object is essentially the same one you would get using the KumaScript routine pages.subpages(). 例えば、: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children This can be used with the ?expand parameter in order to have a more detailed response.
$compare
Presents the source text line differences between revisions specified in required query parameters ?from and ?to. For examle: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$compare?to=911697&from=911067
$edit
Edits the current revision given document instead of displaying it. 例えば、: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$edit
$history
Displays revision history of the newest ten revisions of given document instead of its contents. The full history can be requested with the ?limit=all query parameter value. 例えば、: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$history?limit=all
$revision
Displays the document revision number which must be specified after a "/" separator. 例えば、https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$revision/915141

ドキュメントのタグと貢献者

このページの貢献者: wbamberg, Uemmra3, hamasaki
最終更新者: wbamberg,