API リファレンスページのテンプレート

ページの先頭部分

MDN Web Docs のページにおけるページの先頭部分は、以下の一覧と記述した YAML ヘッダーで構成されます。ページの先頭にあるこの YAML コンテンツは、「ページフロントマター」または「ページメタデータ」を定義するために使用されます。特定のインターフェイスを記述する際には、その値を適切に更新する必要があります。

Note: この説明文全体を削除してから公開してください

---
title: インターフェイス名
slug: Web/API/インターフェイス名
page-type: web-api-interface
tags:
  - API
  - インターフェイス名
  - API 名
  - Reference
  - Experimental

browser-compat: path.to.feature.NameOfTheInterface
---
title

タイトルの見出しは、ページの最上部に表示されます。これはインターフェイスの名前だけです。例えば、 Request インターフェイスのページには Request というタイトルを付けます。

slug

https://developer.mozilla.org/ja/docs/ の後にくる URL の末尾です。これは Web/API/インターフェイス名 のような形式になります。例えば、 Request のスラッグは "Web/API/Request" になります。

page-type

page-type キーは、 Web/API のインターフェイスでは常に web-api-interface です。

tags

API, Reference, Interface, API 名 (WebVR など), インターフェイス名 (IDBIndex など)、 Experimental (この技術が実験的)である場合、Secure context (安全なコンテキストでのみ利用可能な場合)、Deprecated非推奨である場合) のタグを含めてください。 任意で、その技術に関する情報を探すときに検索される可能性のある用語を表す他のタグを記載することができます。例えば、 WebVR インターフェイスのページでは、 VRVirtual reality を含めています。

browser-compat

プレースホルダーの値 path.to.feature.NameOfTheMethodブラウザー互換性データリポジトリー にあるこのメソッドのクエリー文字列に置き換えてください。 ツールチェインが自動的に互換性セクションと仕様書セクションのためにキーを使用します({{Compat}}{{Specifications}} マクロを置き換えます)。

なお、先にブラウザー互換性データリポジトリーに API メソッドのエントリーを作成/更新する必要があり、このエントリーに仕様書を入れておくことが必要です。 これを行うためのガイドを参照してください。

ページ先頭のマクロ

既定では、テンプレートの先頭に 5 つのマクロ呼び出しがあります。以下のアドバイスに従って、これらを更新または削除する必要があります。

Note: この説明文全体を削除してから公開してください

  • {{APIRef("GroupDataName")}} — これは、左側に現在のページに関連するリンクをすばやく参照できるように表示する、リファレンスサイドバーを生成します。 例えば、 WebVR API のすべてのページには同じサイドバーがあり、これは API の他のページを指しています。API に適したサイドバーを生成するには、弊社の KumaScript GitHub リポジトリーに GroupData の項目を追加し、GroupDataName の代わりにマクロ呼び出し内にその項目の名前を記載する必要があります。この方法については、 API リファレンスのサイドバー ガイドを参照してください。
  • {{SeeCompatTable}} — これは これは実験的な機能です。 のバナーを生成し、この技術が実験的であることを示します。もし、あなたが文書化している技術が実験的なものでないなら、これを削除すべきです。実験的なもので、その技術が Firefox の設定で隠されている場合は、 Firefox での実験的な機能 ページにもそのためのエントリーを記入する必要があります。
  • {{SecureContext_Header}} — これは 安全なコンテキスト バナーを生成し、この技術が安全なコンテキストでのみ利用できることを示します。もしそうでないなら、マクロの呼び出しを削除してください。そうである場合は、安全なコンテキストに制限されている機能ページ内の項目も記入してください。
  • {{Deprecated_Header}} — これは 非推奨 バナーを生成し、この技術の使用を避けるべきであることを示します。そうではない場合は、マクロ呼び出しを削除してください。
  • {{Interface_Overview("GroupDataName")}} Experimental — このページ本文(コンストラクタ、プロパティ、メソッド、イベント)を生成します。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

非推奨: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。

概要の段落 - まず、インターフェイスの名前、それがどのインターフェイスに属しているか、そしてそれが何をするものなのかを述べます。これはできれば 1、2 の短い文にすべきです。対応する API ランディングページのインターフェイスの概要から、この大部分をコピーすることができます。

コンストラクター

NameOfTheInterface()

NameOfTheInterface オブジェクトのインスタンスを生成します。

プロパティ

親インターフェイスである NameOfParentInterface から継承しているプロパティもあります。 (注: このインターフェイスが他のインターフェイスを継承していない場合は、この行全体を削除してください)。

NameOfTheInterface.property1 読取専用 Deprecated

ここには、プロパティの簡単な説明と、それが何をするものかを記載してください。各プロパティについて、1つの用語と定義を記載します。プロパティが読み取り専用/実験的/非推奨でない場合、関連するマクロの呼び出しを削除してください。

NameOfTheInterface.property2

etc.

メソッド

親インターフェイスである NameOfParentInterface から継承しているメソッドもあります。 (注: このインターフェイスが他のインターフェイスを継承していない場合は、この行全体を削除してください)。

NameOfTheInterface.method1() Experimental Deprecated

ここにメソッドの簡単な説明と何をするものかを記載してください。各メソッドについて、1つの用語と定義を記載してください。メソッドが実験的/非推奨でない場合、関連するマクロの呼び出しを削除してください。

NameOfTheInterface.method2()

etc.

イベント

これらのイベントは addEventListener() を使用するか、このインターフェイスの oneventname プロパティにイベントリスナーを割り当てることで待ち受けることができます。

eventname1

~時に発生します(イベントがいつ発行されるかの説明を記載する)。 oneventname1 プロパティからも利用できます。

eventname2

~時に発生します (イベントがいつ発行されるかの説明を記載する). oneventname1 プロパティからも利用できます。

etc.

~時に発生します…

説明的な見出し

それぞれの例には、その例を説明する H3 見出し (###) がなければなりません。見出しは例が何を行っているかを説明するものであるべきです。例えば、「単純な例」というのは例について何も説明していないので、良い見出しとは言えません。見出しは簡潔であるべきです。より詳しい説明をする場合は、見出しの後の段落を使用してください。

詳しくは、コード例を追加する方法のガイドをご覧ください。

Note: 他のページで紹介されている例にリンクしたい場合もあるでしょう。

シナリオ 1: このページにいくつかの例があり、別のページにさらにいくつかの例がある場合。

このページのそれぞれの例に H3 見出し (###) を記載し、最後に H3 見出し (###) に「その他の例」というテキストを入れ、その下に他のページの例へのリンクを貼ることができます。例えば次のようにします。

##

### Fetch API の使用
Fetch の例

### その他の例
他のページにある他の例へのリンク

シナリオ 2: このページには何も例がなく、他のページにだけある場合。

H3 の見出しは追加せず、 H2 の見出し「例」の下に直接リンクを追加してください。例えば次のようにします。

 ##

 この API の例については、[Fetch() ページ](https://example.org)を参照してください。

仕様書

No specification found

No specification data found for path.to.feature.インターフェイス名.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

ブラウザーの互換性

No compatibility data found for path.to.feature.インターフェイス名.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

関連情報

  • この API に関連する
  • 有用と思われるリンクの
  • リストを記載してください