API reference page template

This translation is incomplete. この記事の翻訳にご協力ください

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

タイトルとスラッグ

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

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

先頭で使用するマクロ

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

  • {{APIRef("グループデータ名")}} — これは左端にあるサイドバーを生成し、現在のページに関連するクイックリファレンスのリンクを表示します。例えば、 WebVR API の中の各ページは同じサイドバーを持ち、この API 内の他のページを指します。 API で正しいサイドバーを生成するには、 KumaScript の GitHub リポジトリにグループデータの項目を追加し、マクロ呼び出しの中でグループデータ名のところに項目名を入れる必要があります。これを行う方法についてのガイドは API リファレンスサイドバーを参照してください。
  • {{Draft}} — this generates a Draft banner that indicates that the page is not yet complete, and should only be removed when the first draft of the page is completely finished. After it is ready to be published, you can remove this.
  • {{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.
  • {{Interface_Overview("GroupDataName")}} — this generates the main body of the page (Constructor, Properties, Methods and Evenets)

タグ

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.

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

これは実験的な機能です。本番で使用する前にブラウザー実装状況をチェックしてください。

安全なコンテキスト用
この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (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.

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. Please contribute data for "path.to.feature.NameOfTheInterface" (depth: 1) to the MDN compatibility data repository.

関連情報

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