Fuchsia.dev 會使用yaml glossary-yaml 檔案定義所有 Fuchsia 專屬術語。
這類格式可讓 Fuchsia 使用單一來源定義,在單一位置編輯,並在整份文件中更新。這些定義可透過說明文件小工具在整個說明文件中使用,讓您在文件中使用內嵌定義或完整定義。
此外,Fuchsia 還有一個可篩選的主要術語頁面。
新增詞彙集項目
如要新增詞彙定義,請編輯 yaml glossary-yaml,以便加入定義資訊:
參考資料
詞彙定義 | |
---|---|
term | 必填
定義詞彙表字詞。 |
short_description | 必填
為詞彙表術語定義簡短說明。這個定義必須簡短,最好是單句。接著,這項定義可用於將定義設為懸停文字。 請務必使用 HTML 語法。不過,如果您有簡單的定義,也就是單一句子或段落,則可以使用純文字。 舉例來說,以下是「ABI」一詞的定義: ABI |
full_description | 選填
定義詞彙表術語的完整定義。這項說明應完整且詳盡地解釋該詞彙。 請務必使用 HTML 語法,包括連結。不過,如果您有簡單的定義,也就是單一句子或段落,則可以使用純文字。 如要使用連結,請使用以下格式: <a href="link_location">link_title</a> |
see_also | 選填
建立該字詞的相關連結清單。可以是其他條款或相關文件的連結。請務必使用 HTML 語法。
|
related_guides | 選填
建立與該詞相關的指南清單。這個連結只能連至
|
area | 必填
定義字典術語所屬領域的清單。 這些區域可讓您在詞彙表頁面上篩選詞彙表術語。請務必使用 HTML 語法。
有效區域 有效的區域
|
範例
- 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 變更後,詞彙表用語就會顯示在詞彙表頁面中,並可用做說明文件小工具。