Microformats Wiki - User contributions [en]

citation-formats

2006-07-30T21:14:58Z

FredStutzman: /* BibTeX */ Adding practical examples of software that supports the bib format.

= Citation Formats =

This page will display several different types of citation format types. The idea is to compare what properties are common amonst all of the formats and which ones should be blended into this microformat.

See also:
* [[citation]]
* [[citation-brainstorming]]
* [[citation-examples]]
* [[citation-faq]]

== Comparison chart ==
The following chart maps the terms from one implementation to another. This is important because if all the properties are introduced to this microformats, then its possible to map them to a number of different formats. The table currently only uses Dublin Core, MODS, and bibTeX. Each column has all the properties and their equivalent in each format. If there is no corresponding property the cell is grey. At the bottom of the list are the unique terms to each format. Dublin core has basic terms and terms that extend the basic ones. If the property is an extention of a basic term it is in ()'s. MODS uses XML, so any sub-properties are listed in their tree form, property/sub-property.

THIS IS NOT DEFINIATIVE, any errors should be corrected. More formats will be added to the list as they are mapped.

<table border="1">
<tr>
<th>Dublin Core</th>
<th>MODS</th>
<th>bibTeX</th>
<th>Z39.80</th>
</tr>
<tr>
<td>Title (alternative)</td>
<td>titleInfo/title<br/>titleInfo/PartNum</td>
<td>booktitle<br/>title<br/>chapter<br/>number<br/>pages<br/>volume<br/>series</td>
<td>Analytic Title<br/>
Collective or Series Title<br/>
Monographic Title<br/>
Work Fraction Title<br/>
Location of Conference<br/>
Main Entry<br/>
Name of Conference<br/>
Number of Meeting<br/>
Other Title<br/>
Parallel Title<br/>
Title Abbriviation<br/>
Title of Conference Proceedings<br/>
Translated Title<br/>
Uniform Title<br/>
Abbriviated Translated Title<br/>
Symposium or Session Title<br/>
Collective or Series Edition<br/>
Video/Film Edition<br/>
</td>
</tr>
<tr>
<td>creator</td>
<td>name/namePart</td>
<td>author<br/>creator</td>
<td>Author, Primary<br/>
Corporate Author, Primary<br/>
Abstract Author<br/>
Authorship Statement<br/>
Acknowledged Supporters<br/>
Assignee for Patents<br/>
Chairperson of Conference<br/>
Director of AV Program<br/>
Other Author<br/>
Reviewed Book Author<br/>
Studio<br/>
Sponsor of Conference<br/>
Staff/Cast<br/>
Symposium Chairperson<br/>
Author Address or Affiliation<br/>
Author Country<br/>
Electronic Address of Author<br/>
</td>
</tr>
<tr>
<td>subject</td>
<td>subject/topic</td>
<td>keywords</td>
<td>needs mapping</td>
</tr>
<tr>
<td>Description (abstract | tableOfContents)</td>
<td>abstract<br/>note<br/>tableOfContents</td>
<td>abstract<br/>annotation<br/>note<br/>contents</td>
<td>needs mapping</td>
</tr>
<tr>
<td>Contributor</td>
<td>name</td>
<td>editor?</td>
<td>Book/Report/Volume Editor<br/>
Producer<br/>
Translator<br/>
</td>
</tr>
<tr>
<td>Date (available | created | dateAccepted | dateCopyrighted | dateSubmitted | issued | modified | valid)</td>
<td>originInfo/dateIssued<br/>originInfo/dateCreated<br/>originInfo/dateCaptured<br/>originInfo/dateOther</td>
<td>month<br/>year</td>
<td>Copyright Year<br/>Date-generic<br/>Date of conference<br/>Date of Publication<br/>Date of Update/Revisou/Issuance of Database Record<br/>Former Date<br/>Entry date for Database Record<br/>Database Update<br/>Year of Publication</td>
</tr>
<tr>
<td>Type</td>
<td>typeOfResource<br/>genre</td>
<td>@class<br/>type</td>
<td>needs mapping</td>
</tr>
<tr>
<td>Format (extent | medium)</td>
<td>physicalDescription/internetMediaType<br/>physicalDescription/extent<br/>physicalDescription/form</td>
<td>howpublished</td>
<td>needs mapping</td>
</tr>
<tr>
<td>identifier (bibliographicCitation)</td>
<td>identifier</td>
<td>ISBN<br/>ISSN<br/>LCCN<br/>URL</td>
<td>ISBN<br/>Identifier<br/>Report Identfier<br/>ISSN</td>
</tr>
<tr>
<td>Source</td>
<td>relatedItem</td>
<td bgcolor="#cccccc"></td>
<td>needs mapping</td>
</tr>
<tr>
<td>language</td>
<td>language</td>
<td>language</td>
<td bgcolor="#cccccc"></td>
</tr>
<tr>
<td>Relation (...)</td>
<td>relatedItem/...</td>
<td>crossRef</td>
<td>needs mapping</td>
</tr>
<tr>
<td>Coverage (spacial | temporal)</td>
<td>subject/temporal<br/>subject/geographic<br/>subject/hierarchicalGeographic<br/>subject/cartographics</td>
<td></td>
<td>needs mapping</td>
</tr>
<tr>
<td bgcolor="#cccccc"></td>
<td>classifications</td>
<td bgcolor="#cccccc"></td>
<td>needs mapping</td>
</tr>
<tr>
<td>Rights (accessRights | license)</td>
<td>accessConditions</td>
<td>copyright</td>
<td>needs mapping</td>
</tr>
<tr>
<td>publisher</td>
<td bgcolor="#cccccc"></td>
<td>publisher</td>
<td>Publisher Name<br/>
Place of Publication<br/>
Country of Publication<br/>
Generic Address<br/>
</td>
</tr>
<tr>
<td>audience (educationLevel | mediator)</td>
<td>targetAudience</td>
<td bgcolor="#cccccc"></td>
<td>needs mapping</td>
</tr>
<tr>
<td bgcolor="#999999">accualMethod<br/>accualPeriodicaty<br/>accualPolicy<br/>instrcutionalMethod<br/>provenance<br/>rightsHolder</td>
<td bgcolor="#999999">location<br/>extension<br/>recordInfo</td>
<td bgcolor="#999999">address<br/>afflilication<br/>location<br/>edition<br/>institution<br/>journal<br/>key<br/>mrnumber<br/>organization<br/>price<br/>school<br/>size</td>
<td bgcolor="#999999">(the following need to be mapped to the above rows or left here as other)<br/><br/>
Database Source<br/>
Databse Record Identifier<br/>
Database Producer Name<br/>
Rights Management<br/>
Subfile<br/>
Other Source Identifier<br/>
Vendor Record Identifier<br/>
Database Vendor Name<br/>
Column Number<br/>
Edition<br/>
Frequency of Publication<br/>
Internet Location for Document<br/>
Supplement/Part/Special number identifer<br/>
Issue Identifier<br/>
Location in Work<br/>
Number of the Chapter<br/>
Number in Series<br/>
Volume Identifier<br/>
Section Indentifier<br/>
</td>
</tr>
</table>

