新增詞彙表

Fuchsia.dev 採用 yaml glossary-yaml 檔案，定義所有 Fuchsia 特定術語

這種格式可讓 Fuchsia 使用單一來源定義，在 單一位置並隨時更新整份說明文件。這些定義 也能透過說明文件小工具 用於整份說明文件 即可在文件中使用內嵌定義或完整定義。

此外，Fchsia 有一個可篩選的主要詞彙表頁面。

新增詞彙表項目

如要新增詞彙定義，您必須編輯 yaml glossary-yaml，包含定義相關資訊：

參考資料

詞彙表定義
term必填

定義詞彙表字詞。

short_description必填

輸入詞彙表字詞的簡短說明。這個定義 都必須簡短，最好使用單一句子這項定義可以 然後將定義設為懸停文字

必須使用 HTML 語法。不過 一個句子或段落，您可以使用純文字。

例如 ABI ，直接在 Google Cloud 控制台實際操作。

full_description選用

為您的詞彙表字詞定義完整內容。這段說明 完整的說明

您必須使用 HTML 語法 (包括連結)。 不過 一個句子或段落，您可以使用純文字。

連結格式如下：

<a href="link_location">link_title</a>
see_also選用

建立字詞的相關連結清單。這可以是連結 其他條款或相關說明文件必須使用 HTML 語法。

  • 如果是單一連結，請使用下列格式： 
    ['<a href="link_location">link_title</a>']
  • 如果是多個連結，請使用下列格式： 
    ['<a href="link_location">link_title</a>',
['<a href="link_location2">link_title2</a>']
related_guides選用

建立該字詞的相關指南清單。這應該 只能連結至位於//docs/development/的指南。您必須 使用 HTML 語法

  • 如果是單一連結，請使用下列格式： 
    ['<a href="guide_location">guide_title</a>']
  • 如果是多個連結，請使用下列格式： 
    ['<a href="guide_location">guide_title</a>',
['<a href="guide_location2">guide_title2</a>']
area必填

定義詞彙表字詞相關區域的清單。 這些區域能讓您篩選詞彙表字詞 詞彙表頁面。 必須使用 HTML 語法。

  • 如果是單一區域，請使用 ['area'] 格式。
  • 如有多個區域，請使用這個格式 ['area1', ...]

有效區域

有效區域
  • Bluetooth
  • Build
  • Component Framework
  • Developer
  • Devices
  • Diagnostics
  • Driver SDK
  • Drivers
  • EngProd/Infra
  • Experiences
  • FIDL
  • Firmware
  • Foreign ABI Compatibility
  • General
  • Governance
  • Graphics
  • HCI
  • Identity
  • Kernel
  • Languages and Libraries
  • Media
  • Memory
  • Metrics
  • Netstack
  • Performance
  • Power
  • Recovery
  • Security
  • Sessions
  • Software Assembly
  • Software Delivery
  • Storage
  • System
  • Testing
  • Toolchain
  • View System
  • Virtualization
  • Web
  • WLAN

範例

- term: 'ABI'
  short_description: 'The binary-level interface to the system.'
  full_description: 'The <a href="/docs/concepts/packages/system.md">Application Binary Interface</a> (ABI)
  for a system is the binary-level interface to the system. Typically you don''t
  write software that uses the system ABI directly. Instead, you write software
  against the system API. When the software is compiled, the binary artifact
  created by the compiler interfaces with the system through the ABI.
  Changes to the system ABI may require you to recompile your source code to
  account for the changes in the ABI.'
  see_also: ['<a href="/docs/glossary#ABI">ABI</a>',
             '<a href="/docs/glossary#storage-capability">Storage capability</a>']
  related_guides: ['<a href="/docs/development/tracing/tutorial/registering-a-trace-provider.md">Registering a trace provider</a>',
                   '<a href="/docs/development/hardware/paving.md">Installing Fuchsia on a device</a>']
  area: ['System', 'General']

建立詞彙表項目並提交 Gerrit 後 之後的詞彙解釋功能就會顯示在詞彙表頁面中 並做為說明文件小工具使用