hresume-ja: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(Undo revision 35547 by PasboAcelv (Talk))
m (→‎Semantic XHTML Design Principles: use Japanese edition)
Line 20: Line 20:
== Introduction ==
== Introduction ==
=== Semantic XHTML Design Principles ===
=== Semantic XHTML Design Principles ===
{{SemanticXHTMLDesignPrinciples}}
{{semantic-xhtml-design-principles-ja}}


== Format ==
== Format ==

Revision as of 05:02, 10 May 2009

hResume

hResumeは、経歴(resume)や履歴書(CV)を公開するためのmicroformatです。hResume is one of several open microformat standards suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML.

Want to get started with writing an hResume? Use the hResume Creator to create your hResume and publish it, or follow the hResume authoring tips to add hResume markup to your web page or blog.

Microformats Draft Specification

Editor/Author
Ryan King
Acknowledgments
See acknowledgments.

Microformats copyright and patents statements apply.

Status

Draft, version 0.1.

Introduction

Semantic XHTML Design Principles

注:セマンティック XHTML デザイン指針は、始め hCardhCalendar 開発の文脈で書かれました。そのため、この指針は hCard デザインの方法論の文脈において理解しやすくなるでしょう(つまり、そちらをまず読んでください)。Tantek

XHTML は XML に基づいて作られており、そのため XHTML に基づいたフォーマットは、表示に便利なだけでなく一般的なデータ交換目的にも使えます。XHTML に基づいたフォーマットは、多くの点で HTML と XML の世界双方の最もよい所を体現しています。とは言え、XHTML に基づいたフォーマットを作成する時、指針を集めたものがあると役立ちます。

  1. 可能な限り、言及している、既存の確立されてよくサポートされている標準からスキーマ(名前、オブジェクト、プロパティ、値、種類、階層、制約)を再利用する。元の標準で表現されている制約を再宣言することは避ける。参考情報のために言及するのはよい。
    1. 複数の構成要素からなる種類のものには、その構成要素の名前に相当する class 名を持った要素を入れ子にして使う。
    2. 複数の構成要素は一つずつにする。そのため、カンマ区切りの複数のテキスト値を表すには、複数の要素を埋め込んで使う。
  2. 各オブジェクトなどのブロックを構成するのに一番適した意味的な XHTML を使う。
  3. そういったものが無ければ、構造を作る一般的な要素(例えば <span><div>)か文脈に適した要素(例えば <ul><ol> 中の <li>)を使う。
  4. 元のスキーマのその部分を的確に表現する XHTML の構成ブロックが無ければ、元のスキーマ由来の名前に基づいた class 名を使う。元のスキーマ中の名前が大文字と小文字を区別しないならば、相当するものを全て小文字にして使う。構成要素の(明確に定義されたスキーマではなく)日常語風の暗黙的な名前も、使いやすさのために、相当するものを全て小文字にして使うべきである。構成要素名中のスペースはダッシュ '-' 文字になる。
  5. 最後に、元のスキーマに従ったデータの形式があまりに長かったり人間に馴染まない場合、構造を作る一般的な要素の代わりに <abbr> を使い、忠実に従ったデータを(表現を記述する属性である)'title' 属性の中へ、相当するより簡潔で人間に読みやすいものを要素自体の中へ置く。<abbr> のこの使い方に関する説明のより多くの情報:Human vs. ISO8601 dates problem solved(人間 vs ISO8601 日付問題の解決)

Format

In General

The hResume format is based on a set of fields common to numerous resumes published today on the web. Where possible field names have been chosen and reused from preexisting microformats.

Schema

The hResume schema consists of the following:

  • hResume
    • summary. optional. text.
    • contact info. required. Must use hCard. Should use <address> + hCard.
    • experience. optional. One or more hcalendar events with the class name 'experience', with an embedded hCard indicating the job title, name of company, address of company etc.
    • education. optional One or more hcalendar events with the class name 'education', with an embedded hCard indicating the name of school, address of school etc.
    • skills. optional. phrases or keywords using the rel-tag microformat with the class name 'skill'.
    • affiliations. optional. the class name affiliation along with an hcard of the organization
    • publications. optional. One or more citations. Use cite tag.

Field details

