From 6ef1fa4618e08426b874529619a66adbd3d1fcf0 Mon Sep 17 00:00:00 2001 From: Florian Merz Date: Thu, 11 Feb 2021 12:07:59 +0100 Subject: unslug ja: move --- files/ja/mdn/tools/add-ons_and_plug-ins/index.html | 33 ---- files/ja/mdn/tools/document_parameters/index.html | 95 ---------- files/ja/mdn/tools/feeds/index.html | 53 ------ files/ja/mdn/tools/page_deletion/index.html | 61 ------ files/ja/mdn/tools/page_moving/index.html | 57 ------ files/ja/mdn/tools/page_regeneration/index.html | 34 ---- files/ja/mdn/tools/page_watching/index.html | 49 ----- files/ja/mdn/tools/put_api/index.html | 208 --------------------- files/ja/mdn/tools/revision_dashboard/index.html | 117 ------------ files/ja/mdn/tools/template_editing/index.html | 38 ---- files/ja/mdn/tools/unsupported_get_api/index.html | 95 ++++++++++ 11 files changed, 95 insertions(+), 745 deletions(-) delete mode 100644 files/ja/mdn/tools/add-ons_and_plug-ins/index.html delete mode 100644 files/ja/mdn/tools/document_parameters/index.html delete mode 100644 files/ja/mdn/tools/feeds/index.html delete mode 100644 files/ja/mdn/tools/page_deletion/index.html delete mode 100644 files/ja/mdn/tools/page_moving/index.html delete mode 100644 files/ja/mdn/tools/page_regeneration/index.html delete mode 100644 files/ja/mdn/tools/page_watching/index.html delete mode 100644 files/ja/mdn/tools/put_api/index.html delete mode 100644 files/ja/mdn/tools/revision_dashboard/index.html delete mode 100644 files/ja/mdn/tools/template_editing/index.html create mode 100644 files/ja/mdn/tools/unsupported_get_api/index.html (limited to 'files/ja/mdn/tools') diff --git a/files/ja/mdn/tools/add-ons_and_plug-ins/index.html b/files/ja/mdn/tools/add-ons_and_plug-ins/index.html deleted file mode 100644 index d89e8efbdb..0000000000 --- a/files/ja/mdn/tools/add-ons_and_plug-ins/index.html +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: MDN に関連するアドオンとプラグイン -slug: MDN/Tools/Add-ons_and_plug-ins -tags: - - Landing - - MDN Meta - - Site-wide - - Tools -translation_of: MDN/Tools/Add-ons_and_plug-ins ---- -
{{MDNSidebar}}

MDN コミュニティのメンバーは多くの楽しく、便利なプロジェクトを立ち上げています。 MDN の利用や、内容への貢献を簡単にする、ツール、アドオン、ユーテリティを作成するものがあります。

- -

こうした数々のプロジェクトのリンクがここにあります。これらの多くは完成まで手助けも要るため、あなたが助けるものを探しているコーダーである場合、ここに機会が見つかるかもしれません!

- -
-
-
MDN doc tests add-on
-
MDNの編集中に表示されるサイドバーを作成する Firefox アドオンで、コンテンツのテストと妥当性チェックを提供します。これは作業途中なので、より多くのテストを歓迎します!
-
MDN automatic translation
-
{{Glossary("Regular_expression", "正規表現")}}ベースのルールを使って、自動的によくある用語を翻訳された形に置き換える。
-
MDN Search
-
URLバーで "mdn <searchterm>" とタイプすることですばやくMDN のリファレンス素材を検索することができる WebExtension。 組み込みのMDN 検索をベースにしているが、より良い結果を出すようにロジックが追加されている。JavaScript と CSS リファレンスを探すのに最適化されている。
-
MDN Interface Documentation Generator
-
この Firefox アドオンは、XPCOM インターフェイス用に、適切にフォーマットされたスケルトン生成に役立ちます。しばらく更新されてないので、バージョン互換性の情報を正しく表示しませんが、いろいろと便利です。いくつか更新されたら、またかけがえないものに戻るでしょう。
-
 
-
Save with comment hotkey addon
-
MDNエディタのリビジョンコメント欄にすぐにスクロールさせる Firefox アドオン。つまりこれによって、あなたが編集したことに対する、小さな情報を簡単に追加できます。
-
Sublime Text MDN search plug-in
-
コーディング中にドキュメントを得るのに、MDNをすぐに検索できる Sublime Text のプラグイン。
-
Lazarus
-
定期的にフォームデータをlocal storageに自動保存する Firefox 拡張機能で、すべてのデータをクラッシュやエラーから保護します。これは MDN で作業する時に便利で、なぜなら MDN エディターのコンテンツも保存し、成果を保存する前に何か失敗した場合に戻すことができるためです。
-
-
diff --git a/files/ja/mdn/tools/document_parameters/index.html b/files/ja/mdn/tools/document_parameters/index.html deleted file mode 100644 index 6198f8ea7b..0000000000 --- a/files/ja/mdn/tools/document_parameters/index.html +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: URL 引数と文書メタデータ -slug: MDN/Tools/Document_parameters -tags: - - Documentation - - Kuma - - MDN Meta - - Page-level - - Reference - - Tools -translation_of: MDN/Tools/Document_parameters ---- -
{{MDNSidebar}}
- -
-

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

-
- -
-

URL の GET 引数

- -

