Ticket #1278: PATCH.zotero-trunk.patch

chrome/content/zotero/addCitationDialog.js

@@ -26 +26 @@
                 "suffix":"value",
                 "locatorType":"selectedIndex",
                 "locator":"value",
-                "suppressAuthor":"checked"
+                /*
+                 * fbennett: 3
+                 *   5 lines
+                 */
+                "suppressAuthor":"checked",
+                "volume-selector":"value",
+                "volume":"value",
+                "issued":"value",
+                "edition":"value"
         };
         
         var _itemData = new Object();
@@ -52 +60 @@
         this.confirmRegenerate = confirmRegenerate;
         this.accept = accept;
         this.cancel = cancel;
-        
+        /*
+         * fbennett: 2, 3
+         *   162 lines
+         */
+        /*
+         * fbennett: Volume number setting
+         *
+         * ------------
+         * What it does
+         * ------------
+         *
+         * Some styles (well, Bluebook, anyway) require that the
+         * volume number be supplied for multi-volume works by a
+         * single author -- in back-references.  This means that a
+         * single bibliographic entry must be made to work with
+         * multiple volumes, treating the whole set as a single work.
+         * 
+         * This patch modifies Zotero to supply a volume selection
+         * widget to the client UI when there is an appropriate value
+         * in the numberOfVolumes field, and the work cited is not a
+         * specific chapter, dictionary entry, or encyclopedia entry.
+         *
+         * The value in numberOfVolumes may be an integer or a
+         * comma-delimited string.  In the former case, a list of
+         * volume numbers ranging up from one is presented in the
+         * widget.  In the latter case, the literal elements are
+         * presented.
+         *
+         * Selections are persistent, both while editing and after
+         * rendering of the citation.  The value will feed through to
+         * CSL stylesheets in the normal way, through both text and
+         * number declarations.
+         *
+         * ---------------
+         * Functions added
+         * ---------------
+         *
+         * volumeNumberInit() hides the volume number widget in
+         * initial popup view.
+         *
+         * volumeNumber() enables the volume number widget with
+         * appropriate values.
+         *
+         * -------------------
+         * Functions exploited
+         * -------------------
+         *
+         * load() in the single condition resets screen when editing
+         * singles.  (citation is active, so should reset in this
+         * case).
+         * 
+         * load() in the multiple condition resets screen when editing
+         * multiples.  (should take no action, because nothing is
+         * active on initial display).
+         *
+         * listItemSelected() resets screen upon selection in
+         * right-side multiples box.
+         *
+         * treeItemSelected() resets screen on selection in the
+         * left-side box.
+         *
+         * ----
+         * Bugs
+         * ----
+         *
+         * In single-citation entry mode, the selected value is lost
+         * when the user clicks away from the citation and clicks
+         * back.  This looks odd because the locator value (which does
+         * not depend on the citation data in any way, and so does not
+         * need to be reset) does not change.
+         *
+         * The handling of the fallback value could maybe use a little
+         * attention.
+         *
+         * In styles that do not require this level of precision, the
+         * additional field might strike some as a nuisance.
+         * Depending on how users react to this feature, it might be
+         * desirable to add a configuration option to suppress the
+         * selection box.
+         */
+
+        function volumeNumberInit() {
+            document.getElementById("volume-selector").setAttribute("hidden",true);
+            document.getElementById("volume-popup").setAttribute("hidden",true);
+            document.getElementById("volume-label").setAttribute("hidden",true);
+        }
+
+        function volumeNumber(itemID,pos) {
+            
+            var itemDataID = (pos ? itemID+"::"+pos : itemID);
+
+            if (itemID) {
+                var item = Zotero.Items.get(itemID);
+                if(item) {
+
+                    var volume_title = item.getField("title");
+                    var volume_numberof = item.getField("numberOfVolumes");
+                    var volume_blockers = ["bookTitle","encyclopediaTitle","dictionaryTitle"];
+                    var volume_block = true;
+                    if(volume_title && volume_numberof) {
+                        volume_block = false;
+                        for (i in volume_blockers) {
+                            var blocker = volume_blockers[i];
+                            if(item.getField(blocker)) {
+                                volume_block = true;
+                                break;
+                            }
+                        }
+                    }
+                    var volume_range = [];
+                    var volume_labels = [];
+                    if(!volume_block && volume_numberof) {
+                        var numberof = volume_numberof.toString();
+                        if (numberof.match(/^\d+$/)) {
+                            for (i = 1; i <= parseInt(numberof); i++) {
+                                volume_range.push(i.toString());
+                                volume_labels.push(i.toString());
+                            }
+                        } else if (numberof.match(/,/)) {
+                            volume_range = numberof.replace(/, ?/g, "|").split("|");
+                            for (i in volume_range) {
+                                volume_labels.push(volume_range[i].replace(/\/.*$/, ""));
+                                    }
+                        } else {
+                            volume_block = true;
+                        }
+                    }
+            
+                    var menu_volume = document.getElementById("volume-selector");
+                    var popup_volume = document.getElementById("volume-popup");
+                    var label_volume = document.getElementById("volume-label");
+                    label_volume.setAttribute("hidden",volume_block);
+                    popup_volume.setAttribute("hidden",volume_block);
+                    menu_volume.setAttribute("hidden",volume_block);
+                    
+                    while(popup_volume.firstChild) {
+                        popup_volume.removeChild(popup_volume.firstChild);
+                    }
+                    var i = 0;
+                    var _volumeIndexArray = {};
+                    for (var value in volume_range) {
+                        var volume = volume_range[value];
+                        var label = volume_labels[value];
+                        var child = document.createElement("menuitem");
+                        child.setAttribute("value", volume);
+                        child.setAttribute("label", label);
+                        popup_volume.appendChild(child);
+                        _volumeIndexArray[volume] = i;
+                        i++;
+                    }
+                    if(_itemData && _itemData[itemDataID] && _itemData[itemDataID] && _itemData[itemDataID]["volume-selector"]) {
+                        var index = _volumeIndexArray[_itemData[itemDataID]["volume-selector"]];
+                    } else {
+                        var index = 0;
+                    }
+                    menu_volume.selectedIndex = index;
+
+                }
+            }
+        }
+
+
         /*
          * initialize add citation dialog
          */
         function load() {
+                volumeNumberInit();
                 document.getElementById("multiple-sources-button").label = Zotero.getString("citation.multipleSources");
                 document.getElementById("show-editor-button").label = Zotero.getString("citation.showEditor");
                 
@@ -70 +240 @@
                 if(io.citation.sortable) {
                         _sortCheckbox = document.getElementById("keepSorted");
                         _sortCheckbox.hidden = false;
-                        if(io.citation.properties.sort === undefined) io.citation.properties.sort = true;
+                        /* 
+                         * fbennett: n/a
+                         *   Was ===, which I'd never seen before, and assumed was a typo.
+                         */
+                        if(io.citation.properties.sort == undefined) io.citation.properties.sort = true;
                         _sortCheckbox.checked = io.citation.properties.sort;
                 }
                 
@@ -101 +275 @@
                 if(io.citation.citationItems.length) {
                         if(io.citation.citationItems.length == 1) {
                                 // single citation
+                            /*
+                             * fbennett: 2, 3
+                             *   1 line
+                             */
+                                volumeNumber(io.citation.citationItems[0].itemID);
                                 _suppressNextTreeSelect = true;
                                 itemsView.selectItem(io.citation.citationItems[0].itemID);       // treeview from selectItemsDialog.js
                                 for(var property in _preserveData) {
@@ -119 +298 @@
                                         var item = Zotero.Items.get(io.citation.citationItems[i].itemID);
                                         if(item) {
                                                 _addItem(item);
-                                                _itemData[io.citation.citationItems[i].itemID] = io.citation.citationItems[i];
+                                                /*
+                                                 * fbennett: 1
+                                                 *   1 line
+                                                 */
+                                                _itemData[io.citation.citationItems[i].itemID+"::"+i] = io.citation.citationItems[i];
                                         }
                                 }
                         }
@@ -149 +332 @@
         function toggleMultipleSources() {
                 _multipleSourcesOn = !_multipleSourcesOn;
                 if(_multipleSourcesOn) {
+                        var items = itemsView.getSelectedItems(true);
+                        var itemID = (items.length ? items[0] : false);
+                        var itemDataID = itemID+"::"+0;
                         document.getElementById("multiple-sources").hidden = undefined;
                         document.getElementById("zotero-add-citation-dialog").width = "750";
                         document.getElementById("multiple-sources-button").label = Zotero.getString("citation.singleSource");                   
+                        // move user field content to multiple before adding XXXXX
+                        if (itemID) {
+                            _itemData[itemDataID] = new Object();
+                            for (box in _preserveData) {
+                                element = document.getElementById(box);
+                                _itemData[itemDataID][box] = element[_preserveData[box]];
+                            }
+                        }
                         window.sizeToContent();
                         window.moveTo((window.screenX-75), window.screenY);
                         treeItemSelected();
                         // disable adding info until citation added
                         _itemSelected(false);
+                        // add current selection
+                        if (itemID) {
+                            this.add();
+                        } else {
+                            _updateAccept();
+                            _updatePreview();
+                        }
                 } else {
                         document.getElementById("multiple-sources").hidden = true;
                         document.getElementById("zotero-add-citation-dialog").width = "600";
@@ -174 +375 @@
                         
                         // delete all items
                         _clearCitationList();
+                        _updateAccept();
+                        _updatePreview();
                 }
-                _updateAccept();
-                _updatePreview();
         }
         
         /*
@@ -197 +398 @@
                         // disable boxes if item not added; otherwise, enable
                         _itemSelected(hasBeenAdded ? itemID : false);
                         // disable adding nothing, or things already added
-                        document.getElementById("add").disabled = !itemID || hasBeenAdded;
+                        document.getElementById("add").disabled = !itemID;
+                        /*
+                         * fbennett: 1, 2, 3
+                         *   6 lines
+                         */
+                        document.getElementById("remove").disabled = true;
+                        pos = document.getElementById("citation-list").childNodes.length;
+                        volumeNumber(itemID,pos);
                 } else {
+                        volumeNumber(itemID);
                         _updateAccept();
                         _updatePreview();
                 }
@@ -208 +417 @@
          * called when an item in the selected items list is clicked
          */
         function listItemSelected() {
-                var selectedListItem = document.getElementById("citation-list").getSelectedItem(0);
+            /*
+             * fbennett: 1, 2, 3
+             *   8 lines
+             */
+                var selectedListItem = document.getElementById("citation-list").getSelectedItem(0);
                 var itemID = (selectedListItem ? selectedListItem.value : false);
-                _itemSelected(itemID);
+                var pos = selectedListItem.parentNode.selectedIndex;
+                _itemSelected(itemID,pos);
                 
+                volumeNumber(itemID,pos);
                 document.getElementById("remove").disabled = !itemID;
+                document.getElementById("add").disabled = true;
         }
         
         /*
@@ -220 +436 @@
          */
         function add() {
                 var item = itemsView.getSelectedItems()[0]; // treeview from selectItemsDialog.js
-                _itemSelected(item.getID());
+                /*
+                 * fbennett: 1
+                 *   7 lines
+                 */
+                var citation_list = document.getElementById("citation-list");
+                var pos = citation_list.childNodes.length;
                 _addItem(item);
+                _itemSelected(item.getID(), pos);
                 
                 // don't let someone select it again
-                document.getElementById("add").disabled = true;
+                document.getElementById("add").disabled = false;
                 
                 // allow user to press OK
                 _updateAccept();
@@ -239 +461 @@
                 var citationList = document.getElementById("citation-list");
                 var selectedListItem = citationList.getSelectedItem(0);
                 var itemID = selectedListItem.value;
-                
+                /*
+                 * fbennett: 1
+                 *   20 lines
+                 */
+                var itemParent = selectedListItem.parentNode;
+                var pos = itemParent.selectedIndex;
+                var itemFamily = itemParent.childNodes;
+                var itemDataID = itemID+"::"+pos;
+
                 // remove from _itemData
-                delete _itemData[itemID];
-                _itemData[itemID] = undefined;
+                delete _itemData[itemDataID];
+                _itemData[itemDataID] = undefined;
                 _lastSelected = null;
+
+                // renumber in _itemData
                 
+                for (i = pos+1; i < itemFamily.length; i++) {
+                    var oldID = itemFamily.item(i).value+"::"+i;
+                    var newID = itemFamily.item(i).value+"::"+pos;
+                    _itemData[newID] = _itemData[oldID];
+                    delete _itemData[oldID];
+                    pos++;
+                }
+
                 // re-select currently selected in left pane
                 var itemIDs = itemsView.getSelectedItems(true); // treeview from selectItemsDialog.js
                 if(itemIDs.length) {
@@ -287 +527 @@
          * Ask whether to modfiy the preview
          */
         function confirmRegenerate(focusShifted) {
+            /*
+             * fbennett: 2, 3
+             *   lines: 27
+             */
+            var selectedListItem = document.getElementById("citation-list").getSelectedItem(0);
+                if (focusShifted && selectedListItem) {
+                    var itemID = selectedListItem.value;
+                    var pos = selectedListItem.parentNode.selectedIndex;
+                    var volume_selector = document.getElementById('volume-selector');
+                    var volume =  document.getElementById('volume');
+                    var edition = document.getElementById('edition');
+                    var issued = document.getElementById('issued');
+                    var elements = volume_selector.value.replace(/ ?\/ ?/g, "|").split("|");
+
+                    if (elements.length > 1) {
+                        issued.setAttribute("value", elements[1]);
+                    } else {
+                        issued.removeAttribute("value");
+                    }
+                    if (elements.length > 2) {
+                        edition.setAttribute("value", elements[2]);
+                    } else {
+                        edition.removeAttribute("value");
+                    }
+                    if (elements.length > 0) {
+                        volume.setAttribute("value", elements[0]);
+                    } else {
+                        volume.removeAttribute("value");
+                    }
+                    _itemSelected(itemID,pos);
+                }
+
                 if(document.getElementById('editor').value == _originalHTML || _originalHTML === undefined) {
                         // no changes; just update without asking
                         _updatePreview();
@@ -409 +681 @@
          * called when an item is selected; if itemID is false, disables fields; if
          * itemID is undefined, only updates _itemData array
          */
-        function _itemSelected(itemID) {
+        /*
+         * fbennett: 1
+         *   3 lines
+         */
+        function _itemSelected(itemID,pos) {
+                var itemDataID = (itemID ? itemID+"::"+pos : undefined);
+                
                 if(_lastSelected && !_itemData[_lastSelected]) {
                         _itemData[_lastSelected] = new Object();
                 }
@@ -429 +707 @@
                         // restore previous property
                         if(itemID) {
                                 domBox.disabled = false;
-                                if(_itemData[itemID] && _itemData[itemID][box] !== undefined) {
+                                /*
+                                 * fbennett: 1
+                                 *   9 lines
+                                 */
+                                if(_itemData[itemDataID] && _itemData[itemDataID][box] !== undefined) {
                                         if(property == "locatorType") {
-                                                domBox[property] = _locatorIndexArray[_itemData[itemID][box]];
+                                                domBox[property] = _locatorIndexArray[_itemData[itemDataID][box]];
                                         } else {
-                                                domBox[property] = _itemData[itemID][box];
+                                                domBox[property] = _itemData[itemDataID][box];
                                         }
+                                } else {
+                                    domBox[property] = "";
                                 }
                         } else if(itemID !== undefined) {
                                 domBox.disabled = true;
                                 domBox[property] = "";
                         }
                 }
-                
-                if(itemID !== undefined) _lastSelected = itemID;
+                /*
+                 * fbennett: 1
+                 *  1 line
+                 */
+                if(itemID !== undefined) _lastSelected = itemDataID;
         }
         
         /*
@@ -464 +751 @@
                                 // generate citationItems
                                 for(var i=0; i<listLength; i++) {
                                         var itemID = citationList.childNodes[i].value;
-                                        
-                                        var citationItem = _itemData[itemID];
+                                        /*
+                                         * fbennett: 1
+                                         *   2 lines
+                                         */
+                                        var itemDataID = itemID+"::"+i;
+                                        var citationItem = _itemData[itemDataID];
                                         citationItem.itemID = itemID;
                                         io.citation.citationItems.push(citationItem);
                                 }

chrome/content/zotero/addCitationDialog.xul

@@ -160 +160 @@
                                         </vbox>
                                         <vbox>
                                                 <checkbox id="keepSorted" hidden="true" checked="false" oncommand="Zotero_Citation_Dialog.sortCitation()" label="&zotero.citation.keepSorted.label;"/>
+<!--
+  fbennett: n/a
+    onclick seems to work better here.
+-->
                                                 <listbox id="citation-list" flex="1" align="stretch" seltype="single"
-                                                        onselect="Zotero_Citation_Dialog.listItemSelected();"></listbox>
+                                                        onclick="Zotero_Citation_Dialog.listItemSelected();"></listbox>
                                         </vbox>
                                 </hbox>
                         </hbox>
@@ -181 +185 @@
                                 <separator flex="4"/>
                                 <vbox flex="1">
                                         <hbox align="stretch">
-                                                <menulist onchange="Zotero_Citation_Dialog.confirmRegenerate(true)" id="locatorType">
-                                                        <menupopup id="locator-type-popup"/>
+<!-- 
+  fbennett: 2, 3
+    18 lines
+-->
++                                               <menulist onmouseout="Zotero_Citation_Dialog.confirmRegenerate(true)" id="locatorType">
+                                                        <menupopup id="locator-type-popup"/>
+                                                </menulist>
+                                                <textbox oninput="Zotero_Citation_Dialog.confirmRegenerate(false)" onchange="Zotero_Citation_Dialog.confirmRegenerate(true)" id="locator" flex="1"/>
+                                        </hbox>
+                                        <separator height="2px" flex="1"/>
+                                        <hbox align="stretch">
+                                                <checkbox oncommand="Zotero_Citation_Dialog.confirmRegenerate(true)" id="suppressAuthor" label="&zotero.citation.suppressAuthor.label;"/>
+                                                <spacer flex="1"/>
+                                                <label value="&zotero.citation.volume.label;" id="volume-label"/>
+                                                <menulist onmouseout="Zotero_Citation_Dialog.confirmRegenerate(true)" id="volume-selector">
+                                                        <menupopup id="volume-popup"/>
                                                 </menulist>
-                                                <textbox oninput="Zotero_Citation_Dialog.confirmRegenerate(false)" onchange="Zotero_Citation_Dialog.confirmRegenerate(true)" id="locator" flex="1"/>
+                                                <label id="edition" value="" hidden="true"/>
+                                                <label id="issued" value="" hidden="true"/>
+                                                <label id="volume" value="" hidden="true"/>
                                         </hbox>
-                                        <separator style="height: 2px" flex="1"/>
-                                        <checkbox oncommand="Zotero_Citation_Dialog.confirmRegenerate(true)" id="suppressAuthor" label="&zotero.citation.suppressAuthor.label;"/>
-                                </vbox>
+                                </vbox>
                         </hbox>
                 </vbox>
                 

chrome/content/zotero/xpcom/csl.js

@@ -1 +1 @@
 /*
     ***** BEGIN LICENSE BLOCK *****
     
-    Copyright (c) 2006  Center for History and New Media
+   copyright (c) 2006  Center for History and New Media
                         George Mason University, Fairfax, Virginia, USA
                         http://chnm.gmu.edu
     
@@ -20 +20 @@
     ***** END LICENSE BLOCK *****
 */
 
+ /*
+ * See separate PATCH.txt file for key to fbennett changes.
+ */
+
+
 /*
  * CSL: a class for creating bibliographies from CSL files
  * this is abstracted as a separate class for the benefit of anyone who doesn't
@@ -48 +53 @@
         Zotero.debug("CSL: style class is "+this.class);
         
         this.hasBibliography = (this._csl.bibliography.length() ? 1 : 0);
+        /*
+         * fbennett: 5
+         *   7 lines
+         */
+        this.daySuffixes = Zotero.getString("date.daySuffixes").replace(/, ?/g, "|").split("|");
+        for each (i in [0,1,2,3]) {
+                if (suffix = this._getTerm("ordinal-0"+(i+1), false, false, false, true)) {
+                    this.daySuffixes[i] = suffix;
+                }
+            }
+
 }
 
 /*
@@ -70 +86 @@
         "recipient":true,
         "interviewer":true,
         "collection-editor":true,
-        "author":true
+        /*
+         * fbennett: 6
+         *   3 lines
+         */
+        "author":true,
+        "contributor":true,
+        "container-author":true
 }
 
 /*
@@ -260 +282 @@
                         if(Zotero.CSL._textCharRegexp.test(prefix[prefix.length-1])) prefix += " ";
                         
                         citationString.append(prefix);
+                        /*
+                         * fbennett: 7
+                         *   1 line
+                         */
+                        citationString.has_prefix = true;
                 }
                 
                 this._processElements(citationItem.item, context.layout, citationString,
                         context, citationItem, ignore);
                 
                 // add suffix
+                var hasSuffixPunctuation;
                 if(citationItem.suffix) {
                         var suffix = citationItem.suffix;
+                        /*
+                         * fbennett: 7
+                         *   5 lines
+                         */
+                        var sfx = suffix.replace(/^\s*/g, "").replace(/\s*$/g, "");
+                        var pnct = Zotero.CSL.FormattedString._punctuation;
+                        if (pnct.indexOf(sfx[sfx.length-1]) != -1) {
+                            hasSuffixPunctuation = true;
+                        } else {
+                            hasSuffixPunctuation = false;
+                        }
                         
                         // add space to suffix if last char is alphanumeric
                         if(Zotero.CSL._textCharRegexp.test(suffix[0])) suffix = " "+suffix;
@@ -276 +315 @@
                 }
                 
                 string.concat(citationString);
+                string.hasSuffixPunctuation = hasSuffixPunctuation;
         }
         
         var returnString = string.clone();
@@ -489 +529 @@
 /*
  * gets a term, in singular or plural form
  */
-Zotero.CSL.prototype._getTerm = function(term, plural, form, includePeriod) {
+/*
+ * fbennett: 5
+ *   1 line
+ */
+Zotero.CSL.prototype._getTerm = function(term, plural, form, includePeriod, quiet) {
         if(!form) {
                 form = "long";
         }
@@ -502 +546 @@
                 } else if(form != "long") {
                         return this._getTerm(term, plural, "long");
                 } else {
+                    /*
+                     * fbennett: 5
+                     *   3 lines
+                     */
+                    if (!quiet) {
                         Zotero.debug("CSL: WARNING: could not find term \""+term+'"');
+                    }
                         return "";
                 }
         }
@@ -758 +808 @@
                                         
                                         if(variables[j] == "locator") {
                                                 // special case for locator
+                                            /*
+                                             * fbennett: 3
+                                             *   9 lines
+                                             */
                                                 var text = citationItem && citationItem.locator ? citationItem.locator : "";
+                                        } else if(variables[j] == "volume") {
+                                                // special case for volume
+                                                var text = citationItem && citationItem.volume ? citationItem.volume : item.getVariable("volume");
+                                        } else if(variables[j] == "edition") {
+                                                // special case for edition
+                                                var text = citationItem && citationItem.edition ? citationItem.edition : item.getVariable("edition");
+                                        } else if(variables[j] == "date") {
+                                                // special case for date
+                                                var text = citationItem && citationItem.date ? citationItem.date : item.getVariable("date");
                                         } else if(citationItem && citationItem._csl && citationItem._csl[variables[j]]) {
                                                 // override if requested
                                                 var text = citationItem._csl[variables[j]];
@@ -804 +867 @@
                                 for(var j=0; j<variables.length; j++) {
                                         if(ignore[0][variables[j]]) continue;
                                         
-                                        var text = item.getNumericVariable(variables[j], form);
+                                        /*
+                                         * fbennett: 9
+                                         *   1 line
+                                         */
+                                        var text = item.getNumericVariable(variables[j], citationItem, form, this.daySuffixes);
                                         if(text) {
                                                 newString.append(text);
                                                 success = true;
@@ -920 +987 @@
                         for(var j=0; j<variables.length; j++) {
                                 if(ignore[0][variables[j]]) continue;
                                 
-                                var date = item.getDate(variables[j]);
+                                /*
+                                 * fbennett: 3
+                                 *   1 line
+                                 */
+                                var date = item.getDate(variables[j], citationItem);
                                 if(!date) continue;
                                 
                                 var variableString = formattedString.clone();
@@ -1037 +1108 @@
                                         
                                         // inspect variables
                                         var done = false;
-                                        var attributes = ["variable", "is-date", "is-numeric", "is-plural", "type", "disambiguate", "locator", "position"];
+                                        var attributes = ["variable", "is-date", "is-numeric", "is-plural", "type", "disambiguate", "locator", "context", "position"];
                                         for(var k=0; !done && k<attributes.length; k++) {
-                                                var attribute = attributes[k];
+                                                var attribute = attributes[k];
                                                 
                                                 if(newChild["@"+attribute].length()) {
                                                         var variables = newChild["@"+attribute].toString().split(" ");
+
                                                         for(var j=0; !done && j<variables.length; j++) {
                                                                 var exists = false;
                                                                 if(attribute == "variable") {
-                                                                        if(variables[j] == "locator") {
+                                                                        if(variables[j] == "locator") {
                                                                                 // special case for locator
                                                                                 exists = citationItem && citationItem.locator && citationItem.locator.length > 0
                                                                         }
                                                                         else if(Zotero.CSL._dateVariables[variables[j]]) {
                                                                                 // getDate not false/undefined
-                                                                                exists = !!item.getDate(variables[j]);
+                                                                            /*
+                                                                             * fbennett: 3
+                                                                             *   1 line
+                                                                             */
+                                                                            exists = !!item.getDate(variables[j], citationItem);
                                                                         } else if(Zotero.CSL._namesVariables[variables[j]]) {
                                                                                 // getNames not false/undefined, not empty
                                                                                 exists = item.getNames(variables[j]);
@@ -1062 +1138 @@
                                                                                 if (exists) exists = !!exists.length;
                                                                         }
                                                                 } else if (attribute == "is-numeric") {
-                                                                        exists = item.getNumericVariable(variables[j]);
+                                                                    /*
+                                                                     * fbennett: 9
+                                                                     *   3 lines
+                                                                     */
+                                                                    exists = item.getNumericVariable(variables[j], citationItem);
                                                                 } else if (attribute == "is-date") { // XXX - this needs improving
                                                                         if (Zotero.CSL._dateVariables[variables[j]]) {
-                                                                                exists = !!item.getDate(variables[j]);
+                                                                            exists = !!item.getDate(variables[j], citationItem);
                                                                         }
                                                                 } else if(attribute == "is-plural") {
                                                                         if(Zotero.CSL._namesVariables[variables[j]]) {
@@ -1085 +1165 @@
                                                                         exists = (variables[j] == "true" && item.getProperty("disambiguate-condition"))
                                                                                 || (variables[j] == "false" && !item.getProperty("disambiguate-condition"));
                                                                 } else if(attribute == "locator") {
-                                                                        exists = citationItem && citationItem.locator &&
-                                                                                (citationItem.locatorType == variables[j]
-                                                                                || (!citationItem.locatorType && variables[j] == "page"));
+
+                                                                    exists = citationItem && citationItem.locator &&
+                                                                        (citationItem.locatorType == variables[j]
+                                                                         || (!citationItem.locatorType && variables[j] == "page"));
+
+                                                                } else if (attribute == "context") {
+
+                                                                    if (variables[j] == "same-note") {
+                                                                        exists = citationItem && citationItem.sameNote;
+                                                                    } else if(variables[j] == "prefix-punctuation") {
+                                                                        exists = citationItem && citationItem.prefixPunctuation;
+                                                                    }
                                                                 } else {        // attribute == "position"
+
                                                                         if(variables[j] == "first") {
                                                                                 exists = !citationItem
                                                                                         || !citationItem.position
                                                                                         || citationItem.position == Zotero.CSL.POSITION_FIRST;
                                                                         } else if(variables[j] == "subsequent") {
                                                                                 exists = citationItem && citationItem.position >= Zotero.CSL.POSITION_SUBSEQUENT;
+                                                                                /*
+                                                                                 * fbennett: 4
+                                                                                 *   10 lines
+                                                                                 */
                                                                         } else if(variables[j] == "ibid") {
                                                                                 exists = citationItem && citationItem.position >= Zotero.CSL.POSITION_IBID;
                                                                         } else if(variables[j] == "ibid-with-locator") {
-                                                                                exists = citationItem && citationItem.position == Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
+                                                                                exists = citationItem && citationItem.position >= Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
                                                                         }
                                                                 }
                                                                 
@@ -1721 +1815 @@
  * Mappings for names
  */
 Zotero.CSL.Item._zoteroNameMap = {
-        "collection-editor":"seriesEditor"
+    /*
+     * fbennett: 6
+     *   2 lines
+     */
+    "collection-editor":"seriesEditor",
+    "container-author":"containerAuthor"
 }
 
 /*
@@ -1744 +1843 @@
 /*
  * Gets an Item.Date object for a specific type.
  */
-Zotero.CSL.Item.prototype.getDate = function(variable) {
+/*
+ * fbennett: 3
+ *   8 lines
+ */
+Zotero.CSL.Item.prototype.getDate = function(variable, citationItem) {
         // ignore accessed date
         if(this._ignoreURL && variable == "accessed") return false;
         
         // load date variable if possible
         this._refreshItem();
-        if(this._dates[variable] == undefined) {
-                this._createDate(variable);
+        if(this._dates[variable] == undefined || citationItem) {
+                this._createDate(variable, citationItem);
         }
         
         if(this._dates[variable]) return this._dates[variable];
@@ -1761 +1864 @@
 Zotero.CSL.Item._zoteroFieldMap = {
         "long":{
                 "title":"title",
-                "container-title":["publicationTitle",  "reporter", "code"], /* reporter and code should move to SQL mapping tables */
+                /*
+                 * fbennett: 11
+                 *   1 line
+                 */
+                "container-title":["publicationTitle", "journalAbbreviation", "reporter", "code"], /* reporter and code should move to SQL mapping tables */
                 "collection-title":["seriesTitle", "series"],
                 "collection-number":"seriesNumber",
                 "publisher":["publisher", "distributor"], /* distributor should move to SQL mapping tables */
@@ -1786 +1893 @@
                 "call-number":"callNumber",
                 "note":"extra",
                 "number":"number",
-                "references":"history"
+                /*
+                 * fbennett: 8
+                 *   3 lines
+                 */
+                "references":"history",
+                "issued":"date",
+                "accessed":"accessDate"
         },
         "short":{
                 "title":["shortTitle", "title"],
@@ -1840 +1953 @@
 /*
  * convert a number into a ordinal number 1st, 2nd, 3rd etc.
  */
-Zotero.CSL.Item.prototype.makeOrdinal = function(value) {
+/*
+ * fbennett: 5
+ *   3 lines
+ */
+Zotero.CSL.Item.prototype.makeOrdinal = function(value, daySuffixes) {
         var ind = parseInt(value);
-        var daySuffixes = Zotero.getString("date.daySuffixes").replace(/, ?/g, "|").split("|");
         value += (parseInt(ind/10)%10) == 1 ? daySuffixes[3] : (ind % 10 == 1) ? daySuffixes[0] : (ind % 10 == 2) ? daySuffixes[1] : (ind % 10 == 3) ? daySuffixes[2] : daySuffixes[3];
         return value;
 }
@@ -1889 +2005 @@
         "issue":"issue",
         "number-of-volumes":"numberOfVolumes",
         "edition":"edition",
-        "number":"number"
+        /*
+         * fbennett: 5, 9 
+         *   17 lines 
+         *   (including the change to the function interface, which applies to 5)
+         */ 
+        "number":"number",
+        "note":"extra",
+        "title":"title",
+        "container-title":"publicationTitle",
+        "issued":"date",
+        "page":"pages",
+        "locator":"locator",
+        "collection-number":"seriesNumber"
 }
 /*
  * Gets a numeric object for a specific type. <number variable="edition" form="roman"/>
  */
-Zotero.CSL.Item.prototype.getNumericVariable = function(variable, form) {
+// fbennett: add citationItem argument to function, to gain access to
+// locator field
+Zotero.CSL.Item.prototype.getNumericVariable = function(variable, citationItem, form, daySuffixes) {
 
         if(!Zotero.CSL.Item._zoteroNumberFieldMap[variable]) return "";
         
@@ -1910 +2040 @@
         
         var matches;
         for each(var zoteroField in zoteroFields) {
-                var value = this.zoteroItem.getField(zoteroField, false, true).toString();
-                
+                /*
+                 * fbennett: 3, 9
+                 *   13 lines
+                 */
+
+                if(zoteroField == "locator") {
+                    var value = citationItem.locator.toString();
+                } else if ( zoteroField == "volume" && citationItem && citationItem.volume) { 
+                // fbennett: special handling for volume field
+                    var value = citationItem.volume;
+                } else if(zoteroField == "edition" && citationItem && citationItem.edition) {
+                // fbennett: edition too
+                    var value = citationItem.edition;
+                } else {
+                    var value = this.zoteroItem.getField(zoteroField, false, true).toString();
+                }
+
                 // Quoted strings are never numeric
                 if(value.match(Zotero.CSL._quotedRegexp)) {
                         continue;
@@ -1921 +2066 @@
                 if(value != "" && (matches = value.match(Zotero.CSL._numberRegexp)) ) {
                         value = matches[0];
                         if (form == "ordinal") {
-                                return this.makeOrdinal(value);
+                            /*
+                             * fbennett: 5
+                             *   1 line
+                             */
+                            return this.makeOrdinal(value, daySuffixes);
                         }
                         else if (form == "roman") { 
                                 return this.makeRoman(value);
@@ -1951 +2100 @@
         journalArticle:"article-journal",
         magazineArticle:"article-magazine",
         newspaperArticle:"article-newspaper",
+        /*
+         * fbennett: 10
+         *   1 line
+         */
+        dictionaryEntry:"entry-dictionary",
         thesis:"thesis",
         conferencePaper:"paper-conference",
         letter:"personal_communication",
@@ -2057 +2211 @@
  * Generates an date object for a given variable (currently supported: issued
  * and accessed)
  */
-Zotero.CSL.Item.prototype._createDate = function(variable) {
+/*
+ * fbennett: 3
+ *   9 lines
+ */
+Zotero.CSL.Item.prototype._createDate = function(variable, citationItem) {
         // first, figure out what date variable to use.
         if(variable == "issued") {
+            if (citationItem && citationItem.issued) {
+                var date = citationItem.issued
+            } else {
                 var date = this.zoteroItem.getField("date", false, true);
-                var sort = this.zoteroItem.getField("date", true, true);
+            }
+            var sort = this.zoteroItem.getField("date", true, true);
         } else if(variable == "accessed") {
                 var date = this.zoteroItem.getField("accessDate", false, true);
                 var sort = this.zoteroItem.getField("accessDate", true, true);
@@ -2560 +2722 @@
         this.closePunctuation = "";
         this.closeFormatting = "";
         this.useBritishStyleQuotes = false;
+        /*
+         * fbennett: 7
+         *   2 lines
+         */
+        this.hasPrefix = false;
+        this.hasSuffixPunctuation = false;
         
         // insert tab iff second-field-align is on
         this.insertTabAfterField = (!subsequent && this.option.(@name == "second-field-align").@value.toString());
@@ -2603 +2771 @@
                         suffix = element.@suffix.toString();
                         element.@suffix = [];
                 }
-                haveAppended = this.append(formattedString.string, element, false, true);
+                /*
+                /*
+                 * fbennett: 7
+                 *   4 lines
+                 */
+                if (formattedString.hasPrefix || this.hasSuffixPunctuation) {
+                    doNotDelimit = true;
+                } else {
+                    doNotDelimit = false;
+                }
+                haveAppended = this.append(formattedString.string, element, doNotDelimit, true);
         }
         
         // if there's close punctuation to append, that also counts

chrome/content/zotero/xpcom/integration.js

@@ -1197 +1197 @@
  * sets position attribute on a citation
  */
 Zotero.Integration.Session.prototype.getCitationPositions = function(citation, update) {
-        for(var previousIndex = citation.properties.index-1;
-                previousIndex != -1
-                        && (!this.citationsByIndex[previousIndex]
-                        || this.citationsByIndex[previousIndex].properties["delete"]); 
-                previousIndex--) {}
-        var previousCitation = (previousIndex == -1 ? false : this.citationsByIndex[previousIndex]);
-        
-        // if only one source, and it's the same as the last, use ibid
-        if(             // there must be a previous citation with one item, and this citation
-                        // may only have one item
-                        previousCitation && citation.citationItems.length == 1
-                        && previousCitation.citationItems.length == 1
-                        // the previous citation must have been a citation of the same item
-                        && citation.citationItems[0].item == previousCitation.citationItems[0].item
-                        // and if the previous citation had a locator (page number, etc.) 
-                        // then this citation must have a locator, or else we should do the 
-                        // full citation (see Chicago Manual of Style)
-                        && (!previousCitation.citationItems[0].locator || citation.citationItems[0].locator)) {
-                // use ibid, but check whether to use ibid+pages
-                var newPosition = (citation.citationItems[0].locator == previousCitation.citationItems[0].locator
-                        && citation.citationItems[0].locatorType == previousCitation.citationItems[0].locatorType
-                        ? Zotero.CSL.POSITION_IBID : Zotero.CSL.POSITION_IBID_WITH_LOCATOR);
-                // update if desired
-                if(update && (citation.citationItems[0].position || newPosition) && citation.citationItems[0].position != newPosition) {
-                        this.updateIndices[citation.properties.index] = true;
-                }
-                citation.citationItems[0].position = newPosition;
+    /*
+     * fbennett: 4
+     *   133 lines
+     */
+    for(var previousIndex = citation.properties.index-1;
+        previousIndex != -1
+            && (!this.citationsByIndex[previousIndex]
+                || this.citationsByIndex[previousIndex].properties.delete); 
+        previousIndex--) {}
+    var previousCitation = (previousIndex == -1 ? false : this.citationsByIndex[previousIndex]);
+    // if one source is the same as the last, use ibid
+    //
+    // Case 1: source in previous citation
+    // (1) Threshold conditions
+    //     (a) there must be a previous citation with one item
+    //     (b) this item must be the first in this citation
+    //     (c) the previous citation must contain a reference to the same item ...
+    // Case 2: immediately preceding source in this citation
+    // (1) Threshold conditions
+    //     (a) there must be an imediately preceding reference to  the
+    //         same item in this citation
+    // Evaluation
+    //     (a) if the previous citation had no locator and this citation
+    //         has one, use ibid+pages
+    //     (b) if the previous citation had no locator and this citation
+    //         also has none, use ibid
+    //     (c) if the previous citation had a locator (page number, etc.) 
+    //         and this citation has a locator that is identical, use ibid
+    //     (d) if the previous citation had a locator, and this citation
+    //         has one that differs, use ibid+pages
+    //     (e) if the previous citation had a locator and this citation
+    //         has none, use subsequent
+    //     (f) if the current and previous citations are not the same,
+    //         set as FIRST or SUBSEQUENT, as appropriate.
+    //
+    // For Case 1
+    var curr = citation.citationItems[0];
+    if(         
+       previousCitation 
+       && previousCitation.citationItems.length == 1
+       && citation.citationItems[0].item == previousCitation.citationItems[0].item ) {
+        var prev = previousCitation.citationItems[0];
+        var newPosition = this.compareCitePosition(prev, curr, false);
+    } else {
+        var newPosition = this.checkCitePosition(curr, citation, false);
+    }
+    this.updateCitePosition (curr, newPosition, citation, update);
+    citation.citationItems[0].position = newPosition;
+    this.checkCiteContext (citation.citationItems[0], newPosition);
+    //
+    // For Case 2 and non-matching cases
+    for (var i = 1; i < citation.citationItems.length; i++) {
+        var prev = citation.citationItems[i-1];
+        var curr = citation.citationItems[i];
+        if (prev.item == curr.item) {
+            var newPosition = this.compareCitePosition(prev, curr, true);
         } else {
-                // loop through to see which are first citations
-                for(var i=0; i<citation.citationItems.length; i++) {
-                        var citationItem = citation.citationItems[i];
-                        var newPosition = (!this.citationsByItemID[citationItem.itemID]
-                                        || this.citationsByItemID[citationItem.itemID][0].properties.index >= citation.properties.index
-                                ? Zotero.CSL.POSITION_FIRST : Zotero.CSL.POSITION_SUBSEQUENT);
-                        
-                        // update if desired
-                        if(update && (citation.citationItems[i].position || newPosition) && citation.citationItems[i].position != newPosition) {
-                                this.updateIndices[citation.properties.index] = true;
-                        }
-                        citation.citationItems[i].position = newPosition;
-                }
+            var newPosition = this.checkCitePosition(curr, citation, true);
+        }
+        this.updateCitePosition (curr, newPosition, citation, update);
+        citation.citationItems[i].position = newPosition;
+        this.checkCiteContext (citation.citationItems[i], newPosition);
+    }
+}
+
+/*
+ * evaluates position of qualifying cites
+ */
+
+Zotero.Integration.Session.prototype.compareCitePosition = function(prev, curr, samenote) {
+
+    var newPosition;
+    if (!prev.locator) {
+        if (curr.locator) {
+            newPosition = Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
+        } else {
+            newPosition = Zotero.CSL.POSITION_IBID;
+        }
+    } else {
+        if (prev.locator == curr.locator) {
+            newPosition = Zotero.CSL.POSITION_IBID;
+        } else if (curr.locator) {
+            newPosition = Zotero.CSL.POSITION_IBID_WITH_LOCATOR;
+        } else {
+            newPosition = Zotero.CSL.POSITION_SUBSEQUENT;
         }
+    }
+    return newPosition;
+}
+
+/*
+ * checks if cite is in the same note and whether it has a prefix with terminal punctuation
+ */
+Zotero.Integration.Session.prototype.checkCiteContext = function(citationItem, newPosition) {
+
+    if (newPosition ==  Zotero.CSL.POSITION_FIRST) {
+        citationItem.sameNote = true;
+    } else {
+        citationItem.sameNote = false;
+    }
+
+    if (citationItem.prefix && citationItem.prefix.match(/.*[:;.]\s*$/)) {
+        citationItem.prefixPunctuation = true;
+    } else {
+        citationItem.prefixPunctuation = false;
+    }
+}
+    
+/*
+ * checks whether a cite is a first or subsequent reference
+ */    
+Zotero.Integration.Session.prototype.checkCitePosition = function(curr, citation, samenote) {
+
+    var newPosition;
+    if (!this.citationsByItemID[curr.itemID]) {
+        newPosition = Zotero.CSL.POSITION_FIRST;
+    } else if (this.citationsByItemID[curr.itemID][0].properties.index >= citation.properties.index) {
+        newPosition = Zotero.CSL.POSITION_FIRST;
+    } else {
+        newPosition = Zotero.CSL.POSITION_SUBSEQUENT;
+    }
+    return newPosition;
+}
+
+        
+/*
+ * updates indexes
+ *
+ */
+Zotero.Integration.Session.prototype.updateCitePosition = function (curr, newPosition, citation, update) {
+    if(update && (curr.position || newPosition) && curr.position != newPosition) {
+        this.updateIndices[citation.properties.index] = true;
+    }
 }
 
 /*

chrome/locale/en-US/zotero/zotero.dtd

@@ -132 +132 @@
 <!ENTITY zotero.citation.suppressAuthor.label                   "Suppress Author">
 <!ENTITY zotero.citation.prefix.label                                   "Prefix:">
 <!ENTITY zotero.citation.suffix.label                                   "Suffix:">
+<!ENTITY zotero.citation.volume.label                                   "Volume:">
 
 <!ENTITY zotero.richText.italic.label                                   "Italic">
 <!ENTITY zotero.richText.bold.label                                             "Bold">

chrome/locale/en-US/zotero/zotero.properties

@@ -321 +321 @@
 creatorTypes.presenter                  = Presenter
 creatorTypes.guest                              = Guest
 creatorTypes.podcaster                  = Podcaster
+creatorTypes.containerAuthor            = Sponsor
 
 fileTypes.webpage                               = Web Page
 fileTypes.image                                 = Image

chrome/skin/default/zotero/overlay.css

@@ -1 +1 @@
 #zotero-status-bar-icon
 {
-        width: 55px;
+        width: 74px;
         margin: 0 0 -1px; /* For Fitts's law (on OS X, at least) */
         padding: 0 0 1px;
-        list-style-image: url(chrome://zotero/skin/zotero_status_bar.png);
+        list-style-image: url(chrome://zotero/skin/zotero_status_bar_lex.png);
 }
 #zotero-status-bar-icon[compact="true"]
 {

chrome/skin/default/zotero/preferences.css

@@ -60 +60 @@
 
 #fontSize radio, #statusBarIcon radio
 {
-        width: 90px;
+        width: 114px;
 }
 
 #fontSize radio .radio-icon, #statusBarIcon radio .radio-icon

zotero-trunk

@@ -361 +361 @@
 INSERT INTO itemTypeFields VALUES (6, 90, NULL, 2);
 INSERT INTO itemTypeFields VALUES (6, 12, NULL, 3);
 INSERT INTO itemTypeFields VALUES (6, 6, NULL, 4);
-INSERT INTO itemTypeFields VALUES (6, 14, NULL, 5);
-INSERT INTO itemTypeFields VALUES (6, 15, NULL, 6);
-INSERT INTO itemTypeFields VALUES (6, 10, NULL, 7);
-INSERT INTO itemTypeFields VALUES (6, 87, NULL, 8);
-INSERT INTO itemTypeFields VALUES (6, 116, NULL, 9);
-INSERT INTO itemTypeFields VALUES (6, 13, NULL, 10);
-INSERT INTO itemTypeFields VALUES (6, 1, NULL, 11);
-INSERT INTO itemTypeFields VALUES (6, 27, NULL, 12);
-INSERT INTO itemTypeFields VALUES (6, 18, NULL, 13);
-INSERT INTO itemTypeFields VALUES (6, 19, NULL, 14);
-INSERT INTO itemTypeFields VALUES (6, 62, NULL, 15);
-INSERT INTO itemTypeFields VALUES (6, 2, NULL, 16);
-INSERT INTO itemTypeFields VALUES (6, 22, NULL, 17);
+-- fbennett: 12
+--   14 lines
+INSERT INTO itemTypeFields VALUES (6, 7, NULL, 5);
+INSERT INTO itemTypeFields VALUES (6, 14, NULL, 6);
+INSERT INTO itemTypeFields VALUES (6, 15, NULL, 7);
+INSERT INTO itemTypeFields VALUES (6, 10, NULL, 8);
+INSERT INTO itemTypeFields VALUES (6, 87, NULL, 9);
+INSERT INTO itemTypeFields VALUES (6, 116, NULL, 10);
+INSERT INTO itemTypeFields VALUES (6, 13, NULL, 11);
+INSERT INTO itemTypeFields VALUES (6, 1, NULL, 12);
+INSERT INTO itemTypeFields VALUES (6, 27, NULL, 13);
+INSERT INTO itemTypeFields VALUES (6, 18, NULL, 14);
+INSERT INTO itemTypeFields VALUES (6, 19, NULL, 15);
+INSERT INTO itemTypeFields VALUES (6, 62, NULL, 16);
+INSERT INTO itemTypeFields VALUES (6, 2, NULL, 17);
+INSERT INTO itemTypeFields VALUES (6, 22, NULL, 18);
 INSERT INTO itemTypeFields VALUES (7, 110, NULL, 1);
 INSERT INTO itemTypeFields VALUES (7, 90, NULL, 2);
 INSERT INTO itemTypeFields VALUES (7, 69, NULL, 3);
@@ -907 +910 @@
 INSERT INTO creatorTypes VALUES(25, "guest");
 INSERT INTO creatorTypes VALUES(26, "podcaster");
 INSERT INTO creatorTypes VALUES(27, "reviewedAuthor");
+-- fbennett: 6
+--   20 lines
+INSERT INTO creatorTypes VALUES(28, "containerAuthor");
 
 INSERT INTO itemTypeCreatorTypes VALUES(2,1,1);
 INSERT INTO itemTypeCreatorTypes VALUES(2,2,0);
 INSERT INTO itemTypeCreatorTypes VALUES(2,3,0);
 INSERT INTO itemTypeCreatorTypes VALUES(2,4,0);
 INSERT INTO itemTypeCreatorTypes VALUES(2,5,0);
+INSERT INTO itemTypeCreatorTypes VALUES(2,28,0);
 INSERT INTO itemTypeCreatorTypes VALUES(3,1,1);
 INSERT INTO itemTypeCreatorTypes VALUES(3,2,0);
 INSERT INTO itemTypeCreatorTypes VALUES(3,3,0);
 INSERT INTO itemTypeCreatorTypes VALUES(3,4,0);
 INSERT INTO itemTypeCreatorTypes VALUES(3,5,0);
+INSERT INTO itemTypeCreatorTypes VALUES(3,28,0);
 INSERT INTO itemTypeCreatorTypes VALUES(4,1,1);
 INSERT INTO itemTypeCreatorTypes VALUES(4,2,0);
 INSERT INTO itemTypeCreatorTypes VALUES(4,3,0);