API reference page template

公開前に削除してください

タイトルとスラッグ

API リファレンスページでは、そのページで説明しているインターフェイスの名前タイトルにしてください。例えば、 Request インターフェイスのページでは、タイトルRequest にしてください。

スラッグ (URL の最後の部分) も、そのページで説明しているインターフェイスの名前にしてください。したがって、 Request のスラッグは Request です。これはふつう、自動的に設定されます。

先頭で使用するマクロ

既定では、テンプレートの先頭に 5 つのマクロ呼び出しがあります。以下のアドバイスに従って、更新や削除をしてください。

  • {{APIRef("グループデータ名")}} — これは左端にあるサイドバーを生成し、現在のページに関連するクイックリファレンスのリンクを表示します。例えば、 WebVR API の中の各ページは同じサイドバーを持ち、この API 内の他のページを指します。 API で正しいサイドバーを生成するには、 KumaScript の GitHub リポジトリにグループデータの項目を追加し、マクロ呼び出しの中でグループデータ名のところに項目名を入れる必要があります。これを行う方法についてのガイドは API リファレンスサイドバーを参照してください。
  • {{Draft}} — これは、 Draft バナーを生成してページがまだ完成していないことを示すもので、ページの最初の草稿が完全に完成した場合にのみ削除するべきものです。公開できる状態になったら、これを削除することができます。
  • {{SeeCompatTable}} — これは、 This is an experimental technology バナーを生成して、技術が実験的であることを示します。文書化しようとしている技術が実験的でない場合は、これを削除することができます。実験的な技術であり、その技術が Firefox のプレハブに隠されている場合は、 Firefox における試験的機能のページにそのための項目を記入する必要があります。
  • {{SecureContext_Header}} — これは Secure context バナーを生成し、その技術が安全なコンテキストでのみ利用可能であることを示します。そうでない場合、マクロ呼び出しを削除することができます。存在する場合は、安全なコンテキストに制限されている機能ページにも項目を記入してください。
  • {{Deprecated_Header}} — これは Deprecated バナーを生成し、その技術が非推奨であることを示します。そうでない場合は、このマクロを削除することができます。
  • {{Interface_Overview("GroupDataName")}} — これはページの本文 (コンストラクター、プロパティ、メソッド、イベント) を生成します。

タグ

In an API reference page, you need to include the following tags (see the Tags section at the bottom of the editor UI): API, Reference, Interface, the name of the API (e.g. WebVR), the name of the interface (e.g. Request), 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 interface with a {{Compat(…)}} macro call.

草案

このページは完成していません。

Experimental

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

安全なコンテキスト用

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

非推奨

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

The summary paragraph — start by naming the interface, saying what API 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 Interface's summary on the corresponding API landing page.

コンストラクター

NameOfTheInterface.NameOfTheInterface
Creates a new instance of the NameOfTheInterface object.

プロパティ

Also inherits properties from its parent interface, NameOfParentInterface. (Note: If the interface doesn't inherit from another interface, remove this whole line.)

NameOfTheInterface.property1読取専用
Include a brief description of the property and what it does here. Include one term and definition for each property. If the property is not readonly/experimental/deprecated, remove the relevant macro calls.
NameOfTheInterface.property2
etc.

メソッド

Also inherits methods from its parent interface, NameOfParentInterface. (Note: If the interface doesn't inherit from another interface, remove this whole line.)

NameOfTheInterface.method1()
Include a brief description of the method and what it does here. Include one term and definition for each method. If the method is not experimental/deprecated, remove the relevant macro calls.
NameOfTheInterface.method2()
etc.

イベント

Listen to these events using addEventListener() or by assigning an event listener to the oneventname property of this interface.

eventname1
Fired when ... include description of when event fires
Also available via the oneventname1 property.
eventname2
Fired when ... include description of when event fires
Also available via the oneventname2 property.
etc.
Fired when ...

Fill in a simple example that nicely shows a typical usage of the interfaces, 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

仕様書

仕様書 状態 備考
Unknown
NameOfTheFeature の定義
不明 Defines blah blah feature. If no other specs define specific subfeatures of this interface, you can delete this table row.
Unknown
NameOfTheInterface の定義
不明 初回定義

ブラウザーの互換性

No compatibility data found for path.to.feature.NameOfTheInterface.
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