すべての Kuma wiki 文書の URL が HTTP GET で取得されたりブラウザーで見られる時に役立つクエリ引数オプションをサポートしています。

- -

複数のクエリ引数は最初の ? の代わりに & で区切られます (マクロの例を見てください)。

- -
-
summary
-
-

Kuma にページの概要のみを返すよう指示します。 "SEO summary" クラスでマークされたコンテンツがある場合、そのコンテンツが返されます。そのようなコンテンツがない場合、 "Summary" というタイトルのあるコンテンツが返されます。そうならない場合、最初のブロックのコンテンツが返されます。

- -
バグのお知らせ: 現在、 summary 引数は raw 引数も指定しないと文書全体を返すというバグがあります。なお、 $json 代替ビューを使用して返される JSON から概要を取得することもできます。
-
-
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 に指定したアンカー名を持つセクションのみのコンテンツを返すように指示します。
-
例: - - -
バグのお知らせ: 現在、 section 引数は raw 引数も使用しないと文書全体を返すというバグがあります。
-
-
expand
-
-

$children ビューと連結して、サブページごとの詳細情報つきの JSON レスポンスを展開します。これは各サブページごとの $children と $json の連結のように動作します。この方法は、サブページのタグについて学べます。

- -

例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children?expand

-
-
-
- -
-

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

- -

文書の URL のレスポンスを微調整するための引数と一緒に、 URL 接尾辞で指定される文書の代替ビューもいくつかあります。

- -
-
$toc
-
Kuma に HTML のページの目次のみを返すよう命じます。順序付きリスト (つまり {{HTMLElement("ol")}}) として返されます。
-
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$toc
-
$json
-
Kuma に JSON オブジェクトでページを記述するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 wiki.getPage() を使用して得られるものと同じです。
-
例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$json
-
$children
-
Kuma にページのトピックの子を JSON で列挙するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 pages.subpages() を使用して得られるものと同じです。
-
例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children
-
(これは ?expand 引数と共に使用して、もっと詳細のレスポンスを得ることもできます。)
-
$compare
-
必須のクエリ引数 ?from および ?toで指定されたリビジョン間のソーステキスト行の違いを表示します。
-
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$compare?to=911697&from=911067
-
$edit
-
指定された文書の現在のリビジョンを、表示する代わりに編集します。
-
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$edit
-
$history
-
指定された文書の内容を表示する代わりに、最新の10リビジョンのリビジョン履歴を表示します。履歴全体は、クエリ引数の値に ?limit=all を付けることで要求できます。
-
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$history?limit=all
-
$revision
-
文書の "/" の後に指定された番号のリビジョンを表示します。
-
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$revision/915141
-
-
diff --git a/files/ja/mdn/tools/feeds/index.html b/files/ja/mdn/tools/feeds/index.html deleted file mode 100644 index 6d30d1a342..0000000000 --- a/files/ja/mdn/tools/feeds/index.html +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: MDN の Feeds API について -slug: MDN/Tools/Feeds -tags: - - Kuma - - MDN Meta - - Site-wide - - ツール - - リファレンス -translation_of: MDN/Tools/Feeds ---- -
{{MDNSidebar}}

MDN の wiki では、サイトの更新内容を追跡する為にフィード API が提供されています。この API はまだ作成中であるかもしれませんが、この情報は役立つかもしれません。

- -

フィードへのアクセス

- -

フィードは次の様な形式の ベース URL から始まります。

- -
https://developer.mozilla.org/<locale>/docs/feeds/<format>/
- -

ベース URL 内の各プレースホルダーはそれぞれ次の意味を持ちます。

- - - -

json 形式を使用する場合、オプションとして the JSONP convention で JavaScript としてデータを読み込むための ?callback=<callback name> クエリパラメーターが指定可能です。

- -

購読可能フィード

- -
-
all
-
最近の記事の変更すべてを編集日付順で。新規に作成された記事も含む。すべての変更は各記事のフィードのエントリーに結ばれています。例えば: https://developer.mozilla.org/ja/docs/feeds/rss/all
-
revisions
-
特定の記事のリビジョンを編集日付順で。新規作成も含む。各リビジョンはフィードの別々のエントリーを持ちます。例えば: https://developer.mozilla.org/ja/docs/feeds/atom/revisions
-
tag/<tagname>
-
フィードの指定タグの付いた記事の更新情報のみを編集日付順で取得。例えば: https://developer.mozilla.org/ja/docs/feeds/json/tag/CSS?callback=loadFeed
-
files
-
最近のファイルのアップロードまたは変更。例えば: https://developer.mozilla.org/ja/docs/feeds/atom/files
-
l10n-updates
-
翻訳ページの最終更新時以降に翻訳の元となる言語の記事が変更された記事のリスト (つまり、他の言語から翻訳された記事で、元の言語の記事が変更された場合)。例えば: https://developer.mozilla.org/fr/docs/feeds/atom/l10n-updates
-
needs-review[/<reviewtype>]
-
要レビューとされた記事のリスト。technical 、editorial 、kumascript の何れかに絞って取得する事も可能。 - -
-
- -

 

diff --git a/files/ja/mdn/tools/page_deletion/index.html b/files/ja/mdn/tools/page_deletion/index.html deleted file mode 100644 index e6ebdd1910..0000000000 --- a/files/ja/mdn/tools/page_deletion/index.html +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ページの削除 -slug: MDN/Tools/Page_deletion -tags: - - Guide - - MDN - - MDN Project - - Page-level -translation_of: MDN/Tools/Page_deletion ---- -
{{MDNSidebar}}
- -

