Skip to content

Commit ad4dee2

Browse files
esibingaesibinga
committed
changes to level and purpose
1 parent c289586 commit ad4dee2

File tree

1 file changed

+52
-28
lines changed

1 file changed

+52
-28
lines changed

‎galleries/examples/tag_glossary.rst‎

Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Tag Glossary
3434
+-----------------------------------+---------------------------------------------+
3535
|``styling: small-multiples`` | |
3636
+-----------------------------------+---------------------------------------------+
37+
|``styling: conditional`` |styling is determined programmatically by a |
38+
| |condition being met |
39+
+-----------------------------------+---------------------------------------------+
3740
| | |
3841
+-----------------------------------+---------------------------------------------+
3942
|**Primary or relevant plot component** |
@@ -66,18 +69,28 @@ Tag Glossary
6669
+-----------------------------------+---------------------------------------------+
6770
|``component: error`` | |
6871
+-----------------------------------+---------------------------------------------+
72+
|``component: animation`` | |
73+
+-----------------------------------+---------------------------------------------+
6974
| | |
7075
+-----------------------------------+---------------------------------------------+
7176
|**Interactivity** |
7277
+-----------------------------------+---------------------------------------------+
7378
|``interactivity: event handling`` | |
7479
+-----------------------------------+---------------------------------------------+
80+
|``interactivity: click`` | |
81+
+-----------------------------------+---------------------------------------------+
82+
|``interactivity: mouseover`` | |
83+
+-----------------------------------+---------------------------------------------+
7584
|``interactivity: zoom`` | |
7685
+-----------------------------------+---------------------------------------------+
7786
|``interactivity: pan`` | |
7887
+-----------------------------------+---------------------------------------------+
7988
|``interactivity: brush`` | |
8089
+-----------------------------------+---------------------------------------------+
90+
|``interactivity: drag`` | |
91+
+-----------------------------------+---------------------------------------------+
92+
|``interactivity: scroll`` | |
93+
+-----------------------------------+---------------------------------------------+
8194
| | |
8295
+-----------------------------------+---------------------------------------------+
8396
|**Plot Type** |
@@ -96,35 +109,41 @@ Tag Glossary
96109
+-----------------------------------+---------------------------------------------+
97110
|``plot type: specialty`` | |
98111
+-----------------------------------+---------------------------------------------+
99-
|``plot type: `` | |
112+
|``plot type: scatter`` | |
100113
+-----------------------------------+---------------------------------------------+
101114

102115

103116
*2. Structural tags: what format is the example? What context can we provide?*
104117

105-
+-----------------------+-------------------------------------------------------------------+
106-
|``tag`` | use case |
107-
+=======================+===================================================================+
108-
|``level: reference`` |reference docs like "marker reference" or "list of named colors" |
109-
| | - dense collection of short-format information |
110-
| | - well-defined scope, accessible information |
111-
+-----------------------+-------------------------------------------------------------------+
112-
|``level`` |level refers to how much context/background the user will need |
113-
+-----------------------+-------------------------------------------------------------------+
114-
|``level: beginner`` |concepts are standalone, self-contained, require only one module |
115-
+-----------------------+-------------------------------------------------------------------+
116-
|``level: intermediate``|concepts may require knowledge of other modules, have dependencies |
117-
+-----------------------+-------------------------------------------------------------------+
118-
|``level: advanced`` |concepts require multiple modules and have dependencies |
119-
+-----------------------+-------------------------------------------------------------------+
118+
+----------------------------+-------------------------------------------------------------------+
119+
|``tag`` | use case |
120+
+============================+===================================================================+
121+
|``level`` |level refers to how much context/background the user will need |
122+
+----------------------------+-------------------------------------------------------------------+
123+
|``level: beginner`` |concepts are standalone, self-contained, require only one module |
124+
+----------------------------+-------------------------------------------------------------------+
125+
|``level: intermediate`` |concepts may require knowledge of other modules, have dependencies |
126+
+----------------------------+-------------------------------------------------------------------+
127+
|``level: advanced`` |concepts require multiple modules and have dependencies |
128+
+----------------------------+-------------------------------------------------------------------+
129+
|``purpose`` |what's it here for? |
130+
+----------------------------+-------------------------------------------------------------------+
131+
|``purpose: storytelling`` |storytelling exemplar -- build a visual argument |
132+
+----------------------------+-------------------------------------------------------------------+
133+
|``purpose: reference`` |reference docs like "marker reference" or "list of named colors" |
134+
| | - dense collection of short-format information |
135+
| | - well-defined scope, accessible information |
136+
+----------------------------+-------------------------------------------------------------------+
137+
|``purpose: fun`` |just for fun! |
138+
+----------------------------+-------------------------------------------------------------------+
120139

121140
*3. Domain tags: what discipline(s) might seek this example consistently?*
122141

123142
Note: 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.
124143

125144
+-------------------------------+----------------------------------------+
126145
|``tag`` | use case |
127-
+=======================+================================================+
146+
+===============================+========================================+
128147
|``domain`` |for whom is the example relevant? |
129148
+-------------------------------+----------------------------------------+
130149
|``domain: cartography`` | |
@@ -142,14 +161,19 @@ Note: it's futile to draw fences around "who owns what", and that's not the poin
142161

143162
*4. Internal tags: what information is helpful for maintainers or contributors?*
144163

145-
+---------------------------+-----------------------------------------------------------------------+
146-
|``tag`` | use case |
147-
+===========================+=======================================================================+
148-
|``internal: low bandwidth``|allows users to filter out bandwidth-intensive examples like animations|
149-
+---------------------------+-----------------------------------------------------------------------+
150-
|``internal: untagged`` |allows docs contributors to easily find untagged examples |
151-
+---------------------------+-----------------------------------------------------------------------+
152-
|``internal: deprecated`` |examples containing deprecated functionality or concepts |
153-
+---------------------------+-----------------------------------------------------------------------+
154-
|``internal: needs-review`` |example needs to be reviewed for accuracy or pedagogical value |
155-
+---------------------------+-----------------------------------------------------------------------+
164+
+-------------------------------+-----------------------------------------------------------------------+
165+
|``tag`` | use case |
166+
+===============================+=======================================================================+
167+
|``internal: low bandwidth`` |allows users to filter out bandwidth-intensive examples like animations|
168+
+-------------------------------+-----------------------------------------------------------------------+
169+
|``internal: untagged`` |allows docs contributors to easily find untagged examples |
170+
+-------------------------------+-----------------------------------------------------------------------+
171+
|``internal: deprecated`` |examples containing deprecated functionality or concepts |
172+
+-------------------------------+-----------------------------------------------------------------------+
173+
|``internal: needs-review`` |example needs to be reviewed for accuracy or pedagogical value |
174+
+-------------------------------+-----------------------------------------------------------------------+
175+
|``internal: outstanding-todo`` |example has an unfinished to-do |
176+
+-------------------------------+-----------------------------------------------------------------------+
177+
|``internal: too-much`` |the example should be refined, split into multiple examples, or |
178+
| |reformatted into a tutorial or reference |
179+
+-------------------------------+-----------------------------------------------------------------------+

0 commit comments

Comments
 (0)