This is an old revision of the document!


Sharing CSL styles

After creating or modifying a CSL style, consider sharing your new style if it might be of interest to other users (e.g. if the style is for an academic journal, publisher, university, or university department). The easiest way to share your style is via the Zotero Style Repository. To submit styles to the repository, follow the instructions below.

General Instructions

  • The file name the style should contain no characters other than lowercase roman letters (a-z), digits (0-9) and single hyphens (-). The file extension should be ”.csl”. E.g. use “style-name.csl” instead of “StyleName.csl”, “Style Name.csl” or “style_name.txt”.
  • The style ID (set with the <id> element) should be of the form http://www.zotero.org/styles/file-name, without an extension (e.g. http://www.zotero.org/styles/apa for apa.csl).
  • The style should include a license (set with the <rights> element) that permits sharing (most styles use the Creative Commons Attribution-Share Alike 3.0 License). E.g. use
    <rights>This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License:
    http://creativecommons.org/licenses/by-sa/3.0/</rights>
  • If your style is largely derived from an existing style, list the authors and contributors of that style as contributors in your style. Add yourself as the style's author.

Submitting for Casual Coders

The easiest way to submit styles is post a link to your style code on the Zotero forums. Please do not paste style code directly into your post. Instead, use a code sharing website like http://gist.github.com.

Using gist.github.com

Go to the https://gist.github.com/ website, and copy and paste your style code into the large text box. Enter the file name in the “name this file…” text box, and click the “Create Public Gist” button at the bottom of the page.

Create a new thread for your style in the Citation Styles category of the Zotero forum. In your post, ask for your style to be uploaded to the repository, and provide the link to the Gist (copy the URL from the address bar, which should be in the form of https://gist.github.com/766801. Your style will then be added to the repository by one of the Zotero developers or community members. If you don't hear back within a week, post a reminder to the same thread.

Submitting for Advanced and/or Frequent Contributors

If you're a frequent contributor of styles or an advanced user, you may want to add the style to the repository yourself. For that, you first need a SVN/Trac account with Zotero. Next, you will need an SVN client. Many users prefer GUI-based SVN clients, which include Tortoise SVN for windows, Versions (non-free) for Mac, and Rabbit VCS Linux. A comprehensive list of SVN clients is here. With your SVN client, check out the csl repository from Zotero. The repository address is https://www.zotero.org/svn/csl. Add your style to the repository or update the style you're improving and commit your change. Refer to the instructions provided with your SVN client for details.

dev/submitting_citation_styles.1299272931.txt.gz · Last modified: 2011/03/04 16:08 by rmzelle