mf2-spec-template-brainstorming - Revision history

Barnabywalters: Added “see also” section

2013-06-06T16:58:03Z

Added “see also” section

@@ Line 51: / Line 51: @@
+}
 </source>
-</div>
 <hr />

Barnabywalters: Added note about properties being optional

2013-06-06T16:46:03Z

Added note about properties being optional

← Older revision		Revision as of 16:46, 6 June 2013
Line 4:		Line 4:

	== Properties ==		== Properties ==

			All properties are optional and are parsed according to the [[microformats-2-parsing]] specification.

	* '''p-name''' <i>(was <code>fn</code>)</i> full example name		* '''p-name''' <i>(was <code>fn</code>)</i> full example name

Barnabywalters: /* Properties */ Altered property markup slightly

2013-06-06T16:43:20Z

Properties: Altered property markup slightly

← Older revision		Revision as of 16:43, 6 June 2013
Line 5:		Line 5:
	== Properties ==		== Properties ==

	* '''p-name''' (was <code>fn</code>)~~: The~~ name ~~of the example~~		* '''p-name''' <i>(was <code>fn</code>)</i> full example name
	** <code><span class="p-name">Banana #1</span></code>		** <code><span class="p-name">Banana #1</span></code>
	* '''p-summary''' (was <code>example-summary</code>)~~: A~~ short ~~textual~~ summary ~~of the example~~		* '''p-summary''' <i>(was <code>example-summary</code>)</i> short summary
	** <code><p class="p-summary">An example of how examples may be exampled</p></code>		** <code><p class="p-summary">An example of how examples may be exampled</p></code>
	* '''p-author''' (was <code>author</code>)~~: The~~ author ~~of the example. Optionally an [[h-card]]~~		* '''p-author''' [[h-card]] <i>(was <code>author</code>)</i> author

	== Examples ==		== Examples ==

Barnabywalters: Moved discussion to a separate section

2013-06-06T16:37:52Z

Moved discussion to a separate section

@@ Line 1: / Line 1: @@
-'''h-example''' is a [[microformats-2]] schema (?) for representing Examples. It builds upon the classic [[hExample]] microformat.
+'''h-example''' is a [[microformats-2]] standard for representing Examples. It builds upon the classic [[hExample]] microformat.
 Translations: link to each translation as [[hCard]] does
 == Properties ==
 * '''p-name''' (was <code>fn</code>): The name of the example
-** E.G. <code>&lt;span class="p-name">Banana #1&lt;/span></code>
+** <code>&lt;span class="p-name">Banana #1&lt;/span></code>
+* '''p-summary''' (was <code>example-summary</code>): A short textual summary of the example
-TODO: how to handle properties which probably should be a nested microformat but can also be a plain value? E.G. author:
+** <code>&lt;p class="p-summary">An example of how examples may be exampled&lt;/p></code>
 * '''p-author''' (was <code>author</code>): 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.
+Implied examples, if any:
-Minimal sane example (if applicable e.g. implied h-card):
+Full example:
 <source lang=html4strict>
@@ Line 68: / Line 50: @@
 </source>
 </div>

Barnabywalters: /* Examples */ Split out JSON and HTML into columns

2013-06-06T16:31:14Z

Examples: Split out JSON and HTML into columns

← Older revision		Revision as of 16:31, 6 June 2013
Line 35:		Line 35:
	* actually, side by side doesn’t work so well, perhaps one after the other or switch between them or just have an external parser provide the JSON repr?		* actually, side by side doesn’t work so well, perhaps one after the other or switch between them or just have an external parser provide the JSON repr?

	~~<div style="width: 60%; float: left;">~~
	<source lang=html4strict>		<source lang=html4strict>
	<div class="h-example">		<div class="h-example">
Line 49:		Line 48:
	</div>		</div>
	</source>		</source>
	~~</div>~~
	~~<div style="width: 40%; float: left;">~~
	<source lang=javascript>		<source lang=javascript>
	{		{

Barnabywalters: /* Examples */ Added example JSON representation of example, notes on design

2013-06-06T16:29:28Z

Examples: Added example JSON representation of example, notes on design

@@ Line 32: / Line 32: @@
 Meatier example:
 <source lang=html4strict>
 <div class="h-example">
@@ Line 45: / Line 49: @@
 </div>
 </source>

Barnabywalters: /* Examples */ Added fleshed out example

2013-06-06T16:22:21Z

Examples: Added fleshed out example

← Older revision		Revision as of 16:22, 6 June 2013
Line 28:		Line 28:
	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.		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:		Minimal sane example (if applicable e.g. implied h-card):

	~~TODO~~		Meatier example:

	~~Meatier~~ example		<source lang=html4strict>
			<div class="h-example">
	~~TODO~~		<span class="p-name">An Example Example</span>

	~~Outlier~~/~~edge case~~ example?		<p>Published <time class="dt-published" datetime="2013-05-02 12:00:00">two days ago</time></p>

	~~TODO~~		<p class="p-author h-card">Mr. Author</p>

			<img class="u-photo" src="http://cdn.memegenerator.net/instances/400x/38481344.jpg" alt="" />

			<p class="p-summary">An example example showing you how to example</p>
			</div>
			</source>

Barnabywalters: /* Examples */ Added comments on showing JSON representation of all markup examples

2013-06-06T16:15:57Z

Examples: Added comments on showing JSON representation of all markup examples

← Older revision		Revision as of 16:15, 6 June 2013
Line 25:		Line 25:

	== Examples ==		== 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:		Minimal sane example:

Barnabywalters: /* Properties */ Fixed entities

2013-06-06T16:14:05Z

Properties: Fixed entities

← Older revision		Revision as of 16:14, 6 June 2013
Line 18:		Line 18:

	* '''p-name''' (was <code>fn</code>): The name of the example		* '''p-name''' (was <code>fn</code>): The name of the example
	** E.G. <code><span class="p-name">Banana #1</span></code>		** E.G. <code><span class="p-name">Banana #1</span></code>

	TODO: how to handle properties which probably should be a nested microformat but can also be a plain value? E.G. author:		TODO: how to handle properties which probably should be a nested microformat but can also be a plain value? E.G. author:

Barnabywalters: Initial braindump of individual mf2 spec page brainstorming

2013-06-06T16:11:36Z

Initial braindump of individual mf2 spec page brainstorming

New page

'''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. <code>p-name</code>
* 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 <code>fn</code>): The name of the example
** E.G. <code><span class="p-name">Banana #1</span></code>

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 <code>author</code>): The author of the example. Optionally an [[h-card]]

== Examples ==

Minimal sane example:

TODO

Meatier example

TODO

Outlier/edge case example?

TODO