View source for value-class-pattern-ja

<entry-title>Value Class Pattern</entry-title>
<!-- sync: english: 2009-06-03T21:58:07 -->

value class パターンは hCard の「[[hcard-ja#値の抜粋|値の抜粋]]」から派生しています。

''この機能は完成し、マークアップに使う準備が整っていると考えています。実装者は適宜アップデートして[[value-class-pattern-feedback|フィードバック]]することが推奨されます。'''注：'''実装者からのフィードバックによってパースの厳密な動きは変わるかもしれませんが、主な手順は安定しています。このページの更新をチェックしておいてください。''

[http://microformats.org/blog/2009/05/12/value-class-pattern/ ブログのアナウンス]も参照してください。

__TOC__
; 編集者
: <span class="vcard"><span class="fn">[[User:BenWard|Ben Ward]]</span></span>
: <span class="vcard"><span class="fn">[[User:Tantek|Tantek Celik]]</span></span>
; 短縮 URL
: <kbd>http://tr.im/valueclass</kbd>

マイクロフォーマットのプロパティの値として、ある要素の一部だけが使われることがあります。これは [[hcard-ja|hCard]] の <code>tel: type</code> や <code>tel: value</code> など、任意サブプロパティがある時に起こる可能性があります。また、プロパティの一番適切な構造として他の内容を含むということもあります。

こういったプロパティでは、<code>value</code> という特別な class 名を使って大きな要素内容からの関連データの抜粋をマークアップします。

== 簡単な例 ==

自宅の電話番号をマークアップするとしましょう。

vCard の一部はこうです。

<source lang=text>TEL;TYPE=HOME:+1.415.555.1212</source>

hCard の一部はこうです。

<source lang=html4strict>
 <span class="tel">
   <span class="type">Home</span>:
   <span class="value">+1.415.555.1212</span>
 </span>
</source>

この場合、<code>tel</code> の <code>value</code> は <code>+1.415.555.1212</code> であり、<code>Home: +1.415.555.1212</code> とはなりません。

マイクロフォーマットのプロパティの値は、そのプロパティを表現している要素中で複数の断片に分けなければならないこともあります。簡潔な文字列や tel のような値を要求するマイクロフォーマットプロパティのため、"value" という class 名の要素（value 要素）を複数使ってそういった断片を抜き出し、単一の値につなぎ合わせることができます。

別の例を挙げます。今度は（イギリスに）地域化した電話番号を使っています。

<source lang=html4strict>
 <span class="tel">
   <span class="type">Home</span>:
   <span class="value">+44</span> (0) <span class="value">1223 123 123</span>
 </span>
</source>

この場合、<samp>+441223123123</samp> というのが電話番号の妥当な''データ''ですが、イギリスで国内向けの電話番号を表すには <samp>(0)</samp> を含めます。つまり、世界のどこかから <kbd>+441223123123</kbd> で電話でき、イギリス国内からは <kbd>01223123123</kbd> で電話できるのです。<kbd>'''+440'''1223123123</kbd> というのは無効な番号なので、地域化された一般的な表示はデータを邪魔することになります。

上のマークアップでは二つの <code>value</code> クラスが電話番号の文字列の対象となり、慣例的な表現に従いながら国際化された有効な番号にもなっています。

もう一つ例を示します。[[geo]] の座標に場所の名前を追加しています。

<source lang=html4strict>
 <p>ブリックレイヤーズ・アームズの外をぶらぶらしています。
    <span class="geo">
      51° 30' 48.45", -0° 8' 53.23"
      (<span class="value">51.513458;-0.14812</span>)
   </span>
  </p>
</source>

文字列全体が地理上の場所ですが、数字だけがマイクロフォーマットパーサーが扱うべき座標をエンコードしているので、<code>value</code> class を使うことでそれを度分秒の形式から分離しています。表現にはそれを含めて、完全な情報としています。

== パースの基本 ==
# value class パターンは簡潔な文字列、一覧になっている値、電話番号、日時プロパティのみに適用されます。email、URL、URI、UID といった種類のプロパティのパースには影響しません。
# そういったマイクロフォーマットプロパティの class 名を持つ要素に <code>value</code> という子孫要素（"value" 要素）がある場合は、パーサーは、その要素の以下の部分を使うべきです。
## value 要素が <code>img</code> か <code>area</code> 要素であれば、その要素の <code>alt</code> 属性の値を使います。
## value 要素が <code>abbr</code> 要素であれば、その要素の <code>title</code> 属性の値を使います。
## その他の要素の場合は、内部のテキストを使います。
# <code>value</code> という class 名を持つプロパティに複数の子孫がある場合（複数の value 要素）
## そのマイクロフォーマットプロパティが簡潔な文字列、一覧になっている値、電話番号を要求していれば、value 要素から抽出した値は、追加の文字や空白を挿入''せずに''結合するべきです。
## マイクロフォーマットプロパティが日時の値を要求している場合については[[#日付と時刻のパース|日時のパース]]の節を参照してください。
# <code>value</code> という class を持つ子孫は、一階層を越えて深くパースしてはいけません。つまり、<code>value</code> という class の <code>foo</code> 要素に <code>value</code> class の <code>bar</code> という<em>子孫</em>があった場合、<code>value</code> として <strong><code>foo</code></strong> の内容を使います。プロパティの値をさらに分離するために class が <code>value</code> の追加要素を入れ子にして使うことはできません。

例

<source lang=html4strict>
 <p class="description">
  <span class="value">
    <em class="value">子犬は最高！</em>
    <strong>でも子猫はもっといい！</strong>
 </span>
</p>
</source>

この例では、<code>description</code> に子要素‘<code>value</code>’があり、その子要素には''孫要素''の‘<code>value</code>’があります。ですが、<code>value</code> のパースは最初の階層で止まり、<code>description</code> のデータは「<samp><code>&lt;em class="value">子犬は最高！&lt;/em>&lt;strong>でも子猫はもっといい！&lt;/strong></code></samp>」であり、「<samp>子犬は最高！</samp>」ではありません。

== 日時の値 ==
マイクロフォーマットのプロパティには ISO8601 の日時の値を要求するものがあります。例えば [[hcalendar-ja|hCalendar]] の <code>dtstart</code> と <code>dtend</code> や [[hAtom]] の <code>published</code> です。

value class パターンを使って、日付と時刻を別々に記述し、それを一つの日時の値に結合することができます。

例：

<source lang=html4strict>
<p>毎週のディナーは、
    <span class="dtstart">
        <abbr class="value" title="2008-06-24">今週は火曜日</abbr>
     の <span class="value">18:30</span>
    </span>
    に。
</p>
</source>

生成：

<source lang=text>
DTSTART:2008-06-24T18:30:00
</source>

タイムゾーンが無いことは、特定のタイムゾーンに依存しない日時である「変動」日時（"floating" datetime）であることを示します。変動日時の例としては、午前７時になるようセットした目覚まし時計や一般的な労働時間の午前９時～午後５時があります。

=== 日付と時刻のパース ===
全ての（それぞれのマイクロフォーマット仕様で定義された）日付と時刻のプロパティに関して、上述した value class パターンのパースルールに加えて（場合によっては代わりとして）以下のルールが適用されます。

"value" 要素が見付かった時、その要素から次のようにして値をパースします。
* 要素が <code>img</code> か <code>area</code> 要素であれば、その要素の <code>alt</code> 属性の値を使います。
* 要素が <code>abbr</code> 要素であれば、その要素の <code>title</code> 属性の値を使います。
* その他の要素の場合は、内部のテキストを使います。
* 値に ISO8601 仕様に従った日付と時刻があるならそれを使い、"value" 要素を探すのをやめます。
* 値に、仕様に従った日付 ＊ のみ ＊ がある場合、特に次の ISO8601 の日付パターンに（[http://ja.wikipedia.org/wiki/ISO_8601 ウィキペディアの ISO8601 概要] にあるように）適合する場合には、
** YYYY-MM-DD
** YYYY-DDD
** それを日付の値として使います。value class パターンを使うためには、ハイフン "-" で区切った年、月、日又は年間通算日（ordinal day）が必要です。
** 日付を定義する "value" 要素が他にあっても無視します。
* 値に（タイムゾーンはあっても無くても）仕様に従った時刻 ＊ のみ ＊ がある場合、それは時刻として次のいずれかにマッチするかパースします。
** HH:MM:SS-XX:YY
** HH:MM:SS+XX:YY
** HH:MM:SS-XXYY
** HH:MM:SS+XXYY
** HH:MM:SSZ
** HH:MM:SS
** HH:MM-XX:YY
** HH:MM+XX:YY
** HH:MM-XXYY
** HH:MM+XXYY
** HH:MMZ
** HH:MM
** HH は時刻のうちの「時」で、00 から 24 まで、10 未満の時の 最初の 0 は省略できます。
** MM は 00 から 59 までの分です。
** SS は 00 から 59（うるう秒では 60）までの秒で、任意です。省略した場合には 00 と推測します。
** XX はタイムゾーンの時間オフセットで、00 から 12 まで、10 未満の時の 最初の 0 は省略できます。
** YY はタイムゾーンの分オフセットで 00 から 59 ですが、実際には世界中で 00、15、30、45 分のオフセットのみが使われます。
** Z は GMT を表す文字 'Z' です。
** class value パターンを使うためは、時、分、秒をコロン ":" で区切る必要があります。
** ですが、タイムゾーンオフセットでの時間と分を区切るコロン ":" は''任意''で、タイムゾーンオフセットと時刻の混同を減らすため、推奨されません。
** （注：HH の 12 という値を 00 として扱うサフィックス { }"am"|{ }"a.m." や HH の 12 未満の値に 12 を加えるサフィックス { }"pm"|{ }"p.m." は―― [http://en.wikipedia.org/wiki/12-hour_clock Wikipedia 英語版の 12 時間時計]に従って――大文字と小文字を区別しません）
** 時刻を定義する "value" 要素が他にあっても無視します。
* 値に、仕様に従ったタイムゾーン ＊ のみ ＊ がある場合、それは次のいずれかにマッチするかパースします。
** -XX:YY
** +XX:YY
** -XXYY
** +XXYY
** -XX
** +XX
** Z
** XX is the time zone hours offset, from 00 to 12 with optional leading 0 for values less than 10.
** YY is the time zone minutes offset, from 00 to 59, though in practice only 00, 15, 30, 45 minute offsets are used in global timezones.
** Z is the literal 'Z' to indicate GMT.
** タイムゾーンを定義する "value" 要素が他にあっても無視します。

=== 起源とテスト ===
value class パターンでの日付と時刻の扱い方は、元々は [[value-excerption-pattern-brainstorming#date_and_time_separation|value-excerption-pattern-brainstorming ページでブレインストーミングしており]]、その分析とフィードバックを起源としています。そこでは拡張にあたっての別の考え方と共に歴史的な詳細を見られるのが興味深いでしょう。

日付と時刻の分離と連結のテストがあります。[[value-excerption-dt-separation-test]] です。

== <code>title</code> 属性からの値のパース ==
<code>value-title</code> という class 名を使って、親プロパティのデータの値が要素の内部テキストではなく <code>title</code> 属性に含まれていることを示すことができます。

これを使って内容の中で同義語を使ったり、マイクロフォーマットのパース用に形式を変えた情報を、内容を壊さずこっそりと発信することができます。

例として日付の即席の地域化を使うことができます。

<source lang=html4strict>
<p>好物のカシューナッツをいつも食べていることがこの国では高くつくことを理解したのは、
 <span class='dtstart'>
  <span class='value-title' title='2008'>去年</span>
 </span>
  のことです。
</p>
</source>

<code>value-title</code> のパース規則は先述の <code>value</code> と同様で、以下の点が異なります。

* マイクロフォーマットのプロパティが <code>value-title</code> という class 名の子要素を持つ場合は、要素の一部をパースする <code>value</code> という class 名とは違い、その要素の <code>title</code> 属性の内容をパースしなければなりません。

=== 機械向けデータ公開用の <code>value-title</code> の使用 ===

The initial usage of <code>value-title</code> is used to publish alternate, parsable forms of property values in a visible context without the use of the <code>abbr</code> element whose semantics already support interpretation of the 'title' attribute as an expanded, more precise form of the content. 

Experience has found that there are some cases in microformats where a number of publishers want to include a precisely accurate and parsable value for a property but do not want it to be visible in their page, even as a tooltip.

For example, full [[ISO8601]] datetimes may be confusing to readers of the page (as a tooltip or when read aloud by a screen reader), and enumerated values such as the <code>type</code> subproperty of hCard's <code>tel</code> property use US-English terms, which are not part of pages in any other language.

Since both of those scenarios have shown to be obstacles for a number of publishers, for these cases, and these alone, there exists a further extension of value-excerption. This extension allows the parsable form of the property to be published ‘silently’ immediately adjacent with the respective local visible content.

Here is an example, with the required use of a first child element with class name <code>value-title</code>:

<source lang=html4strict>
<p class='tel' lang='en-gb'>
  <span class='type'>
    <span class='value-title' title='cell'> </span>
      mobile
    </span>
  <span class='value'>+44 7773 000 000</span>
</p>
</source>

The <samp>cell</samp> value is parsed for the 'type' subproperty, but <samp>mobile</samp> is presented to the user.

In the case of dates:

<source lang=html4strict>
<p class='dtstart'>
  <span class='value-title' title='2009-03-14T16:28-0600'> </span>
  March 14th 2009, around half-past four
</p>
</source> 

A microformats parser will read the ISO8601 format datetime <samp>2009-03-14T16:28-0600</samp>, but users will only see <samp>March 14th 2009, around half-past four</samp>. Testing has shown that the ISO8601 datetime above does not get exposed to any user at all.

=== 機械向けデータの <code>value-title</code> のパース ===

Browsers collapse the <code>value-title</code> span down to a width of <code>0</code>, effectively providing no visual rendering, whilst keeping the element in the DOM. With no physical dimensions, there is no ‘hover’ state, so no tooltip is revealed. Furthermore, the empty element is not passed to assistive technology layers such as VoiceOver.  Screen readers do not read the contents of the title attribute of an empty <code>span</code> element.

We conducted [[value-excerption-value-title-test|thorough testing]] of these parsing behaviors to ensure accessibility.

''Note: Whilst the <code>value-title</code> element is more gracefully written without whitespace inner-text (or as self-closing <code>&lt;foo /></code> element in XHTML), current tools such as WYSIWYG editors and HTML-Tidy will erroneously discard such elements, resulting in parsable data being thrown away by some tools. As such, <code>&lt;span class='value-title'> &lt;/span></code>, including a single whitespace character between the opening and closing tag, is the required pattern for authors, at this time.''

Parsing this final <code>value-title</code> extension imposes some stricter restrictions on usage. These restrictions exist to reduce the impact of <abbr title="Don't Repeat Yourself">DRY</abbr> violations, reduce the opportunity for sites to spoof data, and encourage best practice for maintaining both forms of data accurately.

Where an element with class <code>value-title</code> is to be parsed as data for a property, and that element also contains no non-whitespace content (hereafter referred to as ‘empty’), the following rules apply:

* The ‘empty’ value-title element must be the '''first, non-whitespace child''' of the property element. That is, it should follow immediately after the property is declared, before the human-readable form, and without any additional nesting.
* The ‘empty’ value-title element can only be used for specific properties. Microformat specifications must explicitly state which properties may be used with this extension of the value-class-pattern.
* Where an ‘empty’ value-title element is to be used as the single property value, it must be the ''only'' such <code>value</code> content. That is, the first instance of a conforming <code>value-title</code> element overrides all other <code>value</code> and <code>value-title</code> siblings and/or cousins.
* Tools written to perform Conformance Testing and/or Validation of microformats ''should'' attempt to compare the machine-data and human legible forms of the property data, and advise authors if the forms do not match.

=== value-title の使用制限 ===

Due to the fact that the value-title pattern hides some amount of data which tends to be a machine-specific duplicate of data that is provided in the human readable content, there are two microformats [[principles]] being compromised: '''visibility''' and '''<abbr title="Don't Repeat Yourself">DRY</abbr>'''. Thus the applicability of this pattern is deliberately restricted to properties that have demonstrated through experience a need for it, with no known better alternative.

In general authors should:

# First, try to directly specify microformats property values inline (the most visible, no duplication),
# Then consider using the value-class pattern
## Including multiple value elements for date and time properties
# and then only if those methods are insufficient, consider the value-title pattern.

This document post-dates other microformat specifications, such that they may not yet indicate which properties permit use of this pattern. In the interim, '''only''' the following types of properties should allow the value-title pattern.

* ISO8601 date, datetime, timezone, and duration values
* Enumerated values (such as the hCard tel/email/adr 'type' subproperties)
* Co-ordinates (such as the [[geo]] 'latitude' and 'longitude' properties)
* Telephone number properties (e.g. the hCard 'tel' property)

The [[machine-data]] page has documentation of some of the properties of some specs which experience has shown need a solution like the value-title pattern.

There are some simple reference examples and tests for this pattern on [[value-class-pattern-tests]].

In future use, ''specification authors'' may inherit use of <code>value-title</code> by use of ISO8601 date and time formats, or reuse of other microformats, but specifications should _avoid_ introducing new data structures that depend on or encourage this pattern. New specifications are themselves expected to adhere to the principals of visibile data and <abbr>DRY</abbr>.

=== <abbr title='Frequently Asked Questions'>FAQ</abbr> ===
This section is '''informative'''.

Frequently asked questions about the value-class-pattern. Once this section grows too big, we'll make a separate wiki page (like [[value-class-faq]]).

<div class='discussion'>
* '''Why use an 'empty' element? Why not embed data in the class attribute?'''
** The class attribute is inappropriate for embedded data values, as per the HTML4 specification, which states <code>class</code> is for ‘general purposing processing’, which is defined as ‘e.g. for identifying fields when extracting data from HTML pages into a database, translating HTML documents into other formats, etc.’. ‘General purpose processing’ does not extend to data itself. Furthermore, this method avoids inventing a new string pattern for embedding data.
* '''Why use an 'empty' element? Why not make up a new attribute, like ‘data’?'''
** Microformats exist and function in valid HTML4 and XHTML1. Those are the current standards for web development, and microformats exist for use ''now''. In the future, perhaps future revisions of HTML will offer up another solution. For now, this method has been tested against browsers, and creates a consistant document structure (where machine-form and human-form data are siblings).
* '''The <code>title</code> attribute should only be used for content!'''
** The <code>title</code> attribute _is_ used for content and is read by microformats parsers. This exists for cases where data cannot be parsed with sufficient precision from just the commonly published, visible information. This pattern allows both forms of content to be included, whilst keeping it invisible to human consumers.
</div>

You can also refer to the general [[faq|Microformats FAQ]] and [[principles]].

== 現実の例 ==
This section is '''informative'''.

The following sites and pages have started marking up content with the value-class-pattern, and are thus good places to go for examples with real world content to test with implementations (i.e. parsers). If you use the value-class-pattern in your content, feel free to add it to the '''top''' of this list. Once the list grows too big, we'll make a separate wiki page (like [[value-class-examples-in-wild]]).
<!--

    add new items to the TOP of this list

-->
* [http://georgebrock.com/ George Brocklehurst's activity stream] and [http://blog.georgebrock.com/ blog] use "value-title" for hAtom <code>published</code> property
* [http://ben-ward.co.uk/ Ben Ward's home page] uses:
** "value-title" for hCard <code>bday</code> property
** "value-title" for hAtom <code>updated</code> property
* [http://microformats.org/ microformats.org] uses:
** "value-title" for hAtom <code>updated</code> property in [[http://microformats.org/ microformats.org blog postss]]]
** date and time value separation for hCalendar <code>dtstart</code> property in [[events|microformats.org recent and upcoming events wiki page]]

''Add your site/page(s) that use the value-class-pattern here, along with a brief description of what value-class-pattern features you use, with which microformat(s) and which of its/their properties.''

== 実装 ==

This section is '''informative'''.

The following implementations have been developed which either generate or parse value-class-pattern property values. If you have an value-class-pattern 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 (like [[value-class-implementations]]).
<!--

    add new items to the TOP of this list

-->
* [[Oomph]] Version 2 passes [[value-class-pattern-tests#Date_and_time_values|Date and time values test cases]] and is a thorough implementation of the value class pattern.
* [[X2V]] v0.9.3 and later:
** implements [[#Date_and_time_values|Date and time values parsing]], including am/pm time values
*** thus passes [[value-class-pattern-tests#Date_and_time_values|Date and time values test cases]].
** implements [[#hCalendar_dtend_implied_date|hCalendar implied dtend date]]
* [[Operator]] has *some* implementation of the value-class-pattern according to Michael Kaply, but precisely how much is implemented, for which properties (property types) and which microformats is not currently known.
* [[Optimus]] v0.8 and later implements <code>value-title</code> as [http://twitter.com/DmitryBaranovsk/status/1891253248 announced by Dmitry Baranovskiy].
* ... add your implementation(s) that parse or generate the value-class-pattern here, along with which features you support (hopefully all!) and note any limitations if any.

== 関連ページ ==
This section is '''informative'''.

* [[value-excerption-pattern-issues]]
* [[hcard#Value_excerpting|hCard: Value Excepting]]
* [[value-excerption-pattern-brainstorming]]
* [[machine-data|Machine Data in Microformats]]