Difference between revisions of "hnews"

From Microformats Wiki
hnews
Jump to navigation Jump to search
(draft of hnews)
 
(redirecting to brainstorming)
Line 1: Line 1:
<entry-title>hNews 0.1</entry-title>
+
#REDIRECT:[[news-brainstorming#Proposal]]
{{Template:DraftSpecification}}
 
 
 
hNews is a data format (similar to 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, [http://newscredit.org/development/newscredit-specification/rel-principles-specification/ 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.
 
__TOC__
 
== Draft Specification ==
 
 
 
;Editor/Author
 
:[[:User:JonathanMalek|Jonathan Malek]] ([http://www.ap.org Associated Press])
 
 
 
;Contributors
 
:[[:User:StuartMyles|Stuart Myles]] ([http://www.ap.org Associated Press])
 
:[[:User:MartinMoore|Martin Moore]] ([http://mediastandardstrust.org Media Standards Trust])
 
:[[:User:MarkNg|Mark Ng]] ([http://mediastandardstrust.org Media Standards Trust])
 
:[[:User:BenCampbell|Ben Campbell]] ([http://mediastandardstrust.org Media Standards Trust])
 
 
 
=== Copyright ===
 
Per the public domain release on the authors' user pages ([[:User:JonathanMalek|Jonathan Malek]]) this specification is released into the public domain.
 
 
 
{{MicroFormatPublicDomainContributionStatement}}
 
 
 
=== Patents ===
 
{{MicroFormatPatentStatement}}
 
 
 
== Introduction ==
 
hNews is a format (similar to 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.
 
 
 
{{rfc-2119-intro}}
 
 
 
== Semantic XHTML Design Principles ==
 
{{semantic-xhtml-design-principles}}
 
 
 
== 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:
 
 
 
* hnews ('''<code>hnews</code>''') and '''<code>hentry</code>'''.  required. Using [[hAtom]].
 
** '''<code>source-org</code>'''. required. Using [[hCard]].[*]
 
** '''<code>dateline</code>'''. optional. Using text or [[hCard]].
 
** '''<code>geo</code>'''. optional. Using [[geo]].[*]
 
** '''<code>item-license</code>'''. required. Using a [http://microformats.org/wiki/licensing-brainstorming#item_as_container license brainstorm proposal].
 
** '''<code>principles</code>'''. required. Using the draft microformat. [http://newscredit.org/development/newscredit-specification/rel-principles-specification/ rel-principles].
 
 
 
[*] Some required elements have defaults if missing, see below.
 
 
 
=== Field and Element Details ===
 
 
 
===== Source Organization =====
 
* a Source Organization element is identified by the class name <code>source-org</code>.
 
* Source Organization represents the originating organization for the news story.
 
* a Source Organization {{must}} be encoded in an [[hCard]].
 
* if the Source Organization is missing
 
** 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 in an [[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 class name <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].
 
 
 
===== Principles =====
 
* a principles element is identified by <code>rel-principles</code>.
 
* principles represents the statement of principles and ethics used by the news organization that produced the news story.
 
* a principles element {{must}} be encoded in [http://newscredit.org/development/newscredit-specification/rel-principles-specification/ rel-principles].
 
* principles {{should}} be linked to using the icons [[image:principles-button-blue.png]] or [[image:principles-book-blue.png]].
 
 
 
=== XMDP Profile ===
 
<pre>
 
<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>.
 
  <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>
 
 
 
  <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>
 
</pre>
 
 
 
== Examples ==
 
 
 
[[hnews-examples]]
 
 
 
=== Examples in the wild ===
 
 
 
[[hnews-examples-in-wild]]
 
 
 
== Implementations ==
 
 
 
[[hnews-implementations]]
 
 
 
== References ==
 
 
 
* [[news-examples]]
 
* [[news-formats]]
 
* [[news-brainstorming]]
 
 
 
== Work in progress ==
 
 
 
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. There is a separate document where we are keeping our brainstorms and other explorations relating to hNews:
 
 
 
* [[hnews-brainstorming|hNews Brainstorming]]
 
 
 
=== Version 0.1 ===
 
 
 
Version 0.1 was drafted August 2008.
 
 
 
== Discussions ==
 
 
 
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
 
 
 
=== Q&A ===
 
 
 
* If you have any questions about hNews, check the [[hnews-faq|hNews FAQ]], and if you don't find answers, add your questions!
 
 
 
=== Issues ===
 
 
 
* Please add any issues with the specification to the separate [[hnews-issues|hNews issues]] document.
 
 
 
[[Category:Draft Specifications]]
 
[[Category:hNews]]
 

Revision as of 21:50, 31 August 2009