Skip to content

Style Requirements

Jump to bottom
Rintze M. Zelle edited this page Dec 3, 2013 · 37 revisions

When preparing submissions to the CSL style repository, please follow the formatting guidelines below:

  1. Avoid abbreviations in the style title. An acronym can be stored in the dedicated <title-short/> element instead. For example:

    <info>
  <title>Modern Humanities Research Association</title>
  <title-short>MHRA</title-short>
</info>

  2. The file name of the style may contain no characters other than lowercase roman letters (a-z), digits (0-9), single hyphens to separate words (-), and must end in a ".csl" extension. Avoid abbreviations in the file name as well, e.g. "modern-humanities-research-association.csl", not "mhra.csl". Drop diacritics such as umlauts (e.g., "für" becomes "fur", not "fuer").

  3. The style ID, which is used to identify the style, must be of the form "http://www.zotero.org/styles/file-name". Replace "file-name" with the file name of the style without the ".csl" extension, e.g. "http://www.zotero.org/styles/modern-humanities-research-association" for "modern-humanities-research-association.csl":

    <info>
  <id>http://www.zotero.org/styles/modern-humanities-research-association</id>
</info>

  4. The style self-link, which indicates where the style can be found online, must match the style ID:

    <info>
  <link href="http://www.zotero.org/styles/modern-humanities-research-association" rel="self"/>
</info>

  5. The style must be licensed under the Creative Commons Attribution-ShareAlike 3.0 License. Use the exact text below, on a single line:

    <info>
  <rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License</rights>
</info>

  6. If you started from another CSL style, delete the original style authors and contributors, and point to the original style with a template-link:

    <info>
  <link href="http://www.zotero.org/styles/original-style" rel="template"/>
</info>

  7. If your style only targets a single language (e.g. US English if you're submitting a style for an American journal), set the default-locale attribute on <style/> to the desired locale ("en-US" for US English; for the list of currently supported locales, see https://github.com/citation-style-language/locales/wiki). The language should also be mentioned in the style title, e.g. <title>Journal of Results (German)</title>, unless the language is English.

  8. If the style is for a journal, include the journal's print and online ISSN:

    <info>
  <issn>0028-0836</issn>
  <eissn>1476-4687</eissn>
</info>

  9. Include a documentation-link to the online style guide (often the "instructions to authors" for journals), or, if no online documentation is available, to a webpage describing the printed style guide. We only accept styles into the repository for which documentation exists. E.g.,

    <info>
  <link href="http://www.mhra.org.uk/Publications/Books/StyleGuide/download.shtml" rel="documentation"/>
</info>

  10. Make sure that your finished style validates against the CSL schema.

Finally, while not a strict requirement, we prefer XML that is indented with 2 spaces per level.

Clone this wiki locally