hcard-parsing - Revision history

Aaronpk: Replace with {{DISPLAYTITLE:}}

2020-07-18T16:26:40Z

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

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

	by [http://tantek.com/log/ Tantek Çelik]		by [http://tantek.com/log/ Tantek Çelik]

Tantek: /* all properties */ generic time element parsing

2012-05-26T09:39:40Z

all properties: generic time element parsing

← Older revision		Revision as of 09:39, 26 May 2012
Line 138:		Line 138:
	* <code><br /></code> OR <code><hr /></code>: the value is the empty string. These two elements do not represent any semantics and thus it is probably an error (at least an abuse) for an author to use them with microformats class names. Nonetheless, if found, treat the value as empty.		* <code><br /></code> OR <code><hr /></code>: the value is the empty string. These two elements do not represent any semantics and thus it is probably an error (at least an abuse) for an author to use them with microformats class names. Nonetheless, if found, treat the value as empty.
	* <code><data value></code>: use the value of the 'value' attribute. If there is no 'value' attribute then use the contents of the element.		* <code><data value></code>: use the value of the 'value' attribute. If there is no 'value' attribute then use the contents of the element.
			* <code><time datetime></code>: use the value of the 'datetime' attribute. If there is no 'datetime' attribute then use the contents of the element.

	==== white-space handling ====		==== white-space handling ====

Tantek: /* all properties */ generic data element parsing

2012-05-26T09:37:51Z

all properties: generic data element parsing

← Older revision		Revision as of 09:37, 26 May 2012
Line 137:		Line 137:
	** For properties which take an ISO8601 datetime value, parsers should pad any necessary precision (e.g. seconds), and should normalize any datetimes with timezone offsets, (e.g. <code>20050814T2305-0700</code>) into UTC (<code>20050815T060500Z</code>). Note that floating dates and times MUST NOT be made into UTC/Z absolute time zoned values.		** For properties which take an ISO8601 datetime value, parsers should pad any necessary precision (e.g. seconds), and should normalize any datetimes with timezone offsets, (e.g. <code>20050814T2305-0700</code>) into UTC (<code>20050815T060500Z</code>). Note that floating dates and times MUST NOT be made into UTC/Z absolute time zoned values.
	* <code><br /></code> OR <code><hr /></code>: the value is the empty string. These two elements do not represent any semantics and thus it is probably an error (at least an abuse) for an author to use them with microformats class names. Nonetheless, if found, treat the value as empty.		* <code><br /></code> OR <code><hr /></code>: the value is the empty string. These two elements do not represent any semantics and thus it is probably an error (at least an abuse) for an author to use them with microformats class names. Nonetheless, if found, treat the value as empty.
			* <code><data value></code>: use the value of the 'value' attribute. If there is no 'value' attribute then use the contents of the element.

	==== white-space handling ====		==== white-space handling ====

Tantek: entry-title, auto toc

2010-07-26T23:02:13Z

entry-title, auto toc

← Older revision		Revision as of 23:02, 26 July 2010
Line 1:		Line 1:
	<h1>hCard parsing</h1>		<entry-title>hCard parsing</entry-title>
	~~{{TOC-right}}~~
	by [http://tantek.com/log/ Tantek Çelik]		by [http://tantek.com/log/ Tantek Çelik]

KitaitiMakoto: Reverted edits by Empress09 to last version by Tantek

2010-05-12T14:58:19Z

Reverted edits by Empress09 to last version by Tantek

← Older revision		Revision as of 14:58, 12 May 2010
Line 340:		Line 340:

	If one or more child elements with the class name of "value" are present inside the element for a property, then concatenate the node values of those child elements (in the order found) and use that as the value of the property. This would be before using the node value of the element for a property itself.		If one or more child elements with the class name of "value" are present inside the element for a property, then concatenate the node values of those child elements (in the order found) and use that as the value of the property. This would be before using the node value of the element for a property itself.

	~~==Related Links:==~~

	~~[http://www.lindaolsson.com/'''palm beach condos''']~~

	== References ==		== References ==

Empress09 at 00:50, 12 May 2010

2010-05-12T00:50:27Z

← Older revision		Revision as of 00:50, 12 May 2010
Line 340:		Line 340:

	If one or more child elements with the class name of "value" are present inside the element for a property, then concatenate the node values of those child elements (in the order found) and use that as the value of the property. This would be before using the node value of the element for a property itself.		If one or more child elements with the class name of "value" are present inside the element for a property, then concatenate the node values of those child elements (in the order found) and use that as the value of the property. This would be before using the node value of the element for a property itself.

			==Related Links:==

			[http://www.lindaolsson.com/'''palm beach condos''']

	== References ==		== References ==

Tantek: /* finding hCards */ linkfix

2010-05-03T21:24:56Z

finding hCards: linkfix

← Older revision		Revision as of 21:24, 3 May 2010
Line 33:		Line 33:
	An (X)HTML document indicates that it may contain [[hcard\|hCards]] by referencing the [[hcard-profile\|hCard XMDP profile]]. See [http://gmpg.org/xmdp/description XMDP] for more details.		An (X)HTML document indicates that it may contain [[hcard\|hCards]] by referencing the [[hcard-profile\|hCard XMDP profile]]. See [http://gmpg.org/xmdp/description XMDP] for more details.

	A parser finds [hcard\|hCards] in an (X)HTML context by looking for elements with the root class name ''vcard'' just as the following [http://www.w3.org/TR/REC-CSS2/selector.html#class-html CSS class selector] does:		A parser finds [[hcard\|hCards]] in an (X)HTML context by looking for elements with the root class name ''vcard'' just as the following [http://www.w3.org/TR/REC-CSS2/selector.html#class-html CSS class selector] does:
	<pre>		<pre>
	.vcard		.vcard

MikeKaply: /* parsing hCard properties and values */

2008-02-07T18:10:54Z

parsing hCard properties and values

← Older revision		Revision as of 18:10, 7 February 2008
Line 105:		Line 105:
	==== class value handling ====		==== class value handling ====

	For all properties, if the element for a property has one or more children with a class name of "value", then concatenate the node values for all those child elements with class name of "value", in their document order, and use that concatenation as the value of the property.		For all properties, if the element for a property has one or more children with a class name of "value", then concatenate the node values for all those child elements with class name of "value", in their document order, and use that concatenation as the value of the property. (also called value excerpting)

	==== more semantic exceptions ====		==== more semantic exceptions ====

Tantek: add explicit note about properties inside nested hCards only applying to the nested hCards, not any containing hCards, similarly nested hCalendar, hReview, xFolk. not finding nested hCard properties

2008-02-07T02:05:34Z

add explicit note about properties inside nested hCards only applying to the nested hCards, not any containing hCards, similarly nested hCalendar, hReview, xFolk. not finding nested hCard properties

← Older revision		Revision as of 02:05, 7 February 2008
Line 12:		Line 12:

	== scope ==		== scope ==

	Although this page is written specifically to explain how to parse [[hcard\|hCard]], the concepts and algorithms contained therein serve as an example for how other [[compound-microformat\|compound microformats]] are to be parsed.		Although this page is written specifically to explain how to parse [[hcard\|hCard]], the concepts and algorithms contained therein serve as an example for how other [[compound-microformat\|compound microformats]] are to be parsed.

	== URL handling ==		== URL handling ==

	An hCard parser may begin with a <abbr title="Uniform Resource Locator">URL</abbr> to retrieve.		An hCard parser may begin with a <abbr title="Uniform Resource Locator">URL</abbr> to retrieve.

Line 24:		Line 22:

	== root class name ==		== root class name ==

	Each compound microformat starts with a root element with a relatively unique class name. By that I mean a class name which isn't simply a common word, and is unlikely to have been used outside the context of the microformat. By choosing such a root class name the microformat avoids (for all practical purposes) colliding with existing class names that may exist within the (X)HTML context. This is essential to enabling such compound microformats to be ''embedded'' inside current, existing content, as well as future content.		Each compound microformat starts with a root element with a relatively unique class name. By that I mean a class name which isn't simply a common word, and is unlikely to have been used outside the context of the microformat. By choosing such a root class name the microformat avoids (for all practical purposes) colliding with existing class names that may exist within the (X)HTML context. This is essential to enabling such compound microformats to be ''embedded'' inside current, existing content, as well as future content.

Line 34:		Line 31:

	== finding hCards ==		== finding hCards ==

	An (X)HTML document indicates that it may contain [[hcard\|hCards]] by referencing the [[hcard-profile\|hCard XMDP profile]]. See [http://gmpg.org/xmdp/description XMDP] for more details.		An (X)HTML document indicates that it may contain [[hcard\|hCards]] by referencing the [[hcard-profile\|hCard XMDP profile]]. See [http://gmpg.org/xmdp/description XMDP] for more details.

Line 55:		Line 51:
	* <code><li class="reviewer vcard first"> </li></code>		* <code><li class="reviewer vcard first"> </li></code>

	Once the root element of an [[hCard]] is found, that element and all its descendants are all that is needed to parse the [[hCard]].		Once the root element of an [[hCard]] is found, that element and all its descendants (except those inside nested hCards) are all that is needed to parse the [[hCard]].

	Thus it is possible for a well-formed [[hCard]] to be extracted from an overall non well-formed context, if the parser has the ability to find elements by class name within that non well-formed context.		Thus it is possible for a well-formed [[hCard]] to be extracted from an overall non well-formed context, if the parser has the ability to find elements by class name within that non well-formed context.

			== nested hCards ==
			When parsing an hCard, if a parser finds a nested hCard, it should treat that hCard as its own object, and treat properties of the nested hCard as only belonging to the nested hCard, not the containing hCard.

			This is essential for example for handling use of the "agent" property to nest an hCard that is the agent of another hCard. See [[hcard-examples-rfc2426#AGENT_Example_2\|hCard examples from RFC2426 AGENT Example 2]] for an actual example.

			Similarly, parsers should treat nested [[hCalendar]], [[hReview]], [[hResume]] [[xFolk]] in the same way, properties inside them {{must}} only apply to the nested microformat, not to the containing microformat.

			All references below to "inside the hCard", "within the contents of the hCard", and similar phrasing {{must}} be interpreted with taking this nesting rule into account.

	== hCard properties ==		== hCard properties ==

	The complete list of class names for hCard properties are documented in the [[hcard-profile\|hCard profile]].		The complete list of class names for hCard properties are documented in the [[hcard-profile\|hCard profile]].

Line 70:		Line 74:

	=== finding hCard properties ===		=== finding hCard properties ===

	To parse an hCard for an hCard property (e.g. "fn"), the parser simply looks for the first element with that class name inside the hCard.		To parse an hCard for an hCard property (e.g. "fn"), the parser simply looks for the first element with that class name inside the hCard.

Line 76:		Line 79:

	<pre>		<pre>
	.vcard .fn		.vcard .fn /* note exception for nested hCards, see below */
	</pre>		</pre>

Line 82:		Line 85:

	Other properties, like "adr", "email", "url", "tel", etc., may (and often do) appear more than once, and thus the parser continues to look for each occurrence within the contents of the hCard.		Other properties, like "adr", "email", "url", "tel", etc., may (and often do) appear more than once, and thus the parser continues to look for each occurrence within the contents of the hCard.

			==== not finding nested hCard properties ====
			Per the [[#nested_hCards\|nested hCards rule]], properties inside a nested hCard {{must not}} apply to the current hCard being parsed. E.g. elements with class name "fn" that match this CSS selector:

			<pre>
			.vcard .vcard .fn
			</pre>

			{{must not}} affect the outer hCard.

	=== parsing hCard properties and values ===		=== parsing hCard properties and values ===

	In general, once an element for a property is found, that element is used for the value.		In general, once an element for a property is found, that element is used for the value.

Tantek: /* Value excerpting */ added detail about subtype specified with no descendant of the property element with class name "value"

2007-11-25T18:52:24Z

Value excerpting: added detail about subtype specified with no descendant of the property element with class name "value"

← Older revision		Revision as of 18:52, 25 November 2007
Line 187:		Line 187:

	Sometimes only part of an element which is the equivalent for a property should be used for the value of the property. This typically occurs when a property has a subtype, like TEL. For this purpose, the special class name "value" is introduced to excerpt out the subset of the element that is the value of the property.		Sometimes only part of an element which is the equivalent for a property should be used for the value of the property. This typically occurs when a property has a subtype, like TEL. For this purpose, the special class name "value" is introduced to excerpt out the subset of the element that is the value of the property.

			Per the section in hCard on [[hcard#type_with_unspecified_value\|type with unspecified value]], if the subtype is specified on a property, and there is no descendant of the property element with class name of "value", then the remainder (excluding the subtype) of the property element is considered the value.

	== Include Pattern and Table Headers ==		== Include Pattern and Table Headers ==