Ticket #1278: 10-volume-pinpoints.patch

chrome/content/zotero/addCitationDialog.js

@@ -26 +26 @@
                 "suffix":"value",
                 "locatorType":"selectedIndex",
                 "locator":"value",
-                "suppressAuthor":"checked"
+                "suppressAuthor":"checked",
+                "volume-selector":"value",
+                "volume":"value",
+                "issued":"value",
+                "edition":"value"
         };
         
         var _itemData = new Object();
@@ -52 +56 @@
         this.confirmRegenerate = confirmRegenerate;
         this.accept = accept;
         this.cancel = cancel;
-        
+        /*
+         * 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
+         * ----
+         *
+         * This is a generally horrible hack.
+         */
+
+        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]["volume-selector"]) {
+                                var index = _volumeIndexArray[_itemData[itemDataID]["volume-selector"]];
+                    } else {
+                                var index = 0;
+                    }
+                    menu_volume.selectedIndex = index;
+
+                }
+            }
+        }
+                
         /*
          * To generate unique keys for items in multi-cite list
          */
@@ -64 +212 @@
          * 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");
                 
@@ -77 +226 @@
                 if(io.citation.sortable) {
                         _sortCheckbox = document.getElementById("keepSorted");
                         _sortCheckbox.hidden = false;
-                        if(io.citation.properties.sort === undefined) io.citation.properties.sort = true;
+                        if(io.citation.properties.sort == undefined) io.citation.properties.sort = true;
                         _sortCheckbox.checked = io.citation.properties.sort;
                 }
                 
@@ -108 +257 @@
                 if(io.citation.citationItems.length) {
                         if(io.citation.citationItems.length == 1) {
                                 // single citation
+                                volumeNumber(io.citation.citationItems[0].itemID);
                                 _suppressNextTreeSelect = true;
                                 itemsView.selectItem(io.citation.citationItems[0].itemID);       // treeview from selectItemsDialog.js
                                 for(var property in _preserveData) {
@@ -223 +373 @@
                         document.getElementById("add").disabled = !itemID;
                         document.getElementById("remove").disabled = true;
                         pos = document.getElementById("citation-list").childNodes.length;
+                        volumeNumber(itemID,pos);
                 } else {
+                        volumeNumber(itemID);
                         _updateAccept();
                         _updatePreview();
                 }
@@ -237 +389 @@
                 var itemID = (selectedListItem ? selectedListItem.value : false);
                 var pos = selectedListItem.parentNode.selectedIndex;
                 _itemSelected(itemID,pos);
+
+                volumeNumber(itemID,pos);
                 
                 document.getElementById("remove").disabled = !itemID;
                 document.getElementById("add").disabled = true;
@@ -330 +484 @@
          * Ask whether to modfiy the preview
          */
         function confirmRegenerate(focusShifted) {
+                if (focusShifted && _multipleSourcesOn) {
+                        var listing = document.getElementById("citation-list");
+                        var selectedListItem = document.getElementById("citation-list").getSelectedItem(0);
+                    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();
@@ -453 +636 @@
          * itemID is undefined, only updates _itemData array
          */
         function _itemSelected(itemID,pos) {
+                // not idempotent!  must only run once when selection is changed
                 var itemDataID = (itemID ? multiKey(itemID,pos) : undefined);
                 if(_lastSelected && !_itemData[_lastSelected]) {
                         _itemData[_lastSelected] = new Object();
@@ -464 +648 @@
                         
                         // save property
                         if(_lastSelected) {
-                                if(property == "locatorType") {
+                                if(box == "locatorType") {
                                         _itemData[_lastSelected][box] = domBox.selectedItem.value;
                                 } else {
                                         _itemData[_lastSelected][box] = domBox[property];
@@ -487 +671 @@
                                 domBox[property] = "";
                         }
                 }
-                if(itemID !== undefined) _lastSelected = itemDataID;
+                if(itemDataID !== undefined) _lastSelected = itemDataID;
         }
         
         /*

chrome/content/zotero/addCitationDialog.xul

@@ -181 +181 @@
                                 <separator flex="4"/>
                                 <vbox flex="1">
                                         <hbox align="stretch">
-                                                <menulist onchange="Zotero_Citation_Dialog.confirmRegenerate(true)" id="locatorType">
-                                                        <menupopup id="locator-type-popup"/>
++                                               <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 onselect="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

@@ -783 +783 @@
                                 
                                 for(var j=0; j<variables.length; j++) {
                                         if(ignore[0][variables[j]]) continue;
-                                        
+                                                var text = citationItem && citationItem.locator ? citationItem.locator : "";
                                         if(variables[j] == "locator") {
                                                 // special case for locator
                                                 var text = citationItem && citationItem.locator ? citationItem.locator : "";
+                                        } else if(variables[j] == "volume") {
+                                                // special case for volume (first of three overrides)
+                                                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(variables[j] == "firstref") {
                                                 // note number of first reference to this citation
-                                                var text = citationItem && citationItem.firstref ? citationItem.firstref : 0;
+                                                var text = citationItem && citationItem.firstRef ? citationItem.firstRef : 0;
                                         } else if(citationItem && citationItem._csl && citationItem._csl[variables[j]]) {
                                                 // override if requested
                                                 var text = citationItem._csl[variables[j]];
@@ -1982 +1991 @@
         
         var matches;
         for each(var zoteroField in zoteroFields) {
-                var value = this.zoteroItem.getField(zoteroField, false, true).toString();
-                
+                if(zoteroField == "locator") {
+                    var value = citationItem.locator.toString();
+                } else if ( zoteroField == "volume" && citationItem && citationItem.volume) { 
+                // special handling for volume field
+                    var value = citationItem.volume;
+                } else if(zoteroField == "edition" && citationItem && citationItem.edition) {
+                // 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;

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">