The fields of the hResume schema represent the following:

  • hresume:: root class name
  • summary:: The class name summary is used to mark up an overview of qualifications and objectives.
  • contact:: Current contact info in an hCard. Should use <address> with hCard when possible.
  • education:: the class name 'education' is applied to an hcalendar event.
  • experience:: the class name 'experience' is applied to an hcalendar event. Job titles/positions should use an hCard.
  • skill:: An hResume may be tagged using the rel-tag microformat and the 'skill' class name.
  • affiliation:: The class name <code="class-name">affiliation is used along with an hcard of the organization
  • publications:: just use <cite>. When there is a citation microformat, then that can be used in combination with the cite element to further markup the components of the citation.

XMDP Profile

Notes

This section is informative.

  • ...

Examples

Summary

An example summary:

<p class="summary">
  I have 10 years experience with all Web 2.0 technologies– I've been working with Ajax since 1996, 
  designing with pastels while others will still using tiled background images and frames...
</p>

Contact

<address class="vcard">
  <span class="fn">Pedro Sanchez</span>
  <span class="adr">
    <span class="street-address">123 Fake St.</span>
    <span class="locality">Preston</span>, <span class="region">Idaho</span> <span class="postal-code">83263</span>
  </span>
  <span>Email: <a class="email" href="mailto:joe@example.com">pedro@vote-for-pedro.com</a></span>
  <span>Homepage: <a class="url" href="http://vote-for-pedro.com/">vote-for-pedro.com</a></span>
  <span>Phone: <span class="tel">+01.208.555.4567</span></span>
</address>

Education

<ol class="vcalendar">
  <li class="education vevent">
    <a class="url summary" href="http://example.edu/">Preston High School</a>
    (<abbr class="dtstart" title="2001-01-24">2001</abbr> - <abbr class="dtend" title="2005-05-25">2005</abbr>)
  </li>
  ...

Experience

Basic

A basic experience event:

<ol class="vcalendar">
  <li class="experience vevent">
    <span class="summary">President</span>,
    <span class="location">Preston High School</span>,
    <abbr class="dtstart" title="2004-09-01">May 2004</abbr> - <abbr title="2005-05-25">present</abbr>
  </li>
  ...

Job Titles

To express one or more job titles/positions in the same experience event you should use hCards. hcard requires the fn ("formatted name") field, but it isn't reasonable to repeat your name for every job title you mark up in hresume. So, you may use an <object> and the class name 'include' with a reference to the fn somewhere else on the page.

For example, this hCard refers to another hCard

<span class="vcard">
  <object  data="#j" class="include"></object>
  <span class="org">Preston High School</span>
  <span class="title">Class President</span>
</span>

Where "j" is the id attribute value of the "fn n" element of the contact hCard at the top of the page, e.g. (shown here as a verbose hCard for purposes of illustration that the reference may be to a subtree, not just a text node):

<address class="vcard">
  <span class="fn n" id="j">
    <span class="given-name">Pedro</span>
    <span class="family-name">Sanchez</span>
  </span>
</address>

This method of hCard property indirection via an object element has been generalized to apply to any/all string/text properties in hCard. Note: the object data attribute MUST be a local ID reference. External references (which would require a consuming application to load an external resource) are currently not supported by this method.

Skills

Some sample skills tags:

I have skills in <a class="skill" rel="tag" href="http://en.wikipedia.org/wiki/Bow_%28weapon%29">bow hunting</a> 
and <a class="skill" rel="tag" href="http://en.wikipedia.org/wiki/Nunchucks">nunchucks</a>.

Affiliations

<span class="affiliation vcard"><span class="fn org">National Honor Society</span></span>

Publications

<cite>Breeding Ligers for Fun and Magic</cite>, Idaho Press, 2004.

Examples in the wild

This section is informative.

The following sites have published hResumes, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you have an hResume on your own page, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

Examples with problems

Implementations

This section is informative.

The following implementations have been developed which either generate or parse hResumes. If you have an hResume 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.

  • The Spur team has created an hResume WordPress plugin located at hResume Plugin. See an example of the hResume markup here. Neat feature of the hResume plugin is that it automatically creates a new page for the resume - no cutting and pasting...
  • Spur also created a standalone hResume Creator located at hResume Creator. The creator will generate hResume markup ready to cut and paste into your webpage.

Copyright

This specification is (C) 2006 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.

Patents

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

References

Normative References

Informative References

@TODO

Acknowledgements

Concept

Related Pages

Further Reading