Microformats Wiki - User contributions [en]

citation-formats

2013-08-11T19:28:51Z

Occurance: /* APA note permalink */

<entry-title> Citation Formats </entry-title>

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.

== styles ==
Citation styles, though perhaps present in proxy through aggregate real world [[citation-examples]], are also good source of explicit citation schemas, and thus implicit formats.

Subsections from [http://en.wikipedia.org/wiki/Citation#Citation_styles Wikipedia: Citation Styles] and focus on documenting citation styles to ''online'' resources first per the [[principle]] of solving a [[simpler]] problem first.

Note also Yale College Center's comparison/overview/methodology:
* [http://writing.yalecollege.yale.edu/why-are-there-different-citation-styles Why Are There Different Citation Styles?] and how to specifically cite:
** [http://writing.yalecollege.yale.edu/citing-internet-sources Internet Sources]
** [http://writing.yalecollege.yale.edu/private-websites Private Websites] ("private website" is their terminology for what are indieweb sites)
** [http://writing.yalecollege.yale.edu/blogs Blogs]

=== APA ===
* [http://en.wikipedia.org/wiki/APA_style Wikipedia: APA style]
==== APA site or profile ====
* APA FAQ: [http://www.apastyle.org/learn/faqs/cite-website.aspx How do you cite an entire website (but not a specific document on that site)?]
** parenthetical, e.g.:
<blockquote><nowiki>Kidspsych is a wonderful interactive website for children (http://www.kidspsych.org).</nowiki></blockquote>
* APA Style Blog: [http://blog.apastyle.org/apastyle/2009/10/how-to-cite-twitter-and-facebook-part-i.html How to Cite Twitter and Facebook, Part I: General] (2009-10-23)
** parenthetical in-text, e.g.:
<blockquote><nowiki>President Obama uses Twitter (http://www.twitter.com/barackobama) and
Facebook (http://www.facebook.com/barackobama)</nowiki></blockquote>
==== APA permalink ====
===== APA note permalink =====
* APA Style Blog: [http://blog.apastyle.org/apastyle/2009/10/how-to-cite-twitter-and-facebook-part-ii.html How to Cite Twitter and Facebook, Part II: Reference List Entries and In-Text Citations]
** outdented Twitter alias / full Facebook name, parenthesized date, tweet/update/note text "<nowiki>[Twitter post]</nowiki>/<nowiki>[Facebook update]</nowiki>". "Retrieved from" permalink. e.g.
<blockquote><pre><nowiki>BarackObama. (2009a, July 15). Launched American Graduation Initiative
to help additional 5 mill. Americans graduate college by 2020:
http://bit.ly/gcTX7 [Twitter post]. Retrieved from
http://twitter.com/BarackObama/status/2651151366</nowiki></pre></blockquote>
<blockquote><pre><nowiki>Barack Obama. (2009b, October 9). Humbled.
http://my.barackobama.com/page/community/post/obamaforamerica/gGM45m
[Facebook update]. Retrieved from http://www.facebook.com/posted.php?
id=6815841748&share_id=154954250775&comments=1#s154954250775</nowiki></pre></blockquote>

===== APA article permalink =====
* APA Style Blog: [http://blog.apastyle.org/apastyle/2010/11/how-to-cite-something-you-found-on-a-website-in-apa-style.html How to Cite Something You Found on a Website in APA Style] (2010-11-18)
** author, date, title, and source, e.g. <blockquote><nowiki>Author, A. (date). Title of document [Format description]. Retrieved from http://URL</nowiki></blockquote><blockquote><nowiki>Freakonomics. (2010, October 29). E-ZPass is a life-saver (literally) [Blog post]. Retrieved from http://freakonomics.blogs.nytimes.com/2010/10/29/e-zpass-is-a-life-saver-literally/</nowiki></blockquote>
** no author is identified in this online news article: <blockquote><nowiki>All 33 Chile miners freed in flawless rescue. (2010, October 13). Retrieved from http://www.msnbc.msn.com/id/39625809/ns/world_news-americas/</nowiki></blockquote>
===== APA undated page =====
** no date is identified in this webpage: <blockquote><nowiki>The College of William and Mary. (n.d.). College mission statement. Retrieved from http://www.wm.edu/about/administration/provost/mission/index.php</nowiki></blockquote>

=== MLA ===
* http://en.wikipedia.org/wiki/MLA_style
* http://www.mla.org/style_faq
==== MLA note permalink ====
* MLA Style FAQ: [http://www.mla.org/style/style_faq/mlastyle_cite_a_tweet How do I cite a tweet?]
** name (username), note text, datetime, "Tweet". In more detail: author’s real name (user name if known and different), entire text of the tweet in quotation marks without changing the capitalization, date and time of the message and the medium of publication "Tweet". If only the user name is known, give it alone. e.g. <blockquote style="padding-left:2em; padding-right:2em; text-indent:-2em"><nowiki>Athar, Sohaib (ReallyVirtual). “Helicopter hovering above Abbottabad at 1AM (is a rare event).” 1 May 2011, 3:58 p.m. Tweet.</nowiki></blockquote> <blockquote>"The date and time of a message on Twitter reflect the reader’s time zone. Readers in different time zones see different times and, possibly, dates on the same tweet. The date and time that were in effect for the writer of the tweet when it was transmitted are normally not known."</blockquote>
** MLA is incorrect about "normally not known". The date and time of tweet creation *are* known and are in the markup in ISOdate form. Thus we should presume they would choose to use that information rather than that of the reader's time zone (which makes no sense, reader of the tweet? reader of the citation of the tweet? unpredictable). - [[User:Tantek|Tantek]] 20:23, 8 May 2012 (UTC)

=== The Chicago Manual of Style ===
* http://en.wikipedia.org/wiki/The_Chicago_Manual_of_Style
* http://www.chicagomanualofstyle.org/home.html
* http://www.chicagomanualofstyle.org/tools_citationguide.html

Examples from CMOS citation guide:
==== TCMOS dated page ====
<blockquote style="padding-left:2em; padding-right:2em; text-indent:-2em"><nowiki>Google. 2009. “Google Privacy Policy.” Last modified March 11. http://www.google.com/intl/en/privacypolicy.html.</nowiki></blockquote>
==== TCMOS undated page ====
<blockquote style="padding-left:2em; padding-right:2em; text-indent:-2em"><nowiki>McDonald’s Corporation. 2008. “McDonald’s Happy Meal Toy Safety Facts.” Accessed July 19. http://www.mcdonalds.com/corp/about/factsheets.html.</nowiki></blockquote>
==== TCMOS permalink ====
<blockquote style="padding-left:2em; padding-right:2em; text-indent:-2em"><nowiki>Posner, Richard. 2010. “Double Exports in Five Years?” The Becker-Posner Blog, February 21. http://uchicagolaw.typepad.com/beckerposner/2010/02/double-exports-in-five-years-posner.html.</nowiki></blockquote>

(Posner 2010)

=== Bluebook ===
* http://en.wikipedia.org/wiki/Bluebook
Per [http://en.wikipedia.org/wiki/Bluebook#Criticism criticism] and law-specific nature, considering this lower priority than other styles.

=== ALWD Citation Manual ===
http://en.wikipedia.org/wiki/ALWD_Citation_Manual

=== ASA style ===
http://en.wikipedia.org/wiki/ASA_style

=== Harvard referencing ===
AKA Parenthetical referencing.
http://en.wikipedia.org/wiki/Harvard_referencing

=== Vancouver system ===
http://en.wikipedia.org/wiki/Vancouver_system

== formats ==
Here is a list of previous/existing explicit citation formats.

The sub-sections probably needs sorting (alphabetical?) to make it easier to browse since it is quite large.[[User:Tantek|Tantek]] 19:26, 2 April 2009 (UTC)

=== 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 microformat, then it's 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 extension 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 DEFINITIVE, 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/Sp*cial 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 describe the data.
* contributor
* coverage
* creator
* date
* description
* format
* identifier
* language
* publisher
* relation
* rights
* source
* subject
* title
* type

From those there are specialised types which are just refinements 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 Library 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)

=== NCBI-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 <pre><source></pre> 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) (but not really BiBTeX oriented, importation macros are old and you must first use Jabref and export to Endnote formats)
* [http://bibdesk.sourceforge.net/ BibDesk]
* [http://www.mackichan.com/index.html?bibdb/default.htm~mainFrame BibDB]
* [http://sourceforge.net/projects/bib-it/ Bib-it]
* [http://jabref.sourceforge.net Jabref] Probably the most useful application because of its facility to search Pubmed (and also to export in many other formats).
* 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 sp*cial LOC envelope

:LOC also delivers [http://www.loc.gov/standards/marcxml/ MARCXML], and [http://www.loc.gov/standards/mods/ MODS], see http://z3950.loc.gov:7090/voyager?version=1.1&operation=explain -- [[User:JakobVoss|JakobVoss]] 05:37, 26 Jul 2007 (PDT)

=== 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, ...)

=== 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 Uniform Resource Names ===
[http://www.faqs.org/rfcs/rfc3187.html RFC3187] defines an ISBN namespace for Uniform Resource Names (URNs).

Example:

URN:ISBN:0-395-36341-1

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

There is also a URN namespace for ISSN (International Standard Serial Number), which identifies serials/periodicals e.g. [http://alistapart.com A List Apart]. It is defined in [http://www.faqs.org/rfcs/rfc3044.html RFC3044]. Additional URN namespaces are listed at http://www.iana.org/assignments/urn-namespaces.

=== ISBD ===
Oh, already a year ago! I was just trying to explain Microformats and its relevance for libraries ([http://jakoblog.de/2007/07/26/von-isbd-zum-web-20-mit-mikroformaten/ here (in German)]. You should have a look at the [http://en.wikipedia.org/wiki/International_Standard_Bibliographic_Description International Standard Bibliographic Description] (ISBD). These rules specify how a bibliographic should be displayed in a library catalouge. This format could be used as basis for hCitation because millions of records are availble in ISBD or variants in library catalouges all over the world.

Here is an example:

<pre>
Title: Harry Potter and the deathly hallows / Joanne K. Rowling. - [Children’s ed.], 1. ed. - London : Bloomsbury, 2007
ISBN: 0-7475-9105-9 - 978-0-7475-9105-4 (Children’s edition)
</pre>

This could be broken into "semantic peaces":

<pre>
<div class='hCitation'>
Titel:
<span class='title'>Harry Potter and the deathly hallows</span> /
<span class='n'>
</span><span class='given-name'>Joanne K.</span>
<span class='family-name'>Rowling</span>
</div>. -
[<span class='edition'>Children's ed.</span>], <span class='edition-number'>1.</span> ed. -
<span class='location'>London</span> : <span class='publisher-name'>Bloomsbury</span>,
<span class='publication-year'>2007</span>
</div>
<div>
ISBN:
<span class='ISBN'>0-7475-9105-9</span> -
<span class='ISBN'>978-0-7475-9105-4</span>
(<span class='edition'>Children's edition</span>)
</div>
</pre>

The advantage of ISBD is that it is very elaborated and covers many field and types of publications and sp*cial cases. Of course you need to simplifiy parts of it for the microformat. I'd prefer a bottom up design with the current mass of real-world records in todays libraries instead of top-down by thinking of an "ideal record" or limited playing databases. -- [[User:JakobVoss|JakobVoss]] 05:34, 26 Jul 2007 (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)

=== Wikimedia foundation projects ===
* http://en.wikipedia.org/wiki/Wikipedia:Citation_templates
** 'The use of Citation templates is not required by WP:CITE and is neither encouraged nor discouraged by any other Wikipedia citation guidelines.' (ibid)
* [http://meta.wikimedia.org/wiki/WikiTextrose WikiTextrose]
* [http://meta.wikimedia.org/wiki/Wikicat Wikicat]
* [http://meta.wikimedia.org/wiki/Wikicite Wikicite]

=== Structurally-Based Citation Formatting ===
Bruce D’Arcus has drafted a partial proposal with a few examples, and a schema for the parts of a citation:

http://www.users.muohio.edu/darcusb/misc/citations-spec.html

* container
* part numbers
* creator
* title
* publisher
* origin place
* year
* genre
* volume
* number
* date
* location
* medium

== additional sources for citation formats ==
* There are more then 1300 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)

== common properties across formats ==
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.apastyle.org/elecsource.html here] for discussion from APA style guide.)

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
* Music Score
* 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

== Concerns not addressed by existing formats ==
There are some aspects '''NOT adequately''' covered by existing formats. I have addressed this issue on the OpenOffice.org wiki page, too. [see http://wiki.services.openoffice.org/wiki/Bibliographic_Database for an extending discussion, the paragraph on ''Reference Types'']

These issues pertain mainly to '''Errata''', '''Comments and Authors Reply''' and '''Article Retractions'''.
* a bidirectional link could be necessary to implement these features (original article <=> eratum, reply, retraction letter)
* '''IMPORTANT: Errata'''
** Erata: one or more Corrections might be posted in various issues of the journal
** this is usually cited as: Orininal Article Citation Data (Correction available in ''Journal, Issue Nr, Year, Pages'') (repeat for more than one correction)
** it is possibly never cited alone
** there should be a link to the original article, while the original article should contain a link to this ''Errata''
* '''IMPORTANT: Commentary and Author Reply'''
** similar to Errata, there might be one or more Comments and Author Replys; this should be stored, too
** however, it is usually not included in the original citation
** it might be used however in a citation, but I do not know exaclty how to cite it optimally (original article should be provided as well)
* '''IMPORTANT: Article Retraction'''
** an article may be retracted because of plagiarism or some other flaw
** this should not be used any further in the research
** however, it might be used e.g. for an article on plagiarism or flawed research
** there should be therefore one field storing this information, too, and a link to:
** the published withdrawal letter (which explains why the article was retracted)

* this issue may need a time-controlled event
* '''IMPORTANT: electronic publishing ahead of print (EPUB)'''
** more and more articles are initially posted online, before the published article gets actually printed
** How should this be used/cited?
** Is this changed, after the print version becomes available?

==See also==
{{citation-related-pages}}

hcard-authoring

2013-08-11T19:09:00Z

Occurance: /* Natural language hCard */

<entry-title>hCard authoring tips</entry-title>
;short URL
:http://ufs.cc/w/hcarda
This page contains useful tips and guidelines for how to author [[hcard|hCards]], either from scratch, or by adding markup to existing content.

'''Goal:''' The goal of this document is to provide some good intuitive guidelines that should make it as easy and as quick as possible for any web author to create hCards or add hCard markup to existing content.

'''Audience:''' Web authors, designers, IA's. This document is written for easy consumption and understanding by any web designer who knows at least enough (X)HTML and CSS to use semantic HTML class names on elements (i.e. [[POSH]]) and write CSS selectors that apply styles to those class names. Please help with clarifying/simplifying this document accordingly.

'''Author(s):''' [[User:Tantek|Tantek Çelik]], [[User:MarkRickerby|Mark Rickerby]]

== A 5 minute primer to using hCard ==

Let's imagine a static page that contains some personal contact details, the main part of which looks something like:

<source lang=html4strict>
<div id="contact">
<h2>Contact Me</h2>
<p>You can contact me via email to
<a href="mailto:jane@example.com">jane@example.com</a>,
or send stuff to me at the following address:</p>
<p>255 Some Street,<br />
Some Place,<br />
Some Town</p>
</div>
</source>

This snippet has all the human readable information needed to produce a valid [[hcard|hCard]] representation - all that is necessary is to add some additional structure that defines each particular detail. The first thing to do is to add the <code>vcard</code> wrapper class to the enclosing <code>div</code>, which identifies this particular block as an [[hcard|hCard]]:

<source lang=html4strict>
<div id="contact" class="vcard">
</source>

One thing that is noticeably missing from this snippet is the name of who these contact details apply to - this makes the information presented more ambiguous and harder to understand. It's good to be explicit with such things, and it just so happens that the name property is a compulsory field within an [[hcard|hCard]] as well. So let's add it, using the <code>fn</code> class:

<source lang=html4strict>
<div id="contact" class="vcard">
<h2>Contact Me</h2>
<h3 class="fn">Jane Doe</h3>
<p>You can contact me via email to
<a href="mailto:jane@example.com">jane@example.com</a>,
or reach me at the following address:</p>
<p>255 Some Street,<br />
Some Town,<br />
Some Place</p>
</div>
</source>

Another thing we can do to improve the semantics of the snippet is to mark up the address with "adr", and use <code>div</code> tags since its not really a paragraph. At the same time, we should also get rid of the [http://tantek.com/log/2002/10.html#L20021022t1432 bed & breakfast] markup in the second paragraph, replacing it with structured classnames for the components of a mailing address: <code>adr</code>, <code>street-address</code>, <code>locality</code>, and <code>region</code>. We can also add the <code>email</code> class to the mailto link, to complete the structure of the [[hcard|hCard]]:

<source lang=html4strict>
<div id="contact" class="vcard">
<h2>Contact Me</h2>
<h3 class="fn">Jane Doe</h3>
<p>You can contact me via email to
<a class="email" href="mailto:jane@example.com">jane@example.com</a>,
or reach me at the following address:</p>
<div class="adr">
<div class="street-address">255 Some Street</div>
<div class="locality">Some Town</div>
<div class="region">Some Place</div>
</div>
</div>
</source>

And that's all it takes!

Aside from the advantages of having such structured visible data, providing these additional class names also increases the visual design possibilities.

== Add To Address Book Links ==
When you update your contact info to include hCard markup, you can also include an "Add to Address Book" link so your users can download your contact info to their address book with one click of a hyperlink!

Here is an example of such a link:

<source lang=html4strict>
<a href="http://h2vx.com/vcf/tantek.com">
Add to Address Book
</a>
</source>

Simply substitute the link to your hCard for the <kbd>tantek.com</kbd> URL fragment above (note that <code>http://</code> is implied, you can add it explicitly if you want).

If you have more than one hCard on that page, you should put a unique ID attribute on each, and then put <kbd>%23yourIDhere</kbd> at the end of your href code where <kbd>yourIDhere</kbd> is the ID attribute value that you put on the hCard you are creating the link for.

You can also use Brian Suda's hosted [[X2V]] service, or download and install the open source X2V XSLT yourself and run it on your own server instead of using an online hCard to vCard converter service.

== Creating new hCards ==
Start with the [http://microformats.org/code/hcard/creator hCard creator], and for additional fields and properties (e.g. telephone numbers, instant messaging contacts), see the [[hcard-examples|hCard examples]] page.

== Adding hCard markup to existing content ==

[[[[Image:Link title]][[Media:--[[User:Occurance|`]] 19:09, 11 August 2013 (UTC)Example.ogg]]]]=== Natural language hCard ===

Perhaps you have a traditional prose description of yourself. Start by reading Jeremy Keith's article "[http://adactio.com/journal/1122/ Adactio: Journal - Natural language hCard]" which provides a nice succinct introduction in the art of adding hCard markup to an existing prose biography.

Jeremy's recent post [http://adactio.com/journal/1393/ Year zero] also contains an inline hCard citation reference to "Malarkey" (who was being quoted) that is quite illustrative of how to markup a simple hyperlinked reference to someone by obvious nickname:

<source lang=html4strict>
<cite class="vcard">
<abbr class="fn" title="Andy Clarke">
<a href="http://www.stuffandnonsense.co.uk/malarkey/">Malarkey</a>
</abbr>
</cite>
</source>

He could actually make this just a bit more semantic by explicitly noting that "Malarkey" is a nickname for Andy Clarke:

<source lang=html4strict>
<cite class="vcard">
<abbr class="fn" title="Andy Clarke">
<a class="nickname" href="http://www.stuffandnonsense.co.uk/malarkey">Malarkey</a>
</abbr>
</cite>
</source>

Similarly, a shortened given name only (e.g. Julie instead of Juliette) reference to someone can be marked up as such, here with XFN added to the hyperlink:

<source lang=html4strict>
<span class="vcard">
<abbr class="fn" title="Juliette Melton">
<a class="url nickname" rel="friend" href="http://juliettemelton.com/">Julie</a>
</abbr>
</span>
</source>

=== Minimal Markup Changes ===

When adding hCard to existing content, keep in mind that hCard was designed for semantically enhancing existing content without affecting its presentation (or minimally so). Thus: change as little markup as possible. If you want to fix various pages to be valid XHTML etc., that's fine.

In all examples below where it says to add an element with class name of "<code>xyz</code>", first look for an existing element that precisely surrounds the necessary content. Re-use that element by simply adding the class name "<code>xyz</code>" (meaning, add " xyz" (without quotes) to the element's existing class attribute, or add a new class attribute <code>class="xyz"</code> to elements without a class attribute).

e.g.
<source lang=html4strict><span>...</span></source>
would become:
<source lang=html4strict><span class="xyz">...</span></source>

and
<source lang=html4strict><span class="foo">...</span></source>
would become:
<source lang=html4strict><span class="foo xyz">...</span></source>

=== Find People or Organizations ===
Start with looking for all mentions of people or organizations on a page. All of those are potential hCards. Even more so if they are linked to their respective URLs (e.g. home pages / blogs).

If a person (or organization, henceforth shortened to just "'''person/org'''") is mentioned several times on a page, consider marking up the mention which is the most detailed, definitive, or otherwise thorough as an hCard. Ideally you might want to mark up ''all'' instances of a person/org as hCards, but for now, just keep it simple and markup the most representative instance. (Perhaps the most "definitive" instance, which could also then be marked up with a <code><nowiki><dfn></nowiki></code> element around the name of the person/org for additional semantic XHTML goodness.)

=== Determine The Surrounding Element for Each ===
For each person/org that you want to turn into an hCard, find the smallest element that contains all the info about that person/org, and no info about any other person/org.

Add the class name "<code>vcard</code>" to that element.

If there is no such element (perhaps the nearest enclosing element contains more than one person/org), then add a <code><nowiki><span class="vcard">...</span></nowiki></code> or <code><nowiki><div class="vcard">...</div></nowiki></code> that wraps the info about that person/org and just that person/org.

The rest of the markup for this hCard MUST go ''inside'' that element with the class name "vcard".

=== The Importance of Names ===
The name is the one required property of hCard. Thus be sure to mark up the name of the person with the class name "fn". For names of people which are two simple words (text separated by space) and where the first word is their given name and the second word is their family name, the class name "fn" is sufficient. E.g.

<source lang=html4strict><div class="vcard"><span class="fn">Rohit Khare</span></div></source>

For people with <span id="middle-name" class="hcard-faq-ref">middle names</span> or multi-word last names, you must mark them up with the "n" property and its sub-properties "given-name" and "family-name" (and "additional-name" when a middle name is included) e.g.:
<source lang=html4strict>


<div class="vcard"><span class="fn n">
<span class="given-name">Erin</span>
<span class="additional-name">Jo</abbr>
<span class="family-name">Richey</span>
</span></div>



<div class="vcard"><span class="fn n">
<span class="given-name">Eric</span>
<abbr class="additional-name">A.</abbr>
<span class="family-name">Meyer</span>
</span></div>



<div class="vcard"><span class="fn n">
<span class="given-name">Emily</span>
<abbr class="additional-name" title="Paige">P.</abbr>
<span class="family-name">Lewis</span>
</span></div>



<div class="vcard"><span class="fn n" lang="no">
<span class="given-name">Håkon</span>
<span class="additional-name">Wium</span>
<span class="family-name">Lie</span>
</span></div>



<div class="vcard"><span class="fn n">
<span class="given-name">Thomas</span>
<span class="family-name">Vander Wal</span>
</span></div>
</source>

==== Organization hCards ====

For hCards for organizations, be sure to put both the "fn" and "org" class names on the same element. Having those be the same is the hint to hCard consumers that the hCard represents an organization rather than a person. E.g.
<source lang=html4strict><div class="vcard"><span class="fn org">Technorati</span></div></source>

=== Link it up ===
<span id="Representative_URLs"> </span>
Add links to your website, your social network profiles and other sites that represent ''you'' specifically to your hCard with the class name <code>url</code>. Here is an example with a personal site, and Twitter and Flickr profile URLs:

<source lang=html4strict>
<span class="vcard">
<span class="fn">Tantek Çelik</span>,
<a class="url" href="http://tantek.com/">my site</a>,
<a class="url" href="http://twitter.com/t">twitter</a>, and
<a class="url" href="http://flickr.com/tantek">flickr</a>.
</span>
</source>

==== connect with yourself ====
If you are marking up an hCard on your own site, be sure to also add the [[xfn|XFN]] <code>rel="me"</code> attribute to indicate that those profile pages are additional facets of your online identity. See <cite>[http://gmpg.org/xfn/and/#idconsolidation Identity consolidation with XFN]</cite> for more details.

<source lang=html4strict>
<span class="vcard">
<span class="fn">Tantek Çelik</span>,
<a rel="me" class="url" href="http://tantek.com/">my site</a>,
<a rel="me" class="url" href="http://twitter.com/t">twitter</a>, and
<a rel="me" class="url" href="http://flickr.com/tantek">flickr</a>.
</span>
</source>

Edit your profiles on those other sites and set the "home page", "URL", or "blog" fields to link back to your own site to connect your social network profiles together.

Sites like http://huffduffer.com and [[Firefox]] plugins like [[Identify]] use APIs like the Google Social Graph API (which indexes rel-me links) to automatically connect your profiles for you in their user interfaces.

See [http://klinger.io/ Andreas Klinger's home page] for a nice, simple, real world example of a personal site with hCard that links to other profiles.

==== name and URL only ====
One of the most common patterns for person/orgs in web content is the name of the person/org, hyperlinked to their definitive/preferred web site.

When you simply reference a person by name with URL, you can simplify the markup.

<source lang=html4strict>
<span class="vcard">
<a href="http://theryanking.com" class="fn url">Ryan King</a>
</span>
</source>

This works because the HTML class attribute takes a space separated set of class names.

Blogrolls are a good example of lists of people with name and URL (see also [[xoxo|XOXO]]).

=== Titles ===
If the person's job title is mentioned, mark it up with <code><nowiki><span class="title">...</span></nowiki></code>.

Though typical vCards/hCards have only a single job title, if someone has several job titles listed say in a comma delimited list, just markup the whole lot of them with one big <code><nowiki><span class="title">...</span></nowiki></code>.

View source on the [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html W3C Technical Plenary Agenda] for examples of people with multiple titles.

=== Other affiliations ===
As vCard seems to imply a model of a person only being associated with one organization (at least certainly that's how most [[vcard-implementations]] appear to be written), consider placing other affiliations and info about the person into <code><nowiki><span class="note">...</span></nowiki></code> elements. You can have more than one; converters will simply append them all in source order.

View source on the [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html W3C Technical Plenary Agenda] for examples of people with additional affiliations (such as W3C Working Groups) marked up inside "note" elements.

Sometimes text in a document near a person/contact will explain *why* that person should be contacted. Such information is also useful to have in a "note" element.

View source on the [http://rbach.priv.at/repos/misc/microformatting/ETech2006/invite.html O'Reilly ETech 2006 invite] for examples of people with additional "For ... " reasons marked up as "note" elements.

=== Set the lang when different ===
In an English language document (<code>lang="en"</code>), be sure to markup the element surrounding any non-English names of people, companies, titles, notes etc. with a lang attribute with the appropriate value.

E.g. Spanish names in an english document should be marked up with (<code>lang="es"</code>) on their elements.

View source on the [http://tantek.com/microformats/2006/03-01-TechPlenAgenda.html W3C Technical Plenary Agenda], specifically Ignacio Marín, for an example of a person and org marked up with a <code>lang</code> attribute.

=== Phone Numbers ===
Add a few phone numbers like this:
<source lang=html4strict>
<div class="tel">
<span class="type">work</span>:
<span class="value">+1-250-555-2142</span>
</div>
<div class="tel">
<span class="type">work</span> toll free:
<span class="value">+1-800-555-1855</span>
</div>
<div class="tel">
<span class="type">work</span>
<span class="type">fax</span>:
<span class="value">+1-250-555-2135</span>
</div>
</source>

This will display something like:

work: +1-250-555-2142
work toll free: +1-800-555-1855
work fax: +1-250-555-2135

The list of tel types are: <code>voice</code> [which is the default if "type" is unspecified], <code>home</code>, <code>msg</code>, <code>work</code>, <code>pref</code>, <code>fax</code>, <code>cell</code>, <code>video</code>, <code>pager</code>, <code>bbs</code>, <code>modem</code>, <code>car</code>, <code>isdn</code>, <code>pcs</code>. As shown in the last example above, a tel may have multiple types. See [[hcard#type_subproperty_values|hCard: Type Subproperty Values]] for the official list.

=== Photographs ===
Mark up representative image(s) of the person/org with the class name "<code>photo</code>", e.g.:

<source lang=html4strict><img class="photo" src="http://www.factorycity.net/images/avatar.jpg" alt="" /></source>

If your name is not already marked up (see the Names section above), and your first and last name consist of only two words, you can set the alt attribute for the image as your name. In this case, include the "fn" class name along with the "photo" class name in the class attribute:

<source lang=html4strict><img class="photo fn" src="http://www.factorycity.net/images/avatar.jpg" alt="Chris Messina" /></source>

To ensure that the picture is not left out whenever a hcard is converted into a vcard, the external URI should be replaced with the actual encoded picture data as follows:

<source lang=html4strict><img alt="photo" class="photo" src="data:image/jpeg;base64,/9j/4AAQSkZJRgAB[...]RRxTwKpCP//Z" /></source>

An easy way to encode a contact picture is to use some application which can export vcard files including contact picture, as the freeware [http://www.palm.com/us/software/desktop/ Palm Desktop] does.

=== Geographic Coordinates ===
Add your geographic coordinates:
<source lang=html4strict>
<span class="geo">
<span class="latitude">48.430092246</span>
<span class="longitude">-123.364348450</span>
</span>
</source>

A more human friendly version would be implemented as follows:

<source lang=html4strict>
<div class="geo">
<abbr class="latitude" title="-31.388333">31°23'18"S</abbr>,
<abbr class="longitude" title="-57.960556">57°57'38"O</abbr>
</div>
</source>

That will look like this: 31°23'18"S, 57°57'38"O.

Note that the degree, minute and seconds characters should go encoded as in the source code example above to prevent that the browser to confuses the character encoding used by the page and shows wrong characters, like chinese characters where accents should be displayed.

A good place to get your coordinate values in both formats is Wikipedia. Look for the article on your city and click the human friendly coordinates to load a page with the decimal values.

=== Fragments and linking ===

An hCard is a logical piece of content that people might like to link to. If it's on a page with other content, it can be hard to link to just the one hCard, unless you have a fragment identifier to use. In HTML, you can create fragment identifiers by adding an 'id' attribute to any element. It is good practice to add an 'id' attribute to an hCard, e.g.

<source lang=html4strict>
<span id="my-hCard" class="vcard">
<a class="url fn" href="http://suda.co.uk">
Brian Suda
</a>
</span>
</source>

=== Canonical hCard within a site ===

Nearly every social website has profile URLs for its members, typically [[hcard-supporting-user-profiles|with hCard]].

Most of the pages on such websites link those canonical user profile URLs on the site itself with the icon and/or name the user. It makes sense to explicitly markup those links with both class names "url" and "uid", e.g. on a list of Twitter friends (note the additional use of the [[XOXO]] microformat) that might be hosted on Twitter itself:

<source lang=html4strict>
<ul class="xoxo">
<li class="vcard">
<a class="url uid" href="http://twitter.com/briansuda">
<img class="fn logo" src="b-icon.jpg" alt="Brian Suda" />
</a>
</li>
<li class="vcard">
<a class="url uid" href="http://twitter.com/pspmikek">
<img class="fn logo" src="m-icon.jpg" alt="Michael Kaply" />
</a>
</li>
<li>
<a class="url uid" href="http://twitter.com/t">
<img class="fn logo" src="t-icon.jpg" alt="Tantek Çelik" />
</a>
</li>
</ul>
</source>

Another example: event sites that list and link to user profiles of the people attending an event (e.g. Upcoming.org).

=== URL of an hCard being the page itself ===
The canonical hCard within a site (as noted above) often has hCard markup itself, and it's useful to markup the page itself as the URL for that hCard.

So how do you markup the URL of an hCard where the URL is the page itself?

A few variants have been observed in real-world publishing, each of which implies a solution:

# '''Profile self-hyperlinking with name/photo.''' Many (most?) [[hcard-supporting-user-profiles]] sites hyperlink the person's name (e.g. [http://www.myspace.com/irhetoric Myspace irhetoric]) and/or image (e.g. [http://upcoming.yahoo.com/user/6623 Upcoming tantek]) on their profile to the profile itself. This is a common design pattern. In this case the answer is obvious: simply add <code>class="url uid"</code> to the existing self-hyperlink.
# '''Profiles with a "profile" link and/or dynamic content.''' Some sites have a "Profile" navigation link which is clickable even on the profile itself (e.g. on [http://twitter.com/ Twitter] login and go to your profile). In some cases the "Profile" link is highlighted among other navigation links to indicate that it's what is currently visible among the nav options (e.g. [http://www.last.fm/ last.fm] - login and go to your profile). Both of these sites have dynamic content on profile pages, and thus could also label such self-hyperlinks with text like "Reload" or "Refresh" - accurately indicating to the user that when they clicked the link, it wouldn't change the URL in their browser address bar, but would reload the page, likely visibly updating the page. In both these cases, the answer is the same as the first case above: simply add <code>class="url uid"</code> to the existing self-hyperlink.
# '''Profiles without apparent self-hyperlinks.''' Some sites' profile pages (e.g. [http://flickr.com/people/tantek/ Flickr tantek]) have no self-hyperlink, possibly because their content is more static, and a visible self-hyperlink would appear to "do nothing" when clicked, either frustrating the user, or making them think the site was broken. For these sites, the author can include an empty hyperlink with an empty href attribute (which is resolved as a relative URL to the page itself) to provide an invisible hyperlink to the page itself which is thus both not typically clickable (since it takes up no space), nor has any content which could be erroneously read by a screen reader. E.g. <code><a class="url" href=""></a></code>. This authoring suggestion is probably good enough to handle this third, perhaps rarest case, though it would be useful to to have some test cases that can be run in various browsers / assistive technologies to see what they do. Another (lengthier) suggestion would be to use [[value-class-pattern]] value-title technique, e.g.: <code><nowiki><span class="url uid"><span class="value-title" title="http://example.com/user/john"> </span></span></nowiki></code>.

=== More tips and guidelines ===
Feel free to add more tips that experience has taught you while marking up hCards, even if all you add is a brief catch phrase that reminds you.

* How to note some text, so you can make a comment like who your admin assistant is.
* More inline code examples, perhaps one for each section (suggestion from Cdevroe)
* (suggestion from brian) you mention blogroll, this might be out of scope, but you could mention that XFN and hCard can be interweaved - it is not one or the other
* ...

== Related Pages ==
{{hcard-related-pages}}