Difference between revisions of "examples-template"

From Microformats Wiki
examples-template
Jump to navigation Jump to search
 
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(14 intermediate revisions by 8 users not shown)
Line 1: Line 1:
= [Example Title] =
+
{{DISPLAYTITLE:*** examples}}
Introductory sentence
+
 
 +
'''(This is the *-examples page template, please replace "*** examples" with the general subject area that you're gathering / documenting / researching examples for, and remove this parenthetical paragraph).'''
 +
 
 +
Introductory sentence.
  
 
== The Problem ==
 
== The Problem ==
''What is the purpose of this exploration?''
+
''What problem prompted this exploration and why is it relevant enough to spend time solving it?''
== Participants ==
+
 
* ''Bulleted list of who is active (or cares)''
+
== Use Cases ==
 +
Whether or not there is a specific problem that is being solved, one or more use cases (actual scenarios which benefit a ''user'') should be documented.
 +
 
 +
It's useful to gather publishing examples within the context of both the problem(s) being solved, and the use case(s).
 +
 
 
== Real-World Examples ==
 
== Real-World Examples ==
 
''Links to public web pages, either popular or insightful''
 
''Links to public web pages, either popular or insightful''
=== [Example #1 (url)] ===
+
 
=== [Example #2 (url)] ===
+
=== short name of Example #1 ===
 +
Linked full name of example #1
 +
 
 +
<source lang=html4strict>
 +
<div>
 +
raw, unescaped snippet of example markup
 +
</div>
 +
</source>
 +
 
 +
Analysis of implied schema of example #1
 +
 
 +
=== short name of Example #2 ===
 +
Linked full name of example #2
 +
 
 +
<source lang=html4strict>
 +
<div>
 +
raw, unescaped snippet of example markup
 +
</div>
 +
</source>
 +
 
 +
Analysis of implied schema of example #2
 +
 
 +
== Common Practices ==
 +
* ''Summary of common patterns discovered''
 +
* common implied schema
  
 
== Existing Practices ==
 
== Existing Practices ==
* ''Summary of common patterns discovered''
+
''Other attempts to solve The Problem''
* ''Other attempts to solve The Problem''
+
* *-formats page
== Proposal ==
+
 
* Early drafts
+
== Brainstorming ==
* ''Link to related pages as they become available''
+
''Link to related pages as they become available''
** -brainstorming
+
* *-brainstorming page
** - proposal
+
* proposal page
** -microformat
+
* microformat spec page
 +
 
 
== See Also ==
 
== See Also ==
* ''Other microformats''
+
* Other microformats
* ''Normative references for tags used''
+
* Normative references

Latest revision as of 16:22, 18 July 2020


(This is the *-examples page template, please replace "*** examples" with the general subject area that you're gathering / documenting / researching examples for, and remove this parenthetical paragraph).

Introductory sentence.

The Problem

What problem prompted this exploration and why is it relevant enough to spend time solving it?

Use Cases

Whether or not there is a specific problem that is being solved, one or more use cases (actual scenarios which benefit a user) should be documented.

It's useful to gather publishing examples within the context of both the problem(s) being solved, and the use case(s).

Real-World Examples

Links to public web pages, either popular or insightful

short name of Example #1

Linked full name of example #1

<div>
raw, unescaped snippet of example markup
</div>

Analysis of implied schema of example #1

short name of Example #2

Linked full name of example #2

<div>
raw, unescaped snippet of example markup
</div>

Analysis of implied schema of example #2

Common Practices

  • Summary of common patterns discovered
  • common implied schema

Existing Practices

Other attempts to solve The Problem

  • *-formats page

Brainstorming

Link to related pages as they become available

  • *-brainstorming page
  • proposal page
  • microformat spec page

See Also

  • Other microformats
  • Normative references