HTML 要素ページのテンプレート

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

訳注: このテンプレートは翻訳記事用です。新たな記事を執筆する場合は、英語版を参照してください。日本語の単独記事を立項することはできません。）

ページのフロントマター:

ページ上部のフロントマターは「ページのメタデータ」を定義するために使用します。値は、個々の要素に応じて適切に書き換える必要があります。

---
title: "<NameOfTheElement>: The NameOfTheElement 要素"
slug: Web/HTML/Element/NameOfTheElement
l10n:
  sourceCommit: 翻訳元コミットID
---

title: タイトルの見出しで、ページの最上部に表示されます。書式は '<NameOfTheElement>: 要素の目的' です。例えば、 <video> 要素の title は '<video>: 埋め込み動画要素' となります。
slug: https://developer.mozilla.org/ja/docs/ の後にくる URL の末尾です。これは Web/HTML/Element/NameOfTheElement のような形式になります。例えば、 <video> 要素の slug は Web/HTML/Element/video となります。
sourceCommit: （翻訳記事のみ）この記事の翻訳元となる英語版記事を GitHub にコミットした際のコミット ID を記述します。 GitHub 上で英語版記事のコミット ID を確認してください。

ページ先頭のマクロ

コンテンツ部の上部（ページのフロントマターのすぐ下）には、いくつかのマクロ呼び出しが現れます。 訳注: 英語版では以下のマクロは自動的に更新されますが、翻訳記事では更新されませんので、翻訳時に手動で英語版のマクロに合わせてください。

{{SeeCompatTable}} — これは これは実験的な機能です。 のバナーを生成し、この技術が実験的であることを示します。実験的なもので、その技術が Firefox の設定で隠されている場合は、 Firefox での実験的な機能ページにもそのためのエントリーを記入する必要があります。
{{Deprecated_Header}} — これは 非推奨 バナーを生成し、この技術の使用を避けるべきであることを示します。
{{Non-standard_Header}} — これは 標準外 バナーを生成し、この機能がどの仕様書にもないことを示します。

下記のアドバイスに従って、以下のマクロを更新または削除してください。

{{SecureContext_Header}} — これは 安全なコンテキスト バナーを生成し、この技術が安全なコンテキストでのみ利用できることを示します。そうではない場合は、マクロ呼び出すを削除することができます。そうである場合は、安全なコンテキストに制限されている機能ページ内の項目も記入してください。
{{HTMLSidebar}} — これは、要素のための左側のリファレンスサイドバーを生成します。サイドバーのコンテンツはページメタデータのタグに依存します。
このページをコピーする際には、 {{MDNSidebar}} マクロを外すのを忘れないでください。

訳注: 英語版では状態ヘッダーマクロは自動的に更新されますが、翻訳記事では更新されません。翻訳時に英語版に合わせて手動で更新してください。

実験的、非推奨、標準外 の各バナーは、このメモブロックの直後に表示しています。

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

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

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

非標準: この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

<要素名を挿入> は HTML の要素で、 （その要素の名前とそれが何をするのか、できれば 1 つか 2 つの短い文章で概要を述べてください） を行います。

{{EmbedInteractiveExample("pages/tabbed/nameOfElement.html", "tabbed-standard")}}

追加情報を記述します。この点で、要素を使用する上で知っておくべき最も重要なことや、その主な機能を説明する段落をいくつか記述してください。この例で何が起こっているのかが分かりにくい場合は、簡単に説明するのが良いでしょう。また、この要素が重要な関連する JavaScript や CSS 機能とどのように相互作用するかについて、重要な点を説明することもできます。あまり詳しくは説明しないでください。ページをまたいでドキュメント化を繰り返したくはないでしょう。しかし、重要な点とその機能のページへのリンクは有益なものでしょう。この例も <video> ページを参照してください。

属性

この要素にはグローバル属性があります。

attribute1 非推奨 Experimental: この属性がどのような働きをするか、ここに記述してください。属性ごとに 1 つずつ用語と定義を記述してください。属性が実験的/非推奨でない場合は、関連するマクロ呼び出しを除去してください。
attribute2: 同様です。

イベント

この型の要素で発生するイベントがあれば、その表も記載してください。

イベント名	発生する条件
イベント 1	いつ発生するか短く説明してください
イベント 2	いつ発生するか短く説明してください
以下同様

例

英語版では、ページ内に例が 1 つしかない場合でも、複数形の "Examples" を使用していることに留意してください。

説明的な見出し

それぞれの例には、その例を説明する H3 見出し (###) がなければなりません。見出しは例が何を行っているかを説明するものであるべきです。例えば、「単純な例」というのは例について何も説明していないので、良い見出しとは言えません。見出しは簡潔であるべきです。より詳しい説明をする場合は、見出しの後の段落を使用してください。

詳しくは、サンプルコードを追加する方法のガイドをご覧ください。

メモ: 他のページで紹介されている例にリンクしたい場合もあるでしょう。

シナリオ 1: このページにいくつかの例があり、別のページにさらにいくつかの例がある場合。

このページのそれぞれの例に H3 見出し (###) を記載し、最後に H3 見出し (###) に「その他の例」というテキストを入れ、その下に他のページの例へのリンクを貼ることができます。例えば次のようにします。

## 例

### Fetch API の使用

Fetch の例

### その他の例

他のページにある他の例へのリンク

シナリオ 2: このページには何も例がなく、他のページにだけある場合。

H3 の見出しは追加せず、 H2 の見出し「例」の下に直接リンクを追加してください。例えば次のようにします。

## 例

この API の例については、[fetch() のページ](https://example.org)を参照してください。

アクセシビリティの考慮

オプションとして、この要素を使用することで存在する可能性のあるアクセシビリティへの問題点と、それを回避する作業方法を説明してください。掲載すべきものがなければ、この節は除去してください。

技術的概要

コンテンツカテゴリー	HTML 要素が属するコンテンツカテゴリーのリストを記入します。
許可されているコンテンツ	この要素が含むことができるコンテンツはどのようなものか。
タグの省略	終了タグが省略可能か、存在する可能性があるか。省略する必要があるか。
許可されている親要素	どの親要素がこの要素を子にすることができるか。例えば、「フローコンテンツを受け入れるすべての要素。」
許可されている ARIA ロール	この要素に設定可能な ARIA ロールの一覧を記入します。例えば `directory` (en-US)。
DOM インターフェイス	どの DOM インターフェイスが JavaScript でこの要素を表すか。例えば、 ol の場合は `HTMLOListElement`。

仕様書

{{Specifications}}

このマクロを使用するには、 Markdown ファイルの逆引用符とバックスラッシュを除去してください。

ブラウザーの互換性

{{Compat}}

このマクロを使用するには、 Markdown ファイルの逆引用符とバックスラッシュを除去してください。