新增詞彙表

yamlglossary-yaml

有了這種格式， Fuchsia 就能在單一位置編輯單一來源定義，並在整個說明文件中更新相關資訊。這些定義接著可透過說明文件小工具用於完整說明文件，讓您在文件中使用內嵌定義或完整定義。

此外，Fchsia 也提供主要的可篩選詞彙表頁面。

新增詞彙表項目

yamlglossary-yaml

參考資料

詞彙解釋定義
term必填

定義詞彙表字詞。

short_description必填

為詞彙表字詞定義簡短說明。這個定義必須為簡短，最好使用單一句子。這項定義接著可用「懸停文字」定義定義。

您必須使用 HTML 語法。不過，如果您有單一句子或段落的簡單定義，就可以使用純文字。

ABI
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 變更之後，詞彙表字詞會顯示在詞彙表頁面，而且可做為說明文件小工具使用。