mf2-spec-template-brainstorming
h-example is a microformats-2 schema (?) for representing Examples. It builds upon the classic hExample microformat.
Translations: link to each translation as hCard does
TODO: properties first or examples first? returning viewers are most likely to want quick reference to properties, first time viewers are most likely to want an example. Perhaps do as hCard does with the property list => markup 1:1 thing, unless that ends up looking too noisy?
Properties
For each property, give:
- classname e.g.
p-name
- legacy BC classname
- meaning e.g. The name of the example
- example value e.g. “An example of an artisanal banana-peeling pattern”
- full element
Example:
- p-name (was
fn
): The name of the example- E.G.
<span class="p-name">Banana #1</span>
- E.G.
TODO: how to handle properties which probably should be a nested microformat but can also be a plain value? E.G. author:
- p-author (was
author
): The author of the example. Optionally an h-card
Examples
Ideally all examples will be shown 1:1 with their JSON representation, OR editable with JS to submit it to a parser and show the JSON — this would encourage people to experiment and greater understand the relationship between markup and parsed structure.
Minimal sane example:
TODO
Meatier example
TODO
Outlier/edge case example?
TODO