citation: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(Added mention of cross referencing Resume Microformat)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(80 intermediate revisions by 26 users not shown)
Line 1: Line 1:
= Citation Formats =
{{DISPLAYTITLE: Citation microformat efforts }}


== Authors ==
This wiki page outlines the overall effort to develop a citation microformat per the [[process]].  
[http://suda.co.uk/ Brian Suda]


== Copyright ==
We are documenting current examples of [http://en.wikipedia.org/wiki/Citation cites/citations] on the web today, their implicit/explicit schemas, and current cite/citation formats, with the intent of creating a citation microformat based on that research.
{{MicroFormatCopyrightStatement2004}}
* [[citation-examples]]
 
* [[citation-formats]]
== Introduction ==
** Latest analysis: [[citation-formats#styles|citation styles]] - formats implied by APA, MLA, TCMOS publishing conventions.
Currently, there has been some discussion about a citation format. This is the wiki page to document current examples of cites/citations on the web today, and current cite/citation formats, and their implicit/explicit schemas, with the intent of deriving a cite microformat from that research.
* [[citation-brainstorming]]
 
** Latest: [[citation-brainstorming#web_citations|web citations]]
== Rules ==
'''This is premature, and inappropriate here.  First document various cite-formats, and then perhaps explore straw proposals in a [[cite-brainstorming]] page''' -[http://tantek.com/log/ Tantek]
 
The citation format will follow the same rules as other microformats.
<pre><nowiki>
<div class="author">John Doe</div>
<div class="publisher">Publishing House, Inc.</div>
</nowiki></pre>
 
== Example Formats ==
 
=== 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:&nbsp;</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:&nbsp;</b></td>
        <td>The edition of a book - for example
        &quot;Second&quot;. Notice that it is in capitals.</td>
    </tr>
    <tr>
        <td><b>editor:&nbsp;</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:&nbsp;</b></td>
        <td>A journal name. Abbreviations are provided for many
        journals.</td>
    </tr>
    <tr>
        <td><b>key:&nbsp;</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:&nbsp;</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:&nbsp;</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:&nbsp;</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,
        &quot;Research Note&quot;.</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:&nbsp;</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 <a href="#proceedings">Proceedings</a>.</td>
    </tr>
    <tr>
        <td><b>conference:</b></td>
        <td>The same as <a href="#inproceedings">Inproceedings</a>.</td>
    </tr>
    <tr>
        <td><b>inbook:</b></td>
        <td>A part of a book, which may be a chapter and/or a
        range 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><a name="inproceedings"></a><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:&nbsp;</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><a name="proceedings"></a><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",
== Example Citations ==
TITLE = "1966 World Gnus Almanac",
[[citation-examples|Citation Examples]] are citations found in the wild that could benefit from semantic mark-up. This is a growing list of examples from all sorts of places including W3C specifications, RFCs and others.  These are the examples which will determine the schema for the citation microformat.
PUBLISHER = {Permafrost Press},
ADDRESS = {Novosibirsk} }


<div class="book" id="kn:gnus">
== Known Citation Formats ==
  <div class="author">Donald E. Knudson</div>
The [[citation-formats|Citation Formats Page]] will be a running tab of known formats for publishing citations.
  <div class="title">1966 World Gnus Almanac</div>
  <div class="publisher">Permafrost Press</div>
  <div class="address">Novosibirsk</div>
</div>


It could be useful to create a chart of how each value from the implicit schema determined by the [[citation-examples]] is represented in each format, and what formats have additional properties that do not map between them. (For example, Format1 calls 'author' 'author', in format2 'author' is called 'writer'. etc)


@article{XAi_HSCheng_1994a,
== Brainstorming ==
* [[citation-brainstorming]]


author = "X. Ai and H. S. Cheng",
== Issues ==
title = "Influence of moving dent on point {EHL} contacts",
The [[citation-issues]] page is intended to capture ongoing issues.
journal = "Tribol. Trans.",
volume = "37",
year = "1994",
pages = "323--335",
}


<div class="article" id="XAi_HSCheng_1994a">
== To Do ==
  <div class="author">X. Ai and H. S. Cheng</div>
* [[existing-classes|Using existing class names]] and creating new names, create property names for the profile
  <div class="title">Influence of moving dent on point {EHL} contacts</div>
* Based on implicit schemas in [[citation-examples]], and terms from one or more [[citation-formats]], do some [[citation-brainstorming]] for a simple citation microformat.
  <div class="journal">Tribol. Trans.</div>
* Create additional strawman proposals
  <div class="volume">37</div>
  <div class="year">1994</div>
  <div class="pages">323--335</div>
</div>
</nowiki></pre>
 
 
== Todo ==
* select a bibliography format to model
* look for HTML tags that give the most semantic meaning
 
== Questions ==
* what is the difference between hReview and a Citation format?
** Right a citation is actually very different from a review, and even although a review could be said to contain a citation to the item being reviewed, in practice, the two are very different.
* if a citation is an author or publisher, isn't that just an hCard
*


== Modularity ==
== Modularity ==
My hope for this microformat is that it can be a sort of module that can be used in other microformats. Once this is developed and flushed out, citation references could easily be used for publications on a Resume/CV, therefore the citation microformat would be a module (subset) of all the possible Resume Values.
This microformat should be developed as a module that can be used in other microformats. Once developed and flushed out, citation references could easily be used for publications on a Resume/CV (e.g. in an [[hResume]]), therefore the citation microformat would be a module (subset) of all the possible Resume Values.
 
Other Microformats that use the Citation Module
* [http://microformats.org/wiki/resume-formats Resume Microformat] (possibly)


Other Microformats that could use the Citation Module
* [[hAtom]], e.g. inside of blog posts to infer a structure of which posts are about which other posts.
* [[hresume|hResume]]
* [[work-of-art]]


Other microformats that the Citation Module could/should re-use
* [[hcard|hCard]] encodings for things like Author, Publisher (people and companies)
* [[hatom|hAtom]] encodings for author/date-time properties
* [[rel-tag]] and "category" encoding for keywords, if any
* [[rel-license]] encoding for copyright, if any


== References ==
== References ==
=== Informative References ===
=== Informative References ===
'''Most of these should be moved to [[citation-formats]] and documented accordingly.'''
* [http://ocoins.info/ COinS]
* [http://ocoins.info/ COinS]
* BibTeX referencesI think a citation micro-format would be useful, but BibTeX is not the best model to use. It has a flat metadata model that does a really poor job representing the sort of citations that people outside of the hard sciences cite.
* [http://xmlresume.sourceforge.net/ XMLResume]: if part of the drive for citations is for publications for a resume/CV then some of this information could be useful
* [http://www.citeulike.org/ CiteUlike] is a free service to help academics to share, store, and organise the academic papers they are reading
* [http://www.connotea.org/ Connotea] is a scientific bookmarking service from Nature.
* [http://www.ariadne.ac.uk/issue43/chudnov/ OpenURL] with Autodiscovery
* [http://cipolo.med.yale.edu/mailman/listinfo/gcs-pcs-list "Gather, Create, Share" and "Personal Collection Systems" memes, and systems implementing either or both]
* [http://www.loc.gov/standards/mods/ Metadata Object Description Schema] developed by the Library of Congress
* [http://www.dublincore.org/documents/dc-citation-guidelines/ Guidelines for Encoding Bibliographic Citation Information in Dublin Core Metadata]
* [http://www.ecst.csuchico.edu/~jacobsd/bib/formats/bibtex.html BibTeX reference] from Dana Jacobsen
* [http://www.refman.com/support/risformat_intro.asp RIS Format Specification] from Thomson ResearchSoft, makers of ReferenceManager
* [http://www.zotero.org/ Zotero] - "Firefox extension to help you collect, manage, and cite your research sources"
*[http://www.doi.org/ DOI] ([http://www.crossref.org/02publishers/guidelines.html CrossRef Guidelines] for use of DOIs in citations)
* [http://info-uri.info/ INFO URI] (URI scheme for representing legacy namespaces)
*[http://www.isbn-international.org/ ISBN] ([http://en.wikipedia.org/wiki/International_Standard_Book_Number ISBN on Wikipedia])
*[http://www.issn.org/ ISSN] ([http://en.wikipedia.org/wiki/International_Standard_Serial_Number ISSN on Wikipedia])
* [http://opcit.eprints.org/ Open Citation Project] - OpCit, a three year (1999-2002)R&D project funded by the Joint NSF - JISC International Digital Libraries Research Programme.
* [http://www.docbook.org/ DocBook] (markup langauige for books); [http://en.wikipedia.org/wiki/Docbook DocBook on Wikipedia]
* [http://www.bl.uk/news/2007/pressrelease20071022.html RDA: Resource Description and Access]
 
== Copyright ==
{{MicroFormatPublicDomainContributionStatement}}
* [[User:Tantek|Tantek]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
* [[User:Brian|Brian Suda]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
* [[User:Edsu|Ed Summers]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
* [[User:Mike|Michael McCracken]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
* ... feel free to similarly add yourself if you're in the pre-2007-12-29 edit history, and preferably add the PD template to your user page e.g. see [[User:Tantek]] for an example to edit/copy-paste.
 
It's been long enough that we should begin going through the edit history and removing/replacing pre-2007-12-29 content in order to bring this page fully into the public domain. [[User:Tantek|Tantek]] 00:53, 20 July 2011 (UTC)
 
* PD cleared from beginning to 2006-02-14T16:59:21
* '''To Do: clear edits from 2006-02-14T16:59:22 to 2007-06-26T21:55:41''' (some of those edits may have ended up in other pages like [[citation-examples]], [[citation-formats]], [[citation-brainstorming]] so be sure to check to see if contributions propagated there).
** As you remove/replace non-PD contributed content accordingly, please update the date range on this to do item.


=== Comments ===
Once the entire history has been PD-cleared, we can remove the Authors and Copyright sections, and simply include the PD template <nowiki>{{cc-pd-license}}</nowiki>
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 is a) more generic and b) hierachical.  
instead.


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?), 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.
== See Also ==
{{citation-related-pages}}

Latest revision as of 16:21, 18 July 2020


This wiki page outlines the overall effort to develop a citation microformat per the process.

We are documenting current examples of cites/citations on the web today, their implicit/explicit schemas, and current cite/citation formats, with the intent of creating a citation microformat based on that research.

Example Citations

Citation Examples are citations found in the wild that could benefit from semantic mark-up. This is a growing list of examples from all sorts of places including W3C specifications, RFCs and others. These are the examples which will determine the schema for the citation microformat.

Known Citation Formats

The Citation Formats Page will be a running tab of known formats for publishing citations.

It could be useful to create a chart of how each value from the implicit schema determined by the citation-examples is represented in each format, and what formats have additional properties that do not map between them. (For example, Format1 calls 'author' 'author', in format2 'author' is called 'writer'. etc)

Brainstorming

Issues

The citation-issues page is intended to capture ongoing issues.

To Do

Modularity

This microformat should be developed as a module that can be used in other microformats. Once developed and flushed out, citation references could easily be used for publications on a Resume/CV (e.g. in an hResume), therefore the citation microformat would be a module (subset) of all the possible Resume Values.

Other Microformats that could use the Citation Module

  • hAtom, e.g. inside of blog posts to infer a structure of which posts are about which other posts.
  • hResume
  • work-of-art

Other microformats that the Citation Module could/should re-use

  • hCard encodings for things like Author, Publisher (people and companies)
  • hAtom encodings for author/date-time properties
  • rel-tag and "category" encoding for keywords, if any
  • rel-license encoding for copyright, if any

References

Informative References

Most of these should be moved to citation-formats and documented accordingly.

Copyright

Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.

  • Tantek: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
  • Brian Suda: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
  • Ed Summers: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
  • Michael McCracken: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
  • ... feel free to similarly add yourself if you're in the pre-2007-12-29 edit history, and preferably add the PD template to your user page e.g. see User:Tantek for an example to edit/copy-paste.

It's been long enough that we should begin going through the edit history and removing/replacing pre-2007-12-29 content in order to bring this page fully into the public domain. Tantek 00:53, 20 July 2011 (UTC)

  • PD cleared from beginning to 2006-02-14T16:59:21
  • To Do: clear edits from 2006-02-14T16:59:22 to 2007-06-26T21:55:41 (some of those edits may have ended up in other pages like citation-examples, citation-formats, citation-brainstorming so be sure to check to see if contributions propagated there).
    • As you remove/replace non-PD contributed content accordingly, please update the date range on this to do item.

Once the entire history has been PD-cleared, we can remove the Authors and Copyright sections, and simply include the PD template {{cc-pd-license}} instead.

See Also