hresume: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
No edit summary
(→‎Examples in the wild: Fixed root element on my portfolio)
Line 153: Line 153:


* [[User:Wim Le Page|Wim Le Page]] has also marked up [http://adrem.ua.ac.be/~wlepage/curriculum-vitae/ his curriculum vitae] as an hResume.
* [[User:Wim Le Page|Wim Le Page]] has also marked up [http://adrem.ua.ac.be/~wlepage/curriculum-vitae/ his curriculum vitae] as an hResume.
* [[user:Jonathan Arkell|Jonathan Arkell]] has posted an [http://portfolio.jonnay.net/cv/ hResume] on his (work in progress) portfolio website. ''Root element hResume. Wrong -- [[DavidJanes]]''
* [[user:Jonathan Arkell|Jonathan Arkell]] has posted an [http://portfolio.jonnay.net/cv/ hResume] on his portfolio website.
* [http://steve.ganz.name/hresume/ Steve Ganz - hResume 0.1]
* [http://steve.ganz.name/hresume/ Steve Ganz - hResume 0.1]
* [[User:Dave Cardwell|Dave Cardwell]] has marked up [http://davecardwell.co.uk/cv/ his curriculum vitae] as an hResume. ''When this is downloaded outside of a browser, WTF it doesn't appear to be HTML? The root element is "htmllang"? -- [[DavidJanes]]''
* [[User:Dave Cardwell|Dave Cardwell]] has marked up [http://davecardwell.co.uk/cv/ his curriculum vitae] as an hResume. ''When this is downloaded outside of a browser, WTF it doesn't appear to be HTML? The root element is "htmllang"? -- [[DavidJanes]]''
* [[user:Izo|Mathieu Drouet]] has posted an [http://izo.aucuneid.com/hresume.html hResume]. ''Incorrect root class name hResume?  -- [[DavidJanes]]''
* [[user:Izo|Mathieu Drouet]] has posted an [http://izo.aucuneid.com/hresume.html hResume]. ''Incorrect root class name hResume?  -- [[DavidJanes]]''


== Profile ==
== Profile ==

Revision as of 00:07, 14 April 2006

hResume

hResume is a microformat for publishing resumes and CVs.

This paragraph is where we write some thing that makes everyone in the world want to use hResume. Because, you know, hResume's the future and people like the future. And so on... Wanna get started on hResume right now?

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

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. <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. The <address> with hCard.
  • 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.

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.

Profile

@TODO

Implementations

@TODO

References

Normative References

Informative References

@TODO

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.


Acknowledgements

Concept

See also

Discussions

Q&A

  • If you have any questions about hResume, check the hResume FAQ, and if you don't find answers, add your questions to the end!

Issues

  • Please add any issues with the specification to the separate hResume issues document.