标签词汇表

API 标签:示例中包含 API 参考中的哪些内容?

tag	用例
主要或相关的绘图组件
component: axes	组件的显着或非常明确的用法
component: axis
component: marker
component: label
component: title
component: legend
component: subplot
component: figure
component: annotation
component: label
component: ticks
component: spines	经常与 component: axis 配对
component: error
component: animation
样式
当绘图包含可教授的示例时,请使用这些标签
styling: color
styling: shape
styling: size
styling: position
styling: texture
styling: colormap
styling: linestyle
styling: small-multiples
styling: conditional	样式由满足的条件以编程方式确定
交互性
interactivity: event handling
interactivity: click
interactivity: mouseover
interactivity: zoom
interactivity: pan
interactivity: brush
interactivity: drag
interactivity: scroll
绘图类型
plot-type: bar	示例包含条形图
plot-type: line	示例包含折线图
plot-type: pie	示例包含饼图
plot-type: polar	示例包含极坐标图
plot-type: 3D	示例包含 3D 图
plot-type: histogram	示例包含直方图
plot-type: specialty
plot-type: scatter

结构标签:示例的格式是什么?我们可以提供什么上下文?

tag	用例
level	level 指的是用户需要多少上下文/背景
level: beginner	概念是独立的,自包含的,只需要一个模块
level: intermediate	概念可能需要了解其他模块,具有依赖关系
level: advanced	概念需要多个模块并且具有依赖关系
purpose	它在这里做什么?
purpose: storytelling	讲故事的范例--构建一个视觉论证
purpose: reference	类似"标记参考"或"命名颜色列表"之类的参考文档 简短格式信息的密集集合 定义明确的范围,可访问的信息
purpose: fun	只是为了好玩!
purpose: showcase	好的展示示例

领域标签:哪些学科可能会持续寻找这个例子?

围绕"谁拥有什么"划定界限是徒劳的,这不是领域标签的重点.请参见下面现有领域标签的列表.如果您没有看到您要查找的标签,并且您认为它应该存在,请考虑提出它.

tag	用例
domain	该示例与谁相关?
domain: cartography
domain: geometry
domain: statistics
domain: oceanography
domain: signal-processing

内部标签:哪些信息对维护者或贡献者有帮助?

这些标签应仅用于开发目的;因此,请在版本保护之后单独添加它们:

.. ifconfig:: releaselevel == 'dev'
    .. tags::  internal: needs-review

tag	用例
internal: high-bandwidth	允许用户过滤掉带宽密集型示例,例如动画
internal: untagged	允许文档贡献者轻松找到未标记的示例
internal: deprecated	包含已弃用功能或概念的示例
internal: needs-review	需要审查示例的准确性或教学价值
internal: outstanding-todo	示例有一个未完成的待办事项
internal: too-much	应该改进示例,将其拆分为多个示例,或重新格式化为教程或参考资料