Differences

This shows you the differences between two versions of the page.

--- dev:submitting_citation_styles [2011/03/04 14:33] – created adamsmith
+++ dev:submitting_citation_styles [2011/04/03 13:48] – rmzelle
@@ Line 1: / Line 1: @@
-====Submitting your Citation Style====
+====== Sharing CSL styles ======
-If you have written a new citation style, or adjusted an existing style, there is a good chance that other users would benefit from the style. Especially if the style is for an academic journal or publisher, a university, or a university department, consider making it available on the [[http://www.zotero.org/styles|Zotero style repository]].
-===General Guidelines===
+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 [[http://www.zotero.org/styles|Zotero Style Repository]]. CSL 1.0 styles can also be submitted to the GitHub [[https://github.com/citation-style-language/styles|CSL 1.0 style code repository]].
-Please make sure to follow the following guidelines for public styles
-  * File names of styles submitted to the Style Repository 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”
-  * New styles should use URIs in the <id> element of the form %%http://www.zotero.org/styles/style-name%%, without an extension.
+===== Preparing Styles for Distribution =====
-  * Styles on the repository should have a creative commons or comparable license. Add <code><rights>This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License:
+The are several requirements for distributing styles via the [[http://www.zotero.org/styles|Zotero Style Repository]] and GitHub [[https://github.com/citation-style-language/styles|CSL 1.0 style code repository]]:
-http://creativecommons.org/licenses/by-sa/3.0/</rights></code> to the <info> section of the style
-  * If your style is based to a significant extent on an existing style, list the author and contributors of that style as <contributor> in the <info> section of your style. Add yourself as the style's author.
-  * Make sure your style [[dev/creating_citation_styles#validation|validates]]
-===Submitting for Casual Coders: gist.github.com===
+  * 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”.
-If you don't expect to contribute many citation styles to Zotero, getting SVN access to Zotero and learning how to use SVN is likely too much trouble. You can still submit your style. Go to http://gist.github.com a free site dedicated to sharing code. Paste the content of your code into the window, enter style-name.csl as the file name and the press the "Create Public Gist" button at the bottom of the page.
-Open a new thread for your style in the Citation Style section of the Zotero forum and ask for it to be uploaded to the repository. Provide the link to the style from the URL bar, i.e. in the form %%https://gist.github.com/123456%%. Your style will be added to the repository by one of the Zotero team members or volunteers. If you don't hear back within a week, post a reminder to the same thread.
-===Submitting for Advanced and/or Frequent Contributors===
+  * The style ID (set with the ''<id>'' element) should be of the form ''<nowiki>http://www.zotero.org/styles/file-name</nowiki>'', without the ''.csl'' extension (e.g. ''<nowiki>http://www.zotero.org/styles/apa</nowiki>'' for ''apa.csl'').
-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 [[https://www.zotero.org/dev/trac_access|SVN/Trac]] account with Zotero.
-Next, you will need an SVN client. Many users prefer GUI-based SVN clients, which include [[http://tortoisesvn.tigris.org|Tortoise SVN]] for windows, [[http://versionsapp.com/|Versions (non-free)]] for Mac, and [[http://www.rabbitvcs.org|Rabbit VCS]] Linux. A comprehensive list of SVN clients is [[http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients|here]].
+  * The style should preferably 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 <code><rights>This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License:
-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.
+http://creativecommons.org/licenses/by-sa/3.0/</rights></code>
+  * 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.
+  * Make sure your style [[dev/creating_citation_styles#validation|validates]].
+===== Submitting to the Zotero Style Repository =====
+There are two ways to submit CSL 0.8.1 and 1.0 styles for inclusion in the Zotero Style Repository:
+==== Submitting for Casual Coders ====
+The easiest way to submit styles is post a link to your style code on the Zotero forums (do not paste style code directly into your post), using a code sharing website like http://gist.github.com.
+=== Using gist.github.com ===
+Go to https://gist.github.com/ and copy and paste your style code into the large text box. Enter the file name of the style 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 [[http://forums.zotero.org/11/|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 ''<nowiki>https://gist.github.com/766801</nowiki>''. One of the Zotero developers or community members will then add your style to the repository. If you don't hear back within a week, feel free to post a reminder to the same thread.
+==== Submitting for Frequent Contributors ====
+While the process is slightly more complicated, you can also add styles to the repository yourself using the Zotero SVN. For that, you first need to register for a [[https://www.zotero.org/dev/trac_access|Zotero SVN/Trac account]]. Next, you will need an SVN client. Many users prefer GUI-based SVN clients like [[http://tortoisesvn.tigris.org|TortoiseSVN]] for Windows, [[http://versionsapp.com/|Versions (commercial)]] or [[http://scplugin.tigris.org/|SCPlugin]] for Mac, and [[http://www.rabbitvcs.org|Rabbit VCS]] for Linux. Check out the ''csl'' directory (''<nowiki>https://www.zotero.org/svn/csl</nowiki>'') with your SVN client, add and commit your style. Note that styles won't immediately appear in the repository (the repository is manually updated, which can take up to 24 hours).
+===== Submitting to the GitHub CSL 1.0 Style Repository =====
+Every now and then, the CSL 0.8.1 styles in the Zotero Style Repository are updated to CSL 1.0 and added to the GitHub [[https://github.com/citation-style-language/styles|CSL 1.0 style code repository]]. At the same time, CSL 1.0 styles are copied directly. If you don't want to wait with making your style available in the GitHub repository, [[http://citationstyles.org/downloads/upgrade-notes.html#updating-csl-0-8-styles|upgrade the style]] if it is in the 0.8.1 format. Then, fork the GitHub repository, commit your changes, and create a [[http://help.github.com/pull-requests/|pull request]]. You can use your Git client of choice, but for new users we recommend [[http://www.syntevo.com/smartgit/index.html|SmartGit]], which is free for non-commercial purposes.