Best Practices for Formats Pages

Jump to: navigation, search


*-formats pages are the second stage of the exploration process which must precede proposing a new microformat. Current explorations are listed on the Main Page.

Contents

Purpose of Formats Pages

Documenting previous formats that have attempted to solve the same problem is useful for several reasons:

See the process for more.

Recommended sections

Top level (<entry-title>):

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

Details on specific sections:

previous formats section

Good Examples of Formats Pages

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

A Good Format Reference Has

A good format reference has several things:

When Adding Formats

When adding examples to an existing *-formats page, please try to add the formats into the existing organizational structure in the page. E.g. if the formats are grouped or categorized in a certain way, try to add new formats 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 formats. 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.

See Also

Best Practices for Formats Pages was last modified: Wednesday, October 3rd, 2012

Views