API property subpage template



API プロパティサブページのタイトルは、インターフェイス名 + "." + プロパティ名としてください。例えば、 VRDisplay インターフェイスの capabilities プロパティのタイトルVRDisplay.capabilities です。

スラッグ (URL の最後の部分) は、プロパティ名を記述してください。ですから capabilities のスラッグは capabilities です。



  • {{APIRef("グループデータ名")}} — これは左端にあるサイドバーを生成し、現在のページに関連するクイックリファレンスのリンクを表示します。例えば、 WebVR API の中の各ページは同じサイドバーを持ち、この API 内の他のページを指します。 API で正しいサイドバーを生成するには、 KumaScript の GitHub リポジトリにグループデータの項目を追加し、マクロ呼び出しの中でグループデータ名のところに項目名を入れる必要があります。これを行う方法についてのガイドは API リファレンスサイドバーを参照してください。
  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental). If the technology you are documenting is not experimental, you can remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.
  • {{SecureContext_Header}} — this generates a Secure context banner that indicates the technology is only available in a secure context. If it isn't, then you can remove the macro call. If it is, then you should also fill in an entry for it in the Features restricted to secure contexts page.
  • {{Deprecated_Header}} — this generates a Deprecated banner that indicates the technology is deprecated. If it isn't, then you can remove the macro call.


In an API method subpage, you need to include the following tags (see the Tags section at the bottom of the editor UI): API, Reference, Property, the name of the API (e.g. WebVR), the name of the parent interface (e.g. VRDisplay), the name of the method (e.g. capabilities), Experimental (if the technology is experimental), Secure context (if it is available in a secure context only), and Deprecated (if it is deprecated).

Optionally, you can elect to include some other tags that effective represent terms people might search for when looking for information on that technology. For example on WebVR interface pages we include VR and Virtual reality.


To fill in the browser compat data, you first need to fill in an entry for the API into our Browser compat data repo — see our guide on how to do this.

Once that is done, you can show the compat data for the method with a {{Compat()}} macro call.

Experimental: これは実験的な機能です。

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

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

The summary paragraph — start by naming the property, saying what interface it is part of, and saying what it does. This should ideally be 1 or 2 short sentences. You could copy most of this from the property's summary on the corresponding API reference page. Include whether it is read-only or not.


Fill in a syntax box, according to the guidance in our syntax sections article.

Include a description of the property's value, including data type and what it represents.

Fill in a simple example that nicely shows a typical usage of the property, then perhaps some more complex examples (see our guide on how to add code examples for more information).

my code block

And/or include a list of links to useful code samples that live elsewhere:

  • x
  • y
  • z


仕様書 状態 備考
NameOfTheProperty の定義
不明 初回定義


No compatibility data found for path.to.feature.NameOfTheProperty.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.


  • Include list of
  • other links related to
  • this API that might
  • be useful