h-review-aggregate - Revision history

GRegorLove: s///

2023-07-26T21:24:57Z

s/<source>/<syntaxhighlight>/

← Older revision		Revision as of 21:24, 26 July 2023
Line 24:		Line 24:
	Here is a simple example showing aggregate review information for a restaurant:		Here is a simple example showing aggregate review information for a restaurant:

	<~~source~~ lang=~~html4strict~~>		<syntaxhighlight lang="html">
	<article class="h-review-aggregate">		<article class="h-review-aggregate">
	<h1 class="p-item">Mediterranean Wraps</h1>		<h1 class="p-item">Mediterranean Wraps</h1>
Line 32:		Line 32:
	based on <span class="p-count">17</span> reviews		based on <span class="p-count">17</span> reviews
	</article>		</article>
	</~~source~~>		</syntaxhighlight>

	== Properties ==		== Properties ==

JamesGallagher: Add Breakfast and Coffee example to h-review-aggregate

2022-09-18T20:40:50Z

Add Breakfast and Coffee example to h-review-aggregate

← Older revision		Revision as of 20:40, 18 September 2022
Line 51:		Line 51:
	Add any h-review-aggregate examples you find in the wild:		Add any h-review-aggregate examples you find in the wild:

	* ...		* [https://breakfastand.coffee Breakfast and Coffee] publishes h-review-aggregate on pages that aggregate all of the reviews for a coffee shop or eatery. The h-review-aggregate is updated automatically when a new, valid h-review [https://indieweb.org/Webmention Webmention] is sent to the page.
			** Example: https://breakfastand.coffee/Fortitude_Coffee_-_Newington_Road_-_Edinburgh

	== Validating ==		== Validating ==

GRegorLove: freenode -> libera.chat link

2021-10-20T16:17:44Z

freenode -> libera.chat link

← Older revision		Revision as of 16:17, 20 October 2021
Line 12:		Line 12:
	:This is a '''Draft Specification'''.		:This is a '''Draft Specification'''.
	;Participate		;Participate
	:[[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:23:43Z

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

← Older revision		Revision as of 16:23, 18 July 2020
Line 4:		Line 4:

	----		----
	~~<entry-title>~~h-review-aggregate~~</entry-title>~~		{{DISPLAYTITLE:h-review-aggregate}}
	<dfn style="font-style:normal;font-weight:bold">h-review-aggregate</dfn> is a simple, open format for embedding review information (of products, services, businesses, etc). Whereas [[h-review]] is intended for an individual review, h-review-aggregate is meant for summary information about a collection of user or critic reviews about an item.		<dfn style="font-style:normal;font-weight:bold">h-review-aggregate</dfn> is a simple, open format for embedding review information (of products, services, businesses, etc). Whereas [[h-review]] is intended for an individual review, h-review-aggregate is meant for summary information about a collection of user or critic reviews about an item.

GRegorLove: /* Example */ simple example

2018-08-27T04:46:06Z

Example: simple example

@@ Line 23: / Line 23: @@
 == Example ==
 Here is a simple example showing aggregate review information for a restaurant:
 == Properties ==

GRegorLove: /* Proposed Properties */ s/rating/average/

2018-08-27T04:37:07Z

Proposed Properties: s/rating/average/

← Older revision		Revision as of 04:37, 27 August 2018
Line 29:		Line 29:

	* '''<code>p-item</code>''' - Required: the thing been reviewed, including embedded microformat for e.g. business or person ([[h-card]]), event ([[h-event]]), place ([[h-adr]] or [[h-geo]]), product ([[h-product]]), website, url, or other item ([[h-item]]).		* '''<code>p-item</code>''' - Required: the thing been reviewed, including embedded microformat for e.g. business or person ([[h-card]]), event ([[h-event]]), place ([[h-adr]] or [[h-geo]]), product ([[h-product]]), website, url, or other item ([[h-item]]).
	* '''<code>p-~~rating~~</code>''' - Required: the fixed point integer [1.0-5.0] of the average rating (5.0 best)		* '''<code>p-average</code>''' - Required: the fixed point integer [1.0-5.0] of the average rating (5.0 best)
	* '''<code>p-best</code>''' - Optionally define best rating value. can be numerically lower than worst.		* '''<code>p-best</code>''' - Optionally define best rating value. can be numerically lower than worst.
	* '''<code>p-worst</code>''' - Optionally define worst rating value. can be numerically higher than best.		* '''<code>p-worst</code>''' - Optionally define worst rating value. can be numerically higher than best.

GRegorLove: /* Backward Compatibility */ draft of parser compatibility, pending feedback and implementations

2018-08-27T04:36:10Z

Backward Compatibility: draft of parser compatibility, pending feedback and implementations

← Older revision		Revision as of 04:36, 27 August 2018
Line 49:		Line 49:

	== Backward Compatibility ==		== Backward Compatibility ==
			=== Parser Compatibility ===
			This is a '''draft''' based on reviewing [[hreview-aggregate-examples-in-wild#Reviewed_Examples\|hReview-aggregate examples]], pending parser implementations and feedback.

			Microformats parsers {{should}} detect classic properties only if a classic root class name is found and parse them as microformats2 properties.

			If an <code>h-review-aggregate</code> is found, don't look for an <code>hreview-aggregate</code> on the same element.

			Compat root class name: <code id="hreview-aggregate">hreview-aggregate</code><br>
			Properties: (parsed as '''p-''' plain text unless otherwise specified):

			* <code>item</code> - parse as '''<code>p-item</code>'''
			* <code>average</code> - parse as '''<code>p-average</code>'''
			* <code>best</code> - parse as '''<code>p-best</code>'''
			* <code>worst</code> - parse as '''<code>p-worst</code>'''
			* <code>count</code> - parse as '''<code>p-count</code>'''
			* <code>votes</code> - parse as '''<code>p-votes</code>'''
			* <code>summary</code> - parse as '''<code>p-name</code>'''

			==== Notes ====
			Based on [[hreview-aggregate-examples-in-wild#Reviewed_Examples\|hReview-aggregate examples]], this is how many times each property appeared.

			<pre>item: 10
			rating: 10
			average: 8
			best: 8
			count: 5
			votes: 5
			worst: 0
			summary: 0</pre>

	== Todo ==		== Todo ==

GRegorLove: /* Examples in the wild */ Add any h-review-aggregate examples you find in the wild

2018-08-21T00:04:56Z

Examples in the wild: Add any h-review-aggregate examples you find in the wild

← Older revision		Revision as of 00:04, 21 August 2018
Line 39:		Line 39:

	== Examples in the wild ==		== Examples in the wild ==
			Add any h-review-aggregate examples you find in the wild:

			* ...

	== Validating ==		== Validating ==

GRegorLove: /* Properties */ proposed properties from hReview-aggregate awaiting citations of publishing and consuming examples

2018-08-20T23:54:07Z

Properties: proposed properties from hReview-aggregate awaiting citations of publishing and consuming examples

← Older revision		Revision as of 23:54, 20 August 2018
Line 25:		Line 25:

	== Properties ==		== Properties ==
			=== Proposed Properties ===
			Proposed properties from [[hReview-aggregate]] awaiting citations of publishing and consuming examples.

			* '''<code>p-item</code>''' - Required: the thing been reviewed, including embedded microformat for e.g. business or person ([[h-card]]), event ([[h-event]]), place ([[h-adr]] or [[h-geo]]), product ([[h-product]]), website, url, or other item ([[h-item]]).
			* '''<code>p-rating</code>''' - Required: the fixed point integer [1.0-5.0] of the average rating (5.0 best)
			* '''<code>p-best</code>''' - Optionally define best rating value. can be numerically lower than worst.
			* '''<code>p-worst</code>''' - Optionally define worst rating value. can be numerically higher than best.
			* '''<code>p-count</code>''' - the total number of reviews
			* '''<code>p-votes</code>''' - the total number of users who have rated the product or service, contributing to the average rating. For some sites, the number of votes is equal to the number of reviews, so <code>count</code> may be used and this property omitted.
			* '''<code>p-name</code>''' - This optional property can be the title for the review collection or a very short summary of the consensus opinion from the collection.

	== Property Details ==		== Property Details ==

GRegorLove: /* Change control */ rm section

2018-08-20T23:27:42Z

Change control: rm section

← Older revision		Revision as of 23:27, 20 August 2018
Line 37:		Line 37:
	== Backward Compatibility ==		== Backward Compatibility ==

	~~== Change control ==~~
	Minor editorial changes (e.g. fixing minor typos or punctuation) that do not change and preferably clarify the structure and existing intended meaning may be done by anyone without filing issues, requiring only a sufficient "Summary" description field entry for the edit. More than minor but still purely editorial changes may be made by an editor. Anyone may question such editorial changes by undoing corresponding edits without filing an issue. Any further reversion or iteration on such an editorial change must be done by filing an issue.

	For the stable features of this document, substantive issue filing, resolution, and edits may be done by filing an [[h-entry-issues\|issue]] and discussing them on the issue and on #microformats [[IRC]] with a link to the issue.

	Because this is primarily a vocabulary specification, very few issues beyond the list of vocabulary have filed or required any lengthy discussion. If such a non-trivial issue arises in the future, use the [[microformats2-parsing#change_control\|microformats2-parsing change control process]] to resolve them.

	In general, non-vocabulary related features or requirements should be avoided in this specification, e.g. changes to microformats2 syntax must be proposed as [[microformats2-parsing]] changes using the [[microformats2-parsing#change_control\|microformats2-parsing change control process]].

	~~Beyond that, the following requirements must be met for adding or moving features (e.g. properties and values) to proposed, draft, or stable:~~

	~~;Proposed~~
	:[[#Proposed_Additions\|Proposed features]] must provide documentation of what specific real world use-cases they are solving, preferably with a link to a step-by-step user scenario, e.g. demonstratable using existing non-standard / single-site / single-implementation tools.
	~~;Draft~~
	:[[#Draft_Properties\|Draft properties]] must in addition be published and consumed in the wild on the public web, demonstrate solving the use case for which they were proposed, and should provide citations of real world public web sites publishing and (other sites) consuming them, interoperably.
	~~;Stable~~
	:Stable features (e.g. [[#Core_Properties\|Core Properties]]) must in addition be published and consumed in the wild on multiple sites by multiple implementations (3+ different sites and implementations for publishing and consuming). When a draft property reaches a critical mass of deployment by numerous sites and implementations (far beyond 3+), due to network effects and backward compatibility considerations it effectively becomes stable, since it becomes increasingly difficult to change it in any way and have so many sites and implementations also change.

	~~For creating an entirely new vocabulary, and more details about how to research existing values, properties, document examples in the wild, etc., see the microformats [[process]].~~


	~~----~~

	== Todo ==		== Todo ==