hnews: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎Implementations: add implementations)
No edit summary
Line 1: Line 1:
<entry-title>hNews 0.1</entry-title>
HOW THING THROUGH
{{Template:DraftSpecification}}
HOW MAKE THING THROUGH
 
HOW THING BE THROUGH
hNews is a microformat for news content. hNews extends [http://microformats.org/wiki/hatom hAtom], introducing a number of fields that more completely describe a journalistic work. hNews also introduces another data format, [[rel-principles]], a format that describes the journalistic principles upheld by the journalist or news organization that has published the news item. hNews will be one of several open standards.
HOW MAKE THING BE THROUGH
__TOC__
HOW ANYTHING THROUGH
== Draft Specification ==
HOW MAKE ANYTHING THROUGH
 
HOW ANYTHING BE THROUGH
;Editor/Author
HOW MAKE ANYTHING BE THROUGH
:[[:User:JonathanMalek|Jonathan Malek]] ([http://www.ap.org Associated Press])
HOW EVERYTHING THROUGH
 
HOW MAKE EVERYTHING THROUGH
;Contributors
HOW EVERYTHING BE THROUGH
:[[:User:Smyles|Stuart Myles]] ([http://www.ap.org Associated Press])
HOW MAKE EVERYTHING BE THROUGH
:[[:User:Martinjemoore|Martin Moore]] ([http://mediastandardstrust.org Media Standards Trust])
HOW UNIVERSE THROUGH
:[[:User:MarkNg|Mark Ng]] ([http://mediastandardstrust.org Media Standards Trust])
HOW MAKE UNIVERSE THROUGH
:[[:User:Tbmartinwiki|Todd B. Martin]] ([http://www.ap.org Associated Press])
HOW UNIVERSE BE THROUGH
 
HOW MAKE UNIVERSE BE THROUGH
=== Copyright ===
HOW THING OUT
Per the public domain release on the authors' user pages ([[:User:JonathanMalek|Jonathan Malek]]) this specification is released into the public domain.
HOW MAKE THING OUT
 
HOW THING BE OUT
{{MicroFormatPublicDomainContributionStatement}}
HOW MAKE THING BE OUT
 
HOW ANYTHING OUT
=== Patents ===
HOW MAKE ANYTHING OUT
{{MicroFormatPatentStatement}}
HOW ANYTHING BE OUT
 
HOW MAKE ANYTHING BE OUT
== Introduction ==
HOW EVERYTHING OUT
hNews is a microformat for identifying semantic information in news stories. It builds on [[hAtom]], while adding a number of fields that more completely define a journalistic work. hNews can be thought of as inheriting from [[hAtom]], since parsers and tools that do not understand the hNews extensions can still parse the [[hAtom]] content. However, those parsers and applications that understand hNews can enable a richer set of semantic actions on news stories.
HOW MAKE EVERYTHING OUT
 
HOW EVERYTHING BE OUT
{{rfc-2119-intro}}
HOW MAKE EVERYTHING BE OUT
 
HOW UNIVERSE OUT
== Semantic XHTML Design Principles ==
HOW MAKE UNIVERSE OUT
{{semantic-xhtml-design-principles}}
HOW UNIVERSE BE OUT
 
HOW MAKE UNIVERSE BE OUT
== Format ==
HOW THING THROUGH
=== In General ===
HOW MAKE THING THROUGH
hNews extends hAtom. As the hAtom draft format notes, "Atom provides a lot more functionality than we need for a 'blog post' microformat, so we've taken the minimal number of elements needed." News stories typically introduce more fields (for instance, the publishing organization) than the current 0.1 draft of hAtom, and those fields are very important when reading or evaluating a news story. We focus on those fields that enable the development of semantic actions around news: license, principles, dateline (geo) and source organization.
HOW THING BE THROUGH
 
HOW MAKE THING BE THROUGH
=== Schema ===
HOW ANYTHING THROUGH
The hNews schema consists of the following:
HOW MAKE ANYTHING THROUGH
 
HOW ANYTHING BE THROUGH
* hNews ('''<code>hnews</code>''') and '''<code>hentry</code>'''.  required. Using [[hAtom]].
HOW MAKE ANYTHING BE THROUGH
** '''<code>source-org</code>'''. required. Using [[hCard]].[*]
HOW EVERYTHING THROUGH
** '''<code>dateline</code>'''. optional. Using text or [[hCard]].
HOW MAKE EVERYTHING THROUGH
** '''<code>geo</code>'''. optional. Using [[geo]].[*]
HOW EVERYTHING BE THROUGH
** '''<code>item-license</code>'''. recommended. Using a [[licensing-brainstorming#item_as_container|brainstorm proposal]].
HOW MAKE EVERYTHING BE THROUGH
** '''<code>principles</code>'''. recommended. Using the draft microformat [[principles-brainstorming#rel-principles_specification|rel-principles]].
HOW UNIVERSE THROUGH
 
HOW MAKE UNIVERSE THROUGH
[*] Some required elements have defaults if missing, see below.
HOW UNIVERSE BE THROUGH
 
HOW MAKE UNIVERSE BE THROUGH
=== Field and Element Details ===
HOW THING OUT
 
HOW MAKE THING OUT
==== hAtom Fields ====
HOW THING BE OUT
 
HOW MAKE THING BE OUT
===== Entry =====
HOW ANYTHING OUT
* an hNews story {{must}} be encoded as an [[hAtom]] <code>hentry</code>.
HOW MAKE ANYTHING OUT
* if an hNews story cannot be parsed as an [[hAtom]] <code>hentry</code>, it is invalid hNews.
HOW ANYTHING BE OUT
 
HOW MAKE ANYTHING BE OUT
==== Additional Fields ====
HOW EVERYTHING OUT
 
HOW MAKE EVERYTHING OUT
===== Source Organization =====
HOW EVERYTHING BE OUT
* a Source Organization element is identified by the class name <code>source-org</code>.
HOW MAKE EVERYTHING BE OUT
* Source Organization represents the originating organization for the news story.
HOW UNIVERSE OUT
* a Source Organization {{must}} be encoded in an [[hCard]].
HOW MAKE UNIVERSE OUT
* if the Source Organization is missing
HOW UNIVERSE BE OUT
** find the [[algorithm-nearest-in-parent]] element(s) with class name <code>source-org</code> and that is/are a valid [[hCard]]
HOW MAKE UNIVERSE BE OUT
** otherwise the entry is invalid hNews
 
===== Dateline =====
* a dateline element is identified by the class name <code>dateline</code>.
* dateline represents the location where the news story was written or filed (see [http://en.wikipedia.org/wiki/Dateline dateline] for more details).
* a dateline element {{may}} be encoded with an [[adr]], [[geo]] or [[hCard]].
* a news story {{should}} have a dateline element.
* dateline sometimes also includes the publish date of the news story. In such cases, use the [[datetime-design-pattern]] to encode the date.
 
===== Geo =====
* a geo element is identified by the class name <code>geo</code>
* geo represents the geographic coordinates of relevant locations in the news story.
* a geo element should be encoded in a [[geo]].
* in those cases where the latitude and longitude represent the dateline, a variant of [[geo]] should be used (see [http://microformats.org/wiki/geo-brainstorming#Geo_improvements Geo Improvements] for an example).
 
===== License =====
* a license element is identified by the rel value of <code>item-license</code>.
* a license element {{must}} be encoded as described in this [http://microformats.org/wiki/licensing-brainstorming#item_as_container license brainstorm proposal].
* a news story {{should}} include a license element.
 
===== Principles =====
* a principles element is identified by <code>rel-principles</code>.
* principles represents the statement of principles and ethics adhered to by the news organization and/or individual that produced the news story at the time of writing.
* a principles element {{must}} be encoded in [[principles-brainstorming#rel-principles_specification|rel-principles]].
* a news story {{should}} include principles.
* principles {{should}} be linked to using the icons http://labs.ap.org/principles-button-blue.png or http://labs.ap.org/principles-book-blue.png.
 
=== XMDP Profile ===
<source lang=html4strict>
<dl class="profile">
 
  <dt>class</dt>
  <dd>
    <p><a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
    HTML4 definition of the 'class' attribute.</a>
    This meta data profile defines some 'class' attribute values (class names)
    and their meanings as suggested by a
    <a href="http://www.w3.org/TR/WD-htmllink-970328#profile">draft of
    "Hypertext Links in HTML"</a>.</p>
    <dl>
 
      <dt>hnews</dt>
      <dd>Used to describe semantic information associated with news stories.</dd>
 
      <dt>source-org</dt>
      <dd>The originating organization for the news story.</dd>
 
      <dt>dateline</dt>
      <dd>Represents the location where the news story was filed.</dd>
 
      <dt>geo</dt>
      <dd>Represents geographic coordinates of relevant locations in the story.</dd>
 
    </dl>
  </dd>
 
  <dt>rel</dt>
  <dd>
    <dl>
 
      <dt>item-license</dt>
      <dd>Represents the license for the story.</dd>
 
      <dt>principles</dt>
      <dd>Represents the statement of principles and ethics used by the news organization that produced the news story.</dd>
 
      </dl>
  </dd>
 
</dl>
</source>
 
== Examples ==
 
See [[hnews-examples]].
 
=== Examples in the wild ===
 
See [[hnews-examples-in-wild]].
 
== Implementations ==
* Readability parses and consumes hNews. See their [http://www.readability.com/developers/guidelines Article Publishing Guidelines] for details.
* [[Google]] also parses hAtom (e.g. it's supported by their Rich Snippets [[validator]]).
 
== References ==
 
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0]
* [[hatom|hAtom]]
* [[hcard|hCard]]
* [http://gmpg.org/xmdp/ XMDP]
* [[rel-tag]]
* [[geo]]
* [[licensing-brainstorming#item_as_container_license|item-license brainstorm]]
* [http://newscredit.org/development/newscredit-specification/rel-principles-specification/ rel-principles]
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)
 
=== Informative References ===
* Other news efforts: see [[news-formats]].
 
== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.
 
=== Version 0.1 ===
 
Version 0.1 was drafted August 2008.
 
== Further Reading ==
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
 
== Related Pages ==
* hnews
* [[news-brainstorming]]: thoughts for improving hNews.
* [[hnews-faq|hNews FAQ]]: if you have any questions about hNews, check here, and if you don't find answers, add your questions!
* [[hnews-issues]]: please add any issues with the specification to the issues page.
* [[news-formats]]: existing news and news management schemas.
* [[news-examples]]: examples of news formats on the web.
** [[hnews-examples]]: examples of how to implement hNews.
 
[[Category:Draft Specifications]]
[[Category:hNews]]

Revision as of 19:36, 25 August 2013

HOW THING THROUGH HOW MAKE THING THROUGH HOW THING BE THROUGH HOW MAKE THING BE THROUGH HOW ANYTHING THROUGH HOW MAKE ANYTHING THROUGH HOW ANYTHING BE THROUGH HOW MAKE ANYTHING BE THROUGH HOW EVERYTHING THROUGH HOW MAKE EVERYTHING THROUGH HOW EVERYTHING BE THROUGH HOW MAKE EVERYTHING BE THROUGH HOW UNIVERSE THROUGH HOW MAKE UNIVERSE THROUGH HOW UNIVERSE BE THROUGH HOW MAKE UNIVERSE BE THROUGH HOW THING OUT HOW MAKE THING OUT HOW THING BE OUT HOW MAKE THING BE OUT HOW ANYTHING OUT HOW MAKE ANYTHING OUT HOW ANYTHING BE OUT HOW MAKE ANYTHING BE OUT HOW EVERYTHING OUT HOW MAKE EVERYTHING OUT HOW EVERYTHING BE OUT HOW MAKE EVERYTHING BE OUT HOW UNIVERSE OUT HOW MAKE UNIVERSE OUT HOW UNIVERSE BE OUT HOW MAKE UNIVERSE BE OUT HOW THING THROUGH HOW MAKE THING THROUGH HOW THING BE THROUGH HOW MAKE THING BE THROUGH HOW ANYTHING THROUGH HOW MAKE ANYTHING THROUGH HOW ANYTHING BE THROUGH HOW MAKE ANYTHING BE THROUGH HOW EVERYTHING THROUGH HOW MAKE EVERYTHING THROUGH HOW EVERYTHING BE THROUGH HOW MAKE EVERYTHING BE THROUGH HOW UNIVERSE THROUGH HOW MAKE UNIVERSE THROUGH HOW UNIVERSE BE THROUGH HOW MAKE UNIVERSE BE THROUGH HOW THING OUT HOW MAKE THING OUT HOW THING BE OUT HOW MAKE THING BE OUT HOW ANYTHING OUT HOW MAKE ANYTHING OUT HOW ANYTHING BE OUT HOW MAKE ANYTHING BE OUT HOW EVERYTHING OUT HOW MAKE EVERYTHING OUT HOW EVERYTHING BE OUT HOW MAKE EVERYTHING BE OUT HOW UNIVERSE OUT HOW MAKE UNIVERSE OUT HOW UNIVERSE BE OUT HOW MAKE UNIVERSE BE OUT

Retrieved from "http://microformats.org/wiki/index.php?title=hnews&oldid=60723"