Best Practices for Examples Pages

(Difference between revisions)

Jump to: navigation, search
m (Changed protection level for "examples" [edit=sysop:move=sysop])
(linking to examples-examples)
Line 82: Line 82:
If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories.  If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the [[IRC]] channel or [http://microformats.org/discuss mailing list].
If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories.  If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the [[IRC]] channel or [http://microformats.org/discuss mailing list].
 +
 +
== See also ==
 +
* [[examples-examples]]

Revision as of 22:16, 1 November 2013


*-examples pages are the first stage of the exploration process which must precede proposing a new microformat. Current explorations are listed on the Main Page. You can use the examples-template to help you create your own page.

Contents

Purpose of Example Pages

(adapted from process)

Document current human behavior on the Web. Remember, we're paving the cowpaths- before you do that you have to find the cowpaths. Your documentation should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat. From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.

Current Human Behavior on the Web

Specifically:

Current


Human

Explicit user entered and published information. While automatically published information such as logs from an eletronic thermometer can be interesting, they are not human produced (unless said thermometer is stuck in a human, and that's only indirect/implicit/uncontrolled) and thus do not reflect what humans themselves explicitly do.

Behavior

Web

Recommended sections

Top level (<entry-title>):

The following items can be used as second level headings == ... ==

Details on specific sections:

real world examples section

Good Examples of Examples

The following pages are some of the best examples of instantiating this design pattern:

A Good Example Has

A good example has several things:

When Adding Examples

When adding examples to an existing *-examples page, please try to add the examples into the existing organizational structure in the page. E.g. if the examples are grouped or categorized in a certain way, try to add new examples into those existing categories, instead of a new section.

If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories. If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the IRC channel or mailing list.

See also

Best Practices for Examples Pages was last modified: Wednesday, December 31st, 1969

Views