hatom-ja: Difference between revisions
Bravenewgame (talk | contribs) (→â€) |
(Undo revision 65842 by Bravenewgame (Talk) spam links) |
||
Line 173: | Line 173: | ||
* [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom | * [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom | ||
* [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format | * [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format | ||
* There is a [http://code.google.com/p/transformr/downloads/detail?name=hatom%280.2%29.zip hAtom toolkit] that extracts hAtom, there is also a [http://transformr.co.uk | * There is a [http://code.google.com/p/transformr/downloads/detail?name=hatom%280.2%29.zip hAtom toolkit] that extracts hAtom, there is also a [http://transformr.co.uk/ demo here] | ||
<!-- | <!-- | ||
Revision as of 09:32, 17 January 2017
<entry-title>hAtom-ja</entry-title>
hAtom 0.1
ã“ã®æ–‡æ›¸ã¯ microformat ã®ãƒ‰ãƒ©ãƒ•ト仕様ã§ã™ã€‚ドラフトãªã®ã§é–‹ç™ºæ®µéšŽã«ãŠã„ã¦ã¯ã„ãらã‹ã¯å®Œæˆã—ã¦ã„ã¾ã™ãŒã€ã“ã®æ–‡æ›¸ã®å®‰å®šæ€§ã¯ä¿è¨¼ã§ãã¾ã›ã‚“。ãªã®ã§é–‹ç™ºè€…ã¯å°†æ¥ã®ç™ºå±•ã¨å¤‰åŒ–ã«å¯¾å¿œã§ãã‚‹ã‚ˆã†æº–å‚™ã—ã¦ãŠãå¿…è¦ãŒã‚りã¾ã™ã€‚æœ€æ–°ã®æƒ…å ±ã‚’å¾—ã‚‹ã«ã¯ã€ã“ã® wiki ページを見る㋠microformats-new mailing list ã®è°è«–ã‹ã‚‰å¦ã‚“ã§ä¸‹ã•ã„。
hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the Atom syndication format. hAtom will be one of several microformats open standards.
Draft Specification
- Editor/Author
- David Janes (BlogMatrix, Inc.)
- Contributors
- Benjamin Carlyle
- Tantek Çelik (http://tantek.com/ and before at Technorati, Inc.)
copyright and patents statements apply.
Status
hAtom 0.1 is a microformats.org draft specification. Public discussion on hAtom takes place on hAtom issues, the #microformats #microformats chat channel on irc.freenode.net, and microformats-discuss mailing list.
Available languages
The English version of this specification is the only normative version. For translations of this document see the #translations section.
Errata and Updates
Known errors and issues in this specification are corrected in resolved and closed issues. Please check there before reporting issues.
The hAtom 0.2 update is currently under development and incorporates known errata corrections as well as the Value Class Pattern.
Introduction
hAtom is a microformat for identifying semantic information in weblog posts and practically any other place Atom may be used, such as news articles. hAtom content is easily added to most blogs by simple modifications to the blog's template definitions.
ã“ã®æ–‡æ›¸å†…ã®èªžå¥ "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" ã¯ã€RFC 2119 ã§è¨˜è¿°ã•れる解釈ã§ä½¿ã‚れã¾ã™ã€‚
Semantic XHTML Design Principles
注:セマンティック XHTML デザイン指é‡ã¯ã€å§‹ã‚ hCard 㨠hCalendar é–‹ç™ºã®æ–‡è„ˆã§æ›¸ã‹ã‚Œã¾ã—ãŸã€‚ãã®ãŸã‚ã€ã“ã®æŒ‡é‡ã¯ hCard ãƒ‡ã‚¶ã‚¤ãƒ³ã®æ–¹æ³•è«–ã®æ–‡è„ˆã«ãŠã„ã¦ç†è§£ã—ã‚„ã™ããªã‚‹ã§ã—ょã†ï¼ˆã¤ã¾ã‚Šã€ãã¡ã‚‰ã‚’ã¾ãšèªã‚“ã§ãã ã•ã„)。Tantek
XHTML 㯠XML ã«åŸºã¥ã„ã¦ä½œã‚‰ã‚Œã¦ãŠã‚Šã€ãã®ãŸã‚ XHTML ã«åŸºã¥ã„ãŸãƒ•ォーマットã¯ã€è¡¨ç¤ºã«ä¾¿åˆ©ãªã ã‘ã§ãªã一般的ãªãƒ‡ãƒ¼ã‚¿äº¤æ›ç›®çš„ã«ã‚‚使ãˆã¾ã™ã€‚XHTML ã«åŸºã¥ã„ãŸãƒ•ォーマットã¯ã€å¤šãã®ç‚¹ã§ HTML 㨠XML ã®ä¸–ç•ŒåŒæ–¹ã®æœ€ã‚‚ã‚ˆã„æ‰€ã‚’体ç¾ã—ã¦ã„ã¾ã™ã€‚ã¨ã¯è¨€ãˆã€XHTML ã«åŸºã¥ã„ãŸãƒ•ォーマットを作æˆã™ã‚‹æ™‚ã€æŒ‡é‡ã‚’集ã‚ãŸã‚‚ã®ãŒã‚ã‚‹ã¨å½¹ç«‹ã¡ã¾ã™ã€‚
- å¯èƒ½ãªé™ã‚Šã€è¨€åŠã—ã¦ã„ã‚‹ã€æ—¢å˜ã®ç¢ºç«‹ã•れã¦ã‚ˆãサãƒãƒ¼ãƒˆã•れã¦ã„る標準ã‹ã‚‰ã‚¹ã‚ーマ(åå‰ã€ã‚ªãƒ–ジェクトã€ãƒ—ãƒãƒ‘ティã€å€¤ã€ç¨®é¡žã€éšŽå±¤ã€åˆ¶ç´„)をå†åˆ©ç”¨ã™ã‚‹ã€‚å…ƒã®æ¨™æº–ã§è¡¨ç¾ã•れã¦ã„る制約をå†å®£è¨€ã™ã‚‹ã“ã¨ã¯é¿ã‘る。å‚è€ƒæƒ…å ±ã®ãŸã‚ã«è¨€åŠã™ã‚‹ã®ã¯ã‚ˆã„。
- è¤‡æ•°ã®æ§‹æˆè¦ç´ ã‹ã‚‰ãªã‚‹ç¨®é¡žã®ã‚‚ã®ã«ã¯ã€ãã®æ§‹æˆè¦ç´ ã®åå‰ã«ç›¸å½“ã™ã‚‹ class åã‚’æŒã£ãŸè¦ç´ を入れåã«ã—ã¦ä½¿ã†ã€‚
- è¤‡æ•°ã®æ§‹æˆè¦ç´ ã¯ä¸€ã¤ãšã¤ã«ã™ã‚‹ã€‚ãã®ãŸã‚ã€ã‚«ãƒ³ãƒžåŒºåˆ‡ã‚Šã®è¤‡æ•°ã®ãƒ†ã‚スト値を表ã™ã«ã¯ã€è¤‡æ•°ã®è¦ç´ を埋ã‚込んã§ä½¿ã†ã€‚
- å„オブジェクトãªã©ã®ãƒ–ãƒãƒƒã‚¯ã‚’æ§‹æˆã™ã‚‹ã®ã«ä¸€ç•ªé©ã—ãŸæ„味的㪠XHTML を使ã†ã€‚
- ãã†ã„ã£ãŸã‚‚ã®ãŒç„¡ã‘れã°ã€æ§‹é€ を作る一般的ãªè¦ç´ (例ãˆã°
<span>
ã‚„<div>
ï¼‰ã‹æ–‡è„ˆã«é©ã—ãŸè¦ç´ (例ãˆã°<ul>
ã‚„<ol>
ä¸ã®<li>
)を使ã†ã€‚ - å…ƒã®ã‚¹ã‚ーマã®ãã®éƒ¨åˆ†ã‚’的確ã«è¡¨ç¾ã™ã‚‹ XHTML ã®æ§‹æˆãƒ–ãƒãƒƒã‚¯ãŒç„¡ã‘れã°ã€å…ƒã®ã‚¹ã‚ーマ由æ¥ã®åå‰ã«åŸºã¥ã„㟠class åを使ã†ã€‚å…ƒã®ã‚¹ã‚ーマä¸ã®åå‰ãŒå¤§æ–‡å—ã¨å°æ–‡å—を区別ã—ãªã„ãªã‚‰ã°ã€ç›¸å½“ã™ã‚‹ã‚‚ã®ã‚’å…¨ã¦å°æ–‡å—ã«ã—ã¦ä½¿ã†ã€‚æ§‹æˆè¦ç´ ã®ï¼ˆæ˜Žç¢ºã«å®šç¾©ã•れãŸã‚¹ã‚ーマã§ã¯ãªãï¼‰æ—¥å¸¸èªžé¢¨ã®æš—黙的ãªåå‰ã‚‚ã€ä½¿ã„ã‚„ã™ã•ã®ãŸã‚ã«ã€ç›¸å½“ã™ã‚‹ã‚‚ã®ã‚’å…¨ã¦å°æ–‡å—ã«ã—ã¦ä½¿ã†ã¹ãã§ã‚る。構æˆè¦ç´ åä¸ã®ã‚¹ãƒšãƒ¼ã‚¹ã¯ãƒ€ãƒƒã‚·ãƒ¥ '-' æ–‡å—ã«ãªã‚‹ã€‚
- 最後ã«ã€å…ƒã®ã‚¹ã‚ーマã«å¾“ã£ãŸãƒ‡ãƒ¼ã‚¿ã®å½¢å¼ãŒã‚ã¾ã‚Šã«é•·ã‹ã£ãŸã‚Šäººé–“ã«é¦´æŸ“ã¾ãªã„å ´åˆã€æ§‹é€ を作る一般的ãªè¦ç´ ã®ä»£ã‚りã«
<abbr>
を使ã„ã€å¿ 実ã«å¾“ã£ãŸãƒ‡ãƒ¼ã‚¿ã‚’(表ç¾ã‚’記述ã™ã‚‹å±žæ€§ã§ã‚る)'title' 属性ã®ä¸ã¸ã€ç›¸å½“ã™ã‚‹ã‚ˆã‚Šç°¡æ½”ã§äººé–“ã«èªã¿ã‚„ã™ã„ã‚‚ã®ã‚’è¦ç´ 自体ã®ä¸ã¸ç½®ã。<abbr>
ã®ã“ã®ä½¿ã„æ–¹ã«é–¢ã™ã‚‹èª¬æ˜Žã®ã‚ˆã‚Šå¤šãã®æƒ…å ±ï¼šHuman vs. ISO8601 dates problem solved(人間 vs ISO8601 日付å•題ã®è§£æ±ºï¼‰
Format
In General
The Atom Syndication Format provides the conceptual basis for this microformat, with the following caveats:
- Atom provides a lot more functionality than we need for a "blog post" microformat, so we've taken the minimal number of elements needed.
- the "logical" model of hAtom is that of Atom. If there is a conflict, Atom should be taken as correct.
- the "physical" model of hAtom -- the actual writing of elements -- is a lot more varied than Atom provides for, due to the variety of ways weblogs are actually produced in the wild. The hAtom microformat provides a number of rules for "bridging the gap"
Schema
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, 'h
') on the outermost container elements -- the Feed or Entry. The parts of this microformat are based on analysis of many weblog, bulletin board and media posts and can be read blog-post-brainstorming.
The hAtom schema consists of the following:
- hfeed (
hfeed
). optional.feed category
. optional. keywords or phrases, using rel="tag".- hentry (
hentry
).entry-title
. required. text.entry-content
. optional (see field description). text. [*]entry-summary
. optional. text.updated
. required using Datetime Design Pattern. [*]published
. optional using Datetime Design Pattern.author
. required using hCard. [*]bookmark
(permalink). optional, using rel-design-pattern.- tags. optional. keywords or phrases, using rel="tag".
[*] Some required elements have defaults if missing, see below.
Field and Element Details
Feed
- a Feed element is identified by the class name
hfeed
- a Feed element represents the concept of an Atom feed
- the Feed element is optional and, if missing, is assumed to be the page
- hAtom documents MAY have multiple Feed elements
Feed Category
- a Feed Category element is identified by rel="tag"
- a Feed MAY have a Feed Category
- a Feed Category element represents the concept of an Atom category inside a feed
- Feed Category elements MUST appear inside a Feed element but not inside an Entry element
- the rel="tag"
href
encodes the atomcategory:term
; the link text defines the atomcategory:label
Entry
- an Entry element is identified by class name
hentry
- an Entry element represents the concept of an Atom entry
- any microformat content inside a
<blockquote>
or<q>
element within the Entry should not be considered part of the Entry.
- This allows quoting other microformated data without worry of corrupting the model
Entry Category
- an Entry Category element is identified by rel="tag"
- an Entry MAY have an Entry Category
- an Entry Category element represents the concept of an Atom category inside an entry
- the rel="tag"
href
encodes the atomcategory:term
; the link text defines the atomcategory:label
Entry Title
- an Entry Title element is identified by the class name
entry-title
- an Entry SHOULD have an Entry Title
- an Entry Title element represents the concept of an Atom entry title
- if the Entry Title is missing, use
- the first
<h#>
element in the Entry, or - the
<title>
of the page, if there is no enclosing Feed element, or - assume it is the empty string
- the first
Entry Content
- an Entry Content element is identified by class name
entry-content
- an Entry SHOULD have Entry Content
- an Entry Content element represents the concept of an Atom content
- an Entry MAY have 0 or more Entry Content elements. The "logical Entry Content" of an Entry is the concatenation, in order of appearance, of all the Entry Contents within the Entry
- Many web logs split content into multiple sections with a "Read More" link and JavaScript tricks. This is also needed in cases where Entry Titles are coded in-line and are considered part of the content.
- if the Entry Content is missing, assume it is the empty string
Entry Summary
- an Entry Summary element is identified by class name
entry-summary
- an Entry Summary element represents the concept of an Atom summary
- an Entry MAY have 0 or more Entry Summary elements. The "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry
Entry Permalink
- an Entry Permalink element is identified by rel-design-pattern
- an Entry SHOULD have an Entry Permalink
- an Entry Permalink element represents the concept of an Atom link in an entry
- if the Entry Permalink is missing, use the URI of the page; if the Entry has an "id" attribute, add that as a fragment to the page URI to distinguish individual entries
Entry Updated
- an Entry Updated element is identified by class name
updated
- an Entry Updated element represents the concept of Atom updated
- an Entry SHOULD have an Entry Updated element
- use the Datetime Design Pattern to encode the updated datetime
- if there is no Entry Updated element,
- use the Entry Published element, if present
- otherwise the page is invalid hAtom
Entry Published
- an Entry Published element is identified by the class name
published
- an Entry Published element represents the concept of Atom published
- use the Datetime Design Pattern to encode the published datetime
Entry Author
- an Entry Author element is represented by class name
author
- an Entry Author element represents the concept of an Atom author
- an Entry Author element MUST be encoded in an hCard
- an Entry Author element SHOULD be encoded in an
<address>
element - an Entry SHOULD have at least one Entry Author element
- an Entry MAY have more than one Entry Author elements
- if the Entry Author is missing
- find the Nearest In Parent
<address>
element(s) with class nameauthor
and that is/are a valid hCard - otherwise the entry is invalid hAtom
- find the Nearest In Parent
XMDP Profile
See hAtom Profile.
Examples
See hatom-examples.
Examples in the wild
See hAtom Examples in the Wild.
Implementations
This section is informative.
The following implementations have been developed which either generate or parse hAtom links. If you have an hAtom implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
- spinn3r-client - implemented in Spinn3r and part of FeedParser and our announcement of hAtom in Spinn3r 2.1
- the Almost Universal Microformat Parser can extract hAtom content from webpages (demo)
- hAtom2Atom.xsl transforms hAtom to Atom (as the name suggests.)
- There is now an hatom2atom proxy that uses hAtom2Atom.xsl.
- Subscribe To hAtom is a script that provides NetNewsWire 2.x users with the ability to subscribe to hAtom documents as they would any other feed. by Chris Casciano.
- Outline Classes - has GPL'ed PHP code for reading hAtom
- BoxtheWeb - supports subscribing to hAtom as a feed format
- There is a hAtom toolkit that extracts hAtom, there is also a demo here
Copyright
This specification is (C) 2005-2023 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.
- Tantek: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
- When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.
特許
ã“ã®ä»•様ã¯ãƒã‚¤ãƒ¤ãƒªãƒ†ã‚£ãƒ¼ãƒ•リーã®ç‰¹è¨±æ–¹é‡ã«å¸°å±žã™ã‚‹ã‚‚ã®ã§ã™ã€‚特許方é‡ã«é–¢ã—ã¦ã¯W3C Patent Policyã‚„RFC3667ã€RFC3668ã‚’ã”覧下ã•ã„。
References
Normative References
Informative References
Further Reading
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 hAtom:
Version 0.1
Version 0.1 was released 28 February 2006.
Discussions
Q&A
- If you have any questions about hAtom, check the hAtom FAQ, and if you don't find answers, add your questions!
Issues
- Please add any issues with the specification to the separate hAtom issues document.
See Also
- h-entry - latest markup spec for Atom entries in HTML
- h-feed - brainstorm/experiment for feeds in HTML
- hAtom - the draft proposal.
- hAtom Cheatsheet - hAtom properties.
- hAtom Examples, in the Wild
- hAtom Hints - help for implementors.
- hAtom Issues - problems? complaints? ideas? Put them here.
- hAtom Brainstorming - active work on iterations toward the next version of hAtom
- hAtom FAQ - knowledge base.
- hAtom advocacy - encourage others to use hAtom.
- rel="enclosure" - how to semantically reference enclosures (e.g. podcasts) in hAtom
- blog-post-brainstorming
- Current Blog Formats
- blog-post-examples
- blog-post-feed-equivalence
- blog-description-format - how to describe a blog (as opposed to the individual entries, which is what we're doing here)
- xhtml-syndication
Translations
Read the hAtom draft specification in additional languages: