User Guides

Edit This Page

术语展示

Bootstrap可以在任意文字上添加提示信息,适用于缩写和专用术语。引入Bootstrap即可使用。

定义术语库

_data目录创建文件glossary.yml,在其中定义所有术语。写法如下:

ONAP: Open Network Automation Platform
HTTP: HyperText Transfer Protocol

冒号前是术语,冒号后是术语描述,冒号和描述中间必须加一个空格。

创建include文件

_includes目录创建文件glossary.html,内容如下:

<span class="glossary" data-toggle="tooltip" data-original-title="{{site.data.glossary[include.glossary]}}">{{include.glossary}}</span>

{{include.glossary}} 是传到glossary.html的术语名词。

{{site.data.glossary[include.glossary]}}glossary.yml中定义好的术语描述。

定义术语样式

_sass/_base.sass文件中加入术语样式,内容如下:

.glossary
  color: #649345
  font-style: italic
  cursor: pointer

使用术语

术语使用方法如下:

{% include glossary.html glossary="ONAP" %} is an open source software platform that delivers capabilities for the design, creation, orchestration, monitoring.

glossary="ONAP"表示将glossary参数传到glossary.html,其值为ONAP

展示效果:ONAP is an open source software platform that delivers capabilities for the design, creation, orchestration, monitoring.

如果术语没有提示信息,可能是因为在_data/glossary.yml中没有定义该术语。