== Dublin Core Metadata ==
[http://dublincore.org/ Dublin Core] metadata uses a small vocabulary to descibe the data.
* contributor
* coverage
* creator
* date
* description
* format
* identifier
* language
* publisher
* relation
* rights
* source
* subject
* title
* type

From those there are specialised types where are just refinments of the previous, for example:

* abstract refines description.
* accessRights refines rights

[http://dublincore.org/documents/dc-citation-guidelines/ Guidelines for Encoding Bibliographic Citation Information in Dublin Core Metadata]

== MODS (Metadata Object Description Schema) ==
This is a format developed for the Libray of Congress for a bibliographic element set that may be used for a variety of purposes, and particularly for library applications.

[http://www.loc.gov/standards/mods/ http://www.loc.gov/standards/mods/]

(the schema is very big, once i devote the proper time to review it, i will post more about the structure -brian)

== NLM Journal Publishing DTD ==

[http://dtd.nlm.nih.gov/publishing/tag-library/2.1/n-fv30.html http://dtd.nlm.nih.gov/publishing/tag-library/2.1/n-fv30.html]

The [http://dtd.nlm.nih.gov/publishing/tag-library/ NLM Journal Publishing DTD] defines the schema used for publishing journal articles as XML. The <pre><citation></pre> element can be placed with paragraphs or within a <pre><ref-list></pre> element at the end of the article.

"Although the DTD does not enforce it, a citation to a journal article should be tagged with as many as possible of the following, so that PubMed Central, CrossRef, or other matching service can make the citation into a live link:

<table border="1">
<tr><td>source</td><td>The title of a journal, book, conference proceedings, etc. that is the source of the cited material. (Note: In PubMed Central processing, this is typically the MEDLINE abbreviation of the journal name.)</td></tr>
<tr><td>article-title</td><td>Title of the article</td></tr>
<tr><td>volume</td><td>Volume of the journal</td></tr>
<tr><td>issue</td><td>Issue of the journal</td></tr>
<tr><td>fpage</td><td>Page number on which the article starts</td></tr>
<tr><td>name</td><td>Name of an author or editor</td></tr>
<tr><td>year</td><td>Year of publication</td></tr>
<tr><td>month</td><td>Month of publication (if present)</td></tr>
<tr><td>day</td><td>Date of publication (if present)</td></tr>
</table>

The other elements (described [http://dtd.nlm.nih.gov/publishing/tag-library/2.1/n-fv30.html here]) may be tagged if desired. Use the <source> element for titles of books, conference proceedings, etc."

== XMLResume ==
<pre>
<!ELEMENT pubs (pub+)>
<!ENTITY % pubElements "(artTitle|bookTitle|author|date|pubDate|publisher|pageNums|url)">
<!ELEMENT pub (para | %pubElements;)*>
<!ATTLIST pub id ID #IMPLIED>
<!ELEMENT artTitle (#PCDATA | link)*>
<!ELEMENT bookTitle (#PCDATA | link)*>
<!ELEMENT author (#PCDATA)>
<!ATTLIST author name IDREF #IMPLIED>
<!ELEMENT pubDate (month?, year)> 
<!ELEMENT publisher (#PCDATA | link | url)*>
<!ELEMENT pageNums (#PCDATA)>
</pre>

* author
* publication date
* publisher
* pages
* title (article/book)
* url

== BibTeX ==
=== Fields Used by Bibtex ===

<table border="1" width="100%">
<tr>
<td><strong>abstract:</strong></td>
<td>An abstract of the work.</td>
</tr>
<tr>
<td><b>address:</b></td>
<td>Publisher's address. For major publishing houses,
just the city is given. For small publishers, you can help the reader by giving the complete address.</td>
</tr>
<tr>
<td><strong>affiliation:</strong></td>
<td>The author's affiliation.</td>
</tr>
<tr>
<td><b>annote:</b></td>
<td>An annotation. It is not used by he standard bibliography styles, but may be used by others that produce an annotated bibliography.</td>
</tr>
<tr>
<td><b>author:</b></td>
<td>The name(s) of the author(s).</td>
</tr>
<tr>
<td><b>booktitle: </b></td>
<td>Title of a book, part of which is being cited. For book entries, use the <strong>title</strong> field instead.</td>
</tr>
<tr>
<td><b>chapter:</b></td>
<td>A chapter (or section) number.</td>
</tr>
<tr>
<td><strong>contents:</strong></td>
<td>A Table of Contents.</td>
</tr>
<tr>
<td><strong>copyright:</strong></td>
<td>Copyright information.</td>
</tr>
<tr>
<td><strong>crossref:</strong></td>
<td>The database key of the entry being cross-referenced.</td>
</tr>
<tr>
<td><b>edition: </b></td>
<td>The edition of a book - for example
"Second". Notice that it is in capitals.</td>
</tr>
<tr>
<td><b>editor: </b></td>
<td>Name(s) of editor(s). If there is also an author field, then the editor field gives the editor of the book or collection in which the reference appears.</td>
</tr>
<tr>
<td><b>howpublished:</b></td>
<td>How something strange has been published. The first word should be capitalized.</td>
</tr>
<tr>
<td><b>institution:</b></td>
<td>The sponsoring institution of a technical report.</td>
</tr>
<tr>
<td><strong>ISBN:</strong></td>
<td>The International Standard Book Number.</td>
</tr>
<tr>
<td><strong>ISSN:</strong></td>
<td>The International Standard Serial Number. Used to
identify a journal.</td>
</tr>
<tr>
<td><b>journal: </b></td>
<td>A journal name. Abbreviations are provided for many journals.</td>
</tr>
<tr>
<td><b>key: </b></td>
<td>Used for alphabetizing and creating a label when the author and editor fields are missing. This field should not be confused with the key that appears at the beginning of the reference.</td>
</tr>
<tr>
<td><strong>keywords:</strong></td>
<td>Key words used for searching or possibly for annotation.</td>
</tr>
<tr>
<td><strong>language:</strong></td>
<td>The language the document is written in.</td>
</tr>
<tr>
<td><strong>LCCN:</strong></td>
<td>The Library of Congress Call Number.</td>
</tr>
<tr>
<td><strong>location:</strong></td>
<td>A location associated with the entry, such as the city in which a conference took place.</td>
</tr>
<tr>
<td><b>month: </b></td>
<td>The month in which the work was published or, for an unpublished work, in which it was written.</td>
</tr>
<tr>
<td><strong>mrnumber:</strong></td>
<td>The <em>Mathematical Reviews</em> number.</td>
</tr>
<tr>
<td><b>note:</b></td>
<td>Any additional information that can help the reader. First word should be capitalized.</td>
</tr>
<tr>
<td><b>number: </b></td>
<td>The number of a journal, magazine, technical report, or of a work in a series. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number; and sometimes books are given numbers in a named series.</td>
</tr>
<tr>
<td><b>organization: </b></td>
<td>The organization that sponsors a conference or publishes a manual.</td>
</tr>
<tr>
<td><b>pages:</b></td>
<td>One or more page numbers or ranges of number, such as 37--42, or 7,53,82--94.</td>
</tr>
<tr>
<td><strong>price:</strong></td>
<td>The price of the material.</td>
</tr>
<tr>
<td><b>publisher:</b></td>
<td>The publisher's name.</td>
</tr>
<tr>
<td><b>school:</b></td>
<td>The name of the school where a thesis was written.</td>
</tr>
<tr>
<td><b>series:</b></td>
<td>Then name given a series or set of books. When citing an entire book, the title field gives its title and the optional series field gives the name of a series in which the book was published.</td>
</tr>
<tr>
<td><strong>size:</strong></td>
<td>The physical dimensions of the work.</td>
</tr>
<tr>
<td><b>title:</b></td>
<td>The work's title.</td>
</tr>
<tr>
<td><b>type:</b></td>
<td>The type of technical report - for example,
"Research Note".</td>
</tr>
<tr>
<td><strong>url:</strong></td>
<td>The WWW Universal Resource Locator that points to the item being referenced. Often used for technical reports to point to the FTP site where it resides.</td>
</tr>
<tr>
<td><b>volume:</b></td>
<td>The volume of a journal or multivolume book.</td>
</tr>
<tr>
<td><b>year:</b></td>
<td>The year of publication or, for an unpublished work, the year it was written. It should only consist of numerals, such as 1976.</td>
</tr>
</table>

=== BibTeX citation Types ===
A reference can be to any of a variety of types. Following is a list of types. Each one also explains the fields associated with that type. Any fields not listed as required or optional are considered to be ignored.
<table border="1" width="100%">
<tr>
<td><b>article:</b></td>
<td>An article from a journal or magazine. Required fields: author, title, journal, year. Optional fields: volume, number, pages, month, note, key.</td>
</tr>
<tr>
<td><b>book:</b></td>
<td>A book with an explicit publisher. Required fields: author or editor, title, publisher, year. Optional fields: volume, series, address, edition, month, note, key.</td>
</tr>
<tr>
<td><b>booklet: </b></td>
<td>A work that is printed and bound, but without a named publisher or sponsoring institution. Required fields: title. Optional fields: author, howpublished, address, month, year, note, key.</td>
</tr>
<tr>
<td><strong>collection:</strong></td>
<td>A collection of works. Same as Proceedings.</td>
</tr>
<tr>
<td><b>conference:</b></td>
<td>The same as Inproceedings.</td>
</tr>
<tr>
<td><b>inbook:</b></td>
<td>A part of a book, which may be a chapter and/or arange of pages. Required fields: author or editor, title, chapter and/or pages, publisher, year. Optional fields: volumer, series, address, edition, month, note, key.</td>
</tr>
<tr>
<td><b>incollection:</b></td>
<td>A part of a book with its own title. Required fields: author, title, booktitle, publisher, year. Optional fields: editor, pages, organization, publisher, address, month, note, key.</td>
</tr>
<tr>
<td><b>inproceedings:</b></td>
<td>An article in a conference proceedings. Required fields: author, title, booktitle, year. Optional fields: editor, pages, organization, publisher, address, month, note, key.</td>
</tr>
<tr>
<td><b>manual: </b></td>
<td>Technical documentation. Required fields: title. Optional fields: author, organization, address, edition, month, year, note.</td>
</tr>
<tr>
<td><b>mastersthesis:</b></td>
<td>A Master's thesis. Required fields: author, title, school, year. Optional fields: address, month, note, key.</td>
</tr>
<tr>
<td><b>misc:</b></td>
<td>Use this type when nothing else fits. Required fields: none. Optional fields: author, title, howpublished, month, year, note, key.</td>
</tr>
<tr>
<td><strong>patent:</strong></td>
<td>A patent.</td>
</tr>
<tr>
<td><b>phdthesis:</b></td>
<td>A Ph.D. thesis. Required fields: author, title, school, year. Optional fields: address, month, note, key.</td>
</tr>
<tr>
<td><b>proceedings:</b></td>
<td>The proceedings of a conference. Required fields: title, year. Optional fields: editor, publisher, organization, address, month, note, key.</td>
</tr>
<tr>
<td><b>techreport:</b></td>
<td>A report published by a school or other institution, usually numbered within a series. Required fields: author, title, institution, year. Optional fields: type, number, address, month, note, key.</td>
</tr>
<tr>
<td><b>unpublished:</b></td>
<td>A document with an author and title, but not formally published. Required fields: author, title, note. Optional fields: month, year, key.</td>
</tr>
</table>

==== Examples ====
<pre><nowiki>
@book{kn:gnus,

AUTHOR = "Donald E. Knudson",
TITLE = "1966 World Gnus Almanac",
PUBLISHER = {Permafrost Press},
ADDRESS = {Novosibirsk} }

<div class="book" id="kn:gnus">
<div class="author">Donald E. Knudson</div>
<div class="title">1966 World Gnus Almanac</div>
<div class="publisher">Permafrost Press</div>
<div class="address">Novosibirsk</div>
</div>

@article{XAi_HSCheng_1994a,

author = "X. Ai and H. S. Cheng",
title = "Influence of moving dent on point {EHL} contacts",
journal = "Tribol. Trans.",
volume = "37",
year = "1994",
pages = "323--335",
}

<div class="article" id="XAi_HSCheng_1994a">
<div class="author">X. Ai and H. S. Cheng</div>
<div class="title">Influence of moving dent on point {EHL} contacts</div>
<div class="journal">Tribol. Trans.</div>
<div class="volume">37</div>
<div class="year">1994</div>
<div class="pages">323--335</div>
</div>
</nowiki></pre>

===Bib-enabled Applications===

Reference-management applications that support the bib format. <strong>This is an incomplete list</strong>.

====Desktop Applications====
* [http://www.endnote.com EndNote] (Large market share)
* [http://bibdesk.sourceforge.net/ BibDesk]
* [http://www.mackichan.com/index.html?bibdb/default.htm~mainFrame BibDB]
* [http://sourceforge.net/projects/bib-it/ Bib-it]
* Large list of other apps at [http://dmoz.org/Computers/Software/Typesetting/TeX/BibTeX/ dmoz] and [http://en.wikipedia.org/wiki/BibTeX#Software Wikipedia]

====Web Applications====
* [http://www.refworks.com RefWorks] (Large market share)
* [http://www.citeulike.org/ CiteULike]
* [http://citeseer.ist.psu.edu/ CiteSeer]
* [http://www.bibsonomy.org/ BibSonomy]
* [http://www.connotea.org Connotea]
* [http://www.2ndminute.org:8080/amatex Amatex - converts Amazon to Bib format]
* Many others can be found at [http://en.wikipedia.org/wiki/BibTeX#External_links Wikipedia]

====Academic Databases====
* [http://academic.live.com/ Windows Live Academic Search]
* [http://portal.acm.org/dl.cfm?dl=ACM ACM Digital Library]
* [http://www.ncbi.nlm.nih.gov/books/bv.fcgi PubMed] via TexMed

== RIS ==

RIS is similar to BibTeX and is handled by most desktop and web-based bibliography management software.

The specification and field types/tags are described at [http://www.refman.com/support/risformat_intro.asp http://www.refman.com/support/risformat_intro.asp]

In particular, see [http://www.refman.com/support/risformat_reftypes.asp the list of different reference types].

A sample item in RIS format:
<pre>
TY - JOUR
A1 - Baldwin,S.A.
A1 - Fugaccia,I.
A1 - Brown,D.R.
A1 - Brown,L.V.
A1 - Scheff,S.W.
T1 - Blood-brain barrier breach following
cortical contusion in the rat
JO - J.Neurosurg.
Y1 - 1996
VL - 85
SP - 476
EP - 481
RP - Not In File
KW - cortical contusion
KW - blood-brain barrier
KW - horseradish peroxidase
KW - head trauma
KW - hippocampus
KW - rat
ER -
</pre>

[http://www-static.cc.gatech.edu/classes/RWL/Projects/citation/Applet/OnlineHelp/refer_doc.html Refer] is a similar, smaller bibliographic format.

* author
* title
* type
* Identifier
* notes/abstract
* reprint status
* keyword
* volume
* issue
* pages
* year
* periodical name (where published)
* publisher
** publisher city
** publisher address
* related links
* link to PDF
* availablity

== OpenURL ==

OpenURL aka [http://www.niso.org/standards/standard_detail.cfm?std_id=783 Z39.88] defines a standard way of bundling citation data in a URL. It is widely deployed in academic libraries around the world to provide access to licensed content via link resolvers such as [http://www.exlibrisgroup.com/sfx_openurl.htm SFX]. The Context Object in Span ([http://ocoins.info/ COinS]) community standard represents one way to embed OpenURLs in XHTML without including a resolver target. OpenURL also provides an XML encoding.

Example (from a book review written using the Structured Blogging plugin):

<pre><nowiki>
<p><b>ISBN</b>: <span class='Z3988'
title='ctx_ver=Z39.88-2004&amp;rft_val_fmt=info:ofi/fmt:kev:mtx:book&amp;rft.isbn=0679426612'>
0679426612</span></p>
</nowiki></pre>

Another example, a journal this time:
<pre>
<nowiki>
<span class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info:ofi/fmt:kev:mtx:journal&rft.issn=1045-4438"></span>
</nowiki>
</pre>

As you can see this isn't very much like semantic XHTML at all. However significant work has gone into defining the set of Key/Encoded Values (KEVs) that can be used in various [http://alcme.oclc.org/openurl/servlet/OAIHandler?verb=ListRecords&metadataPrefix=oai_dc&set=Core:Metadata+Formats types] of citations: [http://www.openurl.info/registry/docs/mtx/info:ofi/fmt:kev:mtx:book book], [http://www.openurl.info/registry/docs/mtx/info:ofi/fmt:kev:mtx:dissertation dissertation], [http://www.openurl.info/registry/docs/mtx/info:ofi/fmt:kev:mtx:journal journal], [http://www.openurl.info/registry/docs/mtx/info:ofi/fmt:kev:mtx:patent patent]. It would be possible to simply provide a standard XHTML bundling for these keys as a microformat.

=== Example ===

<pre>
<nowiki>

<div class="openurl-journal">
<span class="aulast">Berners-Lee</span>,
<span class="aufirst">Tim</a>; Hendler, James; Lassila, Ora.</span>
"<span class="atitle">The Semantic Web</span>".
<span class="jtitle">Scientific American</span>
<span class="volume">284</span>(<span class="issue">5</span>), pp.
pp. <span class="pages">34-43</span>.
<span class="issn">0036-8733</span>
</div>

</nowiki>
</pre>

Using OpenURL in this way would enable third party applications that could, say grab citation metadata from a blog, and without much work fire it off at your university's or public libraries openurl resolver to see if the article is available via a licensed databases. The benefits [http://www.infotoday.com/newsbreaks/nb050801-1.shtml have] [http://www.ariadne.ac.uk/issue43/chudnov/ been] [http://www.wallandbinkley.com/quaedam/?p=30 noted] [http://hublog.hubmed.org/archives/001163.html elsewhere].

== The OpenURL Briefly Explained ==

An OpenURL consists of two independent parts: the ContextObject (or the bibliographic metadata surrounding a citation) and the location of resolver to parse the metadata and present contextual services based on said metadata. The problem is that the term "OpenURL" is also used as a catch-all for all of the independent parts and how they work. This is mainly because it's a catchier term than "Z39.88", which is the [http://www.niso.org/standards/standard_detail.cfm?std_id=783 NISO standard all this is based upon].

The most common representation of the OpenURL ContextObject is seen as arguments in a URL string (which is referred to as "San Antonio Profile 1" -- more commonly SAP1 -- and is represented in Key Encoded Values -- KEVs). This "representation" is independent of the ContextObject (from here on known as CO) itself and is only intended to permit the CO to be transmitted via an HTTP GET request.

There is also SAP2, which is an XML representation of the CO (see: [http://alcme.oclc.org/openurl/servlet/OAIHandler?verb=GetRecord&metadataPrefix=oai_dc&identifier=info:ofi/fmt:xml:xsd:ctx here] for more information) and is a much more human readable format. This still falls outside the scope of microformats, but makes the point that encoding has nothing to do with the CO itself. They are just agreed upon means of conveying the CO to enable machines act upon them consistently.

The ContextObject could be conveyed just as easily in XHTML using attributes, as long as the terms follow the vocabulary defined in the OpenURL framework. The important thing to focus on here is the ContextObject -- the address of the link resolver ''is'' institution-specific and should be handled by a user's (or machine's) activating agent.

However, the link resolver is still a very important component to this whole process. Getting users "appropriate copy" is a very real (and very difficult) problem that libraries are trying to solve. Link resolvers are a pretty efficient means of overcoming this hurdle, so it would make sense to mark up bibiographic citations in a way that link resolvers can easily parse.

== Z39.80 ==
I'm not sure the best place for a guide to Z39.80 so please add links as you see fit:

[http://www.niso.org/standards/resources/drft4rev.html http://www.niso.org/standards/resources/drft4rev.html]

== DocBook ==

A subset of the DocBook vocabulary is dedicated to representing a bibliography: http://www.docbook.org/tdg/en/html/bibliography.html

<pre><nowiki>
<!DOCTYPE bibliography PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<bibliography>
<title>Languages and Semantics</title>
<bibliodiv>
<title>Books</title>
<biblioentry>
<title>Course in General Linguistics</title>
<abbrev>deSaussure59</abbrev>
<author><firstname>Ferdinand</firstname><surname>de Saussure</surname></author>
<editor><firstname>Charles</firstname><surname>Bally</surname></editor>
<editor><firstname>Albert</firstname><surname>Sechehaye</surname></editor>
<othercredit role="translator"><firstname>Wade</firstname><surname>Baskin</surname></othercredit>
<copyright>
<year>1959</year>
<holder>The Philosophical Library Inc.</holder>
</copyright>
<isbn>07-016524-6</isbn>
<publisher>
<publishername>McGraw-Hill Book Company</publishername>
</publisher>
</biblioentry>
</bibliodiv>
</bibliography>
</nowiki></pre>

* publisher
* copyright
* identifier (ISBN)
* title
* author/editor/other credit/
* type (book)

== Ann Arbor District Library XML feed ==

Here's a record in XML format from their project to simplify
access to the catalog. More discussion on [http://www.blyberg.net John Blyberg's blog].

<pre>
<nowiki>
<p:Record>
<callnum>823 Bu</callnum>
<author>Burkart, Gina, 1971-</author>
<fulltitle>A parent's guide to Harry Potter / Gina Burkart</fulltitle>
<title>A parent's guide to Harry Potter </title>
<pubinfo>Downers Grove, Ill. : InterVarsity Press, c2005</pubinfo>
<desc>112 p</desc>
<bibliography>Includes bibliographical references</bibliography>
<contents>
The Harry hype -- More than a story -- The modern fairy tale -- Discussing fantasy with children --
Morals, not magic -- The real issues in Harry Potter -- Dealing with traumatic experiences -- Facing
fears -- Battling bullies -- Delving into diversity -- Hiding hurts -- Letting go of anger -- Getting
help -- Choosing good over evil -- The power of love -- Facing spiritual battles
</contents>
<isbn>0830832882</isbn>
<price>$11.00</price>
<lang>eng</lang>
<copies>0</copies>
<catdate>08-16-2005</catdate>
<mattype>a</mattype>
<avail>No copies available</avail>
<recordlink xlink:href="http://www.aadl.org/cat/seek/record=1249810"/>
</p:Record>
</nowiki>
</pre>

* url
* availablity
* identifier (ISBN/call number)
* author
* title
* publisher
* pages
* description/contents

== SimpleDC supported by the zoom toolkit ==

<pre>
<nowiki>
<dc xmlns="http/www.loc.gov/zing/srw/dcschema/v1.0/">
<title>Kantor Salomon Sulzer und seine Zeit : eine Dokumentation /</title>
<creator>Avenary, Hanoch.</creator>
<creator>Pass, Walter.</creator>
<creator>Vielmetti, Nikolaus.</creator>
<creator>Adler, Israel, (1925-)</creator>
<subject>Sulzer, Salomon, -- 1804-1890.</subject>
<subject>Jewish composers -- Austria -- Biography.</subject>
<subject>Cantors, Jewish -- Biography.</subject>
<date>1985</date>
<publisher>Sigmaringen : Jan Thorbecke Verlag</publisher>
<identifier>3799540636</identifier>
<description>300 p., [12] p. of plates : ill., music, ports. ; 24 cm.</description>
</dc>
</nowiki>
</pre>

this is the output of marc.toSimpleDC()

* title
* creator (author)
* subjects
* date
* publisher
* identifier
* description

(NOTE: this schema is from the example, not the source schema)

== SRU from the Library of Congress ==

http://z3950.loc.gov:7090/voyager?version=1.1&operation=searchRetrieve&query=dinosaur&maximumRecords=1&recordSchema=dc

<pre>
<nowiki>
<?xml version="1.0"?>
<zs:searchRetrieveResponse xmlns:zs="http://www.loc.gov/zing/srw/">
<zs:version>1.1</zs:version>
<zs:numberOfRecords>1701</zs:numberOfRecords>
<zs:records>
<zs:record>
<zs:recordSchema>info:srw/schema/1/dc-v1.1</zs:recordSchema>
<zs:recordPacking>xml</zs:recordPacking>
<zs:recordData>
<srw_dc:dc xmlns:srw_dc="info:srw/schema/1/dc-schema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://purl.org/dc/elements/1.1/"
xsi:schemaLocation="info:srw/schema/1/dc-schema http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd">
<title>3-D dinosaur adventure [computer file].</title>
<creator>Knowledge Adventure, Inc.</creator>
<type>software, multimedia</type>
<publisher>Glendale, CA : Knowledge Adventure,</publisher>

<date>c1995.</date>
<language>eng</language>
<description>Employs a dinosaur theme-park setting to introduce users to Triassic, Jurassic, and
Cretaceous periods. Features hypertext dinosaur encyclopedia covering 150 million years of
paleontology. Includes animated video simulations, three-dimensional dinosaur museum, narration,
games, activities, and color illustrations.</description>
<description>Ages 5 to 10.</description>
<description>System requirements for PC: 486SX/25MHz processor or higher; 8MB RAM; Windows 3.1,
3.11, or 95; SVGA 256-color graphics adapter; hard drive with 5MB free space; double-speed CD-ROM
drive; MPC-compatible sound card; mouse.</description>
<description>System requirements for Macintosh: 68040 or Power PC processor; 8MB RAM; System 7.0 or
higher; 256-color graphics capability; thirteen-inch color monitor or larger; hard drive with 4MB
free space; double-speed CD-ROM drive.</description>

<description>Ages 5 to 10.</description>
<description>Employs a dinosaur theme-park setting to introduce users to Triassic, Jurassic, and
Cretaceous periods. Features hypertext dinosaur encyclopedia covering 150 million years of paleontology.
Includes animated video simulations, three-dimensional dinosaur museum, narration, games, activities,
and color illustrations.</description>
<subject>Dinosaurs--Juvenile software.</subject>
<subject>Dinosaurs.</subject>
<identifier>URN:ISBN:1569972133</identifier>
</srw_dc:dc>
</zs:recordData>
<zs:recordPosition>1</zs:recordPosition>
</zs:record>
</zs:records>
</zs:searchRetrieveResponse>

</nowiki>
</pre>

NOTE: this is just Dublin Core data in a special LOC envelope

== University of Bath reference type ==
<pre>
<nowiki>
<reference>
<authors>
<author>
<forename>E</forename>
<forename>M</forename>
<surname>Phillips</surname>
</author>
<author>
<forename>D</forename>
<forename>S</forename>
<surname>Pugh</surname>
</author>
</authors>
<date>1994</date>
<entity>
<book title="How to get a PhD: A handbook for students and their supervisors">
<location>
<placeofpublication>Buckinghamshire</placeofpublication>
<publisher>Open University</publisher>
</location>
</book>
</entity>
</reference>

<reference>
<authors>
<author>
<forename>Michael</forename>
<surname>Fumento</surname>
</author>
</authors>
<date>1996</date>
<entity>
<website pagetitle="Radon's Real Threat is to the EPA"
uri="http://www.consumeralert.org/fumento/radon1.htm"/>
</entity>
<frdescription>an article by a prolific newspaper columnist in the USA -
quotes empirical scientific research showing no provable link between radon in homes and elevated
cases of lung cancer</frdescription>
</reference>
</nowiki>
</pre>
[http://www.bath.ac.uk/schemas/screenshots/referencetype.png Schema extract]

* author
* date
* url
* description
* type (book/journal/conference)
* title
* artile
* volume
* issue
* chapter
* pages
* publisher
** publisher data (address, city, ...)

== Implied Schema ==
This is the start of the short list of common properties across documented formats. Once this is finished, there will be a union of Implied schemas between EXAMPLES and IMPLEMENTATIONS and we will see what that looks like. (This currently only covers a few of the formats listed, some documented formats still need to be explored)

* creator (author, editor, translator, contributor) - this can be handled with hCard, but will need an additional property to refine what "creator" means
* publisher (this can also be handled with hCard)
* subject/topics/keywords/categories/genre (there is a rel="tag" microformat)
* Description (abstract, note, tableOfContents)
* typeOfResource/format

common location information
* volume
* issue
* page
* edition

Date Fields
* Date Published (some formats have YEAR/MONTH sperately)
* Date accessed (see [http://www.columbia.edu/cu/cup/cgos/basic.html here] for examples)

Again, I'll emphasize: "date published" is problematic. If one needs specificity, then better to have the following list of date classes: date (the generic), issued (braoder than published), copyright (often not the same as issuance date), accessed. -- bruce

Other fields
* Copyright/usage
* audience

* identifier (ISBN, ISSN, id, internal only, other)
* language (this can be handled by the xml:lang attribute native to HTML)

== Types and Roles ==
(Section is informative only as a place to capture various parts of publication citations.)

There are many different types of publications and this information should be captured in the citation. Possible types include:
* Novel/fiction (specify type -- literature, SF, romance, etc.?)
* Non-fiction
* Poem
* Play
* Magazine
* Reference (separate out encyclopedia, dictionary, almanac, etc.?)
* Journal
* Article within a journal
* Chapter within a book
* Dissertation
* Web Site
* Page within a web site
* Music Recording
* Video Recording
* Interview
* Physical object (Statue, Painting, etc.)
* ??

Question:
Certain works have specific types of citations, for example, the Bible--and, I assume, other religious works--have very specific citation formats with different relevant information (chapter/verse) than others, as do the works of Shakespeare. Should these be considered separate types/roles?

A: I think in terms of types, we should at least note the items (chapter, verse, etc). How they get dealt with is still way up in the air. - [[User:Tim White|Tim White]]

Likewise, there are several different roles associated with publications -- author, co-author, editor, translator, etc. Should these be captured under a master "role" or treated as individual elements?

A: Good question. I think there is an important distinction, but whether we follow a design pattern of "role-*" (or more likely "author-*) or some other pattern hasn't been discussed yet. - Tim

== Biblio RDF Class Schema ==
Regading the issue of types notes above, the [http://vocab.org/biblio/schema biblio schema] provides a comprehensive set of classes to describe citation metadata. It might prove useful as a guide for a micro-format. The primary classes are Agent, Reference, Collection, and Event. An "Article", then, would be a subclass of "Part", which in turn is a subclass of Reference. Likewise, a "Journal" is a subclass of a "Periodical," which in turn is a subclass of "Collection." An article would typically be linked to a journal through a dcterms:isPartOf relation.

== ISBN:// Protocol ==

[http://www.faqs.org/rfcs/rfc3187.html RFC3187] defines an isbn protocol

Example:

URN:ISBN:0-395-36341-1

I'm not sure if any browser uses this data, but it might be have an application in citations describing registered materials with an ISBN

== You should know ==
* There are more then 1.300 citation ''styles'' in EndNote 9.
* Libraries have developed formats and rules for publications since more than 100 years. There are millions of records in library catalougues. You should '''at least''' be familiar with AACR and FRBR. There '''already are''' effords to create a new "microformat" called ''Resource Description and Access'' (RDA) [http://www.collectionscanada.ca/jsc/rdaprospectus.html]. Why don't you try to work with the professionals instead of amateurishly trying to reinvent the wheel and create yet another incompatible format? -- [[User:JakobVoss|JakobVoss]] 01:39, 5 Jun 2006 (PDT)
** I agree that the people involved in developing this microformat (including me) ought to be aware of these efforts (in particular FRBR), but I also think your argument is hopelessly naive and pretentious. The professionals you refer to are in fact library professionals, with their own bizarre traditios and unique information needs. Those are different than the professional scholars for whom citations are critical (me), or to the professional web developers who might want to implement these formats. What I do think is important is for us to understand the different design traditions, and their trade-offs, rather than to blindly create a microformat based on one of them -- Bruce (author of citeproc [http://xbiblio.sourceforge.net/citeproc] and csl [http://xbiblio.sourceforge.net/csl]).

Nice to meet you, Bruce! Maybe I'm naive but it still think that there is a way to combine the best of both worlds: scholars and library professionals. Both have developed bizarre traditions and it would be a pitty to create a new bizarre microformat that is not based on both of them. Thanks to your links to xbiblio. I a stumbled upon it a while ago but have to look at it deeper. -- [[User:JakobVoss|JakobVoss]] 11:48, 19 Jul 2006 (PDT)

== OpenDocument ==
The OpenDocument Format also includes parts for citation and bibliography. See also the [http://bibliographic.openoffice.org/ OpenOffice Bibliographic project]. -- [[User:JakobVoss|JakobVoss]] 11:55, 19 Jul 2006 (PDT)

xfolk

2006-07-04T13:18:28Z

FredStutzman: /* Implementations */

<h1> xFolk (RC1) </h1>

xFolk is a simple and open format for publishing collections of bookmarks. It better enables services for improving user experience and sharing data in web-based bookmarking software. xFolk may be embedded in (X)HTML, Atom, RSS, and arbitrary XML. It is one of several open [[microformats|microformat]] standards.

__TOC__

== Draft Specification ==

=== Editor/Author ===
[http://thecommunityengine.com/ Bud Gibson], [http://thecommunityengine.com The Community Engine]

=== Copyright ===
{{MicroFormatCopyrightStatement2005}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: [http://www.cnbc.cmu.edu/~plaut/ David Plaut] who introduced me to the idea that items may partially belong to many categories at once. More recently, thanks to: [http://tantek.com/ Tantek Çelik], [http://epeus.blogspot.com/ Kevin Marks], [http://steve.osdir.com/ Steve Mallet], [http://hybernaut.com/ Brian DelVecchio], and [http://blogmarks.net François Hodierne] who have contributed to the development of xFolk with thoughtful critiques and implementations.

== Introduction ==
Social bookmarking services let users save and tag bookmarks to share with other users. Over the past year, the number of these services has mushroomed to [http://en.wikipedia.org/wiki/Social_bookmarking over 20], with popular examples including: [http://del.icio.us del.icio.us], [http://furl.com furl], [http://de.lirio.us de.lirio.us], [http://jots.com jots], and [http://blogmarks.net blogmarks].

Lack of an open, interoperable data standard is a major issue in using social bookmarking services. An open standard would make it possible to easily collect social bookmark data and remix it to invent new services along the lines of [http://gataga.com gataga]'s experimental bookmark search engine. An open standard would also make it possible to write javascripts that work across services [http://johnvey.com/features/deliciousdirector/ as some currently do for del.icio.us], enabling across-the-board improvements in user experience.

xFolk is an open social bookmarking standard that aims to achieve both benefits. Social bookmarking services that adopt xFolk will continue to differentiate themselves with data services. But, the data itself will be easy to manipulate by third party scripts and easy to share. As a result, bookmarking services will be able to offer a wider array of options to their users at low cost and focus on what truly differentiates them. Individuals or groups operating standalone bookmark repositories will have access to a wider array of functionality than they can produce on their own.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
Extensive analysis of social bookmarking services and linkblogs, reported on [http://thecommunityengine.com/home/archives/xfolk elsewhere], reveals that the data published by both bookmarking services and '''many''' different linkblogs are described by the following implied schema:

* A bookmarked or tagged link.
* A title for the entry.
* Tags for the link.
* An extended description or summary of the link.

As demonstrated in early iterations of the xFolk standard, this general schema can be translated into markup by:

# creating a container element for each entry of class <code>xfolkentry</code>,
# using an <a> element for the bookmarked or tagged link of class <code>taggedlink</code>,
# using title attribute for the tagged link <a> element, if it exists, as the entry title, otherwise using the element value,
# using [[reltag|RelTag]] for the tags, and
# using a container element of class <code>description</code>, such as <p>, for any extended description or summary.

A given xFolk entry will always contain a tagged link including a title with all other elements optional. Entries may have more than one tag as well as more than one element of class <code>description</code>. Multiple elements of class <code>description</code> are ordered by default document order. Semantic elements within xFolk entries may be nested at arbitray depths.

Many social bookmarking systems exist, each with its own markup conventions. Further, many people are already publishing personal link blogs. xFolk is designed with ease of adapting to these current practices as a primary goal. Therefore, few assumptions are made as to the exact kinds of elements used for an xFolk entry. Rather, the work of defining semantics is left entirely to the class and rel (in the case of [[reltag]]) attribute values.

It is expected that developers will use [http://www.w3.org/TR/xpath XPath] or equivalent syntax in accessing xFolk entry elements. a requirement for XPath is that the (X)HTML document be well-formed but not necessarily valid. Thus, while undesirable, it is possible to serviceably use xFolk in an (X)HTML document that does not validate.

=== XMDP Profile ===

See the [[xfolk-profile|xFolk profile]] for the [http://gmpg.org/xmdp XMDP] profile of xFolk.

== Example ==
Here is a sample bookmark as displayed in [http://del.icio.us del.icio.us]'s standard markup. Lines where the value of elements' class attributes must change to conform to xFolk are marked with a comment at the end.
<pre><div class="post"> 
<div>
<a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="extended"> 
Ever wanted to see what posts are related to other posts, what tags
are related to others? Now you can! Just check under the Tag
description on most tag pages, like this one, or this one, and you'll
see the patterns. Can you smell the emergence?
</div>
<div class="meta">
to
<a class="delNav" href="/fpgibson/folksonomy">folksonomy</a> 
<a class="delNav" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div></pre>

The equivalent in xFolk is as follows. Comments are placed at the end of lines where class attribute changes were required.
<pre><nowiki>
<div class="xfolkentry"> 
<div>
<a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="description"> 
Ever wanted to see what posts are related to other posts, what tags
are related to others? Now you can! Just check under the Tag
description on most tag pages, like this one, or this one, and you'll
see the patterns. Can you smell the emergence?
</div>
<div class="meta">
to
<a rel="tag" href="/fpgibson/folksonomy">folksonomy</a> 
<a rel="tag" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div>
</nowiki></pre>

Converting markup to be conformant with xFolk is almost always this easy. The advantage of xFolk is that it provides one set of class attributes that can be reused across all services and link blogs, almost always with no loss of granularity. The next section presents several more examples to illustrate this point.

== Many more examples ==

We have numerous examples to help developers incorporate xFolk into their sites.

=== In the wild ===

These are real live examples of functioning systems that publish bookmarks in xFolk. These are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish using xFolk, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://waferbaby.com/hussy waferbaby's Hussy] currently publishes links using xFolk.
* [http://smarking.com/ Smarking] currently publishes all shared links (including search results) using xFolk.
* [http://unalog.com unalog] currently publishes all shared links (including search results) using xFolk.
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk (scroll down to the export example on the page; the deprecated class attribute <code>extended</code> is used in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://thecommunityengine.com The Community Engine] uses xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]) for its [http://thecommunityengine.com/home main entries] and for its [http://thecommunityengine.com/webcites republished bookmarks].

=== Additional social bookmarking services ===

This example illustrates how xFolk may be applied to one additional service:

* [[xfolk-scuttle | scuttle]]

=== Link blogs ===

Social bookmarking services are only the most recent examples of people publishing links. Link blogs have been around almost since the beginning of blogging. They represent somewhat more of a challenge for xFolk because their markup tends to be less semantic from the outset. The following examples illustrate some particular challenges and how they can be overcome.

* [[xfolk-kottke | kottke]]
* [[xfolk-pollas | pollas]]
* [[xfolk-jacobian | jacobian]]
* [[xfolk-julian-bez | julian-bez]]

== Implementations ==

The following implementations have been developed which generate or use xFolk. If you have an xFolk 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.

* [http://claimid.com claimID] has implemented xFolk for people's links.
* [http://ma.gnolia.com ma.gnolia] now supports xFolk.
* [http://smarking.com/ Smarking.com] (a social bookmarking service) marks up their tagged links with xFolk! Hat tip: [http://3spots.blogspot.com/2006/05/social-bookmarking-smarking.html 3spots: Social + bookMARKING = Smarking] which itself is an [[hreview|hReview]].
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* Bud Gibson and Mike Migurski [http://thecommunityengine.com/home/archives/2005/09/vegomatic_an_al.html have written] [http://thecommunityengine.com/veg-o-matic veg-o-matic], an xFolk reblogging tool and service.
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including xFolk and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''
* [http://www.midgard-project.org/midcom-permalink-6416db7e1f0e297b4cf3dcc285702a8d net.nemein.bookmarks], the bookmark manager in [http://www.midgard-project.org/ Midgard CMS] uses xFolk as the native output format, with added <code>abbr class=posted</code> for publication date and <code>abbr class=poster</code> for user who added the bookmark. See [http://bergie.iki.fi/links/ example]
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk 0.4 (the class attribute <code>extended</code> is used in place of description).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk 0.4 (scroll down to the export example on the page; the class attribute <code>extended</code> is used in place of <code>description</code>).

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[rel-tag]]

=== Informative References ===
* [http://thecommunityengine.com/home/archives/xfolk articles about xFolk]
* [http://thecommunityengine.com/home/archives/tags/microformats articles about the business value of microformats]
* [http://gataga.com gataga social bookmark search engine]
* [http://johnvey.com/features/deliciousdirector/ an ajax based interface for del.icio.us]
* [http://en.wikipedia.org/wiki/Social_bookmarking social bookmarking defined at wikipedia]

=== Similar Work ===
* [[hreview | hReview]]

== Work in progress ==
Although this specification has recently begun to stabilize as indicated by the version RC1, it is still a work in progress. If warranted, I am prepared to go through multiple release candidates to achieve the narrow purpose of making bookmark entries more genrally accessible with as with as light weight a format as possible. All changes since the last iteration have been motivated by the implementation experience of developers attempting to achieve this narrow aim. Further changes will also most likely be motivated by implementation concerns. See "future directions" below for additional microformat possibilities.

=== Changes since xFolk 0.4 ===
The class attribute value <code>extended</code> was deprecated in favor <code>description</code> to better conform with other microformat usage and some requests during implementation. The other change has been to allow use of multiple elements of class <code>extended</code> based on some use cases discovered in implementation.

=== Future directions ===
There are several extensions one might imagine for xFolk. Frequently, these extensions are best achieved by combining xFolk with another microformat. For instance, one might want to indicate his or her evaluation of the bookmarked item. This might be achieved by using [[vote-links | Vote Links]] or [[hreview | hReview]] with xFolk.

One can also imagine extending xFolk to provide data conformant with various social bookmarking service APIs, for instance to provide all bookmarks by tag. These APIs are currently too fluid for specification in any kind of standard. The APIs and the functionality they provide represent one way social bookmarking services and meta services can differentiate themselves.

A companion format called "xFolk definition" is under development. xFolk definition will provide a means of explicitly defining the tags used in social bookmarks.

=== Brainstorming ===
* [[xfolk-brainstorming|xFolk brainstorming]]

== Discussions ==

=== Q&A ===
* If you have any questions about xFolk, check the [[xfolk-faq|xFolk FAQ]], and if you don't find answers, add your questions!

=== Issues ===
* Please add any issues with the specification to the separate [[xfolk-issues | xFolk issues]] document.