添加术语表术语

Fuchsia.dev 使用 yaml glossary-yaml 文件定义所有 Fuchsia 特定术语。

此格式允许 Fuchsia 使用在 并在整个文档中进行了相应更新。这些定义 用户还可以通过文档微件在整个文档中使用 然后允许您在文档中使用内嵌定义或完整定义。

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

添加术语表条目

要添加术语表定义，您需要修改 yaml glossary-yaml 包含有关定义的信息：

参考文档

术语表定义
term必需

定义术语表术语。

short_description必需

为您的术语表术语定义简短说明。此定义 必须简短，最好是一句话。此定义可以 然后用于提供悬停文本定义。

您必须使用 HTML 语法。不过，如果您的定义很简单， 可以是单个句子或段落，则可以使用纯文本。

例如，这是 ABI ，了解所有最新动态。

full_description可选

为您的术语表术语定义一个完整名称。此说明应 完整并完整地解释该术语。

您必须使用 HTML 语法，包括 用于链接的语法。 不过，如果您的定义很简单， 可以是单个句子或段落，则可以使用纯文本。

对于链接，请使用以下格式：

<ph type="x-smartling-placeholder"> 
<a href="link_location">link_title</a>
see_also可选

创建该字词的相关链接列表。这可以是链接 对其他字词或相关文档的影响。您必须使用 HTML 语法。

<ph type="x-smartling-placeholder">
  • 对于单个链接，请使用以下格式： 
    ['<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', ...]

有效区域

有效区域 <ph type="x-smartling-placeholder">
    </ph>
  • 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 后， 您的术语库将显示在术语库页面上 并可用作文档微件。