microformats2-faq - Revision history

GRegorLove: s///

2023-07-26T21:32:02Z

s/<source>/<syntaxhighlight>/

← Older revision		Revision as of 21:32, 26 July 2023
Line 8:		Line 8:

	A: '''Use the microformats2 class names first,''' and in equivalent pairs when marking up more than one property. E.g.		A: '''Use the microformats2 class names first,''' and in equivalent pairs when marking up more than one property. E.g.
	<~~source~~ lang=~~html4strict~~>		<syntaxhighlight lang="html">
	<span class="h-card vcard">		<span class="h-card vcard">
	<a class="p-name fn p-org org u-url url"		<a class="p-name fn p-org org u-url url"
Line 19:		Line 19:
	<time class="dt-start dtstart">2012-11-14 18:00</time>		<time class="dt-start dtstart">2012-11-14 18:00</time>
	</span>		</span>
	</~~source~~>		</syntaxhighlight>
	Here's how:		Here's how:
	* [[microformats2#backward_compatible\|using microformats2 and backward compatible microformats]].		* [[microformats2#backward_compatible\|using microformats2 and backward compatible microformats]].
Line 100:		Line 100:
	E.g. this from the microformats2 page:		E.g. this from the microformats2 page:

	<~~source~~ lang=~~html4strict~~>		<syntaxhighlight lang="html">
	<h1 class="h-card">		<h1 class="h-card">
	<span class="p-name">		<span class="p-name">
Line 108:		Line 108:
	</span>		</span>
	</h1>		</h1>
	</~~source~~>		</syntaxhighlight>

	Here is the same markup with RDFa 1.1 syntax, using an implied or explicit RDFa Profile from somewhere else (undefined):		Here is the same markup with RDFa 1.1 syntax, using an implied or explicit RDFa Profile from somewhere else (undefined):

	<~~source~~ lang=~~html4strict~~>		<syntaxhighlight lang="html">
	<h1 typeof="h-card">		<h1 typeof="h-card">
	<span property="p-name">		<span property="p-name">
Line 120:		Line 120:
	</span>		</span>
	</h1>		</h1>
	</~~source~~>		</syntaxhighlight>

	The similarity of these two markup examples implies that it may be possible to extend RDFa 1.1 compliant parsers to become compliant microformats2 parsers.		The similarity of these two markup examples implies that it may be possible to extend RDFa 1.1 compliant parsers to become compliant microformats2 parsers.

Tantek: /* why are microformats2 properties prefixed */ link to main page on prefixes

2021-08-17T15:14:55Z

why are microformats2 properties prefixed: link to main page on prefixes

← Older revision		Revision as of 15:14, 17 August 2021
Line 27:		Line 27:

	== why are microformats2 properties prefixed ==		== why are microformats2 properties prefixed ==
			{{main\|prefixes}}
	<span id="why_are_microformats_2_properties_prefixed">Q: Why do microformats2 property class names have prefixes like 'p-', 'u-', 'dt-', 'e-' ?</span>		<span id="why_are_microformats_2_properties_prefixed">Q: Why do microformats2 property class names have prefixes like 'p-', 'u-', 'dt-', 'e-' ?</span>

Aaronpk: Replace with {{DISPLAYTITLE:}}

2020-07-18T16:29:26Z

Replace <entry-title> with {{DISPLAYTITLE:}}

← Older revision		Revision as of 16:29, 18 July 2020
Line 1:		Line 1:
	~~<entry-title>~~microformats2 FAQ~~</entry-title>~~		{{DISPLAYTITLE:microformats2 FAQ}}

	Frequently asked questions about [[microformats2]].		Frequently asked questions about [[microformats2]].

Tantek: collapse similar faqs, use microformats2 (oneword)

2019-01-25T19:39:34Z

collapse similar faqs, use microformats2 (oneword)

← Older revision		Revision as of 19:39, 25 January 2019
Line 26:		Line 26:
	* The prefixes (h-, p-, etc.) of microformats2 class names provide easier recognition (as class names ''for'' microformats), and when followed by the similarly named existing class name, they're more easily recognized as related and thus kept together when the markup is moved or maintained over time.		* The prefixes (h-, p-, etc.) of microformats2 class names provide easier recognition (as class names ''for'' microformats), and when followed by the similarly named existing class name, they're more easily recognized as related and thus kept together when the markup is moved or maintained over time.

	== why are ~~microformats 2~~ properties prefixed ==		== why are microformats2 properties prefixed ==
	Q: Why do ~~microformats 2~~ property class names have prefixes like 'p-', 'u-', 'dt-', 'e-' ?		<span id="why_are_microformats_2_properties_prefixed">Q: Why do microformats2 property class names have prefixes like 'p-', 'u-', 'dt-', 'e-' ?</span>

	A: For the benefit of both web authors and developers of parsers/consumers. By using class names with a small handful of short easily recognizable prefixes, it's easier to see which class names belong to microformats, and which may serve other purposes on the page. This helps web designers better recognize and maintain support for microformats across site redesigns for example. In particular:		A: For the benefit of both web authors and developers of parsers/consumers. By using class names with a small handful of short easily recognizable prefixes, it's easier to see which class names belong to microformats, and which may serve other purposes on the page. This helps web designers better recognize and maintain support for microformats across site redesigns for example. In particular:
Line 34:		Line 34:
	* 'dt-' is for date and time related properties that have a particular format themselves, and ideally should make good use of the HTML5 <time> element, though for backward compatibility they work on any element.		* 'dt-' is for date and time related properties that have a particular format themselves, and ideally should make good use of the HTML5 <time> element, though for backward compatibility they work on any element.
	* Finally, 'e-' is for properties whose value is the entirety of the text and HTML inside an element, as represented by the element's DOM. The 'e-entry-content' property from hAtom for example permits marking up and parsing/extracting an entire post from an HTML blog post page to an Atom feed entry with full markup/DOM fidelity of the original post.		* Finally, 'e-' is for properties whose value is the entirety of the text and HTML inside an element, as represented by the element's DOM. The 'e-entry-content' property from hAtom for example permits marking up and parsing/extracting an entire post from an HTML blog post page to an Atom feed entry with full markup/DOM fidelity of the original post.
	Since prefixes determine specific parsing rules, parser developers are able to write simple and efficient generic ~~microformats 2.0~~ parsers without needing to know any specific vocabularies, either currently or in the future. These are both advantages of ~~microformats 2.0~~ over original microformats. For more details, including why and how ~~microformats 2.0~~ class name prefixes were developed, see: [[microformats2-prefixes]].		Since prefixes determine specific parsing rules, parser developers are able to write simple and efficient generic microformats2 parsers without needing to know any specific vocabularies, either currently or in the future. These are both advantages of microformats2 over original microformats. For more details, including why and how microformats2 class name prefixes were developed, see: [[microformats2-prefixes]].

	== how do you use experimental microformats and property names ==		== how do you use experimental microformats and property names ==
Line 77:		Line 77:
	In practice this has yet to be seen, thus for now, any concerns about awkward or confusing implied names for things like h-adr or h-geo are categorized as a "theoretical issue". If someone finds a real world example where the implied "name" causes a bad user experience in some actual use-case, then we can re-explore this topic.		In practice this has yet to be seen, thus for now, any concerns about awkward or confusing implied names for things like h-adr or h-geo are categorized as a "theoretical issue". If someone finds a real world example where the implied "name" causes a bad user experience in some actual use-case, then we can re-explore this topic.

	== does ~~microformats 2 combine~~ vocabularies ~~and syntax~~ ==		== how does microformats2 separate syntax and vocabularies ==
	Q: ~~Does microformats 2 combine~~ vocabularies ~~and syntax~~?		<span id="does_microformats_2_split_vocabularies_and_syntax">Q: How does microformats2 separate syntax and vocabularies?</span>

	A: ~~No. From~~ a parsing ~~perspective,~~ microformats ~~2 syntax~~ is independent of any ~~particular~~ vocabulary~~. There are some~~ [[~~microformats2~~-~~brainstorming~~]] ~~proposals that take advantage~~ of ~~semantic HTML to imply certain~~ common ~~properties~~ (name, url, photo) ~~but that's an extremely limited set that's been~~ determined from common markup patterns.		A: microformats2 [[microformats2-parsing\|specifies a syntax for parsing microformats]] which is independent of any specific vocabulary such as [[h-card]], [[h-entry]], or [[h-event]], each of which themselves defines vocabularies and backward compatibility handling for their classic microformats equivalents. Thus microformats2 separates specific vocabularies and syntax, whereas classic microformats combined the rules for parsing and specific vocabularies. There are three common property names (name, url, photo) determined from common markup patterns that the generic parsing algorithm is specified to imply. These apply across all vocabularies and thus are not dependent on any specific vocabulary.

	=~~= does microformats 2 split vocabularies and syntax ==~~		<span id="does_microformats_2_combine_vocabularies_and_syntax">Q: Does microformats2 combine vocabularies and syntax?</span>
	Q: Does ~~microformats 2 split~~ vocabularies and syntax?

	A: ~~Yes~~, ~~microformats 2 specifies a~~ syntax ~~for parsing microformats which~~ is independent of any ~~specific~~ vocabulary~~. So in that sense it can be said that microformats 2 splits vocabularies and syntax~~.		A: No. From a parsing perspective, microformats2 syntax is independent of any particular vocabulary.

	~~== are microformats 2 vocabularies available to other languages ==~~
	~~Q: Are microformats 2 vocabularies available to other languages?~~

	~~A: ''Existing'' microformats~~ vocabularies ~~have [http://microformats.org/profile profiles] which are already~~ available to other languages. Each term is defined by a URL ending in a hash and the term. This is due to the design of [[XMDP]] which deliberately produces such URLs which are compatible with microdata, RDF, and any other LinkedData system. microformats 2 vocabularies ~~will use the same profile format and thus also be~~ available to other languages.		== are microformats2 vocabularies available to other languages ==
			<span id="are_microformats_2_vocabularies_available_to_other_languages">Q: Are microformats2 vocabularies available to other languages?</span>

	~~== how do you convert a~~ microformats ~~2 example~~ to ~~RDFa syntax ==~~		A: ''Existing'' microformats vocabularies have [http://microformats.org/profile profiles] which are already available to other languages. Each term is defined by a URL ending in a hash and the term. This is due to the design of [[XMDP]] which deliberately produces such URLs which are compatible with microdata, RDF, and any other LinkedData system. microformats2 vocabularies will use the same profile format and thus also be available to other languages.
	~~Q: How do you convert~~ a ~~microformats 2 example~~ to ~~RDFa 1~~.~~1 syntax?~~

	A: ~~In short~~ you ~~have~~ to ~~use the 'typeof' attribute for the microformats 2 root class name, and use the 'property' attribute for microformats 2 properties~~.		== how do you convert a microformats2 example to RDFa syntax ==
			<span id="how_do_you_convert_a_microformats_2_example_to_RDFa_syntax">Q: How do you convert a microformats2 example to RDFa 1.1 syntax?</span>

	E.g. this from the ~~microformats 2~~ page:		A: In short you may use the 'typeof' attribute for the microformats2 root class name, and use the 'property' attribute for microformats2 properties.

			E.g. this from the microformats2 page:

	<source lang=html4strict>		<source lang=html4strict>
Line 121:		Line 121:
	</source>		</source>

	The similarity of these two markup examples implies that it may be possible to extend RDFa 1.1 compliant parsers to become compliant ~~microformats 2~~ parsers.		The similarity of these two markup examples implies that it may be possible to extend RDFa 1.1 compliant parsers to become compliant microformats2 parsers.

	== see also ==		== see also ==

Tantek: /* how do you use experimental microformats and property names */ see vendor-prefixes\

2017-03-24T18:44:55Z

how do you use experimental microformats and property names: see vendor-prefixes\

← Older revision		Revision as of 18:44, 24 March 2017
Line 48:		Line 48:
	* <code>h-goog-volcano</code> for a proprietary "volcano" object		* <code>h-goog-volcano</code> for a proprietary "volcano" object
	* <code>p-osm-shop</code> for an OSM-site specific "shop" property		* <code>p-osm-shop</code> for an OSM-site specific "shop" property

			See '''[[vendor-prefixes]]''' for currently used and proposed vendor-prefixes (in case there already is one for the vendor-specific stuff you want to publish or consume, re-use instead of reinvent etc.).

	'''2. Experimental''' - ideas that authors/developers want to experiment with in the wild without going through the microformats [[process]] to craft well-researched microformats and property names. Or for experimental formats that you're not even sure would be worth trying to standardize, may apply to a narrow / small community etc. (which might still grow as a result of experimentation, and thus eventually merit a format).		'''2. Experimental''' - ideas that authors/developers want to experiment with in the wild without going through the microformats [[process]] to craft well-researched microformats and property names. Or for experimental formats that you're not even sure would be worth trying to standardize, may apply to a narrow / small community etc. (which might still grow as a result of experimentation, and thus eventually merit a format).

Tantek: /* how do you use experimental microformats and property names */ h-recipe

2017-03-24T18:39:07Z

how do you use experimental microformats and property names: h-recipe

← Older revision		Revision as of 18:39, 24 March 2017
Line 53:		Line 53:
	Use <code>-x-</code> immediately after a microformats2 prefix, e.g.:		Use <code>-x-</code> immediately after a microformats2 prefix, e.g.:
	* <code>h-x-test-fixture</code> for an experimental "text-fixture" format (e.g. for a [[test-suite]]).		* <code>h-x-test-fixture</code> for an experimental "text-fixture" format (e.g. for a [[test-suite]]).
	* <code>p-x-prep-time</code> - a possible experimental preparation time property to be added to [[~~hRecipe~~]] upon consideration/documentation of real-world usage/uptake.		* <code>p-x-prep-time</code> - a possible experimental preparation time property to be added to [[h-recipe]] upon consideration/documentation of real-world usage/uptake.

	== how do h-adr and h-geo work with an implied name property ==		== how do h-adr and h-geo work with an implied name property ==

TomMorris: /* see also */ adding experimental properties link

2015-07-11T14:50:27Z

see also: adding experimental properties link

← Older revision		Revision as of 14:50, 11 July 2015
Line 124:		Line 124:
	* [[microformats2]]		* [[microformats2]]
	* [[microformats2-brainstorming]]		* [[microformats2-brainstorming]]
			* [[microformats2-experimental-properties]]
	* [[microformats2-prefixes]]		* [[microformats2-prefixes]]
	* [[microformats2-faq]]		* [[microformats2-faq]]

Tantek: How do you use experimental microformats and property names

2012-12-02T18:49:09Z

How do you use experimental microformats and property names

@@ Line 35: / Line 35: @@
 * Finally, 'e-' is for properties whose value is the entirety of the text and HTML inside an element, as represented by the element's DOM. The 'e-entry-content' property from hAtom for example permits marking up and parsing/extracting an entire post from an HTML blog post page to an Atom feed entry with full markup/DOM fidelity of the original post.
 Since prefixes determine specific parsing rules, parser developers are able to write simple and efficient generic microformats 2.0 parsers without needing to know any specific vocabularies, either currently or in the future. These are both advantages of microformats 2.0 over original microformats. For more details, including why and how microformats 2.0 class name prefixes were developed, see: [[microformats2-prefixes]].
 == how do h-adr and h-geo work with an implied name property ==

Tantek: when using both h-card and vcard which should be first and why

2012-11-16T22:56:20Z

when using both h-card and vcard which should be first and why

← Older revision		Revision as of 22:56, 16 November 2012
Line 2:		Line 2:

	Frequently asked questions about [[microformats2]].		Frequently asked questions about [[microformats2]].

			== when using both h-card and vcard which should be first and why ==
			Q: When using both microformats2 and traditional microformats for backwards compatibility, which class name should go first and why?
			Another example: should "h-event" be first (before the "vevent") in the class attribute?

			A: '''Use the microformats2 class names first,''' and in equivalent pairs when marking up more than one property. E.g.
			<source lang=html4strict>
			<span class="h-card vcard">
			<a class="p-name fn p-org org u-url url"
			href="http://microformats.org/">microformats.org</a>
			</span>

			<span class="h-event vevent">
			<a class="p-name summary u-url url"
			href="http://plancast.com/p/e83d">microformats meetup SF</a>,
			<time class="dt-start dtstart">2012-11-14 18:00</time>
			</span>
			</source>
			Here's how:
			* [[microformats2#backward_compatible\|using microformats2 and backward compatible microformats]].

			And why:
			* The prefixes (h-, p-, etc.) of microformats2 class names provide easier recognition (as class names ''for'' microformats), and when followed by the similarly named existing class name, they're more easily recognized as related and thus kept together when the markup is moved or maintained over time.

	== why are microformats 2 properties prefixed ==		== why are microformats 2 properties prefixed ==

Tantek: how do h-adr and h-geo work with an implied name property

2012-10-23T20:35:12Z

how do h-adr and h-geo work with an implied name property

@@ Line 12: / Line 12: @@
 * Finally, 'e-' is for properties whose value is the entirety of the text and HTML inside an element, as represented by the element's DOM. The 'e-entry-content' property from hAtom for example permits marking up and parsing/extracting an entire post from an HTML blog post page to an Atom feed entry with full markup/DOM fidelity of the original post.
 Since prefixes determine specific parsing rules, parser developers are able to write simple and efficient generic microformats 2.0 parsers without needing to know any specific vocabularies, either currently or in the future. These are both advantages of microformats 2.0 over original microformats. For more details, including why and how microformats 2.0 class name prefixes were developed, see: [[microformats2-prefixes]].
 == does microformats 2 combine vocabularies and syntax ==