添加术语表术语

yamlglossary-yaml

这种格式允许 Fuchsia 使用单一源定义，以便在单个位置修改并在整个文档中更新。然后，您可以通过文档 widget 在整个文档中使用这些定义，这样您就可以在文档中使用内嵌定义或完整定义。

此外，Fuchsia 有一个可过滤的主要术语库页面。

添加术语表条目

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 更改后，术语表术语将显示在术语库页面上，并可用作文档 widget。