From f749e5272cdd1cf18d1703fc9d88716ce7d17ebd Mon Sep 17 00:00:00 2001
From: Dan Stillman <dstillman@zotero.org>
Date: Mon, 17 Sep 2007 20:33:23 +0000
Subject: [PATCH] Add tooltip ("Save to Zotero") to the scrape icon, with the
 translator used in parentheses (e.g. "Save to Zotero (Library Catalog
 (Voyager))" to help with user debugging

Also added a few things to help with right-to-left languages:

- chromedir attribute on zotero-pane
- Zotero.dir property containing 'ltr' or 'rtl'
- Zotero.localeJoin(arr, separator=' ') to join an array into a string in the proper locale order
---
 chrome/content/zotero/browser.js             | 14 ++++++++++
 chrome/content/zotero/overlay.xul            | 11 ++++++--
 chrome/content/zotero/xpcom/zotero.js        | 29 ++++++++++++++++++++
 chrome/locale/en-US/zotero/zotero.properties |  1 +
 4 files changed, 53 insertions(+), 2 deletions(-)

diff --git a/chrome/content/zotero/browser.js b/chrome/content/zotero/browser.js
index 4ddd3f223..bc6ffc18f 100644
--- a/chrome/content/zotero/browser.js
+++ b/chrome/content/zotero/browser.js
@@ -420,6 +420,7 @@ var Zotero_Browser = new function() {
 		var captureIcon = tab.getCaptureIcon();
 		if(captureIcon) {
 			Zotero_Browser.statusImage.src = captureIcon;
+			Zotero_Browser.statusImage.tooltipText = tab.getCaptureTooltip();
 			Zotero_Browser.statusImage.hidden = false;
 		} else {
 			Zotero_Browser.statusImage.hidden = true;
@@ -664,6 +665,19 @@ Zotero_Browser.Tab.prototype.getCaptureIcon = function() {
 	return false;
 }
 
+Zotero_Browser.Tab.prototype.getCaptureTooltip = function() {
+	if (this.page.translators && this.page.translators.length) {
+		var arr = [Zotero.getString('ingester.saveToZotero')];
+		if (this.page.translators[0].itemType == 'multiple') {
+			arr.push('...');
+		}
+		arr.push (' ' , '(' + this.page.translators[0].label + ')');
+		return Zotero.localeJoin(arr, '');
+	}
+	return '';
+}
+
+
 /**********CALLBACKS**********/
 
 /*
diff --git a/chrome/content/zotero/overlay.xul b/chrome/content/zotero/overlay.xul
index 8b9ae3ec8..134f358b3 100644
--- a/chrome/content/zotero/overlay.xul
+++ b/chrome/content/zotero/overlay.xul
@@ -21,7 +21,13 @@
     ***** END LICENSE BLOCK *****
 -->
 <?xml-stylesheet href="chrome://zotero/skin/overlay.css" type="text/css"?>
-<!DOCTYPE window SYSTEM "chrome://zotero/locale/zotero.dtd">
+
+<!DOCTYPE window [
+	<!ENTITY % globalDTD SYSTEM "chrome://global/locale/global.dtd">
+	%globalDTD;
+	<!ENTITY % zoteroDTD SYSTEM "chrome://zotero/locale/zotero.dtd">
+	%zoteroDTD;
+]>
 
 <overlay id="zotero"
 	xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
@@ -73,7 +79,8 @@
 			onmouseup="ZoteroPane.updateTagSelectorSize()"/>
 		<hbox id="zotero-pane" persist="savedHeight" hidden="true"
 			onkeydown="ZoteroPane.handleKeyDown(event, this.id)"
-			onkeyup="ZoteroPane.handleKeyUp(event, this.id)">
+			onkeyup="ZoteroPane.handleKeyUp(event, this.id)"
+			chromedir="&locale.dir;">
 			<popupset>
 				<popup id="zotero-collectionmenu" onpopupshowing="ZoteroPane.buildCollectionContextMenu();">
 					<menuitem label="&zotero.toolbar.newCollection.label;" oncommand="ZoteroPane.newCollection()"/>
diff --git a/chrome/content/zotero/xpcom/zotero.js b/chrome/content/zotero/xpcom/zotero.js
index 83c186be5..e13f01ae0 100644
--- a/chrome/content/zotero/xpcom/zotero.js
+++ b/chrome/content/zotero/xpcom/zotero.js
@@ -48,6 +48,7 @@ var Zotero = new function(){
 	this.varDump = varDump;
 	this.safeDebug = safeDebug;
 	this.getString = getString;
+	this.localeJoin = localeJoin;
 	this.getLocaleCollation = getLocaleCollation;
 	this.setFontSize = setFontSize;
 	this.flattenArguments = flattenArguments;
@@ -69,6 +70,7 @@ var Zotero = new function(){
 	this.version;
 	this.platform;
 	this.locale;
+	this.dir; // locale direction: 'ltr' or 'rtl'
 	this.isMac;
 	this.isWin;
 	this.initialURL; // used by Schema to show the changelog on upgrades
@@ -143,8 +145,17 @@ var Zotero = new function(){
 		var stringBundleService =
 			Components.classes["@mozilla.org/intl/stringbundle;1"]
 			.getService(Components.interfaces.nsIStringBundleService);
+		
 		_localizedStringBundle = stringBundleService.createBundle(src, appLocale);
 		
+		// Set the locale direction to Zotero.dir
+		// DEBUG: is there a better way to get the entity from JS?
+		var xmlhttp = Components.classes["@mozilla.org/xmlextras/xmlhttprequest;1"]
+						.createInstance();
+		xmlhttp.open('GET', 'chrome://global/locale/global.dtd', false);
+		xmlhttp.send(null);
+		this.dir = xmlhttp.responseText.match(/(ltr|rtl)/)[0];
+		
 		try {
 			this.getZoteroDirectory();
 		}
@@ -589,6 +600,24 @@ var Zotero = new function(){
 	}
 	
 	
+	/*
+	 * Join the elements of an array into a string using the appropriate
+	 * locale direction
+	 *
+	 * |separator| defaults to a space (not a comma like Array.join()) if
+	 *   not specified
+	 */
+	function localeJoin(arr, separator) {
+		if (typeof separator == 'undefined') {
+			separator = ' ';
+		}
+		if (this.dir == 'rtl') {
+			str.reverse();
+		}
+		return arr.join(separator);
+	}
+	
+	
 	function getLocaleCollation() {
 		var localeService = Components.classes["@mozilla.org/intl/nslocaleservice;1"]
 			.getService(Components.interfaces.nsILocaleService);
diff --git a/chrome/locale/en-US/zotero/zotero.properties b/chrome/locale/en-US/zotero/zotero.properties
index 449661eb9..279ef2e1c 100644
--- a/chrome/locale/en-US/zotero/zotero.properties
+++ b/chrome/locale/en-US/zotero/zotero.properties
@@ -316,6 +316,7 @@ fileTypes.document				= Document
 save.attachment					= Saving Snapshot...
 save.link						= Saving Link...
 
+ingester.saveToZotero			= Save to Zotero
 ingester.scraping				= Saving Item...
 ingester.scrapeComplete			= Item Saved
 ingester.scrapeError			= Could Not Save Item