This is an old revision of the document!


A Step-by-step Guide to Changing CSL Styles

Although there currently is no style editor for the csl styles used by Zotero, changing styles is not hard. The following guide is designed to enable everyone, including users with no knowledge of xml/html let alone programming, to adjust existing styles to their needs.

The Zotero Reference Test Pane

An easy way to get started with editing CSL styles is by using the Zotero Reference Test Pane. This tool renders items from your Zotero library with the CSL style of your choice, and gives real-time feedback when you edit the style.

To open the Zotero Reference Test Pane, paste

chrome://zotero/content/tools/csledit.xul

into the Firefox address bar and press Enter.

Open the Zotero pane, and select one or several items. Now select a style from the drop-down menu in the top-right corner of the Test Pane, or copy and paste a CSL style into the text box into the upper half of the split pane window. The lower half of the window will show how citations and bibliographies are formatted for the selected style and Zotero items.

Make some changes

You can now make changes to the CSL code in the upper half of the split window. As long as the changed style is still correct XML and CSL, the lower half of the window will automatically update after each change. Style changes are lost when you close the Firefox tab or switch styles. If you plan to make extensive changes, make sure to save your edits often.

CSL 0.8.1 styles

Minor issues are likely to be in the <citation> or <bibliography> sections, which are usually near the bottom.

For example, to remove all given-name disambiguation, find the line:

<option name=“disambiguate-add-givenname” value=“true”/>

And just delete the whole line. You'll see the change occur immediately in the preview pane below.

The CSL 0.8.1 syntax summary explains how the CSL works. Common options you might wish to change are here.

A bit of trial and error, and testing with a few combinations should help. You can see what different items and combinations will look like by selecting them in Zotero (Ctrl-click to select multiple items), and then “Refresh” at the top-left of the Test pane.

TIP : If nothing happens when you click refresh, you've broken the style!
Use Ctrl-Z to undo, or if you get really stuck, just select the style from the drop-down again and you're back where you started.

(optional) Change the Style Title and ID

Changing the title and ID of your modified style has two advantages:

  • Installing your modified style won't overwrite the original style
  • It will prevent your modified from being overwritten itself. The styles that ship with Zotero are automatically updated. If you modified one of these styles and didn't change the title/ID, your modified style will be overwritten when a style update becomes available.

The title and ID are stored within the <title> and <id> elements near the top of the style. For example,

<title>Harvard Reference format 1 (Author-Date)</title> 
<id>http://www.zotero.org/styles/harvard1</id>

can be changed to

<title>Harvard Style Modified</title>
<id>http://www.zotero.org/styles/harvard-modified</id>

Using your Edited Style with Zotero

You've made some changes to a style, and now you'd like to use your edited style with Zotero. How do you install this new style?

Select all the style code in the upper half of the test pane (Ctrl-A on Windows, Cmd-A on Mac OS X). Copy and paste the code into a text editor and save the style with a “.csl” file extension (don't use Microsoft Word or WordPad; suitable text editors include Notepad on Windows, and TextEdit on Mac OS X [in plain text mode: Format menu → Make Plain Text], and gedit or Kate on Linux).

To install the style, drag the file from where you saved it into an open Firefox page, and click Install. Done!

Some Slightly more advanced tips

For anything more advanced, this page is your friend, especially if you have made changes that would have wider appeal and you wish to share them.

If you are making several changes, you might want to copy all the CSL code from the top window (Ctrl-A, Ctrl-C) and paste it into a new file in a text editor. Notepad works fine, though using a good text editor designed for programming like the free Notepad++ for Windows or TextWrangler for Mac, can help you to see the structure clearly and not make mistakes. Set the “language” to XML (CSL is based around XML).

The Zotero forums have little nuggets of gold all through them, and searching usually finds the solution to any issue. If you are still having trouble, post a question in the Styles section of the Forum and it's likely to get answered quickly.

Sharing Styles

If your new style has general appeal, consider submitting it for inclusion into the Zotero Style Repository.