citation: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(A Prescriptive Propose (new section))
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(21 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<h1> Citation microformat efforts </h1>
{{DISPLAYTITLE: Citation microformat efforts }}


This wiki page outlines the overall effort to develop a citation microformat. 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 deriving a cite microformat from that research.
This wiki page outlines the overall effort to develop a citation microformat per the [[process]].  


__TOC__
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.
 
* [[citation-examples]]
;Authors
* [[citation-formats]]
:[http://tantek.com/ Tantek Çelik]
** Latest analysis: [[citation-formats#styles|citation styles]] - formats implied by APA, MLA, TCMOS publishing conventions.
:[http://suda.co.uk/ Brian Suda]
* [[citation-brainstorming]]
:[http://www.inkdroid.org Ed Summers]
** Latest: [[citation-brainstorming#web_citations|web citations]]
 
== Copyright ==
{{MicroFormatCopyrightStatement2004}}
* [[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.
** When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.
* [[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.
 
== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}


== Example Citations ==
== Example Citations ==
Line 25: Line 16:
The [[citation-formats|Citation Formats Page]] will be a running tab of known formats for publishing citations.
The [[citation-formats|Citation Formats Page]] will be a running tab of known formats for publishing citations.


Eventually, I would like to see 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)
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)
 
== A Prescriptive Propose ==
 
Here is a propose which was derived from what one actually has to give as information in a cite as usual in our universities. (I don't know where to put that, so I put it right here.)
 
First, we need a frame, let's say "hcitation". Multiple citations can be put in a "hcitation" frame. Inside there, we can tell the type of citation, I suggest: "monograph"; "anthology", "periodical" , "reference", "thesis" , "standard", "internet", "specialist".
 
If a "label" was used to refer to the ressource in the text (often in square brackets) it can be named so.
 
Here comes the list of field names we need: "article", "atime", "author", "ctime", "department", "edition", "editor", "eligibility", "employer", "number", "overalltitle", "pagerange", "part", "place", "publisher", "subseries", "title", "type", "url", "volume", "volumetitle", "year".


A field "page" is to mark up which page you actually quote from. Marking up whatever as "prefix" should give you a hint that this is to be put at first place, but not to refer to when sorting. E.G. "The" should be marked as "prefix" either in "The Crocodile" and also in "Crocodile, the".
== Brainstorming ==
 
* [[citation-brainstorming]]
<table border="1">
    <tr>
        <th>Field</th>
        <th>Description</th>
        <th><code>monograph</code></th>
        <th><code>anthology</code></th>
        <th><code>periodical</code></th>
        <th><code>thesis</code></th>
        <th><code>standard</code></th>
        <th><code>internet</code></th>
        <th><code>specialist</code></th>
    </tr>
    <tr>
        <td><code>article</code></td>
        <td>Name of the Article in question</td>
        <td align="center">&nbsp;</td>
        <td align="center">3</td>
        <td align="center">3</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>atime</code></td>
        <td>Last access time for online ressources. Use abbr
        convention for datetime encoding.</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">11</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">5</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>author</code></td>
        <td>Creator. Use fn or n markup for every single entity.</td>
        <td align="center">1</td>
        <td align="center">1</td>
        <td align="center">1</td>
        <td align="center">1</td>
        <td align="center">&nbsp;</td>
        <td align="center">1</td>
        <td align="center">1</td>
    </tr>
    <tr>
        <td><code>ctime</code></td>
        <td>Date / Last modification. Use abbr convention for
        datetime encoding.</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">8</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">4</td>
        <td align="center">5</td>
    </tr>
    <tr>
        <td><code>department</code></td>
        <td>special field / faculty</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">6</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">3</td>
    </tr>
    <tr>
        <td><code>edition</code></td>
        <td>Edition information</td>
        <td align="center">6</td>
        <td align="center">8</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">2</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>editor</code></td>
        <td>Editors of an anthology. Use fn or n markup for every single entity. Add &quot;transl&quot; for translators and &quot;comp&quot; for compilers</td>
        <td align="center">&nbsp;</td>
        <td align="center">4</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>eligibility</code></td>
        <td>Qualification of a specialist</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">2</td>
    </tr>
    <tr>
        <td><code>employer</code></td>
        <td>Name of university eg.</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">4</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">4</td>
    </tr>
    <tr>
        <td><code>number</code></td>
        <td>Number</td>
        <td align="center">10</td>
        <td align="center">12</td>
        <td align="center">9</td>
        <td align="center">&nbsp;</td>
        <td align="center">1</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>overalltitle</code></td>
        <td>Overall Title / Title of series</td>
        <td align="center">9</td>
        <td align="center">11</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">8</td>
    </tr>
    <tr>
        <td><code>pagerange</code></td>
        <td>Page range of an article in an anthology / periodical</td>
        <td align="center">&nbsp;</td>
        <td align="center">13</td>
        <td align="center">10</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>part</code></td>
        <td>Part of article (if having several parts)</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">4</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>place</code></td>
        <td>Place of publication</td>
        <td align="center">7</td>
        <td align="center">9</td>
        <td align="center">&nbsp;</td>
        <td align="center">5</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>publisher</code></td>
        <td>House of Publish</td>
        <td align="center">8</td>
        <td align="center">10</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>subseries</code></td>
        <td>name of subseries, If any</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">6</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>title</code></td>
        <td>The main title. Anthology: name of antology.
        Periodical: name of periodical</td>
        <td align="center">3</td>
        <td align="center">5</td>
        <td align="center">5</td>
        <td align="center">3</td>
        <td align="center">3</td>
        <td align="center">3</td>
        <td align="center">6</td>
    </tr>
    <tr>
        <td><code>type</code></td>
        <td>Type (type of thesis or type of utterance (radio
        interview, e-mail, ...) of a speciaist)</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">7</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">7</td>
    </tr>
    <tr>
        <td><code>url</code></td>
        <td>URL</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">12</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">6</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>volume</code></td>
        <td>Volume information (eg. Vol. 22)</td>
        <td align="center">4</td>
        <td align="center">6</td>
        <td align="center">7</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>volumetitle</code></td>
        <td>Volume title</td>
        <td align="center">5</td>
        <td align="center">7</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
        <td align="center">&nbsp;</td>
    </tr>
    <tr>
        <td><code>year</code></td>
        <td>Year of appearance. 4 digit year. Use abbr convention
        for datetime encoding.</td>
        <td align="center">2</td>
        <td align="center">2</td>
        <td align="center">2</td>
        <td align="center">2</td>
        <td align="center">&nbsp;</td>
        <td align="center">2</td>
        <td align="center">&nbsp;</td>
    </tr>
</table>
 
This table shows what has to go together. Other Information than given here (eg. ISBN, ...) actually has not to be put into citations, students would recive negative evaluations if they do so. (I hope this will help somehow. sorry for bad english.)


== Issues ==
== Issues ==
Line 311: Line 30:


== 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 could use the Citation Module
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]]
* [[hresume|hResume]]
* [[work-of-art]]
* [[work-of-art]]


Other Microformats that the Citation Module will use
Other microformats that the Citation Module could/should re-use
* [[hcard|hCard]] encodings for things like Author, Publisher (people and companies)
* [[hcard|hCard]] encodings for things like Author, Publisher (people and companies)
* [[hatom|hAtom]] encodings as a possible container, and author/date-time properties
* [[hatom|hAtom]] encodings for author/date-time properties
* [[rel-tag]] encoding for keywords
* [[rel-tag]] and "category" encoding for keywords, if any
* [[rel-license]] encoding for copyright
* [[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]
* [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://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
Line 343: Line 64:
* [http://www.docbook.org/ DocBook] (markup langauige for books); [http://en.wikipedia.org/wiki/Docbook DocBook on Wikipedia]
* [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]
* [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.
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>
instead.


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