microformats2-parsing - Revision history

Tantek: Proposed for e- parsing, normalized absolute URLs in all URL attributes except those with fragment only values, to solve issue 38 and allow for relative links to inside e-* properties to keep working in embedded use-cases

2023-02-08T19:23:16Z

Proposed for e- parsing, normalized absolute URLs in all URL attributes except those with fragment only values, to solve issue 38 and allow for relative links to *inside* e-* properties to keep working in embedded use-cases

← Older revision		Revision as of 19:23, 8 February 2023
Line 103:		Line 103:

	* return a dictionary with two keys:		* return a dictionary with two keys:
	** <code>html</code>: the <code>innerHTML</code> of the element by using the [https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments HTML spec: Serializing HTML Fragments algorithm], with leading/trailing spaces removed.		** <code>html</code>: the <code>innerHTML</code> of the element by using the [https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments HTML spec: Serializing HTML Fragments algorithm], with leading/trailing spaces removed. Proposed: and normalized absolute URLs in all URL attributes except those that are fragment-only, e.g. start with '#'.([https://github.com/microformats/microformats2-parsing/issues/38 issue 38])
	** <code>value</code>: the <code>textContent</code> of the element after:		** <code>value</code>: the <code>textContent</code> of the element after:
	*** dropping any nested <code><script></code> & <code><style></code> elements;		*** dropping any nested <code><script></code> & <code><style></code> elements;

Tantek: editorial: s/whitespace/spaces, and add note in HTML parsing rules clarifying existing meaning of 'spaces' meaning HTML collapsible blank spaces (which is what’s implemented)

2023-02-08T19:17:00Z

editorial: s/whitespace/spaces, and add note in HTML parsing rules clarifying existing meaning of 'spaces' meaning HTML collapsible blank spaces (which is what’s implemented)

Tantek: add "Proposed:" "or no e-*" to both implied 'photo' and 'url' properties, issue # tbd, use-case https://geekosaur.com/post/geekosaur-news-26/

2023-02-01T23:46:13Z

add "Proposed:" "or no e-*" to both implied 'photo' and 'url' properties, issue # tbd, use-case https://geekosaur.com/post/geekosaur-news-26/

← Older revision		Revision as of 23:46, 1 February 2023
Line 128:		Line 128:
	*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present;		*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present;
	** remove all leading/trailing whitespace		** remove all leading/trailing whitespace
	* if no explicit "<code>photo</code>" property, and no other explicit <code>u-*</code> properties, and no nested microformats,		* if no explicit "<code>photo</code>" property, and no other explicit <code>u-</code> (Proposed: change to: <code>u-</code> or <code>e-*</code>) properties, and no nested microformats,
	* then imply by:		* then imply by:
	** if <code>img.h-x[src]</code>, then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo		** if <code>img.h-x[src]</code>, then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo
Line 137:		Line 137:
	** else if <code>.h-x>:only-child:not[.h-]>object[data]:only-of-type:not[.h-]</code>, then use that <code>object</code>’s <code>data</code> for photo		** else if <code>.h-x>:only-child:not[.h-]>object[data]:only-of-type:not[.h-]</code>, then use that <code>object</code>’s <code>data</code> for photo
	** if there is a gotten photo value, return the normalized absolute URL of it, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).		** if there is a gotten photo value, return the normalized absolute URL of it, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).
	* if no explicit "<code>url</code>" property, and no other explicit <code>u-*</code> properties, and no nested microformats,		* if no explicit "<code>url</code>" property, and no other explicit <code>u-</code> (Proposed: change to: <code>u-</code> or <code>e-*</code>) properties, and no nested microformats,
	* then imply by:		* then imply by:
	** if <code>a.h-x[href]</code> or <code>area.h-x[href]</code> then use that <code>[href]</code> for url		** if <code>a.h-x[href]</code> or <code>area.h-x[href]</code> then use that <code>[href]</code> for url

Btrem: Fix: corrects syntaxhightlight lang attributes

2022-11-30T23:49:31Z

Fix: corrects syntaxhightlight lang attributes

