examples

(Difference between revisions)

Jump to: navigation, search
(A Good Example Has)
(Real World Examples section)
Line 26: Line 26:
*** *-formats
*** *-formats
*** *-brainstorming
*** *-brainstorming
 +
 +
=== Real World Examples section ===
 +
 +
* '''Flat list at a minimum.''' The real world examples section should be at a minimum a flat list of examples.  See further down for what a good example has.
 +
* '''Grouping into categories can help.''' A giant flat list of examples can sometimes be difficult to navigate and analyze as a whole. Consider grouping related examples into a flat list of categories.  If you're not sure how to categorize the examples, or if there are multiple axes across which you could categorize the examples, ask on the [http://microformats.org/discuss mailing list and/or irc channel]
== Good Examples of Examples ==
== Good Examples of Examples ==

Revision as of 18:43, 23 January 2006

Contents

Best Practices for Example Pages

Example 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.

Purpose of Example Pages

(adapted from process)

Document current human behavior. 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.

Recommended sections

Top level (=):

Second level (==):

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 mailing list or irc channel.

examples was last modified: Wednesday, December 31st, 1969

Views