hresume: Difference between revisions
No edit summary |
(added format) |
||
Line 17: | Line 17: | ||
== Status == | == Status == | ||
'''Very rough draft, work in progress.''' | '''Very rough draft, work in progress.''' | ||
Line 23: | Line 25: | ||
=== Semantic XHTML Design Principles === | === Semantic XHTML Design Principles === | ||
{{SemanticXHTMLDesignPrinciples}} | {{SemanticXHTMLDesignPrinciples}} | ||
== Format == | == 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. <code class="element"><address></code> + [[hcard|hCard]]. | |||
** education. optional. One or more [[hcalendar]] events with the class name '<code class="class-name">education</code>', with an embedded [[hcard|hCard]] indicating the job title, name of company, address of company etc. | |||
** experience. optional One or more [[hcalendar]] events with the class name '<code class="class-name">experience</code>', with an embedded [[hcard|hCard]] indicating the name of school, address of school etc. | |||
** skills. optional. phrases or keywords using the [[rel-tag]] microformat with the class name '<code class="class-name">skill</code>'. | |||
** affiliations. optional. the class name <code class="class-name">affiliation</code> along with an [[hcard]] of the organization | |||
** publications. optional. One or more citations. Use cite tag. | |||
** references. optional. One or more references. | |||
=== Field details === | |||
The fields of the hReview schema represent the following: | |||
* '''summary''':: This optional field serves as a overview of qualifications and objectives. | |||
* '''contact''':: Current contact info. The <code class="element"><address></code> with [[hCard]]. | |||
* '''education''':: the class name '<code class="class-name">education</code>' is applied to an [[hcalendar]] event. | |||
* '''experience''':: the class name '<code class="class-name">experience</code>' is applied to an [[hcalendar]] event. Job titles/positions should use an [[hCard]]. | |||
* '''skills''':: An hResume may be tagged using the [[rel-tag]] microformat and the '<code class="class-name">skill</code>' class name. | |||
* '''affiliations''':: The class name <code="class-name">affiliation</code> is used along with an [[hcard]] of the organization | |||
* '''publications''':: just use <code class="element"><cite></code>. 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. | |||
* '''rel="reference"'''. For references, link to the person with rel="reference" and any other [http://gmpg.org/xfn/ XFN] values that apply (e.g. "colleague", "co-worker", "friend", "kin" etc.), and use [[hcard|hCard]] to markup the name of the reference. | |||
=== Notes === | |||
This section is informative. | |||
*... | |||
== Examples == | == Examples == |
Revision as of 07:57, 9 February 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
Very rough draft, work in progress.
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.
- 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.
<span>
or<div>
), or the appropriate contextual element (e.g. an<li>
inside a<ul>
or<ol>
). - 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
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. - education. optional. One or more hcalendar events with the class name '
education
', with an embedded hCard indicating the job title, name of company, address of company etc. - experience. optional One or more hcalendar events with the class name '
experience
', 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.
- references. optional. One or more references.
Field details
The fields of the hReview schema represent the following:
- summary:: This optional field serves as a 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. - skills:: An hResume may be tagged using the rel-tag microformat and the '
skill
' class name. - affiliations:: 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. - rel="reference". For references, link to the person with rel="reference" and any other XFN values that apply (e.g. "colleague", "co-worker", "friend", "kin" etc.), and use hCard to markup the name of the reference.
Notes
This section is informative.
- ...
Examples
@TODO
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
- Ryan King, Technorati
- Tantek Çelik, Technorati
- SimplyHired guys... @TODO
- Kevin Marks, Technorati