glossary-entries.md

{% include "docs/glossary/_common/_glossary_header.md" %}

{% import 'docs/_common/_doc_widgets.md' as widgets %}

Adding a glossary term

Fuchsia.dev uses a [_glossary.yaml][glossary-yaml] file to define all Fuchsia specific terminology.

This format allows Fuchsia to use single-source definitions to be edited in a single location and updated throughout the documentation. These definitions can then be used throughout documentation using documentation widgets, which then allows you to use inline definitions or full definitions in your documents.

Note: For more information, see [documentation widgets][documentation-widgets].

Additionally, Fuchsia has a main filterable [glossary page][glossary-index].

Add a glossary entry

To add a glossary definition, you need to edit the [_glossary.yaml][glossary-yaml] to include information about your definition:

Reference

Glossary definition
term	Required Define the glossary term.
short_description	Required Define a short description for your glossary term. This definition must be short, preferably a single sentence. This definition can then be used to have definitions as hover-over text. You must use HTML syntax. However, if you have a simple definition that is a single sentence or paragraph, you can use plain text. For example, this is the definition for the term {{ widgets.glossary_simple ('ABI') }}.
full_description	Optional Define a full for your glossary term. This description should be complete and fully explain the term. You must use HTML syntax, including for links. However, if you have a simple definition that is a single sentence or paragraph, you can use plain text. For a link, use this format: Note: Links to the glossary should use this link location format, /glossary/README.md#term. {% htmlescape %}{% endhtmlescape %}link_title{% htmlescape %}{% endhtmlescape %}
see_also	Optional Create a list of related links for the term. This can be links to other terms or related documentation. You must use HTML syntax. Note: Links to the glossary should use this link location format, /glossary/README.md#term. For a single link, use this format: {% htmlescape %}['{% endhtmlescape %}link_title{% htmlescape %}']{% endhtmlescape %} For multiple links, use this format: {% htmlescape %}['{% endhtmlescape %}link_title{% htmlescape %}'{% endhtmlescape %}, {% htmlescape %}['{% endhtmlescape %}link_title2{% htmlescape %}']{% endhtmlescape %}
related_guides	Optional Create a list of related guides for the term. This should only be links to guides located in //development/. You must use HTML syntax. For a single link, use this format: {% htmlescape %}['{% endhtmlescape %}guide_title{% htmlescape %}']{% endhtmlescape %} For multiple links, use this format: {% htmlescape %}['{% endhtmlescape %}guide_title{% htmlescape %}'{% endhtmlescape %}, {% htmlescape %}['{% endhtmlescape %}guide_title2{% htmlescape %}']{% endhtmlescape %}
area	Required Define a list of the areas that your glossary term pertains to. These areas make the glossary terms filterable on the glossary page. You must use HTML syntax. For a single area, use this format ['area']. For multiple areas, use this format ['area1', ...] Valid areas Note: If you think there should be additional areas, suggest a new area. Valid areas {% for area in areas %} {{ area }} {% endfor %}

Sample

- term: 'ABI'
  short_description: 'The binary-level interface to the system.'
  full_description: '{% htmlescape %}The Application Binary Interface (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.{% endhtmlescape %}'
  see_also: ['{% htmlescape %}ABI',
             'Storage capability{% endhtmlescape %}']
  related_guides: ['{% htmlescape %}Registering a trace provider',
                   'Installing Fuchsia on a device{% endhtmlescape %}']
  area: ['System', 'General']

Once you have created the entry for your glossary entry and submitted the Gerrit change, your glossary term will be visible on the [glossary page][glossary-index] and usable as a [documentation widget][documentation-widgets].

[glossary-yaml]: {{fuchsia_editor }}docs/glossary/_glossary.yaml [glossary-index]: /glossary [documentation-widgets]: /reference/documentation/widgets.md