MDN からページを完全に削除することは滅多にありません。もっともよくある理由は、ページがスパムによって作成された、または間違って作成された場合です。かつては有用であったページが時代遅れの技術の記述となった場合には、削除するのではなく MDN の /Archive セクションに移動することでアーカイブされます。

- -

ページの削除の申請

- -

MDN の管理者だけがページを削除することができます。管理者以外のユーザーは、ページの削除をリクエストすることができます。

- -

ページを削除するには次のようにしてください。

- -
    -
  1. ページコンテンツの削除や変更はしないでください。ページ削除時にはその時点のコンテンツを記録しておきます。
    2. -
  2. ページに "Junk" タグを追加してください。他のタグは削除しないでください。
    3. -
  3. ページの削除に緊急を要する場合 (例えばコンテンツが不適切、攻撃的、あるいは技術的に危険なものである場合など) は、 MDN 管理者にお知らせください。
    4. -
- -

管理者は削除が適切かどうか判断した上で、随時ページを削除していきます。

- -

ページを削除するには

- -

ページを削除すると決めた管理者は、以下のようにしてください。

- -
    -
  1. 削除したいページの右上隅付近にある詳細メニューを開いてください。
    2. -
  2. このページを削除をクリックしてください。「ページの削除」画面が次のように現れます。
    -
    - 削除しようと選択したページのタイトルと、関連する一部のメタデータが表示されます。
    3. -
  3. 理由欄に "Spam" や "Junk" や "Created by mistake" など、適切な理由を入力してください。
    4. -
  4. 削除ボタンをクリックしてください。「文書が削除されました」画面が表示され、このページへのリンクがあれば表示されます。 (権限のないユーザーには、この文書を復元ボタンが表示されません。)
    5. -
- -

アクセス制限

- -

ページ削除ツールには文書の構造を破壊する可能性が存在するため、アクセスには上位の権限を必要とします。

- -

この権限を持つロール

- - - -

この権限を得るための条件

- -

このツールにアクセスする権限を得るための条件は以下のとおりです。

- - - -

この権限を取得する手続については、上位権限の申請を参照してください。

diff --git a/files/ja/mdn/tools/page_moving/index.html b/files/ja/mdn/tools/page_moving/index.html deleted file mode 100644 index 920c6f299c..0000000000 --- a/files/ja/mdn/tools/page_moving/index.html +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ページの移動 -slug: MDN/Tools/Page_moving -tags: - - Guide - - MDN Meta - - Page-level - - Tools -translation_of: MDN/Tools/Page_moving ---- -
{{MDNSidebar}}
- -

なぜページ (またはページのツリー) を移動するのでしょう。サイトの階層の適切な場所ではなく、サイトの最上位に作成してしまったのかもしれません。あるいは既存の文書を整頓しているのかもしれませんね。古い内容をアーカイブする必要があるのかもしれません。このような理由で MDN はページを移動する機能を持っており、1つのページを移動するだけではなく、その下位のページをまとめて移動することもできます。

- -

ページ移動ツールにより、編集者は MDN ツリー内の文書およびそのすべてのサブページの URL またはスラッグを変更することができます。ページを整頓したり、間違った位置にあるページを修正したりするときに、とても手軽で強力なツールです。

- -
-

メモ: 特別な権限を持つユーザーだけが MDN でページを移動することができます。この記事を移動という選択肢が詳細 メニューに表示されない場合、使用するのに権限が必要です。この権限を得る方法については、下にあるアクセス制限 を見てください。

-
- -

ページを移動するには

- -

ページまたはページのツリーを移動するには、以下のようにします。

- -
    -
  1. MDN で移動したいページの右上の角にある詳細 メニューを開いてください。
    -
    2. -
  2. この記事を移動 をクリックしてください。下のような「ページの移動」画面が表示されます。
    -
    - 一番上には、すべて (アルファベットが) 大文字で、移動しようとしているページのタイトルが表示され、続いてページを移動するためのフォームを正しく記入する方法についての注意書きの一覧が表示されます。ページタイトルは編集可能となっていますが、ここで変更しても反映されません。この問題の状態については、 {{bug(828533)}} を参照してください。
    3. -
  3. 新しい URL スラグの隣の枠に、ページの移動先としたいスラグを入力してください。この行の上にあるのは URL のプレビューで、ここに、新しい URL スラグの値を反映した、ページ移動後のフルパスの URL が表示されます。
    4. -
  4. この移動操作によって影響を受ける全てのサブページの一覧が表示されます。N ページを移動ボタンとキャンセルボタンの下にあります。サブページがなければ、その旨が表示されます。この一覧は、ページの移動が予測しなかった副作用を与えるのか判断するのに役立つかもしれません。閲覧の多いコンテンツの移動や、一度に大量のページを移動するのには注意を払ってください。
    5. -
  5. すべてが望み通り設定されていると分かったら、 N ページを移動するボタンをクリックします。非同期のバックグラウンドプロセスが始まり、各ページを移動してかつ元のページにリダイレクトを設置します。ですので、古い URL もリダイレクトによって動作し続けます。移動のプロセスが完了したらメールが届きます。そのメールには、ページの新しい場所にクリックして移動できるリンクが含まれています。
    6. -
