Difference between revisions of "hresume"
m (→Publications: - fixed typo)
|Line 147:||Line 147:|
=== Publications ===
=== Publications ===
<cite>Breeding for Fun and Magic</cite>, Idaho Press, 2004.
Revision as of 02:53, 10 August 2006
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
- 1 hResume
- 1.1 Microformats Draft Specification
- 1.2 Status
- 1.3 Introduction
- 1.4 Format
- 1.5 Examples
- 1.6 Examples in the wild
- 1.7 Implementations
- 1.8 Copyright
- 1.9 Patents
- 1.10 References
- 1.11 Acknowledgements
- 1.12 Related Pages
- 1.13 Further Reading
Draft, version 0.1.
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.
- 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.
- For types with multiple components, use nested elements with class names equivalent to the names of the components.
- Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
- Use the most accurately precise semantic XHTML building block for each object etc.
- Otherwise use a generic structural element (e.g.
<div>), or the appropriate contextual element (e.g. an
- 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.
- 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
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.
The hResume schema consists of the following:
- summary. optional. text.
- contact info. required. Must use hCard. Should use
- experience. optional. One or more hCalendar 1.0 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 1.0 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 '
- affiliations. optional. the class name
affiliationalong with an hCard 1.0 of the organization
- publications. optional. One or more citations. Use cite tag.
The fields of the hResume schema represent the following:
hresume:: root class name
summary:: The class name
summaryis used to mark up an overview of qualifications and objectives.
- contact:: Current contact info in an hCard 1.0. Should use
<address>with hCard 1.0 when possible.
education:: the class name '
education' is applied to an hCalendar 1.0 event.
experience:: the class name '
experience' is applied to an hCalendar 1.0 event. Job titles/positions should use an hCard 1.0.
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 1.0 of the organization
- publications:: just use
<cite>. When there is a Citation microformat efforts microformat, then that can be used in combination with the cite element to further markup the components of the citation.
- hResume Profile (@TODO)
This section is informative.
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>
<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:email@example.com">firstname.lastname@example.org</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>
<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> ...
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> ...
To express one or more job titles/positions in the same experience event you should use hCards. hCard 1.0 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.
<span class="vcard"> <object data="#j" class="include"></object> <span class="org">Preston High School</span> <span class="title">Class President</span> </span>
j" is the id attribute value of the "
fn n" element of the contact hCard 1.0 at the top of the page, e.g. (shown here as a verbose hCard 1.0 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.
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>.
<span class="affiliation vcard"><span class="fn org">National Honor Society</span></span>
<cite>Breeding Tigers 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.
- Kenn Wilson has marked up his resume using hResume, following Ralph Brandi's method of using object.include.
- Ralph Brandi has marked up his resume with hResume, additionally using the object.include method to associate one description with three hCalendar experiences.
- Pat Ramsey has his resume marked up as an hResume.
- Wim Le Page has also marked up his curriculum vitae as an hResume.
- Jonathan Arkell has posted an hResume on his portfolio website.
- Steve Ganz - hResume 0.1
- Dave Cardwell has marked up his curriculum vitae as an hResume.
- Lindsey Simon has his resume marked up as an hResume - with lots of thanks to Pat Ramsey.
- User:BenWard has published his CV with hResume.
- Kelley Chambers has published her resume via Sajid Saiyed's Microformat hResume Plugin for Wordpress.
Examples with problems
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...
- The Sajid Saiyed has created an hResume WordPress plugin located at Microformat Resume Plugin. See an example of the hResume markup here.
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.
- Resume Formats
- Feedback is encouraged on the hresume-feedback page.
- If you have any questions about hResume, check the hResume FAQ, and if you don't find answers, add your questions to the end!
- Please add any issues with the specification to the separate hResume issues document.
- See also blogs discussing this page.