Skip to content

Citation Styles

Jack Reed edited this page Jun 6, 2016 · 1 revision

SUL-PUB Citations

Citations are generated by the PubHash model. It uses the citeproc-ruby and csl-styles gems, which implement the Citation Style Language (CSL). For detailed commentary or support on working on CSL, there is a development listserv for CSL at https://lists.sourceforge.net/lists/listinfo/xbiblio-devel

CSL Resources

The CSL Documentation has various download formats available at http://readthedocs.org/projects/citation-style-language/downloads/. There are useful appendices that define the CSL types (document types) and variables (document fields), see

The CSL claims, "Our crowdsourced repository offers over 8000 free CSL citation styles." They provide information about searching styles at http://citationstyles.org/styles/. One way to search is to create an example of the citation required and use it, see

If we cannot find a suitable style defined for the document types and styles we require, we can use an existing style and dynamically modify it. An example of this is in PubHash for the Chicago style that has a modified et al rule when there are more than 5 authors.

The CSL web site provides an online editor, see

If a modification to an existing style or a new style needs to be incorporated into the github repository for styles, there are contribution guidelines for doing that via a github pull request.

Mapping doc-types to CSL item types and fields

CSL currently doesn't specify what document types go well with what CSL item types, but most CSL repository styles are based around the document type mappings used by Zotero [1,2] and Mendeley [3]. So, to expand support for doc-types in sul-pub, we could consider these Zotero [1,2] and Mendeley [3] examples of mapping UI label -> doc-type field -> CSL field. Also, it looks like a JSON-SCHEMA [4] is a useful validator for the citation data generated by any doc-type field mapping into CSL data.

Example of mapping working paper into CSL report fields

Zotero document their mapping in http://aurimasv.github.io/z2csl/typeMap.xml#map-report Mendeley have a similar mapping of working-paper into report, see the bottom of the page at http://support.mendeley.com/customer/portal/articles/364144-csl-type-mapping

* TYPE: WorkingPaper -> report
   Abstract -> abstract
   Chapter -> chapter-number
   DOI -> DOI
   Date Accessed -> accessed
   Edition -> edition
   Genre -> genre
   ISBN -> ISBN
   ISSN -> ISSN
   Issue -> issue
   Number -> number
   Pages -> page
   Publisher -> publisher
   Sections -> section
   Series Title -> container-title
   Short Title -> shortTitle
   Title -> title
   Volume -> volume

The CSL website has style info for the three citation formats supported by CAP (Chicago, MLA and APA):

OCLC Citation Services

The SearchWorks project uses an OCLC service to get back citations, including APA, MLA and Chicago formats. The SearchWorks code appears to be in:

It appears to use the OCLC Service at

We do not know anything about the OCLC service internals, at this time. It may use the Citation Style Language that is used in sul-pub.

Examples of citations for each new document type and citation format:

Possibly relevant background docs are:

SUL Resources on Citation Styles:

Words shown in bold are different from existing styles. Always append publicationURL at the end of the style if it exists.

Working papers (cite these like we would dissertations/theses, lectures, paper or other presentations, add new publicationURL at the end)

Case Studies (cite like we would a book)

Technical Reports (same as journal article)

Other

  • Key data:
    • Author(s)
    • Title
    • Date
    • URL/Source
    • Publisher
    • Place of publication
    • Series name and number (if a report) - not required and we do not believe currently in the UI specification for CAP

Note: Grace put together a word document called Report_citation_format_revised_6Jan2016. that includes a bunch of examples from various departments/groups on campus that produce Working Papers, Case Studies and Technical Reports. The info in that document may be helpful.

Helpful links: Re APA citation styles: https://owl.english.purdue.edu/owl/resource/560/01/