Tag Glossary#
API tags: what content from the API reference is in the example?
Structural tags: what format is the example? What context can we provide?
Domain tags: what discipline(s) might seek this example consistently?
Internal tags: what information is helpful for maintainers or contributors?
API tags: what content from the API reference is in the example?#
|
use case - if not obvious |
---|---|
Primary or relevant plot component |
|
|
remarkable or very clear use of component |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
frequently paired with |
|
|
|
|
Styling |
|
Use these tags when plot contains a teachable example |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
styling is determined programmatically by a condition being met |
Interactivity |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Plot Type |
|
|
example contains a bar plot |
|
example contains a line plot |
|
example contains a pie plot |
|
example contains a polar plot |
|
example contains a 3D plot |
|
example contains a histogram |
|
|
|
Structural tags: what format is the example? What context can we provide?#
|
use case |
---|---|
|
level refers to how much context/background the user will need |
|
concepts are standalone, self-contained, require only one module |
|
concepts may require knowledge of other modules, have dependencies |
|
concepts require multiple modules and have dependencies |
|
what's it here for? |
|
storytelling exemplar -- build a visual argument |
|
|
|
just for fun! |
|
good showcase example |
Domain tags: what discipline(s) might seek this example consistently?#
It's futile to draw fences around "who owns what", and that's not the point of domain tags. Domain tags help groups of people to privately organize relevant information, and so are not displayed publicly. See below for a list of existing domain tags. If you don't see the one you're looking for and you think it should exist, consider proposing it.
|
use case |
---|---|
|
for whom is the example relevant? |
|
|
|
|
|
|
|
|
|
Internal tags: what information is helpful for maintainers or contributors?#
|
use case |
---|---|
|
allows users to filter out bandwidth-intensive examples like animations |
|
allows docs contributors to easily find untagged examples |
|
examples containing deprecated functionality or concepts |
|
example needs to be reviewed for accuracy or pedagogical value |
|
example has an unfinished to-do |
|
the example should be refined, split into multiple examples, or reformatted into a tutorial or reference |