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.
It's futile to draw fences around "who owns what", and that's not the point of domain
tags. 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.
Tags have a one-to-many organization (i.e. one example can have several tags), while the gallery structure requires that examples are placed in only one location. This means tags provide a secondary layer of organization and make the gallery of examples more flexible and more user-friendly.
Tags have a one-to-many organization (i.e. one example can have several tags), while
the gallery structure requires that examples are placed in only one location. This means
tags provide a secondary layer of organization and make the gallery of examples more
flexible and more user-friendly.
They allow for better discoverability, search, and browse functionality. They are helpful for users struggling to write a search query for what they're looking for.
They allow for better discoverability, search, and browse functionality. They are
helpful for users struggling to write a search query for what they're looking for.
Hidden tags provide additional functionality for maintainers and contributors.
How to tag?
-----------
Place the tag directive at the bottom of each page and add the tags underneath, e.g.:
.. code-block:: rst
.. tags::
topic: tagging, purpose: reference
What gets a tag?
----------------
Expand All
@@ -20,56 +33,38 @@ Every gallery example should be tagged with:
* 1+ content tags
* structural, domain, or internal tag(s) if helpful
Tags can repeat existing forms of organization (e.g. an example is in the Animation folder and also gets an ``animation`` tag).
Tags can repeat existing forms of organization (e.g. an example is in the Animation
folder and also gets an ``animation`` tag).
Tags are helpful to denote particularly good "byproduct" examples. E.g. the explicit
purpose of a gallery example might be to demonstrate a colormap, but it's also a good
demonstration of a legend. Tag ``legend`` to indicate that, rather than changing the
title or the scope of the example.
Tags are helpful to denote particularly good "byproduct" examples. E.g. the explicit purpose of a gallery example might be to demonstrate a colormap, but it's also a good demonstration of a legend. Tag ``legend`` to indicate that, rather than changing the title or the scope of the example.
.. card::
**Tag Categories** - See :doc:`Tag Glossary <tag_glossary>` for a complete list of tags.
**Tag Categories**
^^^
.. rst-class:: section-toc
I. API tags: what content from the API reference is in the example?
II. Structural tags: what format is the example? What context can we provide?
III. Domain tags: what discipline(s) might seek this example consistently?
IV. Internal tags: what information is helpful for maintainers or contributors?
.. toctree::
:maxdepth: 2
tag_glossary
+++
See :doc:`Tag Glossary <tag_glossary>` for a complete list
Proposing new tags
------------------
1. Review existing tag list, looking out for similar entries (i.e. ``axes`` and ``axis``).
2. If a relevant tag or subcategory does not yet exist, propose it. Each tag is two parts: ``subcategory: tag``. Tags should be one or two words.
3. New tags should be be added when they are relevant to existing gallery entries too. Avoid tags that will link to only a single gallery entry.
2. If a relevant tag or subcategory does not yet exist, propose it. Each tag is two
parts: ``subcategory: tag``. Tags should be one or two words.
3. New tags should be be added when they are relevant to existing gallery entries too.
Avoid tags that will link to only a single gallery entry.
4. Tags can recreate other forms of organization.
Note: Tagging organization aims to work for 80-90% of cases. Some examples fall outside of the tagging structure. Niche or specific examples shouldn't be given standalone tags that won't apply to other examples.
How to tag?
-----------
Put each tag as a directive at the bottom of the page.
Related content
---------------
What is a gallery example?
^^^^^^^^^^^^^^^^^^^^^^^^^^
The gallery of examples contains visual demonstrations of matplotlib features. Gallery examples exist so that users can scan through visual examples.
Unlike tutorials or user guides, gallery examples teach by demonstration, rather than by explanation or instruction.
Gallery examples should avoid instruction or excessive explanation except for brief clarifying code comments. Instead, they can tag related concepts and/or link to relevant tutorials or user guides.
Format
^^^^^^
All :ref:`examples-index` should aim to follow the following format:
* Title: 1-6 words, descriptive of content
* Subtitle: 10-50 words, action-oriented description of the example subject
* Image: a clear demonstration of the subject, showing edge cases and different applications if possible
* Code + Text (optional): code, commented as appropriate + written text to add context if necessary
Example:
The ``bbox_intersect`` gallery example demonstrates the point of visual examples:
* this example is "messy" in that it's hard to categorize, but the gallery is the right spot for it because it makes sense to find it by visual search
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.