- -

アクセス制限

- -

内容をおかしな場所に移動することで害となる明らかな可能性が存在するため、このツールは誰もが使えるようにはなっていません。

- -

この権限を持つロール

- - - -

この権限を得るための条件

- -

このツールにアクセスする権限を得るための条件は以下のとおりです。

- - - -

この権限を取得する手続については、上位権限の申請を参照してください。

diff --git a/files/ja/mdn/tools/page_regeneration/index.html b/files/ja/mdn/tools/page_regeneration/index.html deleted file mode 100644 index 590eda0260..0000000000 --- a/files/ja/mdn/tools/page_regeneration/index.html +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MDN 上のページのレンダリング -slug: MDN/Tools/Page_regeneration -tags: - - Guide - - MDN Meta - - Page-level - - Tools -translation_of: MDN/Tools/Page_regeneration ---- -
{{MDNSidebar}}
- -

MDN サイトは性能上の理由でページをキャッシュしています。 この結果、ページに対する保存済みの変更が、次回リロード時に反映されない場合があります。常にではないがしばしば、ページがの更新が処理中であることを示すバナーが表示されます。ブラウザーで強制リフレッシュしてサーバーからページをリロードできますが、サーバー上の更新が完了しないと効果がないことがあります。

- -

いくつかのページ (特に Landing ページ【訳注: 階層下のページの一覧を列挙するページ】) では、マクロを使って自動的に内容の生成と更新を行っています。Landing ページのためにこれを行うことで、作者が手動で更新しなくても、新しい記事が自動的にページに載ることが保証されます。これは長期間の貢献者には便利であり、新参者にはサイトの階層のどこにリンクすべきか分からずに成果を見失うことを避けるのに役立ちます。

- -

またあるページを別のページにトランスクルージョンする(例えば {{TemplateLink("Page")}} マクロを使って)のにも使います。

- -

MDN は性能上の理由でレンダリングしたコンテンツをキャッシュしているため、元の素材（たとえばマクロの出力や引用されるページ）に加わった変更は自動的にはページに反映されません。そのような元の素材に頻繁に変更が加わることがわかっているならば、ページの自動生成を有効にすることを検討したくなるかもしれません。

- -

自動生成を有効にするには: 【訳注: この機能は現在、英語版のページでのみ設定できます】

- -
    -
  1. EDIT ボタンをクリックし、編集モードに入ります。
    2. -
  2. ページタイトルの下にある  Edit page title and properties をクリックします。ページのメタデータフィールドが現れます。
    3. -
  3. Rendering max age に値を設定します。この値が、キャッシュされたページが(マクロの再実行も含めて)再生成されるスケジュールを決定します。普通は 4 または 8 Hours を指定します。 文書が頻繁に変更される技術に関しては、より少ない数値を指定しても良いでしょう。
    4. -
  4. 変更を保存します。リビジョンコメントに、設定内容を記録しておくのは良い習慣です。例: "Rendering max age を 4 Hours に設定"
    5. -
- -

ページは指定したスケジュールに従って再生成されます。

- -
-

注: "Edit page title and properties" オプションは、文書の作成時には現れませんので、一度保存してから開き直す必要があります。

-
diff --git a/files/ja/mdn/tools/page_watching/index.html b/files/ja/mdn/tools/page_watching/index.html deleted file mode 100644 index fe7b3a7f45..0000000000 --- a/files/ja/mdn/tools/page_watching/index.html +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ページやページ群を監視・購読する -slug: MDN/Tools/Page_watching -tags: - - Guide - - MDN Meta - - Page-level - - Tools -translation_of: MDN/Tools/Page_watching ---- -
{{MDNSidebar}}
- -

MDN ページを購読することで、そのページが更新・変更された時はいつでもメールで通知を受け取ることができます。すべての MDN ページの右上の隅に、監視ボタンがあります。購読のオプションにアクセスするには、監視ボタンの上にポインターを動かして監視メニューを開くいてください。

- -

MDN の監視メニューのスクリーンショット

- -

そのページだけを購読するか、サブページも一緒に購読するかをオプションで選択してください。

- -

ページを購読する

- -

ユーザーがそのページを編集するたびにメール通知を受け取るには、ページの上部にある詳細メニューの最初のオプション「この記事を購読」をクリックします。

- -

ページとすべてのサブページを購読する

- -

2つ目のオプション「この記事と全サブ記事を購読」をクリックすると、ユーザーがそのページとすべてのサブページを編集するたびにメール通知を受け取るようになります。これは購読を要求した後に追加されたサブページも含むため、将来多くのサブページが作られた場合、その通知も同様に受け取ります。

- -

ページの購読解除

- -

購読を解除してページの監視をやめる場合は、再び監視メニューを開いて「この記事の購読を中止」をクリックしてください。ページを購読していると「この記事の購読を中止」とだけ表示されています。ページが変更されるたびにメール通知を受けることはなくなります。

- -

ページ変更のメール

- -

ページを購読すると、ページが保存されるたびにメールを受け取ります。このメールは notifications@developer.mozilla.org から MDN アカウントに登録されたメールアドレスに送信されます。各メッセージにはこの形のタイトルがあります:

- -
[MDN] ページ "ページタイトル" が ユーザー名 によって変更されました
- -

