h-resume: Difference between revisions
(validating) |
GRegorLove (talk | contribs) (s/<source>/<syntaxhighlight>/) |
||
(19 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:h-resume}} | |||
<span class="h-card vcard"><span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span> | <span class="h-card vcard"><span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span> | ||
---- | ---- | ||
<dfn style="font-style:normal;font-weight:bold">h-resume</dfn> is a simple, open format for publishing resumes and CVs on on the web. h-resume is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML | <dfn style="font-style:normal;font-weight:bold">h-resume</dfn> is a simple, open format for publishing resumes and CVs on on the web. h-resume is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML. | ||
h-resume is the [[microformats2]] update to [[hResume]]. | h-resume is the [[microformats2]] update to [[hResume]]. | ||
{{cc0-owfa-license}} | |||
== Example == | == Example == | ||
Here is a simple resume example: | Here is a simple resume example: | ||
< | <syntaxhighlight lang="html"> | ||
<div class="h-resume"> | <div class="h-resume"> | ||
<a class="p-contact h-card" href="http://example.org"> | <span class="p-name"> | ||
<a class="p-contact h-card" href="http://example.org"> | |||
<img src="http://example.org/photo.png" alt="" /> | <img src="http://example.org/photo.png" alt="" /> | ||
Joe Bloggs | Joe Bloggs | ||
</ | </a> | ||
resume | |||
</span> | |||
<p class="p-summary">Joe is a top-notch llama farmer with a degree in <span class="p-skill">Llama husbandry</span> and a thirst to produce the finest wool known to man</p> | <p class="p-summary">Joe is a top-notch llama farmer with a degree in <span class="p-skill">Llama husbandry</span> and a thirst to produce the finest wool known to man</p> | ||
</div> | </div> | ||
</ | </syntaxhighlight> | ||
Parsed JSON: | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
"items": [ | |||
{ | |||
"type": [ | |||
"h-resume" | |||
], | |||
"properties": { | |||
"name": [ | |||
"Joe Bloggs resume" | |||
], | |||
"contact": [ | |||
{ | |||
"value": "Joe Bloggs", | |||
"type": [ | |||
"h-card" | |||
], | |||
"properties": { | |||
"name": [ | |||
"Joe Bloggs" | |||
], | |||
"photo": [ | |||
"http://example.org/photo.png" | |||
], | |||
"url": [ | |||
"http://example.org" | |||
] | |||
} | |||
} | |||
], | |||
"summary": [ | |||
"Joe is a top-notch llama farmer with a degree in Llama husbandry and a thirst to produce the finest wool known to man" | |||
], | |||
"skill": [ | |||
"Llama husbandry" | |||
] | |||
} | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
=== Get started === | === Get started === | ||
Line 27: | Line 75: | ||
== Properties == | == Properties == | ||
h-resume properties, inside an element with class '''h-resume''': | h-resume properties, inside an element with class '''h-resume''': | ||
* '''<code>p-name</code>''' - brief name of the resume | |||
* '''<code>p-summary</code>''' - overview of qualifications and objectives | * '''<code>p-summary</code>''' - overview of qualifications and objectives | ||
* '''<code>p-contact</code>''' - current contact info in an <code>[[h-card]]</code> | * '''<code>p-contact</code>''' - current contact info in an <code>[[h-card]]</code> | ||
* '''<code>p-education</code>''' - an education <code>[[h-event]]</code> event, years, | * '''<code>p-education</code>''' - an education <code>[[h-event]]</code> event, years, embedded <code>[[h-card]]</code> of the school, location. {{main|h-event}} {{main|h-card}} | ||
* '''<code>p-experience</code>''' - a job or other professional experience <code>[[h-event]]</code> event, years, | * '''<code>p-experience</code>''' - a job or other professional experience <code>[[h-event]]</code> event, years, embedded <code>[[h-card]]</code> of the organization, location, job-title. {{main|h-event}} {{main|h-card}} | ||
* '''<code>p-skill</code>''' - a skill or ability, optionally including level and/or duration of experience | * '''<code>p-skill</code>''' - a skill or ability, optionally including level and/or duration of experience | ||
* '''<code>p-affiliation</code>''' - an affiliation with an <code>[[h-card]]</code> organization | * '''<code>p-affiliation</code>''' - an affiliation with an <code>[[h-card]]</code> organization | ||
Line 38: | Line 87: | ||
== Status == | == Status == | ||
'''h-resume''' is a microformats.org draft specification. Public discussion on h-resume takes place on [[h-resume-feedback]] | '''h-resume''' is a microformats.org draft specification. Public discussion on h-resume takes place on [[h-resume-feedback]] and the #microformats [[irc]] channel on irc.freenode.net. | ||
h-resume is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-resumes up with classic [[hResume]] classnames. | h-resume is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-resumes up with classic [[hResume]] classnames. | ||
Line 46: | Line 95: | ||
(stub, add any property explanations here) | (stub, add any property explanations here) | ||
'''p-skill''' has a [[hresume-skill-brainstorm|proposed expansion into competency]] with explicit summary, rating and/or duration components. Based on existing real world adoption, we should consider an h- | '''p-skill''' has a [[hresume-skill-brainstorm|proposed expansion into competency]] with explicit summary, rating and/or duration components. Based on existing real world adoption, we should consider an h-skill vocabulary with p-name, p-rating, and dt-duration properties. | ||
== Examples in the Wild == | == Examples in the Wild == | ||
* | * [https://lejenome.github.io/ Moez Bouhlel] has marked up his [https://lejenome.github.io/resume résumé] using h-resume. | ||
* [[User:Almorca|Almorca]] has marked up [http://www.almorca.es/ his personal web page (in spanish)]. | |||
* [https://petermolnar.net/ Peter Molnar] has marked up [https://petermolnar.net/about.html his resume] (on his about page) using h-resume. | |||
* View (and add!) more examples here: | |||
** https://indieweb.org/resum%C3%A9#IndieWeb_Examples | |||
'''Archived examples''' (past examples from sites that may be gone, down, or had markup changes) | |||
* [[User:Csarven|Sarven Capadisli]] marked up his [https://web.archive.org/web/20160309095003/http://csarven.ca/cv Curriculum Vitae] as an h-resume. | |||
* … find archive.org links for any broken examples above and move them here | |||
== Validating == | |||
{{h-spec-section-validating}} | {{h-spec-section-validating}} | ||
== Backward Compatibility == | == Backward Compatibility == | ||
Line 77: | Line 133: | ||
* [[microformats2]] | * [[microformats2]] | ||
* [[h-card]] and [[h-event]] are both | * [[h-card]] and [[h-event]] are both embedded in h-resume | ||
* The [[include-pattern]] is likely to be useful to avoid repeating information in any | * The [[include-pattern]] is likely to be useful to avoid repeating information in any embedded h-cards | ||
* [[hResume]] is the classic microformat replaced by h-resume | * [[hResume]] is the classic microformat replaced by h-resume | ||
[[Category:Draft Specifications]] | [[Category:Draft Specifications]] |
Latest revision as of 21:53, 13 November 2022
Tantek Çelik (Editor)
h-resume is a simple, open format for publishing resumes and CVs on on the web. h-resume is one of several open microformat draft standards suitable for embedding data in HTML.
h-resume is the microformats2 update to hResume.
Per CC0, to the extent possible under law, the editors have waived all copyright and related or neighboring rights to this work. In addition, as of 2024-11-21, the editors have made this specification available under the Open Web Foundation Agreement Version 1.0.
Example
Here is a simple resume example:
<div class="h-resume">
<span class="p-name">
<a class="p-contact h-card" href="http://example.org">
<img src="http://example.org/photo.png" alt="" />
Joe Bloggs
</a>
resume
</span>
<p class="p-summary">Joe is a top-notch llama farmer with a degree in <span class="p-skill">Llama husbandry</span> and a thirst to produce the finest wool known to man</p>
</div>
Parsed JSON:
{
"items": [
{
"type": [
"h-resume"
],
"properties": {
"name": [
"Joe Bloggs resume"
],
"contact": [
{
"value": "Joe Bloggs",
"type": [
"h-card"
],
"properties": {
"name": [
"Joe Bloggs"
],
"photo": [
"http://example.org/photo.png"
],
"url": [
"http://example.org"
]
}
}
],
"summary": [
"Joe is a top-notch llama farmer with a degree in Llama husbandry and a thirst to produce the finest wool known to man"
],
"skill": [
"Llama husbandry"
]
}
}
]
}
Get started
The class h-resume
is a root class name that indicates the presence of an h-resume.
See microformats2-parsing to learn more about property classnames.
Properties
h-resume properties, inside an element with class h-resume:
p-name
- brief name of the resumep-summary
- overview of qualifications and objectivesp-contact
- current contact info in anh-card
p-education
- an educationh-event
event, years, embeddedh-card
of the school, location.Main article: h-eventMain article: h-cardp-experience
- a job or other professional experienceh-event
event, years, embeddedh-card
of the organization, location, job-title.Main article: h-eventMain article: h-cardp-skill
- a skill or ability, optionally including level and/or duration of experiencep-affiliation
- an affiliation with anh-card
organization
All properties are optional.
Status
h-resume is a microformats.org draft specification. Public discussion on h-resume takes place on h-resume-feedback and the #microformats irc channel on irc.freenode.net.
h-resume is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-resumes up with classic hResume classnames.
Property Details
(stub, add any property explanations here)
p-skill has a proposed expansion into competency with explicit summary, rating and/or duration components. Based on existing real world adoption, we should consider an h-skill vocabulary with p-name, p-rating, and dt-duration properties.
Examples in the Wild
- Moez Bouhlel has marked up his résumé using h-resume.
- Almorca has marked up his personal web page (in spanish).
- Peter Molnar has marked up his resume (on his about page) using h-resume.
- View (and add!) more examples here:
Archived examples (past examples from sites that may be gone, down, or had markup changes)
- Sarven Capadisli marked up his Curriculum Vitae as an h-resume.
- … find archive.org links for any broken examples above and move them here
Validating
Test and validate microformats2 markup in general with:
- https://pin13.net/mf2/ - enter your markup directly
- https://pin13.net/ - enter a URL to a page to test where it says "Microformats Parser"
Backward Compatibility
Publisher Compatibility
(stub)
Parser Compatibility
Microformats parsers SHOULD detect the following root class name and property names. A microformats2 parser may use existing microformats parsers to extract these properties. If an "h-resume" is found, don't look for an "hresume" on the same element.
compat root class name: hresume
properties: (parsed as p- plain text unless otherwise specified)
summary
contact
- including compat rootvcard
in the absence ofh-card
education
- including compat rootvevent
in the absence ofh-event
experience
- including compat rootvevent
in the absence ofh-event
skill
affiliation
- including compat rootvcard
in the absence ofh-card
Background
h-resume is based on the existing hResume specification.
See Also
- microformats2
- h-card and h-event are both embedded in h-resume
- The include-pattern is likely to be useful to avoid repeating information in any embedded h-cards
- hResume is the classic microformat replaced by h-resume