用語集エントリ

定義

用語集にある、1 つの用語とその定義です。

使用箇所

用語集、ドキュメントページ、ツールチップ。

構成

データ

用語集の元データは、/src/content/glossary/* ↗ フォルダー内の YAML ファイルにあります。

各ファイルは、次のような構成にします。

dns.yamlyaml

---
productName: DNS
entries:
  - term: active zone
    general_definition: |-
      a DNS zone that is active on Cloudflare requires changing its nameservers to Cloudflare's for management.
    associated_products:
      - Cloudflare One

  - term: apex domain
    general_definition: |-
      apex domain is used to refer to a domain that does not contain a subdomain part, such as `example.com` (without `www.`). It is also known as "root domain" or "naked domain".

  - term: DNS over HTTPS
    general_definition: |-
      DNS over HTTPS (DoH) is a standard for encrypting DNS traffic, preventing tracking and spoofing of DNS queries.
    associated_products:
      - 1.1.1.1
      - Cloudflare One

  - term: DNS over TLS
    general_definition: |-
      DNS over TLS (DoT) is a standard for encrypting DNS traffic using its own port (853) and TLS encryption.
    associated_products:
      - 1.1.1.1
      - Cloudflare One

主な値は次のとおりです。

productName string（必須）
- このファイルに関連するコア製品です。associated_products と同じ表記にします。
entries object（必須）
- term string（必須）
  - 用語そのものです。
- general_definition string（必須）
  - 用語の定義です。複数の製品に当てはまる、一般的な内容にします。固有名詞で始まらない限り、先頭は小文字にします。
- associated_products array（任意）
  - ほかの製品とも関連する場合に使います。名前は、関連するファイルの productName と一致させます。

使い方

用語集には構造化データがあるため、これらの用語を複数の場所へ取り込めます。

製品レベルの用語集

製品レベルの用語集には、その製品に関連するすべての用語が含まれます。その製品の用語集ファイルにある用語と、associated_products にその製品が含まれる用語を取り込みます。

/src/content/docs/dns/glossary.mdxmdx

---
title: Glossary
pcx_content_type: glossary
---

import { Glossary } from "~/components";

Review the definitions for terms used across Cloudflare's DNS documentation.

<Glossary product="dns" />

用語集の定義

<GlossaryDefinition> コンポーネントで、用語集の定義を Markdown へ直接取り込みます。

Cloudflare 上でアクティブな DNS ゾーンは、管理のためにネームサーバーを Cloudflare のものへ変更する必要があります。

引用付きの定義で、次から得られます。

<GlossaryDefinition term="active zone" prepend="An active zone is " />

プロパティは次のとおりです。

term string（必須）
- 既存の用語集 YAML ファイル内の用語と一致させます。
prepend string（任意）
- 定義の前に足すテキストです。

用語集のツールチップ

<GlossaryTooltip> コンポーネントで、特定の語句にフォーカス可能なツールチップとして定義を表示します。

これはツールチップの例です。

これは <GlossaryTooltip term="active zone">ツールチップ</GlossaryTooltip> の例です。

プロパティは次のとおりです。

term string（必須）
- 既存の用語集 YAML ファイル内の用語と一致させます。
prepend string（任意）
- 定義の前に足すテキストです。
link string（任意）
- 内側のテキストを Markdown リンクで囲みます。通常の Markdown と同じです。

スペースの都合で、ツールチップは常に用語の短い定義（最初の改行より前の定義文）を使います。