メッセージはタイトル情報の繰り返しで始まり、つぎにコンテンツの標準差分を表示して、正確に何が変更されたかを示します。変更は HTML ソースコードで表示され、 MDN のコンテンツに慣れていない場合少し読みにくいかもしれません。

- -

差分の下には、変更に対応するのに役立つ、次のようなリンクの一覧があります:

- - - -

メールの最後には、"HTML element reference とその全サブ記事に対する編集の購読を開始しました" といった、どんな購読でメールが生成されたかの通知や、購読をやめるためのリンクがあります。購読をやめるリンクをクリックすると、その監視リクエストのメッセージを受け取らなくなります。

diff --git a/files/ja/mdn/tools/put_api/index.html b/files/ja/mdn/tools/put_api/index.html deleted file mode 100644 index 6e05522016..0000000000 --- a/files/ja/mdn/tools/put_api/index.html +++ /dev/null @@ -1,208 +0,0 @@ ---- -title: PUT API -slug: MDN/Tools/PUT_API -tags: - - Advanced - - Automation - - Documentation - - Draft - - Guide - - MDN Meta - - PUT API - - Page-level - - Tools -translation_of: MDN/Tools/PUT_API ---- -
{{MDNSidebar}}
- -
 {{draft}}
- -

MDN Wiki はページの全体、または一部の更新のための実験的な HTTP PUT API を提供しています。この機能は、次のような時に便利です:

- - - -

アプリケーションをテストする

- -

MDN を実行するソフトウェアを開発する中で、次のようにいろいろなステージ上のサイトインスタンスをホストしています:

- - - -

プロダクションサイトを無駄にしないようにするには、まずステージングに対してアプリケーションを開発する必要があります。それから、あなたが望むことを合理的に実行することができたら、それをプロダクションに反映するように再構成します。また、開発に取り組むこともできますが、問題が発生する可能性があります。

- -

API キーを作成する

- -

APIキーを使うと、毎回 Persona ログインするような介入を要求せずに、アプリケーションを代理人として動作させることができます。SSL 上の HTTP ベーシック認証を使ってユーザー名とパスワードを提供します。基本的な使用のトラッキングを集めて、どのように使われているかがわかるようにします。そして、たまたま持つべきでない人々に渡った場合は、アクセスを無効にするよう API キーを削除できます。

- -

If you have the correct privileges to do so, to create an API key, sign into MDN and visit the API keys management page. This page lets you create and delete API keys, as well as inspect recent usage history.  Only Mozillians in good standing can currently get API keys, since they grant abilities to automate changes to content rapidly, so unprivileged users must request the ability by filing a bug.

- -

{{NoteStart}}The above link goes to the Production site, and the same keys do not work between Production and Staging. You can also get to this page by visiting your profile on the respective site: Click on your username in the upper right of the site. On your profile page, you should see a "Manage API Keys" button.{{NoteEnd}}

- -

From there, clicking on the "Create a new API key" button should take you to an entry form so you can submit a request for an API key.

- -

