API メソッドサブページのテンプレート

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


ページの先頭部分:

ページ上部の先頭部分は、「ページのメタデータ」を定義するために使用します。 値は、個々のメソッドに応じて適切に書き換える必要があります。

---
title: インターフェイス名.メソッド名()
slug: Web/API/インターフェイス名/メソッド名
page-type: web-api-instance-method または web-api-static-method
tags:
  - メソッド名
  - API
  - Method
  - Reference
  - Experimental
  - Deprecated
  - Non-standard
browser-compat: path.to.feature.NameOfTheMethod
---
title

タイトルの見出しは、ページの最上部に表示されます。 書式は インターフェイス名.メソッド名() です。 例えば、 IDBIndex (en-US) インターフェイスの count() (en-US) メソッドには IDBIndex.count() というタイトルを付けます。

slug

https://developer.mozilla.org/ja/docs/ の後にくる URL の末尾です。 これは Web/API/インターフェイス名/メソッド名 のような形式になります。 なお、スラッグでのメソッド名は括弧を省略してください(末尾は NameOfTheMethod であり NameOfTheMethod() ではありません)。

page-type

page-type キーは、 Web/API メソッドでは web-api-instance-method (インスタンスメソッドの場合)または web-api-static-method (静的メソッドの場合)です。

tags

常に API, Reference, Method, API 名 (WebVR など), インターフェイス名 (IDBIndex など), メソッド名 (count() など) のタグを含めてください。

必要に応じて以下のタグを入れてください。

  • 技術状態: Experimental (この技術が実験的である場合)、 Deprecated非推奨である場合)、 Non-standard (標準化過程にない場合)
  • 特別な要件: Secure context (安全なコンテキストでのみ利用可能な場合)
  • その他、技術に関連して検索されそうな言葉を表すタグ。 例えば、 WebVR インターフェイスのページでは、 VRVirtual reality を入れています。
browser-compat

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

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


ページ先頭のマクロ

コンテンツセクションの上部(ページの先頭部分のすぐ下)には、いくつかのマクロ呼び出しが現れます。 以下のアドバイスに従って、更新または削除してください。

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

公開する前に、この説明文全体を削除することを忘れないでください

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

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

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

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

構文

構文の節の案内に従って、構文ボックスを埋めてください。

引数

parameter1 省略可

ここでは、引数の簡単な説明とその役割を記載してください。各引数につき 1 つの用語と定義を記載してください。引数が省略可能でない場合は、 {{optional_inline}} マクロ呼び出しを削除してください。

parameter2

同様です。

Note: この章は必須です。引数がない場合は、定義リストの代わりに「なし。」と記述してください。

返値

メソッドの返値について、データ型や何を表すかなどの説明を記載します。

メソッドが何も返さない場合は、「なし (undefined)」と記述してください。

例外

Exception1

そのメソッドが発生させる可能性があるすべての例外のリストを、その例外がどのように発生するかの説明と一緒に記載してください。それぞれの例外について、 1 つずつ用語と定義を記載してください。

Exception2

etc.

例外には 2 種類あることに注意してください。それは DOMException オブジェクトと TypeErrorRangeError などの通常の JavaScript 例外です。ウェブ開発者は次のことを知る必要があります。

  • どのオブジェクトが投げられるか
  • DOMException オブジェクトの例外の場合、その例外の name

ここでは、あるメソッドが IndexSizeError という名前の DOMException と、 InvalidNodeTypeError という名前の 2 つ目の DOMException 、そして TypeError という型の JavaScript 例外を発生させることができる例を示します。

IndexSizeError DOMException

Thrown …

InvalidNodeTypeError DOMException

Thrown …

TypeError

Thrown …

説明的な見出し

それぞれの例には、その例を説明する 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.NameOfTheMethod.
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.NameOfTheMethod.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

関連情報

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