Difference between revisions of "hnews"

From Microformats Wiki
hnews
Jump to navigation Jump to search
m (Reverted edits by Gowrvw (Talk) to last version by Tantek)
Line 1: Line 1:
HOW THING THROUGH
+
<entry-title>hNews 0.1</entry-title>
HOW MAKE THING THROUGH
+
{{Template:DraftSpecification}}
HOW THING BE THROUGH
+
 
HOW MAKE 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 ANYTHING THROUGH
+
__TOC__
HOW MAKE ANYTHING THROUGH
+
== Draft Specification ==
HOW ANYTHING BE THROUGH
+
 
HOW MAKE ANYTHING BE THROUGH
+
;Editor/Author
HOW EVERYTHING THROUGH
+
:[[:User:JonathanMalek|Jonathan Malek]] ([http://www.ap.org Associated Press])
HOW MAKE EVERYTHING THROUGH
+
 
HOW EVERYTHING BE THROUGH
+
;Contributors
HOW MAKE EVERYTHING BE THROUGH
+
:[[:User:Smyles|Stuart Myles]] ([http://www.ap.org Associated Press])
HOW UNIVERSE THROUGH
+
:[[:User:Martinjemoore|Martin Moore]] ([http://mediastandardstrust.org Media Standards Trust])
HOW MAKE UNIVERSE THROUGH
+
:[[:User:MarkNg|Mark Ng]] ([http://mediastandardstrust.org Media Standards Trust])
HOW UNIVERSE BE THROUGH
+
:[[:User:Tbmartinwiki|Todd B. Martin]] ([http://www.ap.org Associated Press])
HOW MAKE UNIVERSE BE THROUGH
+
 
HOW THING OUT
+
=== Copyright ===
HOW MAKE 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 THING BE OUT
+
 
HOW MAKE THING BE OUT
+
{{MicroFormatPublicDomainContributionStatement}}
HOW ANYTHING OUT
+
 
HOW MAKE ANYTHING OUT
+
=== Patents ===
HOW ANYTHING BE OUT
+
{{MicroFormatPatentStatement}}
HOW MAKE ANYTHING BE OUT
+
 
HOW EVERYTHING OUT
+
== Introduction ==
HOW MAKE 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 EVERYTHING BE OUT
+
 
HOW MAKE EVERYTHING BE OUT
+
{{rfc-2119-intro}}
HOW UNIVERSE OUT
+
 
HOW MAKE UNIVERSE OUT
+
== Semantic XHTML Design Principles ==
HOW UNIVERSE BE OUT
+
{{semantic-xhtml-design-principles}}
HOW MAKE UNIVERSE BE OUT
+
 
HOW THING THROUGH
+
== Format ==
HOW MAKE THING THROUGH
+
=== In General ===
HOW THING BE 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 MAKE THING BE THROUGH
+
 
HOW ANYTHING THROUGH
+
=== Schema ===
HOW MAKE ANYTHING THROUGH
+
The hNews schema consists of the following:
HOW ANYTHING BE THROUGH
+
 
HOW MAKE ANYTHING BE THROUGH
+
* hNews ('''<code>hnews</code>''') and '''<code>hentry</code>'''.  required. Using [[hAtom]].
HOW EVERYTHING THROUGH
+
** '''<code>source-org</code>'''. required. Using [[hCard]].[*]
HOW MAKE EVERYTHING THROUGH
+
** '''<code>dateline</code>'''. optional. Using text or [[hCard]].
HOW EVERYTHING BE THROUGH
+
** '''<code>geo</code>'''. optional. Using [[geo]].[*]
HOW MAKE EVERYTHING BE THROUGH
+
** '''<code>item-license</code>'''. recommended. Using a [[licensing-brainstorming#item_as_container|brainstorm proposal]].
HOW UNIVERSE THROUGH
+
** '''<code>principles</code>'''. recommended. Using the draft microformat [[principles-brainstorming#rel-principles_specification|rel-principles]].
HOW MAKE UNIVERSE THROUGH
+
 
HOW UNIVERSE BE THROUGH
+
[*] Some required elements have defaults if missing, see below.
HOW MAKE UNIVERSE BE THROUGH
+
 
HOW THING OUT
+
=== Field and Element Details ===
HOW MAKE THING OUT
+
 
HOW THING BE OUT
+
==== hAtom Fields ====
HOW MAKE THING BE OUT
+
 
HOW ANYTHING OUT
+
===== Entry =====
HOW MAKE ANYTHING OUT
+
* an hNews story {{must}} be encoded as an [[hAtom]] <code>hentry</code>.
HOW ANYTHING BE OUT
+
* if an hNews story cannot be parsed as an [[hAtom]] <code>hentry</code>, it is invalid hNews.
HOW MAKE ANYTHING BE OUT
+
 
HOW EVERYTHING OUT
+
==== Additional Fields ====
HOW MAKE EVERYTHING OUT
+
 
HOW EVERYTHING BE OUT
+
===== Source Organization =====
HOW MAKE EVERYTHING BE OUT
+
* a Source Organization element is identified by the class name <code>source-org</code>.
HOW UNIVERSE OUT
+
* Source Organization represents the originating organization for the news story.
HOW MAKE UNIVERSE OUT
+
* a Source Organization {{must}} be encoded in an [[hCard]].
HOW UNIVERSE BE OUT
+
* if the Source Organization is missing
HOW MAKE 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]]
 +
** 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:49, 25 August 2013

<entry-title>hNews 0.1</entry-title> This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats Freenode IRC channel to stay up-to-date.

hNews is a microformat for news content. hNews extends hAtom, introducing a number of fields that more completely describe a journalistic work. hNews also introduces another data format, rel-principles 0.1, 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.

Draft Specification

Editor/Author
Jonathan Malek (Associated Press)
Contributors
Stuart Myles (Associated Press)
Martin Moore (Media Standards Trust)
Mark Ng (Media Standards Trust)
Todd B. Martin (Associated Press)

Copyright

Per the public domain release on the authors' user pages (Jonathan Malek) this specification is released into the public domain.

Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Introduction

hNews is a microformat for identifying semantic information in news stories. It builds on hAtom 0.1, while adding a number of fields that more completely define a journalistic work. hNews can be thought of as inheriting from hAtom 0.1, since parsers and tools that do not understand the hNews extensions can still parse the hAtom 0.1 content. However, those parsers and applications that understand hNews can enable a richer set of semantic actions on news stories.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Semantic XHTML Design Principles

Note: the Semantic XHTML Design Principles were written primarily within the context of developing hCard and hCalendar, thus it may be easier to understand these principles in the context of the hCard design methodology (i.e. read that first). Tantek

XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of principles.

  1. Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported standards by reference. Avoid restating constraints expressed in the source standard. Informative mentions are ok.
    1. For types with multiple components, use nested elements with class names equivalent to the names of the components.
    2. Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
  2. Use the most accurately precise semantic XHTML building block for each object etc.
  3. Otherwise use a generic structural element (e.g. <span> or <div>), or the appropriate contextual element (e.g. an <li> inside a <ul> or <ol>).
  4. Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part of the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters.
  5. Finally, if the format of the data according to the original schema is too long and/or not human-friendly, use <abbr> instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the more brief and human readable equivalent into the element itself. Further informative explanation of this use of <abbr>: Human vs. ISO8601 dates problem solved

Format

In General

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.

Schema

The hNews schema consists of the following:

[*] Some required elements have defaults if missing, see below.

Field and Element Details

hAtom Fields

Entry
  • an hNews story MUST be encoded as an hAtom 0.1 hentry.
  • if an hNews story cannot be parsed as an hAtom 0.1 hentry, it is invalid hNews.

Additional Fields

Source Organization
  • a Source Organization element is identified by the class name source-org.
  • Source Organization represents the originating organization for the news story.
  • a Source Organization MUST be encoded in an hCard 1.0.
  • if the Source Organization is missing
Dateline
  • a dateline element is identified by the class name dateline.
  • dateline represents the location where the news story was written or filed (see dateline for more details).
  • a dateline element MAY be encoded with an adr, Geo or hCard 1.0.
  • 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 geo
  • 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 Geo Improvements for an example).
License
  • a license element is identified by the rel value of item-license.
  • a license element MUST be encoded as described in this license brainstorm proposal.
  • a news story SHOULD include a license element.
Principles
  • a principles element is identified by rel-principles.
  • 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 rel-principles.
  • a news story SHOULD include principles.
  • principles SHOULD be linked to using the icons principles-button-blue.png or principles-book-blue.png.

XMDP Profile

<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>

Examples

See hnews-examples.

Examples in the wild

See hnews-examples-in-wild.

Implementations

References

Normative References

Informative References

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

Related Pages

  • hnews
  • news-brainstorming: thoughts for improving hNews.
  • 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.