After filling out and submitting the form, you will receive a key ID and secret. These are your username and password, respectively. Copy these down somewhere safe (eg. to your application's configuration settings); the site will never display them again, and there is no recovery method. If you lose them, simply delete the API key and create another.

- -

PUT リクエストを作成する

- -

Since the PUT API works by way of HTTP, it should be compatible with the application environment and libraries of your choice. This first example uses the command-line tool cURL and a UNIX shell to demonstrate how to issue a simple PUT request to MDN.

- -

リクエスト

- -
# Base URL and API key from staging (example only; substitute your own)
-MDN_BASE_URL="https://developer.allizom.org"
-MDN_KEY_ID="frsNFFR3w0yEALRE9IA9oN1KwoDno8vVGrzsBNvCofI"
-MDN_SECRET="423PdCvnvraH0FkCDTKnizTmKGNkEdgQTi6RlEFTiWs"
-
-# Document-specific details
-DOC_USERNAME="lmorchard"  # Change this to your name
-DOC_PATH=/ja//docs/User:$DOC_USERNAME/PutExample"
-DOC_TYPE="text/html"
-DOC_DATA="<b>HELLO WORLD</b>"
-
-# Putting it all together...
-curl -si -X PUT -H"Content-Type: $DOC_TYPE" -d"$DOC_DATA" -u"$MDN_KEY_ID:$MDN_SECRET" "$MDN_BASE_URL$DOC_PATH"
- -

Since there's a lot going on in this cURL invocation, the example is broken into variables:

- - - -

So, along with the variables, here are some general notes on the example and its use of the PUT API:

- - - -

レスポンス

- -

There are several responses you may see if you try this example: 403, 404, 201, or 205. (You may see others, but those suggest something has gone wrong with the site. That will, hopefully, be rare.)

- -

403 Forbidden

- -

If either the key ID or secret are incorrect, you'll see a 403 Forbidden response. Double check your key details and that you're using the right pair for the right server. Create a new API key, if necessary.

- -

404 Not Found

- -

If you've never created a document at the URL path /en-US/docs/User:$MDN_USERNAME, you'll see a 404 Not Found response.

- -

{{NoteStart}}The PUT API will not automatically create parent documents. If you're creating a number of documents intended to comprise a subsection of MDN, make sure to create parent documents first from the top down in the hierarchy.{{NoteEnd}}

- -

201 Created

- -

If the parent document exists, but the path itself doesn't, you should see a 201 Created response. This signifies that a new document was created, as opposed to an existing one having been updated.

- -

205 Reset Content

- -

In the case of an updated document, you'll see a 205 Reset Content response. This means that the document content has been updated, and that you should reload the document if you happen to need to see the results.

- -

{{NoteStart}}MDN performs certain filtering and processing steps on content, so what you put in may not be exactly what gets served back.{{NoteEnd}}

- -

サポートされるコンテンツのタイプ

- -

The PUT API accepts one of several content types in the request body.

- -

text/html

- -

There are actually two forms of text/html accepted: fragment and document.

- -

Fragment

- -

An HTML fragment is just an arbitrary chunk of markup, and is used as-is to revise document content. This is the simplest way to update documents.

- -

Document

- -

However, if the request body consists of an <html> element containing <head> and <body> elements, it's treated as a full HTML document. In this case, the following processing happens:

- - - -

This is a more complex way to update documents, but is intended as a convenience to accomodate submission of existing HTML pages.

- -

application/json

- -

Although the text/html content type is handy, there are more fields belonging to documents that are useful to manage. These include the following:

- - - -

These fields can be supplied as string values in a JSON-encoded object with the application/json content-type in a PUT request.

- -
# Auth Stuff
-DOC_USERNAME="lmorchard"  # Change this to your name
-MDN_KEY_ID="frsNFFR3w0yEALRE9IA9oN1KwoDno8vVGrzsBNvCofI"
-MDN_SECRET="423PdCvnvraH0FkCDTKnizTmKGNkEdgQTi6RlEFTiWs"
-
-# Base Settings (for Staging Env)
-MDN_BASE_URL="https://developer.allizom.org"
-DOC_PATH=/ja//docs/User:$DOC_USERNAME/PutExample"
-DOC_TYPE="application/json"
-
-# Doc Content
-echo '{"content": "<b>Hello World</b>", "title": "New Sample Title", "show_toc": 1, "tags": "Beginner, Tutorial", "review_tags": "editorial, technical", "summary": "Sample JSON update from the API"}' > /tmp/mdn.json
-
-# Submitting Content
-curl -X PUT -H "Content-Type: $DOC_TYPE" -d @/tmp/mdn.json -u"$MDN_KEY_ID:$MDN_SECRET" "$MDN_BASE_URL$DOC_PATH"
-
- -

multipart/form-data

- -

This content type is handled basically like application/json - the same fields are accepted. But, it might be less useful than JSON and is supported mainly for testing purposes.

- -

1 つのセクションを更新する

- -

Normally, an HTTP PUT request replaces the entirety of a document with the submitted content in a new revision. However, you can use the query parameter ?section to constrain revision to a single section of the document and leave the rest of the content as-is. This is handy for automating changes to one part of a document that is otherwise managed by hand, or even for aggregating changes from many sources or scripts into one document.

- -

文書のセクションを作成する

- -

Documents on MDN can be broken up into sections. These sections are useful for building a table of contents, linking to specific parts, and editing subsets of document content.

- -

Using headers

- -

Headers (ie. <h2> .. <h6>) make sections in MDN documents. The text of each header is transformed automatically into an ID, and that's used for anchor links in the table of contents sidebar on most documents. Those auto-generated IDs can be overriden with the name attribute on headers. Either way, looking at the table of contents is the easiest way to see how a document is broken up into sections, and to discover the IDs for those sections.

- -

The contents of a section include its header and everything following the header up to (but not including) another header of the same or higher level. So, a section that starts with an <h2> continues until the next <h2>, including any subsections started by <h3> .. <h6>. That also means sections can be nested: An <h3> appearing after an <h2> creates a subsection, including any further nested subsections started by <h4> .. <h6>, up to the next <h3> or <h2>.

- -

@@TODO: Show an HTML example with headers, here. This is a bit confusing.

- -

Using container elements

- -

Setting an id attribute on a container element (eg. a <div> or <span> or <section>) in the source editor also creates a section, at least with respect to the PUT API. This is a bit more advanced and requires manual changes to raw HTML, rather than using the WYSIWYG editor. But, if you want to update a chunk of the page without the need for headers, this is how to do it.

- -

セクションを指定する

- - diff --git a/files/ja/mdn/tools/revision_dashboard/index.html b/files/ja/mdn/tools/revision_dashboard/index.html deleted file mode 100644 index 10c96bfa07..0000000000 --- a/files/ja/mdn/tools/revision_dashboard/index.html +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: リビジョンダッシュボード -slug: MDN/Tools/Revision_dashboard -tags: - - Guide - - MDN Meta - - Site-wide - - Tools -translation_of: MDN/Tools/Revision_dashboard ---- -
{{MDNSidebar}}
- -

リビジョンダッシュボード は MDN Web Docs Wiki の機能で MDN での最近の更新と追加を見たり、何が変更されたのか詳細を確認したり、それらの更新に対して様々な方法で行動することができます。 この記事では、リビジョンダッシュボードの使い方を説明します。

- -

外観

- -

リビジョンダッシュボードのインターフェイスは多くの要素を持ち、便利な機能が満載です。まずはインターフェイスの主要な部分の概観から始めましょう。

- -

Annotated screenshot of main revision dashboard view

- -

ここで注意すべき最も大事なことは履歴のリストで、ここでフィルターにマッチする履歴や、履歴の差分 (クリックした履歴で変更された内容が見られます) を一通り見ることができます。

- -

リビジョン一覧

- -

リビジョンダッシュボードウィンドウの中ほどにあるリビジョン一覧は、最近なされた変更を提供します。この一覧は、最近変更された記事が最初に来るように順序付けられていて、先に進むともっと古い履歴になります。

- -

リビジョン一覧のすぐ下にあるのは、検索クエリーにマッチしたページがどれくらいあり、そのうちのどこを見ているのかを示すインジゲーターです。何もフィルターをかけていない場合、MDN wiki になされたすべての履歴のページ数が見えます。

- -

一覧の各行は wiki への 1 つの変更に対応しています。"変更" とは次のいずれかからなっています:

- - - -

各行は 4 つの列からなります: リビジョン、タイトル、コメント、著者です。

- -

リビジョン列

- -

リビジョン列はなされた変更の情報が与えられます。この列ではいくつかの情報が提供されます:

- -
-
タイムスタンプ
-
リビジョンが保存された正確な日付と時間。これはリビジョン詳細ページへのリンクで、そこではリビジョンのメタデータとコンテンツが表示されます。
-
ロケール
-
記事のロケールが列のタグとして示されます。これは言語の省略コードで表示され、例えば英語では "en-US" です。
-
ファイル変更インジゲーター
-
これまで存在しない新しい記事には new のタグが表示されます。ページが削除されたことを示す場合は、deleted タグが出てきます。ページが 1 回の改訂だけで削除された場合、new と deleted タグの両方が表示されることもありえます。
-
-

タイトル列

-
-
- -
-
記事のタイトル
-
記事のタイトルは、ページにセットされているため、列に表示されます。タイトルは、直接移動して素早く簡単に見られるような、wiki 記事へのリンクでもあります。
-
記事のパス
-
記事のタイトルの下に、記事のパスが表示されます。これは記事の URL の一部分で、http://developer.mozilla.org/<locale>/docs/ の後に来るものです。
-
-

コメント列

-
-
- -
-
リビジョンコメント
-
変更の著者がリビジョンコメントを変更の保存時に追加していた場合、そこにあります。これは小さめのイタリックなテキストで表示されます。
-
移動の情報
-
リビジョンがページの移動を表す場合、wiki 上の移動元と行き先のパスが表示されます。
-
-

著者列

-
-
- -

著者の列はそのリビジョンを保存した人のユーザー名が表示されます。それをクリックしてユーザーのプロフィールページをすぐに見ることができます。

- -
-

管理者のみ: 管理者権限を持つ MDN ユーザーは著者列の見出しに Toggle IPs ボタンもあります。これをクリックするとそれぞれの著者の IP アドレスが表示され、不正なユーザーを IP アドレスによって禁止することができます。ユーザーが禁止されたら、ユーザー名の下に印が出ますが、これは管理者のみに見えます。

-
- -

フィルター

- -

MDN はいくつかの便利なフィルターオプションを提供しており、あなたのニーズに応じてリビジョンの「物」の量を削減できます。フィルターを調整して、絞り込み ボタンを押して適用します。しばらくすると、ディスプレイはフィルター結果を更新します。いくつかのフィルターを利用できます:

- -
-
ロケール
-
You may filter so that you only see changes in a specific locale. 既定では, you see changes across all locales, but this may not be useful to you. Indeed, if you're a member of a localization team, 例えば、the only locales you're likely to care about are your own and English. You can specify the locale to filter by in the URL when going to the revision dashboard by adding "locale=<localename>" to the query string. 例えば、: https://developer.mozilla.org/ja/dashboards/revisions?locale=en-US filters to show only changes to English documents.
-
ユーザー
-
Interested in what a specific user has been up to? You can look at the revisions submitted by a single user by entering it in this field. You can specify a user in the URL when going to the revision dashboard by adding "user=<username>" to the query string. 例えば、you can see changes by the user Sheppy with https://developer.mozilla.org/ja/dashboards/revisions?user=Sheppy. This box will offer suggestions as you type, to help you find exactly the person you're looking for.
-
トピック
-
If you'd like to see changes only about a given topic area, you can specify a topic string. This will be matched against the URLs of articles that have been changed and show only those whose titles include this string. You can specify the parameter "topic=<topic>" in the URL's query string to filter on this, as well. 例えば、if you'd like to see only JavaScript-related changes: https://developer.mozilla.org/ja/dashboards/revisions?topic=JavaScript.
-
開始日と終了日
-
You can specify that you want to see only revisions in a certain range of dates, or with a certain starting or ending date. The dashboard UI provides date selection widgets for these fields. You can specify these parameters in the URL's query string, but you must use your system locale's version of the date string. 例えば、: https://developer.mozilla.org/ja/dashboards/revisions?start_date=09%2F01%2F2015 for revisions starting with September 2, 2015 in the en-US locale.
-
先行期間
-
Rather than typing or selecting start or end dates, you can specify that you want to see revisions from a selected period prior to the present time, such as the last hour, day, week, or 30 days.
-
- -

フィルターを組み合わせて使うのにも注目すぺきで、ユーザーインターフェイスや URL のクエリーストリングの両方でそれは言えます。かなり複雑な検索も実効できます。例えば、ユーザー{{UserLink("evilpie")}} が書いた英語の JavaScript 記事を見つけるには、このようにします https://developer.mozilla.org/ja/dashboards/revisions?locale=en-US&user=evilpie&topic=JavaScript.

- - - -

更新の差分

- -

ページのあるリビジョンと前のリビジョンの違いを表示する「差分」を見ることができます。あるリビジョンの差分を見るには、リンクではない行のいずれかをクリックします (つまり、タイムスタンプ、記事のタイトル、著者のユーザー名以外)。この行はリビジョンの差分とリビジョンコントロールを説明します。

- -

Annotated screenshot of revision dashboard view

- -

リビジョンコントロールは次の記事操作を許可します:

- - diff --git a/files/ja/mdn/tools/template_editing/index.html b/files/ja/mdn/tools/template_editing/index.html deleted file mode 100644 index d32794f82e..0000000000 --- a/files/ja/mdn/tools/template_editing/index.html +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: テンプレートの編集 -slug: MDN/Tools/Template_editing -tags: - - Page-level -translation_of: MDN/Tools/Template_editing ---- -
{{MDNSidebar}}

MDNでは、 KumaScript で書かれたテンプレートがコンテンツの自動生成、およびページのカスタマイズに使われています。 それぞれのテンプレートは、別々の Wiki ページに置かれていて、ページ名は以下のとおりです:
- /en-US/docs/Template:テンプレートの名前

- -

MDN の Wikiを編集している人なら誰でも、マクロを通じてテンプレートを呼び出すことができます。KumaScript は強力なので、テンプレートの作成と編集のための権限は、必要な経験を持ち合わせた信頼できるユーザーのみに与えられています。

- -

この権限を持つ役割の人

- - - -

この権限を得るための条件

- -

このツールにアクセスする権限を得るための条件は以下のとおりです:

- - - -

この権限を得るためのプロセスについては、上位権限のリクエスト を見てください。

- -

テンプレート編集の権限を持っている人（peer）たち

- - diff --git a/files/ja/mdn/tools/unsupported_get_api/index.html b/files/ja/mdn/tools/unsupported_get_api/index.html new file mode 100644 index 0000000000..6198f8ea7b --- /dev/null +++ b/files/ja/mdn/tools/unsupported_get_api/index.html @@ -0,0 +1,95 @@ +--- +title: URL 引数と文書メタデータ +slug: MDN/Tools/Document_parameters +tags: + - Documentation + - Kuma + - MDN Meta + - Page-level + - Reference + - Tools +translation_of: MDN/Tools/Document_parameters +--- +
{{MDNSidebar}}
+ +
+

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

+
+ +
+

URL の GET 引数

+ +

すべての Kuma wiki 文書の URL が HTTP GET で取得されたりブラウザーで見られる時に役立つクエリ引数オプションをサポートしています。

+ +

複数のクエリ引数は最初の ? の代わりに & で区切られます (マクロの例を見てください)。

+ +
+
summary
+
+

Kuma にページの概要のみを返すよう指示します。 "SEO summary" クラスでマークされたコンテンツがある場合、そのコンテンツが返されます。そのようなコンテンツがない場合、 "Summary" というタイトルのあるコンテンツが返されます。そうならない場合、最初のブロックのコンテンツが返されます。

+ +
バグのお知らせ: 現在、 summary 引数は raw 引数も指定しないと文書全体を返すというバグがあります。なお、 $json 代替ビューを使用して返される JSON から概要を取得することもできます。
+
+
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 に指定したアンカー名を持つセクションのみのコンテンツを返すように指示します。
+
例: + + +
バグのお知らせ: 現在、 section 引数は raw 引数も使用しないと文書全体を返すというバグがあります。
+
+
expand
+
+

$children ビューと連結して、サブページごとの詳細情報つきの JSON レスポンスを展開します。これは各サブページごとの $children と $json の連結のように動作します。この方法は、サブページのタグについて学べます。

+ +

例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children?expand

+
+
+
+ +
+

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

+ +

文書の URL のレスポンスを微調整するための引数と一緒に、 URL 接尾辞で指定される文書の代替ビューもいくつかあります。

+ +
+
$toc
+
Kuma に HTML のページの目次のみを返すよう命じます。順序付きリスト (つまり {{HTMLElement("ol")}}) として返されます。
+
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$toc
+
$json
+
Kuma に JSON オブジェクトでページを記述するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 wiki.getPage() を使用して得られるものと同じです。
+
例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$json
+
$children
+
Kuma にページのトピックの子を JSON で列挙するよう命じます。このオブジェクトは基本的に、 KumaScript の処理 pages.subpages() を使用して得られるものと同じです。
+
例: https://developer.mozilla.org/ja/docs/Web/Guide/HTML/HTML5$children
+
(これは ?expand 引数と共に使用して、もっと詳細のレスポンスを得ることもできます。)
+
$compare
+
必須のクエリ引数 ?from および ?toで指定されたリビジョン間のソーステキスト行の違いを表示します。
+
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$compare?to=911697&from=911067
+
$edit
+
指定された文書の現在のリビジョンを、表示する代わりに編集します。
+
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$edit
+
$history
+
指定された文書の内容を表示する代わりに、最新の10リビジョンのリビジョン履歴を表示します。履歴全体は、クエリ引数の値に ?limit=all を付けることで要求できます。
+
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$history?limit=all
+
$revision
+
文書の "/" の後に指定された番号のリビジョンを表示します。
+
例: https://developer.mozilla.org/ja/docs/MDN/Contribute/Tools/Document_parameters$revision/915141
+
+
-- cgit v1.2.3-54-g00ecf