API プロパティサブページのテンプレート
メモ: この説明文全体を削除してから公開してください。
訳注: このテンプレートは翻訳記事用です。新たな記事を執筆する場合は、英語版を参照してください。日本語の単独記事を立項することはできません。）
ページのフロントマター:
ページ上部のフロントマターは「ページのメタデータ」を定義するために使用します。 値は、個々のプロパティに応じて適切に書き換える必要があります。
---
title: "NameOfTheParentInterface: NameOfTheProperty プロパティ"
short-title: NameOfTheProperty
slug: Web/API/NameOfTheParentInterface/NameOfTheProperty
l10n:
sourceCommit: 翻訳元コミットID
---
- title
-
タイトルの見出しで、ページの最上部に表示されます。 書式は
NameOfTheParentInterface: NameOfTheProperty プロパティです。 例えば、 VRDisplay インターフェイスの capabilities プロパティのtitleはVRDisplay: capabilities プロパティとしてください。 - short-title
-
このプロパティの名前です（サイドバーで使用されます）。
- slug
-
https://developer.mozilla.org/ja/docs/の後にくる URL の末尾です。 これはWeb/API/NameOfTheParentInterface/NameOfThePropertyのような形式になります。静的プロパティの場合、スラッグには
_staticの接尾辞を付けて、Web/API/インターフェイス名/プロパティ名_staticのようにしてください。これによって、インスタンスプロパティと静的プロパティが同じ名前の場合に対応することができます。 - sourceCommit
-
（翻訳記事のみ）この記事の翻訳元となる英語版記事を GitHub にコミットした際のコミット ID を記述します。 GitHub 上で英語版記事のコミット ID を確認してください。
ページ先頭のマクロ
コンテンツ部の上部（ページのフロントマターのすぐ下）には、いくつかのマクロ呼び出しが現れます。
訳注: 英語版では以下のマクロは自動的に更新されますが、翻訳記事では更新されませんので、翻訳時に手動で英語版のマクロに合わせてください。
{{SeeCompatTable}}— これは これは実験的な機能です。 のバナーを生成し、この技術が実験的であることを示します。 実験的なもので、その技術が Firefox の設定で隠されている場合は、 Firefox での実験的な機能 ページにもそのためのエントリーを記入する必要があります。{{Deprecated_Header}}— これは 非推奨 バナーを生成し、この技術の使用を避けるべきであることを示します。{{Non-standard_Header}}— これは 標準外 バナーを生成し、この機能がどの仕様書にもないことを示します。
下記のアドバイスに従って、以下のマクロを更新または削除してください。
{{SecureContext_Header}}— これは 保護されたコンテキスト バナーを生成し、この技術が保護されたコンテキストでのみ利用できることを示します。 そうではない場合は、マクロ呼び出すを削除することができます。 そうである場合は、保護されたコンテキストに制限されている機能ページ内の項目も記入してください。{{AvailableInWorkers}}— これにより、ウェブワーカーで利用可能というメモが生成され、その技術が ウェブワーカーのコンテキスト で利用可能であることを示します。 ウィンドウコンテキストでのみ利用できる場合は、そのマクロの呼び出しを除去できます。 もしそれがワーカーコンテキストでも利用できる、あるいはワーカーコンテキストでのみ利用できる場合、その利用状況に応じて引数を渡す必要があることがあります（利用できるすべての値については、{{AvailableInWorkers}} マクロのソースコードをご参照ください）。また、ウェブワーカーで利用可能な Web API ページに、その項目を追加する必要があることがあります。{{APIRef("GroupDataName")}}— これをクリックすると、現在のページに関連するすばやく参照できるリンクを表示する左側のリファレンスサイドバーが生成されます。 例えば、 WebVR API の中の各ページは同じサイドバーを持ち、そこでこの API の別なページにアクセスできます。 API に適したサイドバーを生成するには、GitHub リポジトリーにGroupDataエントリーを追加し、マクロ呼び出しの中で GroupDataName の代わりにそのエントリーの名前を記載する必要があります。 この方法については、 API リファレンスのサイドバーガイドを参照してください。
訳注: 英語版では状態ヘッダーマクロは自動的に更新されますが、翻訳記事では更新されません。翻訳時に英語版に合わせて手動で更新してください。
保護されたコンテキスト、ワーカーで利用可能、実験的、非推奨、標準外 の各バナーは、このメモブロックの直後に表示しています。
公開する前に、この説明文全体を削除することを忘れないでください。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能はウェブワーカー内で利用可能です。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
非推奨;: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。
非標準: この機能は標準化されていません。非標準の機能はブラウザーの対応が限られ、将来的に変更または削除される可能性があるため、本番環境での使用は推奨されません。ただし、標準の選択肢が存在しない特定のケースでは、有効な代替手段となる場合があります。
NameOfTheProperty は {{domxref("NameOfTheParentInterface")}} インターフェイスの[読み取り専用]プロパティで、 <その動作の簡潔な概要を提供します>。
まず、プロパティの名前（読み取り専用かどうかを示す）と、そのプロパティが属するインターフェイスを指定し、その後にそのプロパティの役割を示します。
これはできれば 1、2 の短い文にすべきです。 数段落以上の説明が必要な場合は、「例」の節の前に「解説」の節を追加して、そこに記載してください。
値
{{domxref("SomeDataType" )}} です。
通常はデータ型のみを記載し、必要に応じてそのデータ型の取り得る値も記載します。 プロパティのセッターとゲッターの動作が異なる場合は、通常、それぞれ別個の文で網羅します。
場合によっては、データ型が何を表しているかについて、さらに詳しく説明したいことがあるでしょう。 これは問題ありませんが、「解説」の節に書かれている情報と重複しないようにしてください（値の意味については、そちらに記載すべきです）。
一部のプロパティページでは、「...を表す [プロパティ型の名前] を返す」という形式で記述されていますが、これは推奨される形式ではありません。 また、特定の意味を持つ一部の WebIDL 拡張属性は、その型に関連付けられます。これらを文書化する標準的な方法があります。詳細については、WebIDL ファイルに含まれる情報を参照してください。
例
ページ内に例が 1 つしかない場合でも、複数形の "Examples" を使用することに留意してください。
説明的な見出し
それぞれの例には、その例を説明する H3 見出し (###) がなければなりません。見出しは例が何を行っているかを説明するものであるべきです。例えば、「単純な例」というのは例について何も説明していないので、良い見出しとは言えません。見出しは簡潔であるべきです。より詳しい説明をする場合は、見出しの後の段落を使用してください。
詳しくは、サンプルコードを追加する方法のガイドをご覧ください。
メモ: 他のページで紹介されている例にリンクしたい場合もあるでしょう。
シナリオ 1: このページにいくつかの例があり、別のページにさらにいくつかの例がある場合。
このページのそれぞれの例に H3 見出し (###) を記載し、最後に H3 見出し (###) に「その他の例」というテキストを入れ、その下に他のページの例へのリンクを貼ることができます。例えば次のようにします。
## 例
### Fetch API の使用
Fetch の例
### その他の例
他のページにある他の例へのリンク
シナリオ 2: このページには何も例がなく、他のページにだけある場合。
H3 の見出しは追加せず、 H2 の見出し「例」の下に直接リンクを追加してください。例えば次のようにします。
## 例
この API の例については、[fetch() のページ](https://example.org/)を参照してください。
仕様書
{{Specifications}}
このマクロを使用するには、 Markdown ファイルの逆引用符とバックスラッシュを除去してください。
ブラウザーの互換性
{{Compat}}
このマクロを使用するには、 Markdown ファイルの逆引用符とバックスラッシュを除去してください。
関連情報
現在の API に関連するリファレンスページやガイドへのリンクを記述してください。その他のガイドラインについては、スタイル設定ガイドの「関連情報」の節を参照してください。
- リンク1
- リンク2
- 外部リンク (年)