citation-examples: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(MAJOR RE-WRITE :: Implied schema corrected and Analysis constructed)
Line 12: Line 12:
== Contributors ==
== Contributors ==
* ...
* ...
* ...
* [http://suda.co.uk/ Brian Suda]
* Tantek Çelik
* Tantek Çelik
* [http://michael-mccracken.net/wp/ Michael McCracken]
* [http://michael-mccracken.net/wp/ Michael McCracken]
Line 23: Line 23:


=== ABC-CLIO Product [http://www.abc-clio.com/products/overview.aspx?productid=109327 detail page] ===
=== ABC-CLIO Product [http://www.abc-clio.com/products/overview.aspx?productid=109327 detail page] ===
* title
* subtitle
* subtitle
* title
* author
* author
* Image
* image
* pubdate
* publication date
* pages
* pages
* volumes
* volumes
* trimsize (book dimentions 8.5x11)
* specifications (book dimentions 8.5x11, weight, etc)
* Format
* Format - (Hardback, softback)
* Price
* Price
* ISBN
* ISBN
Line 37: Line 37:
=== Greenwood Press [http://www.greenwood.com/ home page] featured book ===
=== Greenwood Press [http://www.greenwood.com/ home page] featured book ===
* title
* title
* sub_title
* subtitle
* author
* author
* isbn
* ISBN
* price
* Price
* bookDescription
* Description


=== Greenwood Press [http://www.greenwood.com/catalog/GR2847.aspx Product detail page] ===
=== Greenwood Press [http://www.greenwood.com/catalog/GR2847.aspx Product detail page] ===


* Title
* Title
* SubTitle
* subtitle
* authors
* authors
* AuthorsNote
* AuthorsNote
* BookCode
* BookCode (internal code system)
* Isbn
* ISBN
* PageColation
* Page
* Imprint
* Publisher
* PubDate
* Publication Date
* ListPrice
* Price
* Availability
* Availability
* MediaType
* MediaType
* BookInformation (categories)
* categories
* LC Card Number
* LC Card Number
* LCC Class
* LCC Class
* Dewey Class:
* Dewey Class


=== Marshall Cavendish [http://www.marshallcavendish.com/marshallcavendish/academic/redirector.xml?url=/marshallcavendish/academic/catalogue/books/regionalism_n_regional_security/9812102108.xml product page] ===
=== Marshall Cavendish [http://www.marshallcavendish.com/marshallcavendish/academic/redirector.xml?url=/marshallcavendish/academic/catalogue/books/regionalism_n_regional_security/9812102108.xml product page] ===


* ISBN Number
* ISBN
* Series
* Series
* Title
* Title
* Imprint
* publisher
* Specifications (dimentions/weight)
* Specifications (dimentions/weight)
* Authors
* Authors
Line 80: Line 80:
* edition
* edition
* byline
* byline
* isbnNumber
* ISBN
* format - hardback
* format - hardback
* publicationDate
* publication Date
* price
* price
* description
* description
Line 97: Line 97:
* format - hardback
* format - hardback
* pages
* pages
* publicationDate
* publication Date
* availability
* availability
* cost
* price


=== Thomson Gale product detail page ===
=== Thomson Gale product detail page ===


* title_main
* title
* excerp
* excerp
* Volume
* Volume
* Published by
* Publisher
* description
* description
* Published/Released
* Published date
* ISBN:
* ISBN
* Product number
* Product number (internal code system)
* Page count:
* Pages
* Shipping Weight:
* Shipping Weight
* price
* price
== Breakdown of Citation Elements ==
Using the above examples, various parts of the citations (titles, authors, etc.) can be grouped together for comparision:
=== Book titles: ===
=== Book Series Name: ===
=== Sub-title: ===
=== Author: ===
=== Publication Date: ===
=== Volumes: ===
=== ISBN: ===
=== Book Edition: ===
Added by [[User:Tim White|Tim]]


== RFC vCard Example ==
== RFC vCard Example ==


* refID
* refID (HTML @ID)
* title
* title
* publication
* publication
Line 152: Line 130:
== W3C XHTML Spec Example ==
== W3C XHTML Spec Example ==


* refID
* refID (HTML @ID)
* URL
* URL
* title
* title
Line 170: Line 148:
The XHTML output for CiteProc[http://xbiblio.sourceforge.net/citeproc.html] wasn't designed per se as a microformat, but is probably not a bad place to start. It is desgined to handle a wide range of content. Here is the APA output:
The XHTML output for CiteProc[http://xbiblio.sourceforge.net/citeproc.html] wasn't designed per se as a microformat, but is probably not a bad place to start. It is desgined to handle a wide range of content. Here is the APA output:


* refID
* refID (HTML @ID)
* author
* author
* date
* date
Line 189: Line 167:
* authors
* authors
* Pages
* Pages
* format
* format (PDF)
* Additional Information
* Additional Information
* abstract
* abstract
Line 219: Line 197:
* publication (where it was found)
* publication (where it was found)
* pages  
* pages  
* pubdate
* publication date
* URL
* URL


Line 230: Line 208:
* subjects
* subjects
* image
* image
* Vol
* Volume
* No.
* Number
* pubdate
* publication date
* page
* page


Line 247: Line 225:
* title
* title
* author
* author
* publicationseriesname
* series title
* page
* page


Line 261: Line 239:
== Implied schema ==
== Implied schema ==


Many of the examples have simple citations in <p>, <div>, <td> etc with no further coding; i.e. <td>Book Title. Author. Publisher, date.</td>
=== List of all properties ===
This are a summation of all the properties in the examples, I have tried to logically group them together.


The following lists the most common markup:
* title
* subtitle
* author
* image
* publication date
* language
* description/Summary/abstract
* excerp
* index terms
* categories (keywords, tags, labels, etc.)


=== Book Titles: ===
LOCATION INFORMATION
* pages
* volume
* series title
* Series
* edition
* issue
* publication
* journal
* part (1 of X)


*id="title"
PHYSICAL ATTRIBUTES
*class="producttitle"
* Specifications (dimentions/weight)
*class="title"
* Format/type (book, newspaper, proceedings)
*id="lblTitle"
*h1
*h2
*<dt></dt>
*<cite></cite>
*<strong></strong>
*<i></i>


=== Book Series: ===
IDENTIFIERS
* ISBN
* LC Card Number
* LCC Class
* Dewey Class
* URL
* RFC ID
* ISO/IEC ID
* DOI
* PubMedID


*id="serieslbl"
PUBLISHER
*class="productsubtitle"
* publisher


=== Sub-titles: ===


*id="subtitle"
These are sort of left overs, the are not really about citations, but more about commerce or other things. If they are important we can move them to the above list.
*class="productsubtitle"
* refID (HTML @ID)
*class="sub_title"
* Reviewed (BOOLEAN YES/NO)
*id="lblSubTitle"
* Availability
*class="book_subline"
* Price
*class="subTitle"
* Shipping Weight
 
* related
=== Author: ===
* Product number (internal system code)
 
* BookCode (internal system code)
*id="credit"
* AuthorsNote
*class="productauthor"
* Additional Information
*class="author"
* Target Audience
*Authors (table cell)
*class="byline"
*class="creator"
*class="role"
*Inside <dd></dd> with other elements
*<li></li>
 
=== Publication Date: ===
 
*id="pubdate"
*Publication Date: (table cell)
*id="pnlPubDate"
*Publication Date:
*class="publicationdate"
*Published/Released:
*class="date" w/ class="year", class="month", class="day"
*Inside <dd></dd> with other elements
 
=== Publisher: ===
 
*class="publisher"
*class="origin" (publication location)
 
=== Volumes: ===
 
*class="volume"
 
=== Issue Number: ===
 
*class="issue"
 
=== Page Numbers: ===
 
*class="locator" (inclusive page numbers)
 
=== ISBN: ===
 
*class="isbn"
*id="pnlIsbn"
*id="lblIsbn"
*class="isbnNumber"
 
=== Book Edition: ===
 
*class="edition"
*Inside <dd></dd> with other elements
 
 
== Citeproc XHTML output ==
 
I'm the author of the [http://xbiblio.sourceforge.net/citeproc.html citeproc] project, which includes a micro-format of sorts (though I never thought of it as such) in its XHTML output mode.  See [http://xbiblio.sourceforge.net/examples/apa-en.html here] for an example.  The difference compared to the bibtex-derived model is that is a) more generic and b) hierachical.
 
It would be possible, certainly, to do a flat model if for some reason there was a good technical reason not to go hierarchical (though is there?)
 
'''The burden of proof is on *going* hierarchical, rather than a simpler flat solution.  Complexity must be justified, not simplicity.'''
 
... but then you need to think outside the BibTeX box in any case. Any model of this sort ought to be able to handle legal citations, magazine articles, patents, etc. etc.; not just a narrow range of BibTeX types.
 
'''Per the microformats [[process]], microformats are designed to support existing practice on the Web, anything else should be omitted from at least the first version.'''


=== Analysis of Examples ===
With exception of just a few properties, all of the above appeared in atleast two different examples. The following properties were very common in most the example formats:
* title
* subtitle
* author
* publication date
* description
* pages
* ISBN
* publisher


== Styles ==
== Styles ==

Revision as of 06:20, 10 April 2006

Citation Examples

The following examples are real world examples of citations found on the web. Please add to this list. The idea is that we get a solid sample of examples and see what commonalities there are amonst them and try to build this microformat so that it can meet 80% of typical uses.

See also:

Contributors

Citation Mark Up in the Wild

Mark up examples from reference publisher's websites (online catalogs), including ABC-CLIO, Greenwood Press, Marshall Cavendish, Oxford University Press (USA) and Thomson Gale. Examples are broken down and organized by element.

(For a cleaner version, see [1])

ABC-CLIO Product detail page

  • title
  • subtitle
  • author
  • image
  • publication date
  • pages
  • volumes
  • specifications (book dimentions 8.5x11, weight, etc)
  • Format - (Hardback, softback)
  • Price
  • ISBN

Greenwood Press home page featured book

  • title
  • subtitle
  • author
  • ISBN
  • Price
  • Description

Greenwood Press Product detail page

  • Title
  • subtitle
  • authors
  • AuthorsNote
  • BookCode (internal code system)
  • ISBN
  • Page
  • Publisher
  • Publication Date
  • Price
  • Availability
  • MediaType
  • categories
  • LC Card Number
  • LCC Class
  • Dewey Class

Marshall Cavendish product page

  • ISBN
  • Series
  • Title
  • publisher
  • Specifications (dimentions/weight)
  • Authors
  • Target Audience
  • Price
  • description

Oxford University Press (USA) homepage

  • title
  • subTitle
  • edition
  • byline
  • ISBN
  • format - hardback
  • publication Date
  • price
  • description
  • related

Oxford University Press (USA) Product page

  • title
  • subTitle
  • edition
  • byline
  • image
  • isbnNumber
  • format - hardback
  • pages
  • publication Date
  • availability
  • price

Thomson Gale product detail page

  • title
  • excerp
  • Volume
  • Publisher
  • description
  • Published date
  • ISBN
  • Product number (internal code system)
  • Pages
  • Shipping Weight
  • price

RFC vCard Example

  • refID (HTML @ID)
  • title
  • publication
  • title
  • Journal
  • Volume
  • Issue
  • page
  • pubdate
  • RFC ID

W3C XHTML Spec Example

  • refID (HTML @ID)
  • URL
  • title
  • subtitle
  • part (1 of X)
  • journal
  • authors
  • pubdate
  • language
  • ISO/IEC ID
  • RFC ID

XHTML1.0 Spec references

CiteProc XHTML Output

The XHTML output for CiteProc[2] wasn't designed per se as a microformat, but is probably not a bad place to start. It is desgined to handle a wide range of content. Here is the APA output:

  • refID (HTML @ID)
  • author
  • date
  • title
  • volume
  • issue
  • page
  • issue
  • type (book, newspaper, proceedings)
  • Edition
  • publisher

ACM Digital Library Search Result Examples

The ACM Digital Library is a heavily used computer science literature database.

  • title
  • authors
  • Pages
  • format (PDF)
  • Additional Information
  • abstract
  • index terms
  • journal
  • issue
  • volume
  • pubdate
  • DOI

IEEE IEEExplore Search Results Markup

  • title
  • authors
  • issue
  • Volume
  • Issue
  • pubdate
  • Page
  • Digital Object Identifier (DOI)
  • Summary

CiteSeer database search results

The CiteSeer database has been another heavily used Computer Science online resource, and it has minimal markup:

  • author
  • title
  • publication (where it was found)
  • pages
  • publication date
  • URL

CiteULike.org citation listing

CiteULike

  • title
  • author
  • subjects
  • image
  • Volume
  • Number
  • publication date
  • page

Links to services with the following IDs embedded in the link

  • Z3988
  • DOI
  • Pubmed
  • Hubmed

Amazon.com citation info

This is from a detail page on Amazon.com for a book.

  • title
  • author
  • series title
  • page

PubMed Medical Journal Example

  • abstract
  • title
  • publisher
  • date/time published
  • Review (BOOLEAN YES/NO)
  • PubMedID

Implied schema

List of all properties

This are a summation of all the properties in the examples, I have tried to logically group them together.

  • title
  • subtitle
  • author
  • image
  • publication date
  • language
  • description/Summary/abstract
  • excerp
  • index terms
  • categories (keywords, tags, labels, etc.)

LOCATION INFORMATION

  • pages
  • volume
  • series title
  • Series
  • edition
  • issue
  • publication
  • journal
  • part (1 of X)

PHYSICAL ATTRIBUTES

  • Specifications (dimentions/weight)
  • Format/type (book, newspaper, proceedings)

IDENTIFIERS

  • ISBN
  • LC Card Number
  • LCC Class
  • Dewey Class
  • URL
  • RFC ID
  • ISO/IEC ID
  • DOI
  • PubMedID

PUBLISHER

  • publisher


These are sort of left overs, the are not really about citations, but more about commerce or other things. If they are important we can move them to the above list.

  • refID (HTML @ID)
  • Reviewed (BOOLEAN YES/NO)
  • Availability
  • Price
  • Shipping Weight
  • related
  • Product number (internal system code)
  • BookCode (internal system code)
  • AuthorsNote
  • Additional Information
  • Target Audience

Analysis of Examples

With exception of just a few properties, all of the above appeared in atleast two different examples. The following properties were very common in most the example formats:

  • title
  • subtitle
  • author
  • publication date
  • description
  • pages
  • ISBN
  • publisher

Styles

This does NOT define a format, but instead shows how the format should be displayed. This is something out of the direct scope of this project. CSS styles will handle the look-and-feel of the text, and the author can put it in any order they choose. These links are mentioned for two reasons, one is informative, the other is so we know at least meet the minimum properties that are used in the styles.

Retrieved from "http://microformats.org/wiki/index.php?title=citation-examples&oldid=5790"