このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

CSS プロパティページのテンプレート

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

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


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

ページ上部のフロントマターは「ページのメタデータ」を定義するために使用します。 値は具体的なプロパティに応じて適切に更新してください。

md
---
title: name-of-the-property
slug: Web/CSS/Reference/Properties/name-of-the-property
l10n:
  sourceCommit: 翻訳元コミットID
---
title

title の値はページの先頭に表示されます。タイトルの書式は name-of-the-property です。 例えば、background-color プロパティのタイトルは background-color です。

slug

slug の値は https://developer.mozilla.org/ja/docs/ の後に続く URL の末尾です。これは Web/CSS/Reference/Properties/name-of-the-property のような形式です。 例えば、background-color プロパティのスラッグは Web/CSS/background-color です。スラッグ内の Getting_started のような複数単語の成分の場合、スラッグは /ja/docs/Learn_web_development/Core/Structuring_content のようにアンダースコアを使用します。

sourceCommit

(翻訳記事のみ)翻訳元の英語版記事の GitHub コミット ID を記述します。GitHub 上で英語版記事のコミット ID を確認してください。


ページ先頭のマクロ

コンテンツ部の上部(ページのフロントマターのすぐ下)には、いくつかのマクロ呼び出しが現れます。

訳注: 英語版では以下のマクロは自動的に追加・更新されますが、翻訳記事には自動的に反映されません。翻訳時に英語版に合わせて手動で追加、更新、削除してください。

  • {{SeeCompatTable}} — これは 実験的 バナーを生成し、この技術が実験的であることを示します。 技術が実験的で、Firefox の設定によって利用できないようにされている場合は、Firefox での実験的な機能ページにも項目を記入してください。
  • {{Non-standard_Header}} — これは 標準外 バナーを生成し、この機能がどの仕様書にもないことを示します。

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

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


ページ内のその他のマクロ

  • 形式文法の節の内容は {{CSSSyntax}} マクロを使用して生成します。このマクロは @webref/css npm パッケージを使用して仕様書からデータを取得します。

  • 公式定義の節の内容は {{CSSInfo}} マクロを使用して生成します。この節のデータは、mdn/data リポジトリーの properties.json データファイルの対応するプロパティに、確実に適切な項目が記入されている必要があります。詳細はプロパティのページを参照してください。

  • 仕様書とブラウザーの互換性の節: ビルドツールは自動的にページのフロントマターから browser-compat のキーと値のペアを用いて、仕様書とブラウザーの互換性の節にデータを挿入します(それぞれこれらの節の {{Specifications}} および {{Compat}} マクロを置き換えます)。

    なお、最初の段階で Browser compat data リポジトリーに、プロパティとその仕様書の項目を作成/更新する必要があるかもしれません。 項目の追加や編集の情報については、互換性一覧表のガイドを参照してください。

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

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

非標準: この機能は標準化されていません。非標準の機能はブラウザーの対応が限られ、将来的に変更または削除される可能性があるため、本番環境での使用は推奨されません。ただし、標準の選択肢が存在しない特定のケースでは、有効な代替手段となる場合があります。

ページのコンテンツは導入段落から始めましょう。プロパティ名から始め、それが何をするのかを書いてください。 できれば 1、2 文の短い段落にしてください。それ以外の説明があれば、「解説」の節に記載してください。

試してみましょう

この節は InteractiveExample マクロで生成されます。 「試してみましょう」という節の見出しとコードエディターが現れます。 詳しくはガイドラインのインタラクティブサンプルの節を参照してください。

構成要素のプロパティ

この節は、animation のような一括指定プロパティの場合にのみ追加し、関連する個別指定プロパティをすべて列挙してください。

プロパティに応じて、次のいずれかの文で値を導入してください。

md
このプロパティは、次の CSS プロパティの一括指定です。

このプロパティは、次の論理プロパティの一括指定です。

このプロパティは、次の物理プロパティの一括指定です。

リセットのみのサブプロパティ

この節は、animation のような一括指定プロパティの場合にのみ追加し、一括指定プロパティによってリセットされるものの、一括指定では設定できない個別指定プロパティをすべて列挙してください。

次の導入文を使用して、プロパティを紹介してください。

md
このプロパティは、次の CSS プロパティを初期値にリセットします。

構文

一般的な用途をコードブロックとして記載し、完全な値を構成する成分のサブ値を記述します。

css
/* よくある用途を示すまたは値のカテゴリーを示す */
/* コードブロックを挿入します */

値

プロパティの値の構成を伝えるために、次のいずれかのような文を記載してください。

md
このプロパティは、次のキーワード値のいずれかで指定します。

このプロパティは、次のリストから選んだ単一の値で指定します。

このプロパティは、次の値を空白区切りのリストとして指定します。

この文に続けて、サブ値ごとに用語と定義を 1 つずつ含む定義リストを記載してください。値の型に対応する MDN リファレンスページがある場合は、用語にそのページへのリンクを追加してください。

subvalue1

サブ値の説明、データ型、何を表すかを記載します。

subvalue2

サブ値の説明、データ型、何を表すかを記載します。

警告: CSS のページには、インライン状態マクロを追加しないでください。

解説

この節では、プロパティについて説明し、どのように動作するかを解説してください。関連用語やプロパティの使用例もここで説明します。

プロパティが一括指定の一部である場合は、値を指定する別の方法も記載してください。

md
`property-name` プロパティは、{{cssxref("sibling-property")}} プロパティとともに、{{cssxref("shorthand-property")}} 一括指定を使用して設定することもできます。

公式定義

{{CSSInfo}}

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

形式文法

{{CSSSyntax}}

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

アクセシビリティ

この節はオプションです。このプロパティを使用する際に開発者が注意すべきアクセシビリティに関する警告があれば、ここに記載することができます。また、こうしたアクセシビリティの懸念の回避策があれば、それも含めることができます。

例

英語版では、例が 1 つだけのページでも、複数形の "Examples" を使用しています。

説明的な見出し

それぞれの例には、その例の内容を説明する H3 見出し (###) が必要です。見出しには例で何を行うかを具体的に記述してください。「単純な例」のような、何を示すのか分からない見出しは避けてください。見出しは簡潔にし、詳しい説明は見出しの後の段落に記載してください。ただし、最初の例が値の代入のみを示し、後により複雑な例が続く場合は、「基本的な使い方」を最初の例の見出しとして使用できます。見出しは簡潔にします。詳しい説明は見出しの後に段落として記述してください。

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

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

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

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

md
## 例

### Fetch API の使用

Fetch の例

### その他の例

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

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

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

md
## 例

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

仕様書

{{Specifications}}

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

ブラウザーの互換性

{{Compat}}

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

関連情報

現在のプロパティに関連するリファレンスページやガイドへのリンクを記載してください。また、そのプロパティが属する CSS モジュールへのリンクも含めてください。その他のガイドラインについては、執筆スタイルガイドの「関連情報」の節を参照してください。

  • リンク1
  • リンク2
  • CSS モジュールへのリンク
  • 外部リンク (年)