用語集のエントリ

定義

用語集における単一の用語とそれに対応する定義。

使用される場所

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

構造

データ

私たちの用語集の基礎となるデータは、/data/glossary/* ↗ フォルダー内のYAMLファイルにあります。

各ファイルは以下のように構成されるべきです：

dns.yaml

---
productName: DNS
entries:
- term: active zone
  general_definition: |-
    Cloudflareで管理するためには、アクティブなDNSゾーンのネームサーバーをCloudflareのものに変更する必要があります。
  associated_products:
    - Cloudflare One

- term: apex domain
  general_definition: |-
    apex domainは、`example.com`（`www.`なし）など、サブドメイン部分を含まないドメインを指すために使用されます。「ルートドメイン」または「ネイキッドドメイン」とも呼ばれます。

- term: DNS over HTTPS
  general_definition: |-
    DNS over HTTPS (DoH)は、DNSトラフィックを暗号化するための標準であり、DNSクエリの追跡や偽装を防ぎます。
  associated_products:
    - 1.1.1.1
    - Cloudflare One

- term: DNS over TLS
  general_definition: |-
    DNS over TLS (DoT)は、独自のポート（853）とTLS暗号化を使用してDNSトラフィックを暗号化するための標準です。
  associated_products:
    - 1.1.1.1
    - Cloudflare One

関連する値は以下の通りです：

• productName string required

  • このファイルに関連するコア製品。常にassociated_productsで使用されるのと同じフォーマット/スタイリングと一致する必要があります。

• entries object required

  • term string required

    • 用語集の用語そのもの。

  • general_definition string required

    • 用語の定義。複数の製品に適用できるように一般的であるべきです。また、固有名詞で始まる場合を除き、小文字で始まる必要があります。

  • associated_products array optional

    • 用語が他の製品に関連している場合。使用される名前は、その関連ファイルのproductNameに対応する必要があります。

使用法

私たちの用語集に関連する構造化データのおかげで、これらの用語を複数の場所に引き出すことができます。

製品レベルの用語集

製品レベルの用語集には、特定の製品に関連するすべての用語が含まれ、その製品の用語集ファイル内の用語と、associated_productsにその製品を含む用語が直接引き出されます。

/dns/glossary.md

---
title: 用語集
pcx_content_type: glossary
layout: wide
---

# 用語集

CloudflareのDNSドキュメントで使用される用語の定義を確認してください。

{{</*glossary product="DNS"*/>}}

用語集の定義

{{</*glossary-definition*/>}}コンポーネントを使用して、Markdownに用語集の定義を直接引き出します。

A DNS zone that is active on Cloudflare requires changing its nameservers to Cloudflare's for management.

は、以下からの引用された定義です：

{{</*glossary-definition term_id="active zone" prepend="アクティブゾーンは "*/>}}

プロパティは以下の通りです：

• term_id string required

  • 既存の用語集YAMLファイル内の用語と一致する必要があります。

• prepend string optional

  • 定義の前に追加するテキスト。

• length string default: long

  • shortとして指定された場合、定義内の最初の改行の前の定義テキストのみを引き出します。

用語集ツールチップ

{{</*glossary-tooltip*/>}}コンポーネントを使用して、特定のフレーズの焦点を当てたツールチップにコンポーネント定義を引き出します。

以下はツールチップの例です。

以下は{{</*glossary-tooltip term_id="active zone">}}ツールチップ{{</glossary-tooltip*/>}}の例です。

プロパティは以下の通りです：

• term_id string required

  • 既存の用語集YAMLファイル内の用語と一致する必要があります。

• prepend string optional

  • 定義の前に追加するテキスト。

• link string optional

  • 内部テキストを通常のMarkdownフォーマットに似たMarkdownリンクでラップします。

スペースの制限のため、ツールチップは常に用語の短い定義にデフォルト設定され、定義テキストは最初の改行の前のものになります。