← Older revision		Revision as of 23:49, 30 November 2022
Line 19:		Line 19:
	To parse a document for microformats, follow the HTML parsing rules and do the following:		To parse a document for microformats, follow the HTML parsing rules and do the following:
	* start with an empty JSON "items" array and "rels" & "rel-urls" hashes:		* start with an empty JSON "items" array and "rels" & "rel-urls" hashes:
	<syntaxhighlight lang=~~javascript~~>		<syntaxhighlight lang=json>
	{		{
	"items": [],		"items": [],
Line 171:		Line 171:

	E.g. parsing this markup:		E.g. parsing this markup:
	<syntaxhighlight lang=~~xml~~>		<syntaxhighlight lang=html>
	<a rel="author" href="http://example.com/a">author a</a>		<a rel="author" href="http://example.com/a">author a</a>
	<a rel="author" href="http://example.com/b">author b</a>		<a rel="author" href="http://example.com/b">author b</a>
Line 183:		Line 183:

	Would generate this JSON:		Would generate this JSON:
	<syntaxhighlight lang=~~javascript~~>		<syntaxhighlight lang=json>
	{		{
	"items": [],		"items": [],

Btrem: Fix: replaces deprecated tag with

2022-11-30T23:46:07Z

Fix: replaces deprecated <source> tag with <syntaxhighlight>

← Older revision		Revision as of 23:46, 30 November 2022
Line 19:		Line 19:
	To parse a document for microformats, follow the HTML parsing rules and do the following:		To parse a document for microformats, follow the HTML parsing rules and do the following:
	* start with an empty JSON "items" array and "rels" & "rel-urls" hashes:		* start with an empty JSON "items" array and "rels" & "rel-urls" hashes:
	<~~source~~ lang=javascript>		<syntaxhighlight lang=javascript>
	{		{
	"items": [],		"items": [],
Line 25:		Line 25:
	"rel-urls": {}		"rel-urls": {}
	}		}
	</~~source~~>		</syntaxhighlight>
	* parse the root element for class microformats, adding to the JSON items array accordingly		* parse the root element for class microformats, adding to the JSON items array accordingly
	* parse all hyperlink (<code><a> <area> <link></code>) elements for rel microformats, adding to the JSON rels & rel-urls hashes accordingly		* parse all hyperlink (<code><a> <area> <link></code>) elements for rel microformats, adding to the JSON rels & rel-urls hashes accordingly
Line 171:		Line 171:

	E.g. parsing this markup:		E.g. parsing this markup:
	<~~source~~ lang=xml>		<syntaxhighlight lang=xml>
	<a rel="author" href="http://example.com/a">author a</a>		<a rel="author" href="http://example.com/a">author a</a>
	<a rel="author" href="http://example.com/b">author b</a>		<a rel="author" href="http://example.com/b">author b</a>
Line 180:		Line 180:
	media="handheld"		media="handheld"
	hreflang="fr">French mobile homepage</a>		hreflang="fr">French mobile homepage</a>
	</~~source~~>		</syntaxhighlight>

	Would generate this JSON:		Would generate this JSON:
	<~~source~~ lang=javascript>		<syntaxhighlight lang=javascript>
	{		{
	"items": [],		"items": [],
Line 217:		Line 217:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

Tantek: editorial: de-dup issues section, already have links in header, frag to maintain section link

2022-02-03T18:11:29Z

editorial: de-dup issues section, already have links in header, frag to maintain section link

← Older revision		Revision as of 18:11, 3 February 2022
Line 5:		Line 5:
	:This is a '''Living Specification''' with several interoperable [[#implementations\|implementations]]. This specification is stable, subject to editorial changes only for improving clarity of existing meaning. While substantive changes are unexpected, it is a living specification subject to substantive change by issues and errata filed in response to implementation experience, requiring consensus among participating implementers (since 2015-01-21) as part of an explicit [[#change_control\|change control]] process. There are currently no draft or proposed new features in this specification, and if any were to be added, they would be explicitly labeled as such.<br/>Note: This specification is only marked as a "Draft Specification" because of pending edits from [[microformats2-parsing-issues\|resolved issues before 2016-06-20]]. Once those edits have been completed, the link to <nowiki>[[Category:Draft Specifications]]</nowiki> at the bottom of this document should be changed to <nowiki>[[Category:Specifications]]</nowiki>.		:This is a '''Living Specification''' with several interoperable [[#implementations\|implementations]]. This specification is stable, subject to editorial changes only for improving clarity of existing meaning. While substantive changes are unexpected, it is a living specification subject to substantive change by issues and errata filed in response to implementation experience, requiring consensus among participating implementers (since 2015-01-21) as part of an explicit [[#change_control\|change control]] process. There are currently no draft or proposed new features in this specification, and if any were to be added, they would be explicitly labeled as such.<br/>Note: This specification is only marked as a "Draft Specification" because of pending edits from [[microformats2-parsing-issues\|resolved issues before 2016-06-20]]. Once those edits have been completed, the link to <nowiki>[[Category:Draft Specifications]]</nowiki> at the bottom of this document should be changed to <nowiki>[[Category:Specifications]]</nowiki>.
	;Participate		;Participate
	:[https://github.com/microformats/microformats2-parsing/issues Open Issues]		:<span id="issues">[https://github.com/microformats/microformats2-parsing/issues Open Issues]</span>
	:[[microformats2-parsing-issues\|Resolved issues before 2016-06-20]]		:[[microformats2-parsing-issues\|Resolved issues before 2016-06-20]]
	:[[IRC]]: [irc://irc.libera.chat/microformats #microformats on Libera]		:[[IRC]]: [irc://irc.libera.chat/microformats #microformats on Libera]
Line 266:		Line 266:
	See the FAQ:		See the FAQ:
	* [[microformats2-parsing-faq]]		* [[microformats2-parsing-faq]]

	~~== issues ==~~
	~~See the issues page:~~
	* [[microformats2-parsing-issues]]

	== implementations ==		== implementations ==

GRegorLove: libera.chat link

2021-10-20T16:18:50Z

libera.chat link

← Older revision		Revision as of 16:18, 20 October 2021
Line 7:		Line 7:
	:[https://github.com/microformats/microformats2-parsing/issues Open Issues]		:[https://github.com/microformats/microformats2-parsing/issues Open Issues]
	:[[microformats2-parsing-issues\|Resolved issues before 2016-06-20]]		:[[microformats2-parsing-issues\|Resolved issues before 2016-06-20]]
	:[[IRC]]: [irc://irc.~~freenode~~.~~net~~/microformats #microformats on ~~Freenode~~]		:[[IRC]]: [irc://irc.libera.chat/microformats #microformats on Libera]
	<div class="p-author h-card vcard">		<div class="p-author h-card vcard">
	;<span class="p-role role">Editor</span>		;<span class="p-role role">Editor</span>

Aaronpk: Replace with {{DISPLAYTITLE:}}

2020-07-18T16:29:54Z

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

← Older revision		Revision as of 16:29, 18 July 2020
Line 1:		Line 1:
	~~<entry-title>~~microformats2 parsing specification~~</entry-title>~~		{{DISPLAYTITLE:microformats2 parsing specification}}
	<dfn style="font-style:normal;font-weight:bold">[[microformats2]]</dfn> is a simple, open format for marking up data in HTML. The microformats2 parsing specification describes how to [[#implementations\|implement]] a microformats2 parser, independent of any specific vocabularies.		<dfn style="font-style:normal;font-weight:bold">[[microformats2]]</dfn> is a simple, open format for marking up data in HTML. The microformats2 parsing specification describes how to [[#implementations\|implement]] a microformats2 parser, independent of any specific vocabularies.

Tantek: incorporate proposal for issue 2, edits reviewed, test case provided in issue https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-450669274

2019-01-01T06:04:28Z

incorporate proposal for issue 2, edits reviewed, test case provided in issue https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-450669274

Tantek: issue 44 proposal accepted per resolution https://github.com/microformats/microformats2-parsing/issues/44#issuecomment-450613049

2018-12-31T06:36:35Z

issue 44 proposal accepted per resolution https://github.com/microformats/microformats2-parsing/issues/44#issuecomment-450613049

← Older revision		Revision as of 06:36, 31 December 2018
Line 40:		Line 40:
	**** <code>type: <nowiki>[array of unique microformat "h-*" type(s) on the element sorted alphabetically]</nowiki>,</code>		**** <code>type: <nowiki>[array of unique microformat "h-*" type(s) on the element sorted alphabetically]</nowiki>,</code>
	**** <code>properties: { } </code> - to be filled in when that element itself is parsed for microformats properties		**** <code>properties: { } </code> - to be filled in when that element itself is parsed for microformats properties
	**** ~~PROPOSED ([https://github.com/microformats/microformats2-parsing/issues/44 per issue 44]):~~ if the element has a non-empty <code>id</code> attribute:		**** if the element has a non-empty <code>id</code> attribute:
	***** <code>id:</code> string value of element's id attribute		***** <code>id:</code> string value of element's id attribute
	*** parse child elements (document order) by:		*** parse child elements (document order) by:

← Older revision		Revision as of 19:17, 8 February 2023
Line 72:		Line 72:
	** dropping any nested <code><script></code> & <code><style></code> elements;		** dropping any nested <code><script></code> & <code><style></code> elements;
	** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present; otherwise their <code>src</code> attribute, if present, adding a space at the beginning and end, resolving the URL if it’s relative;		** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present; otherwise their <code>src</code> attribute, if present, adding a space at the beginning and end, resolving the URL if it’s relative;
	** removing all leading/trailing ~~whitespace~~		** removing all leading/trailing spaces

	==== parsing a <code>u-</code> property ====		==== parsing a <code>u-</code> property ====
Line 86:		Line 86:
	* else if <code>abbr.u-x[title]</code>, then get the <code>title</code> attribute		* else if <code>abbr.u-x[title]</code>, then get the <code>title</code> attribute
	* else if <code>data.u-x[value]</code> or <code>input.u-x[value]</code>, then get the <code>value</code> attribute		* else if <code>data.u-x[value]</code> or <code>input.u-x[value]</code>, then get the <code>value</code> attribute
	* else get the <code>textContent</code> of the element after removing all leading/trailing ~~whitespace~~ and nested <code><script></code> & <code><style></code> elements		* else get the <code>textContent</code> of the element after removing all leading/trailing spaces and nested <code><script></code> & <code><style></code> elements
	* return the normalized absolute URL of the gotten value, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).		* return the normalized absolute URL of the gotten value, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).

Line 97:		Line 97:
	* else if <code>abbr.dt-x[title]</code>, then return the <code>title</code> attribute		* else if <code>abbr.dt-x[title]</code>, then return the <code>title</code> attribute
	* else if <code>data.dt-x[value]</code> or <code>input.dt-x[value]</code>, then return the <code>value</code> attribute		* else if <code>data.dt-x[value]</code> or <code>input.dt-x[value]</code>, then return the <code>value</code> attribute
	* else return the <code>textContent</code> of the element after removing all leading/trailing ~~whitespace~~ and nested <code><script></code> & <code><style></code> elements.		* else return the <code>textContent</code> of the element after removing all leading/trailing spaces and nested <code><script></code> & <code><style></code> elements.

	==== parsing an <code>e-</code> property ====		==== parsing an <code>e-</code> property ====
Line 103:		Line 103:

	* return a dictionary with two keys:		* return a dictionary with two keys:
	** <code>html</code>: the <code>innerHTML</code> of the element by using the [https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments HTML spec: Serializing HTML Fragments algorithm], with leading/trailing ~~whitespace~~ removed.		** <code>html</code>: the <code>innerHTML</code> of the element by using the [https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments HTML spec: Serializing HTML Fragments algorithm], with leading/trailing spaces removed.
	** <code>value</code>: the <code>textContent</code> of the element after:		** <code>value</code>: the <code>textContent</code> of the element after:
	*** dropping any nested <code><script></code> & <code><style></code> elements;		*** dropping any nested <code><script></code> & <code><style></code> elements;
	*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present; otherwise their <code>src</code> attribute, if present, adding a space at the beginning and end, resolving the URL if it’s relative;		*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present; otherwise their <code>src</code> attribute, if present, adding a space at the beginning and end, resolving the URL if it’s relative;
	*** removing all leading/trailing ~~whitespace~~		*** removing all leading/trailing spaces


Line 127:		Line 127:
	*** dropping any nested <code><script></code> & <code><style></code> elements;		*** dropping any nested <code><script></code> & <code><style></code> elements;
	*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present;		*** replacing any nested <code><img></code> elements with their <code>alt</code> attribute, if present;
	** remove all leading/trailing ~~whitespace~~		** remove all leading/trailing spaces
	* if no explicit "<code>photo</code>" property, and no other explicit <code>u-</code> (Proposed: change to: <code>u-</code> or <code>e-*</code>) properties, and no nested microformats,		* if no explicit "<code>photo</code>" property, and no other explicit <code>u-</code> (Proposed: change to: <code>u-</code> or <code>e-*</code>) properties, and no nested microformats,
	* then imply by:		* then imply by:
Line 245:		Line 245:
	* ignore <code><template></code> elements - stuff between <code><template></code> tags don't end up in the DOM		* ignore <code><template></code> elements - stuff between <code><template></code> tags don't end up in the DOM
	** test-case in the wild: http://sixtwothree.org/blog/now-accepting-webmentions/		** test-case in the wild: http://sixtwothree.org/blog/now-accepting-webmentions/

			'spaces' in the algorithm refers to HTML collapsible blank spaces of any kind, whether ' ' or linefeed, carriage return, etc.

	== note backward compatibility details ==		== note backward compatibility details ==

← Older revision		Revision as of 06:04, 1 January 2019
Line 79:		Line 79:

	* if <code>a.u-x[href]</code> or <code>area.u-x[href]</code> or <code>link.u-x[href]</code>, then get the <code>href</code> attribute		* if <code>a.u-x[href]</code> or <code>area.u-x[href]</code> or <code>link.u-x[href]</code>, then get the <code>href</code> attribute
	* ~~PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]):~~ else if <code>img.u-x[src]</code> return the result of "parse an img element for src and alt" (see Sec.1.5)		* else if <code>img.u-x[src]</code> return the result of "parse an img element for src and alt" (see Sec.1.5)
	* else if ~~<code>img.u-x[src]</code> or~~ <code>audio.u-x[src]</code> or <code>video.u-x[src]</code> or <code>source.u-x[src]</code> or <code>iframe.u-x[src]</code>, then get the <code>src</code> attribute (PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]): the "<code>img.u-x[src]</code> or" clause can be dropped from beginning of this conditional)		* else if <code>audio.u-x[src]</code> or <code>video.u-x[src]</code> or <code>source.u-x[src]</code> or <code>iframe.u-x[src]</code>, then get the <code>src</code> attribute
	* else if <code>video.u-x[poster]</code>, then get the <code>poster</code> attribute		* else if <code>video.u-x[poster]</code>, then get the <code>poster</code> attribute
	* else if <code>object.u-x[data]</code>, then get the <code>data</code> attribute		* else if <code>object.u-x[data]</code>, then get the <code>data</code> attribute
Line 130:		Line 130:
	* if no explicit "<code>photo</code>" property, and no other explicit <code>u-*</code> properties, and no nested microformats,		* if no explicit "<code>photo</code>" property, and no other explicit <code>u-*</code> properties, and no nested microformats,
	* then imply by:		* then imply by:
	** if <code>img.h-x[src]</code>, ~~then use <code>src</code> for photo (INSTEAD PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]):~~ then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo)		** if <code>img.h-x[src]</code>, then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo
	** else if <code>object.h-x[data]</code> then use <code>data</code> for photo		** else if <code>object.h-x[data]</code> then use <code>data</code> for photo
	** else if <code>.h-x>img[src]:only-of-type:not[.h-*]</code> ~~then use that <code>img</code> <code>src</code> for photo (INSTEAD PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]):~~ then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo)		** else if <code>.h-x>img[src]:only-of-type:not[.h-*]</code> then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo
	** else if <code>.h-x>object[data]:only-of-type:not[.h-*]</code> then use that <code>object</code>’s <code>data</code> for photo		** else if <code>.h-x>object[data]:only-of-type:not[.h-*]</code> then use that <code>object</code>’s <code>data</code> for photo
	** else if <code>.h-x>:only-child:not[.h-]>img[src]:only-of-type:not[.h-]</code>, ~~then use that <code>img</code>’s <code>src</code> for photo (INSTEAD PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]):~~ then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo)		** else if <code>.h-x>:only-child:not[.h-]>img[src]:only-of-type:not[.h-]</code>, then use the result of "parse an img element for src and alt" (see Sec.1.5) for photo
	** else if <code>.h-x>:only-child:not[.h-]>object[data]:only-of-type:not[.h-]</code>, then use that <code>object</code>’s <code>data</code> for photo		** else if <code>.h-x>:only-child:not[.h-]>object[data]:only-of-type:not[.h-]</code>, then use that <code>object</code>’s <code>data</code> for photo
	** if there is a gotten photo value, return the normalized absolute URL of it, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).		** if there is a gotten photo value, return the normalized absolute URL of it, following the containing document's language's rules for resolving relative URLs (e.g. in HTML, use the current URL context as determined by the page, and first <code><base></code> element, if any).
Line 221:		Line 221:

	=== parse an img element for src and alt ===		=== parse an img element for src and alt ===
	~~''This section is PROPOSED (per [https://github.com/microformats/microformats2-parsing/issues/2#issuecomment-392608361 issue 2]).''~~
	To parse an <code>img</code> element for <code>src</code> and <code>alt</code> attributes:		To parse an <code>img</code> element for <code>src</code> and <code>alt</code> attributes:
	* if <code>img[alt]</code>		* if <code>img[alt]</code>