├── deploy
    ├── .gitignore
    ├── config.yaml
    └── update.rdf
├── .gitignore
├── .jshintrc
├── addon
    ├── chrome
    │   ├── skin
    │   │   └── default
    │   │   │   └── lyz
    │   │   │       ├── lyz.png
    │   │   │       └── overlay.css
    │   ├── content
    │   │   └── lyz
    │   │   │   ├── include.js
    │   │   │   ├── select.js
    │   │   │   ├── select.xul
    │   │   │   ├── migration5.xul
    │   │   │   ├── settings.xul
    │   │   │   ├── overlay.xul
    │   │   │   ├── settings.js
    │   │   │   └── lyz.js
    │   └── locale
    │   │   └── en-US
    │   │       └── lyz
    │   │           └── lyz.dtd
    ├── chrome.manifest
    ├── install.rdf
    └── LICENSE.md
├── Makefile
├── .jscsrc
├── README.md
└── LICENSE.md


/deploy/.gitignore:
--------------------------------------------------------------------------------
1 | github.token
2 | release
3 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.sw?
2 | *~
3 | .DS_Store
4 | lyz.xpi
5 | Extra/AMO_README.txt
6 | Extra/README.html
7 | 


--------------------------------------------------------------------------------
/.jshintrc:
--------------------------------------------------------------------------------
1 | {
2 |     "asi": true,
3 | 	"esnext": true,
4 |     "globalstrict": false,
5 |     "moz": true
6 | }
7 | 


--------------------------------------------------------------------------------
/addon/chrome/skin/default/lyz/lyz.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wshanks/lyz/HEAD/addon/chrome/skin/default/lyz/lyz.png


--------------------------------------------------------------------------------
/addon/chrome/skin/default/lyz/overlay.css:
--------------------------------------------------------------------------------
1 | #lyz-menu-button  {
2 | 	list-style-image: url('chrome://lyz/skin/lyz.png');
3 | }
4 | 
5 | 
6 | 


--------------------------------------------------------------------------------
/addon/chrome.manifest:
--------------------------------------------------------------------------------
1 | content	lyz	chrome/content/lyz/
2 | locale	lyz	en-US				chrome/locale/en-US/lyz/
3 | skin	lyz	default	chrome/skin/default/lyz/
4 | overlay chrome://zotero/content/zoteroPane.xul chrome://lyz/content/overlay.xul
5 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/include.js:
--------------------------------------------------------------------------------
1 | // Only create main object once
2 | if (!Zotero.Lyz) {
3 |     const lyzLoader = Components.classes["@mozilla.org/moz/jssubscript-loader;1"]
4 |         .getService(Components.interfaces.mozIJSSubScriptLoader);
5 |     lyzLoader.loadSubScript("chrome://lyz/content/lyz.js");
6 |     window.addEventListener('load', function(e) { Zotero.Lyz.init(); }, false);
7 | }
8 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | BLDDIR = build
 2 | 
 3 | # Necessary because zip copies leading directories if run from above targets
 4 | ABS_BLDDIR := $(shell readlink -f $(BLDDIR))
 5 | 
 6 | all: xpi
 7 | 
 8 | xpi: $(BLDDIR)/lyz.xpi
 9 | 
10 | $(BLDDIR)/lyz.xpi:
11 | 	@mkdir -p $(dir $@)
12 | 	cd addon; zip -FSr $(ABS_BLDDIR)/lyz.xpi * -x \*.swp -x '#*#' -x \*~
13 | 
14 | clean:
15 | 	rm -f $(BLDDIR)/lyz.xpi
16 | 
17 | .PHONY: all clean xpi
18 | 


--------------------------------------------------------------------------------
/addon/chrome/locale/en-US/lyz/lyz.dtd:
--------------------------------------------------------------------------------
 1 | <!ENTITY cite "Cite in LyX">
 2 | <!ENTITY settings "Settings...">
 3 | <!ENTITY about "About...">
 4 | <!ENTITY update-bibtex "Update BibTeX">
 5 | <!ENTITY check-bibtex "Update from BibTeX">
 6 | <!ENTITY delete-bib "Delete BibTeX record...">
 7 | <!ENTITY delete-doc "Delete LyX document record...">
 8 | <!ENTITY rename-bib "Rename BibTeX record...">
 9 | <!ENTITY rename-doc "Rename LyX document record...">
10 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/select.js:
--------------------------------------------------------------------------------
 1 | function onLoad() {
 2 |     var dic = window.arguments[0].inn.items;
 3 |     var type = window.arguments[0].inn.type;
 4 |     for (var i=0;i<dic.length;i++){
 5 | 	document.getElementById("lyz-listbox").appendItem(dic[i][type],dic[i][type]);
 6 |     }
 7 | }
 8 | 
 9 | function onOK() {
10 |     window.arguments[0].out = {item:document.getElementById("lyz-listbox").value};
11 |     return true;
12 | }
13 | 
14 | function onCancel() {
15 |     window.arguments[0].out = null;
16 |     return true;
17 | }
18 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/select.xul:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <?xml-stylesheet href="chrome://global/skin/" type="text/css"?>
 3 | <dialog
 4 |   xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
 5 |   id="lyz-select-dialog"
 6 |   title="Select records"
 7 |   buttons="accept,cancel"
 8 |   onload="return onLoad();"
 9 |   ondialogaccept="return onOK();"
10 |   ondialogcancel="return onCancel();">
11 |   <script type="application/javascript" src="chrome://lyz/content/select.js"/>
12 |   <listbox id="lyz-listbox">
13 |   </listbox>
14 |   
15 | </dialog>
16 | 


--------------------------------------------------------------------------------
/deploy/config.yaml:
--------------------------------------------------------------------------------
 1 | github:
 2 |     user: wshanks
 3 |     repo: lyz 
 4 |     token: deploy/github.token
 5 |     assets:
 6 |     - path: build/lyz.xpi
 7 |       type: application/x-xpinstall
 8 | 
 9 | git_release:
10 |     remote: origin
11 |     branch: release
12 | 
13 | version_strings:
14 | - path: addon/install.rdf
15 |   pattern: (<em:version>)(?P<release>.*)(</em:version>)
16 | - path: deploy/update.rdf
17 |   pattern: (<em:version>)(?P<release>.*)(</em:version>)
18 | - path: deploy/update.rdf
19 |   pattern: (<em:updateLink>https://github.com/wshanks/lyz/releases/download/v)(?P<release>.*)(/lyz.xpi</em:updateLink>)
20 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/migration5.xul:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | 
 3 | <?xml-stylesheet href="chrome://global/skin/" type="text/css"?>
 4 | 
 5 | <dialog
 6 | 	id="lyz-migration-dialog"
 7 | 	xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
 8 | 	orient="vertical"
 9 | 	buttons="accept"
10 | 	buttonlabelaccept="Close"
11 | 	ondialogaccept="return true;"
12 | 	flex="1"
13 | 	width="650"
14 | 	height="450">
15 |         <text value="LyZ: migration complete"
16 |               style="font-weight: bold; font-size: x-large; font-family: Roman"/>
17 |         <text value="The following citation keys were changed. This information was also written to the lyz_migration.csv file in the Zotero data directory."
18 |               style="font-family: Roman"/>
19 | 	<groupbox flex="1">
20 |         <vbox flex="1" style="overflow:auto; border: 1px dotted black; padding: 2px;">
21 |         <description id="lyz-migration-description" style="white-space: pre-wrap;"/>
22 |         </vbox>
23 | 		
24 | 	</groupbox>
25 |         <script>
26 |           <![CDATA[
27 | document.getElementById('lyz-migration-description').textContent = window.arguments[0]
28 | ]]>
29 |         </script>
30 | </dialog>
31 | 


--------------------------------------------------------------------------------
/addon/install.rdf:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 3 |      xmlns:em="http://www.mozilla.org/2004/em-rdf#">
 4 | 
 5 |   <Description about="urn:mozilla:install-manifest">
 6 |     <em:id>lyz@zotero.org</em:id>
 7 |     <em:version>4.1.3a1</em:version>
 8 | 	<em:multiprocessCompatible>true</em:multiprocessCompatible>
 9 |         <em:updateURL>https://raw.githubusercontent.com/wshanks/lyz/release/deploy/update.rdf</em:updateURL>
10 |     <em:type>2</em:type>
11 |     <em:unpack>true</em:unpack>
12 |     <!-- Target Application this extension can install into, 
13 |          with minimum and maximum supported versions. --> 
14 |     <em:targetApplication>
15 |       <Description>
16 | 	<em:id>zotero@chnm.gmu.edu</em:id>
17 | 	<em:minVersion>5.0.24</em:minVersion>
18 | 	<em:maxVersion>*</em:maxVersion>
19 |       </Description>
20 |     </em:targetApplication>
21 |     <em:targetApplication>
22 |       <Description>
23 | 	<em:id>juris-m@juris-m.github.io</em:id>
24 | 	<em:minVersion>5.0.24</em:minVersion>
25 | 	<em:maxVersion>*</em:maxVersion>
26 |       </Description>
27 |     </em:targetApplication>
28 |   <em:name>LyZ</em:name>
29 |   <em:description>LyX integration plugin.</em:description>
30 |   <em:creator>Petr Šimon</em:creator>
31 |   <em:homepageURL>https://github.com/wshanks/lyz</em:homepageURL>
32 |   </Description>      
33 | </RDF>
34 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/settings.xul:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <?xml-stylesheet href="chrome://global/skin/" type="text/css"?>
 3 | <dialog
 4 |   xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
 5 |   id="lyz-settings-dialog"
 6 |   title="Settings"
 7 |   onload="return onLoad();"
 8 |   ondialogaccept="return onOK();">
 9 |   <script type="application/javascript" src="chrome://lyz/content/settings.js"/>
10 |   <grid>
11 |     <columns><column/><column/></columns>
12 |     <rows>
13 |       <row align="center">
14 |       	<label value="Lyx Server"/>
15 |       	<textbox id="lyxserver"/>
16 |      </row>
17 |      
18 |      <row align="center">
19 | 		<label value="Create cite key?"/>
20 | 		<checkbox id="createcitekey" onclick="enableCiteKey();"/>
21 |       </row>
22 |       
23 |       <row align="center">
24 | 		<label value="Cite Key"/><textbox id="citekey" disabled="false" />
25 |       </row>
26 |      
27 |       <row align="center">
28 | 		<label value="Possible keywords:"/>
29 | 		<label value="author year title zotero zoteroShort"/>
30 |       </row>
31 |       <row align="center">
32 | 	<label value="Export format (translator)"/>
33 |         <menulist id="format-menu">
34 |           <menupopup id="format-popup"/>
35 |         </menulist>
36 |       </row>      
37 |       
38 |       <row align="center">
39 | 		<label value="Use journal abbreviations?"/>
40 | 		<checkbox id="journalabbrev"/>
41 |       </row>
42 |     </rows>
43 |   </grid>
44 | </dialog>
45 | 


--------------------------------------------------------------------------------
/.jscsrc:
--------------------------------------------------------------------------------
 1 | {
 2 |     "disallowKeywords": ["with"],
 3 |     "disallowKeywordsOnNewLine": ["else"],
 4 |     "disallowMixedSpacesAndTabs": true,
 5 |     "disallowMultipleVarDecl": "exceptUndefined",
 6 |     "disallowNewlineBeforeBlockStatements": true,
 7 |     "disallowQuotedKeysInObjects": true,
 8 |     "disallowSpaceAfterObjectKeys": true,
 9 |     "disallowSpaceAfterPrefixUnaryOperators": true,
10 |     "disallowSpacesInFunction": {
11 |         "beforeOpeningRoundBrace": true
12 |     },
13 |     "disallowSpacesInsideParentheses": true,
14 |     "disallowTrailingWhitespace": true,
15 |     "maximumLineLength": 80,
16 |     "requireCamelCaseOrUpperCaseIdentifiers": true,
17 |     "requireCapitalizedConstructors": true,
18 |     "requireCurlyBraces": [
19 |        "if",
20 |        "else",
21 |        "for",
22 |        "while",
23 |        "do",
24 |        "try",
25 |        "catch"
26 |     ],
27 |     "requireSpaceAfterKeywords": [
28 |         "if",
29 |         "else",
30 |         "for",
31 |         "while",
32 |         "do",
33 |         "switch",
34 |         "case",
35 |         "return",
36 |         "try",
37 |         "catch",
38 |         "typeof"
39 |     ],
40 |     "requireSpaceAfterLineComment": true,
41 |     "requireSpaceAfterBinaryOperators": true,
42 |     "requireSpaceBeforeBinaryOperators": true,
43 |     "requireSpaceBeforeBlockStatements": true,
44 |     "requireSpaceBeforeObjectValues": true,
45 |     "requireSpacesInFunction": {
46 |         "beforeOpeningCurlyBrace": true
47 |     },
48 |     "disallowTrailingComma": true,
49 |     "validateIndentation": 4,
50 |     "validateLineBreaks": "LF",
51 |     "validateQuoteMarks": "'"
52 | }
53 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/overlay.xul:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <?xml-stylesheet href="chrome://lyz/skin/overlay.css" type="text/css"?>
 3 | <!DOCTYPE window SYSTEM "chrome://lyz/locale/lyz.dtd">
 4 | 
 5 | <overlay id="lyz-overlay"
 6 | 	xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 7 | 	
 8 | 	<stringbundleset id="stringbundleset">
 9 | 		<stringbundle id="lyz-strings"
10 | 			src="chrome://lyz/locale/lyz.properties"/>
11 | 	</stringbundleset>
12 | 	<hbox class="toolbar"  id="zotero-items-toolbar" align="center">
13 | 	  <toolbarbutton id="lyz-menu-button" tooltiptext="LyZ" type="menu" 
14 | 	  		 class="zotero-tb-button"
15 | 			 insertafter="zotero-tb-attachment-add">
16 | 	    <menupopup id="lyz-menupopup">
17 | 	      <menuitem id="lyz-send" 
18 | 			label="&cite;" 
19 | 			oncommand="Zotero.Lyz.checkAndCite()"
20 | 			tooltip="Send citation to LyX"/>
21 | 	      <menuitem id="lyz-update-bibtex" 
22 | 			label="&update-bibtex;"
23 | 			oncommand="Zotero.Lyz.updateBibtexAll()"
24 | 			tooltip="Update modified items in BibTeX file"/>
25 | 	      <menuseparator />
26 | 	      <menuitem id="lyz-delete-bib" label="&delete-bib;"
27 | 			oncommand="Zotero.Lyz.dbDeleteBib()"
28 | 			tooltip="Delete BibTeX database and associated documet records from LyZ database"/>
29 | 	      <menuitem id="lyz-delete-doc" label="&delete-doc;"
30 | 			oncommand="Zotero.Lyz.dbDeleteDoc()"
31 | 			tooltip="Delete document record from LyZ database"/>
32 | 	      <menuseparator />
33 | 	      <menuitem id="lyz-rename-bib" label="&rename-bib;"
34 | 			oncommand="Zotero.Lyz.dbRenameBib()"/>
35 | 	      <menuitem id="lyz-rename-doc" label="&rename-doc;"
36 | 			oncommand="Zotero.Lyz.dbRenameDoc()"/>
37 | 	      <menuseparator />
38 | 	      <menuitem id="lyz-settings" label="&settings;"
39 | 			oncommand="Zotero.Lyz.settings()"/>
40 | 	      <menuseparator />
41 | 	      <menuitem id="lyz-test"
42 | 	      		label="LyX command..."
43 | 	      		oncommand="Zotero.Lyz.test()"/>
44 | 	    </menupopup>
45 | 	  </toolbarbutton>  
46 | 	</hbox>
47 | 	<!-- context menu -->
48 | 	<popup id="zotero-itemmenu">
49 | 	  <menuseparator />
50 | 	  <menuitem label="&cite;"
51 | 		    oncommand="Zotero.Lyz.checkAndCite()"/>
52 | 	</popup>
53 | 	
54 | 	<!-- Include the main extension logic -->
55 | 	<script src="chrome://zotero/content/include.js"/>
56 | 	<script src="chrome://lyz/content/include.js"/>
57 | </overlay>
58 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/settings.js:
--------------------------------------------------------------------------------
 1 | function onLoad() {
 2 | 	document.getElementById("lyxserver").value = window.arguments[0].inn.lyxserver;
 3 | 	document.getElementById("citekey").value = window.arguments[0].inn.citekey;
 4 | 	if (window.arguments[0].inn.createcitekey){
 5 | 		document.getElementById("createcitekey").checked = true;
 6 | 		document.getElementById("citekey").disabled = false;
 7 | 	} else {
 8 | 		document.getElementById("createcitekey").checked = false;
 9 | 		document.getElementById("citekey").disabled = true;
10 | 	}
11 | 	var translators = window.arguments[0].inn.translators;
12 | 	
13 | 	var prefService =
14 | 		Components.classes["@mozilla.org/preferences-service;1"].
15 | 		getService(Components.interfaces.nsIPrefBranch);
16 | 	document.getElementById("journalabbrev").checked = 
17 | 		prefService.getBoolPref("extensions.lyz.useJournalAbbreviation");
18 | 
19 | 	var formatMenu = document.getElementById("format-menu");
20 | 	var formatPopup = document.getElementById("format-popup");
21 | 	var defaultIndex = 0;
22 | 
23 | 	// add styles to format popup
24 | 	for ( var i in translators) {
25 | 		var itemNode = document.createElement("menuitem");
26 | 		itemNode.setAttribute("label", translators[i].label);
27 | 		formatPopup.appendChild(itemNode);
28 | 
29 | 		// select last selected translator
30 | 		if (translators[i].translatorID == window.arguments[0].inn.selectedTranslator) {
31 | 			formatMenu.selectedIndex = i;
32 | 		}
33 | 		if (translators[i].translatorID == '9cb70025-a888-4a29-a210-93ec52da40d4') {
34 | 			defaultIndex = i; // plain BibTeX
35 | 		}
36 | 		if (translators[i].target != "bib") {
37 | 			itemNode.setAttribute("hidden", true);
38 | 		}
39 | 	}
40 | 	// select plain BibTeX as default:
41 | 	if (formatMenu.selectedIndex == -1) {
42 | 		formatMenu.selectedIndex = defaultIndex;
43 | 	}
44 | }
45 | 
46 | function onOK() {
47 | 	var index = document.getElementById("format-menu").selectedIndex;
48 | 	window.arguments[0].out = {
49 | 		lyxserver : document.getElementById("lyxserver").value,
50 | 		citekey : document.getElementById("citekey").value,
51 | 		createcitekey: document.getElementById("createcitekey").checked,
52 | 		selectedTranslator : window.arguments[0].inn.translators[index].translatorID,
53 | 		useJournalAbbreviation : document.getElementById("journalabbrev").checked
54 | 	};
55 | 	return true;
56 | }
57 | 
58 | function enableCiteKey(){
59 | 	if (document.getElementById("citekey").disabled){
60 | 		document.getElementById("citekey").disabled = false;
61 | 	} else {
62 | 		document.getElementById("citekey").disabled = true;
63 | 	}
64 | }
65 | 
66 | 


--------------------------------------------------------------------------------
/deploy/update.rdf:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 3 |         xmlns:em="http://www.mozilla.org/2004/em-rdf#">
 4 |     <rdf:Description rdf:about="urn:mozilla:extension:lyz@zotero.org">
 5 |         <em:updates>
 6 |             <rdf:Seq>
 7 |                 <rdf:li>
 8 |                     <rdf:Description>
 9 |                         <em:version>4.1.3a1</em:version>
10 |                         <em:targetApplication>
11 |                             <rdf:Description>
12 |                                 <em:id>zotero@chnm.gmu.edu</em:id>
13 |                                 <em:minVersion>5.0.24</em:minVersion>
14 |                                 <em:maxVersion>*</em:maxVersion>
15 |                                 <em:updateLink>https://github.com/wshanks/lyz/releases/download/v4.1.3a1/lyz.xpi</em:updateLink>
16 |                             </rdf:Description>
17 |                         </em:targetApplication> 
18 | 
19 |                         <em:targetApplication>
20 |                             <rdf:Description>
21 |                                 <em:id>juris-m@juris-m.github.io</em:id>
22 |                                 <em:minVersion>5.0.24</em:minVersion>
23 |                                 <em:maxVersion>*</em:maxVersion>
24 |                                 <em:updateLink>https://github.com/wshanks/lyz/releases/download/v4.1.3a1/lyz.xpi</em:updateLink>
25 |                             </rdf:Description>
26 |                         </em:targetApplication>
27 | 
28 |                     </rdf:Description>
29 |                 </rdf:li>
30 | 
31 |                 <rdf:li>
32 |                     <rdf:Description>
33 |                         <!-- Pin version 4.0.1 for older version of Zotero -->
34 |                         <!-- Note that the eversion and updateLink tags must
35 |                              have the line breaks before the closing tags to 
36 |                              avoid getting matched by the regexes in
37 |                              deploy/config.yaml -->
38 |                         <em:version>4.0.1
39 |                             </em:version>
40 |                         <em:targetApplication>
41 |                             <rdf:Description>
42 |                                 <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
43 |                                 <em:minVersion>34.0</em:minVersion>
44 |                                 <em:maxVersion>56.*</em:maxVersion>
45 |                                 <em:updateLink>https://github.com/wshanks/lyz/releases/download/v4.0.1/lyz.xpi
46 |                                     </em:updateLink>
47 |                             </rdf:Description>
48 |                         </em:targetApplication>
49 | 
50 |                         <em:targetApplication>
51 |                             <rdf:Description>
52 |                                 <em:id>zotero@chnm.gmu.edu</em:id>
53 |                                 <em:minVersion>3.0b1</em:minVersion>
54 |                                 <em:maxVersion>5.0.74</em:maxVersion>
55 |                                 <em:updateLink>https://github.com/wshanks/lyz/releases/download/v4.0.1/lyz.xpi
56 |                                     </em:updateLink>
57 |                             </rdf:Description>
58 |                         </em:targetApplication> 
59 | 
60 |                         <em:targetApplication>
61 |                             <rdf:Description>
62 |                                 <em:id>juris-m@juris-m.github.io</em:id>
63 |                                 <em:minVersion>4.0</em:minVersion>
64 |                                 <em:maxVersion>5.0.74</em:maxVersion>
65 |                                 <em:updateLink>https://github.com/wshanks/lyz/releases/download/v4.0.1/lyz.xpi
66 |                                     </em:updateLink>
67 |                             </rdf:Description>
68 |                         </em:targetApplication>
69 | 
70 |                     </rdf:Description>
71 |                 </rdf:li>
72 | 
73 |             </rdf:Seq>
74 |         </em:updates>
75 |     </rdf:Description>
76 | </rdf:RDF>
77 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | LyZ
  2 | ---
  3 | LyZ is a plugin for [Zotero](http://www.zotero.org), which is intended to make working with LyX/Zotero more pleasant. The latest source code is available at [GitHub](https://github.com/wshanks/lyz). The latest stable release is available from [the GitHub releases page](https://github.com/wshanks/lyz/releases).
  4 | 
  5 | Features
  6 | --------
  7 | * Inserting citations to LyX from Zotero.
  8 | * BibTeX database automatically updated when citation is inserted.
  9 | * BibTeX database can be updated when the references in Zotero are modified.
 10 | * Custom BibTeX key format.
 11 | * Unique BibTeX key check.
 12 | * Custom BibTeX translators.
 13 | * Synchronization of BibTex keys between LyX document, BibTeX database and LyZ.
 14 | * Editing of master/child documents (the same BibTeX database) and multiple documents (different BibTeX database for each document).
 15 | * Persistent association of LyX documents and BibTeX databases.
 16 | * Support for group cooperation.
 17 | 
 18 | **NOTE:** As of version 4.0, LyZ is distributed from the [GitHub releases page](https://github.com/wshanks/lyz/releases).
 19 | New updates will not be published to the location checked by previous versions of LyZ (the Mozilla Add-ons page).
 20 | To receive new LyZ updates, please update to the latest version of LyZ.
 21 | 
 22 | Installation and Settings
 23 | -------------------------
 24 | 1. Download the lyz `.xpi` file from the [GitHub releases page](https://github.com/wshanks/lyz/releases).
 25 | 2. Install LyZ in Zotero by selecting Add-ons from the Tools menu and then clicking the gear icon in the Add-ons window, selecting "Install add-on from file" and selecting the lyz `.xpi` file.
 26 | 3. Open LyX and set LyXServer path (in LyX go to menu, Tools > Preferences... > Paths and set LyXServer pipe to): Windows users can use the default path setting in LyZ, i.e. `\\.\pipe\lyxpipe`. Linux and Mac users can use e.g. `~/.lyxpipe` and change the LyZ settings accordingly.
 27 | 4. By default all characters are escaped, e.g. š becomes \v{s}. Set `extensions.lyz.use_utf8` to true in `about:config` to avoid escaping (in case you need to use non-latin scripts such as Chinese).
 28 | 5. Open document in LyX.
 29 | 
 30 | **NOTE for Firefox users:** Firefox treats `.xpi` files as Firefox add-ons and tries to install them.
 31 | To download:  
 32 | 1. Right click on link  
 33 | 2. Select 'Save Link As'  
 34 | 3. Select a folder to save in  
 35 | 4. Click 'Save'  
 36 | 5. The file will now download  
 37 | 
 38 | You can also download it either with a different browser or with a command-line tool like `curl` or `wget`.
 39 | 
 40 | Adding and inserting citations
 41 | ------------------------------
 42 | 1. Open the LyX document you want to add a citation to and put the cursor at the point in the text at which you want the citation added.
 43 | 
 44 | 2. From Zotero, select a citation and either from the LyZ menu or from the context menu (right click on the citation) do “Cite in LyX”.
 45 | 
 46 | 	When you try to insert a citation into a new document (i.e. document unknown to LyZ) you have to select a BibTeX database. You will be asked to either create a new database or choose a database you have created before (by LyZ). Type the database name (*.bib extension is automatically added if you don’t provide it) and press OK. The citation is added into the BibTeX database you have just created and inserted into the LyX document. Your citation should appear in LyX document now.  Further citations are automatically added to this database.
 47 | 3. Insert the BibTeX database into the LyX document by adding a bibliography (`Insert->List/TOC->BibTeX Bibliography...`) and then selecting the newly created \*.bib file as the database.
 48 | 	* From the bibliography window (which appears when the bibliography is created and may be accessed by clicking on the bibliography), you may also select a BibTeX style file (*.bst).  This file determines how your references will be formatted in the bibliography.  Most TeX packages come with a large number of style files.  Some journals (or other publishing entities) also provide their own style files.  One good option is [apalike2](http://www.ctan.org/pkg/apalike2).
 49 | 	* From `Document->Settings->Bibliography`, you may choose a citation style which determines how your citations will appear in the text.  Natbib and Jurabib give more flexible citation styles than the default numerical option.
 50 | 	* A helpful introduction to working with BibTeX and LyX is available from the [LyX website](http://wiki.lyx.org/BibTeX/Introduction).
 51 | 4. Insert additional citations
 52 | 	* New citations can be added from Zotero as above. 
 53 | 	* Previously added citations can be either inserted through Zotero or through the LyX interface.
 54 | 5. If you modify the reference information of previously cited items in Zotero, use “Update BibTeX” from the LyZ menu to update the BibTeX database.
 55 | 
 56 | Custom BibTeX keys
 57 | ------------------
 58 | * Custom BibTeX keys can be set in LyZ > Settings dialog.
 59 | * The default format is “author year title”. Good alternative for the use with natbib package is format “zotero”, which will produce “human unreadable” BibTeX keys. It consists of library ID and zotero item key, e.g. `0_XXXXX`. Format keyword “zoteroShort” will produce only XXXXX, which can be used when exporting from OOo.
 60 | * Key formats can be composed from keywords “author”, “year”, “title”, “zotero” and separators such as “\_” (the following characters should be safe to use: ``a-z, 0-9!$&*+-.:;<>?[]^\`|``), e.g. “author year title”, which will produce authoryeartitle BibTeX key, e.g. tichy1988thefoundations. If you prefer the default format used in Zotero BibTeX export (tichy\_thefoundations\_1988), change the pattern to “author _ title _ year”. The keywords and any separating characters have to be separated by space. Characters in citekeys are escaped and unsafe characters are removed conforming to the regular expression ``/[^a-z0-9\!\$\&\*\+\-\.\/\:\;\<\>\?\[\]\^\_\`\|]+/g``.
 61 | * If you use custom BibTeX translator and want to use the cite keys generated in the translator, go to LyZ > Setting and switch creation of cite keys off.
 62 | 
 63 | Update BibTeX
 64 | -------------
 65 | Menu command “Update BibTex” will update BibTeX database of the active LyX document. Whatever changes made in Zotero will be reflected in the update, including BibTeX keys if the BibTeX key format or the relevant information (first author, title, year) have been changed.
 66 | 
 67 | When a single BibTeX database is shared among several authors, e.g. using version control system such as SVN and CVS, LyZ database is updated from local working copy of BibTeX database.
 68 | 
 69 | Only current LyX document will be updated. Multiple document update is implemented, but seems unreliable. Needs more testing…
 70 | 
 71 | Synchronization between LyX/BibTeX/LyZ
 72 | --------------------------------------
 73 | 
 74 | When Zotero reference is changed, BibTeX database as well as the LyX document can be updated. This is useful when nice BibTeX keys are used, such as ‘author year title’ and e.g. the title or the first author’s surname has been modified, which will result in modification of the BibTeX key. When the “Update BibTeX” is run, you should select to update the LyX document in case your modifications to Zotero references might affect your BibTeX keys. Before the update, a backup of the active LyX document is made (extension *.lyz). LyZ will save, close and then reopen your document.
 75 | 
 76 | Notes on usage
 77 | --------------
 78 | * Always modify your references in Zotero. If you modify the BibTeX database manually or using other software, LyZ will overwrite all the changes when you run “Update BibTeX“.
 79 | 
 80 | * Lyz stores identifiers for all of the references in the BibTeX database as a space separated string in the first line of the BibTeX file. Do not modify this line. When Lyz updates the BibTeX file, it first reads this line to check the current contents of the BibTeX (this behavior is useful if you are passing the BibTeX around between computers and want Lyz to keep up with the changes). If this line is not properly formed, an error will occur and Lyz will not work properly.
 81 | 
 82 | * Keep your Zotero items unique. LyZ does not make an attempt to identify duplicates, they will be treated as different items and unique BibTeX keys will be created.
 83 | 
 84 | * When working with master/child documents in LyX, you will have to specify the BibTeX database for each child document. This will be the same file as specified for the master document. Unfortunately LyZ has no way of knowing the relationship between documents, so it has to be done manually.
 85 | 
 86 | * Old writing projects can be deleted from LyZ menu. When the record of BibTeX database is deleted, all associated LyX document records are also deleted. When LyX document is deleted, associated BibTeX database will remain untouched as it may be used by another document. The actual file won’t be deleted.
 87 | 
 88 | * BibTeX database is uniformly exported to UTF8 and all characters are escaped. Exporting to doesn’t seem to have any advantages. When your references contain extra characters such as the degree symbol, add `\usepackage{textcomp}` to your preamble.
 89 | 
 90 | * URLs in bibliography. Use bibliography style that can handle URLs, such as apalike, or add `\usepackage{url}` to your preamble.
 91 | 
 92 | * LyZ stores the information about documents and BibTeX databases in lyz.sqlite in the Zotero folder. If you backup Zotero with some synchronization application, you will notice the new file.
 93 | 
 94 | * When working with non-latin scripts such as Chinese, set `extensions.lyz.use_utf8` to true in `about:config` to avoid escaping.
 95 | 
 96 | Problems, Ideas, Requests
 97 | -------------------------
 98 | Please follow these tips to find out the source of your problem:
 99 | 
100 | * Run Lyx in debugging mode from commandline by (Linux and Mac users change accordingly)
101 | 
102 |         lyx.exe -dbg lyxserver
103 | 
104 | * Useful messages should appear whenever you send some command from Lyz. A useful message will contain words like ERROR, undefined etc.
105 | 
106 | * To send a command from Lyz, you simply use one of the functions, e.g. “Cite in Lyx” or use command line, viz. [http://wiki.lyx.org/LyX/LyXServer](http://wiki.lyx.org/LyX/LyXServer).
107 | 
108 | * Also you can use a variant of the last version of Lyz, which has additional menu item “Test…”. This will allow you to send single commands to Lyx. Currently Lyz uses the following commands (code in the parentheses indicates usage):
109 | 
110 |         server-get-filename (server-get-filename)
111 |         citation-insert (citation-insert:LYZ:author2010title)
112 |         buffer-next (buffer-next)
113 |         server-get-xy (server-get-xy)
114 |         buffer-write (buffer-write)
115 |         buffer-close (buffer-close)
116 |         file-open (file-open:path, where path is the response from server-get-filename)
117 | 
118 | * All functions Lyz has are patched together using these commands. The most trouble some seems to be the server-get-filename.
119 | 
120 | * Extract useful information from Zotero’s Error Console (by starting Zotero on the command line with the `--jsconsole` option) and from commandline where you ran `lyx.exe -dbg lyxserver`.
121 | 
122 | * Peruse the Issues opened by other users at [https://github.com/wshanks/lyz](https://github.com/wshanks/lyz).  Be sure to check the closed issues as well to see if a solution has already been found for your problem.  If not, open a new issue.
123 | 
124 | Common Issues
125 | -------------
126 | ### Update BibTeX does not work
127 | Some users have found that the Update BibTeX command stops working unexpectedly. One possible solution is to edit the `lyz.sqlite` file in the Zotero data directory directly and to remove any bibliography entries in it that look malformed (e.g. some of their fields are empty). To edit `lyz.sqlite`, a SQLite editor is needed. The [sqlite-manager Firefox addon](https://code.google.com/p/sqlite-manager/) is a light-weight option. If you experience this issue and have any insight on what causes it, please contact the developer via GitHub (open a new issue or comment on one of the closed issues related to Update BibTeX).
128 | 
129 | ### Using a non-standard lyxpipe
130 | On Windows the lyxpipe path (`\\.\pipe\lyxpipe`) is a special path and not a real file. You should not try to change this path to something else.
131 | 
132 | ### Compatibility note
133 | Zotero 5.0 introduced numerous API changes. Versions 3.0.0 and higher of Lyz are compatible with Zotero 5.0 and greater. Versions 2.x and lower only support Zotero version 4 and earlier.
134 | 
135 | Current state of development
136 | ----------------------------
137 | The current maintainer of LyZ is not the original creator and is not intimately familiar with the source code.  He plans to update LyZ as necessary to maintain functionality with the latest releases of LyX and Zotero.  He will also happily accept and merge code patches submitted by other users.  He will try to help with other issues that users experience, but he doesn't make any promises about being able to make things work.
138 | 
139 | How to Contribute
140 | -----------------
141 | 1. Star the repository on GitHub. The number of stars on GitHub is one of the most visible metrics for gauging the level of interest in project.
142 | 2. Encourage others to use the project, either directly or by writing a blog post. Besides GitHub stars, the other metric for gauging interest in the project is the total number of downloads of the xpi.
143 | 
144 | Credits
145 | -------
146 | Lyz was written by  Petr Šimon.  It is inspired by Lytero, which Petr wanted to improve, but he ended up starting from scratch. Hence the new name. Thanks to Dan Stillman and mronkko at zotero.org forum. Justin Wood for BOM and escaping suggestions and donation!  It is currently maintained on GitHub by Will Shanks.
147 | 3. Submit new features or translations. However, keep in mind that new features add to the maintenance burden of the project. So get in contact before putting a lot of time into a new feature.
148 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/addon/LICENSE.md:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/addon/chrome/content/lyz/lyz.js:
--------------------------------------------------------------------------------
   1 | // Credits:
   2 | // - small bits were borrowed from Lytero by Demetrio Girardi, lytero@dementrioatgmail.com
   3 | Components.utils.import("resource://gre/modules/Services.jsm");
   4 | Components.utils.import("resource://gre/modules/osfile.jsm");
   5 | 
   6 | Zotero.Lyz = {
   7 | 
   8 |     prefs : null,
   9 |     DB : null,
  10 |     replace : false,
  11 |     wm : null,
  12 |     os: null,
  13 | 
  14 |     init: async function() {
  15 |         await Zotero.Schema.schemaUpdatePromise
  16 | 
  17 |         //set up preferences
  18 |         if (navigator.platform.indexOf("Win")===0){
  19 |             this.os = "Win";
  20 |         } else {// assuming this works also for MacOS better
  21 |             this.os = "Linux";
  22 |         }
  23 |         this.prefs = Services.prefs.getBranch("extensions.lyz.");
  24 |         this.setDefaultPrefs()
  25 |         
  26 |         this.wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
  27 |                 .getService(Components.interfaces.nsIWindowMediator);
  28 | 
  29 |         var shutdownObserver = {observe: this.shutdown}
  30 |         Services.obs.addObserver(shutdownObserver, "quit-application", false);
  31 | 
  32 |         var sqlDocs = "CREATE TABLE IF NOT EXISTS docs (id INTEGER PRIMARY KEY, doc TEXT, bib TEXT)";
  33 |         var sqlKeys = "CREATE TABLE IF NOT EXISTS keys (id INTEGER PRIMARY KEY, key TEXT, bib TEXT, zid TEXT)";
  34 |         this.DB = new Zotero.DBConnection("lyz");
  35 |         await this.DB.queryAsync(sqlDocs);
  36 |         await this.DB.queryAsync(sqlKeys);
  37 |         if (this.prefs.getBoolPref('checkZotero5Migration')) {
  38 |             this.migrateToZotero5()
  39 |         }
  40 |     },
  41 | 
  42 |     setDefaultPrefs: function() {
  43 |         var defaults = Services.prefs.getDefaultBranch("extensions.lyz.")
  44 |         if (this.os == "Win") {
  45 |             defaults.setCharPref("lyxserver", "\\\\.\\pipe\\lyxpipe");
  46 |         } else {
  47 |             defaults.setCharPref("lyxserver", "~/.lyx/lyxpipe");
  48 |         }
  49 |         defaults.setCharPref("citekey", "author year title");
  50 |         defaults.setBoolPref("createCiteKey", true);
  51 |         defaults.setCharPref("selectedTranslator", "9cb70025-a888-4a29-a210-93ec52da40d4");
  52 |         defaults.setBoolPref("use_utf8", false)
  53 |         defaults.setBoolPref("useJournalAbbreviation", false)
  54 |         defaults.setBoolPref("checkZotero5Migration", true)
  55 | 
  56 |     },
  57 | 
  58 |     lyxGetDoc : function() {
  59 |         var res, fre, fname;
  60 |         var win = this.wm.getMostRecentWindow("navigator:browser");
  61 |         if (this.os=="Win"){
  62 |             res = this.lyxAskServer("server-get-filename");
  63 |         } else {
  64 |             res = this._lyxAskServer("server-get-filename");
  65 |         }
  66 |         if (!res) {
  67 |             win.alert("Could not contact server at: " +
  68 |                       this.prefs.getCharPref("lyxserver"));
  69 |             return null;
  70 |         }
  71 | 
  72 |         fre = /.*INFO:lyz:server-get-filename:(.*)\n/;
  73 |         fname = fre.exec(res);
  74 |         if (fname == null) {
  75 |             win.alert("ERROR: lyxGetDoc: \n\n" + res);
  76 |             return null;
  77 |         }
  78 |         return fname[1];
  79 |     },
  80 | 
  81 |     lyxGetPos : function() {
  82 |         if (this.os=="Win"){
  83 |             res = this.lyxAskServer("server-get-xy");
  84 |         } else {
  85 |             res = this._lyxAskServer("server-get-xy");
  86 |         }
  87 |         var xy = /INFO:lyz:server-get-xy:(.*)/.exec(res)[1];
  88 |         return xy;
  89 |     },
  90 | 
  91 |     lyxPipeInit : function() {
  92 |         // reading from lyxpipe.out
  93 |         var pipeout;
  94 |         var path;
  95 |         var pipeout_stream;
  96 |         var cstream;
  97 |         var data;
  98 |         var str;
  99 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 100 | 
 101 |         pipeout = Components.classes["@mozilla.org/file/local;1"]
 102 |                 .createInstance(Components.interfaces.nsIFile);
 103 |         path = this.prefs.getCharPref("lyxserver");
 104 |         pipeout.initWithPath(path + ".out");
 105 |         if (!pipeout.exists()) {
 106 |             win.alert("The specified LyXServer pipe does not exist.");
 107 |             return null;
 108 |         }
 109 |         pipeout_stream = Components.classes["@mozilla.org/network/file-input-stream;1"]
 110 |                 .createInstance(Components.interfaces.nsIFileInputStream);
 111 |         cstream = Components.classes["@mozilla.org/intl/converter-input-stream;1"]
 112 |                 .createInstance(Components.interfaces.nsIConverterInputStream);
 113 |         pipeout_stream.init(pipeout, -1, 0, 0);
 114 |         cstream.init(pipeout_stream, "UTF-8", 0, 0);
 115 |         return cstream;
 116 |     },
 117 | 
 118 |     /*
 119 |      * FIXME: two version of lyxPipeWriteRead and lyxAskServer, one combo works in Linux other in Windows
 120 |      * Problem: I don't know why.
 121 |      */
 122 |     lyxPipeWriteAndRead : function(command) {
 123 |         // Works in Windows
 124 |         // writing to lyxpipe.in
 125 |         var pipein, pipein_stream, msg, str, data;
 126 | 
 127 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 128 | 
 129 |         try {
 130 |             pipein = Components.classes["@mozilla.org/file/local;1"]
 131 |                     .createInstance(Components.interfaces.nsIFile);
 132 |             pipein.initWithPath(this.prefs.getCharPref("lyxserver") + ".in");
 133 |         } catch (e) {
 134 |             win.alert("Wrong path to Lyx server:\n" +
 135 |                       this.prefs.getCharPref("lyxserver") + "\n" + e);
 136 |             return false;
 137 |         }
 138 | 
 139 |         if (!pipein.exists()) {
 140 |             win
 141 |                     .alert("Wrong path to Lyx server.\nSet the path specified in Lyx preferences.");
 142 |             return false;
 143 |         }
 144 | 
 145 |         try {
 146 |             pipein_stream = Components.classes["@mozilla.org/network/file-output-stream;1"]
 147 |                     .createInstance(Components.interfaces.nsIFileOutputStream);
 148 |             pipein_stream.init(pipein, 0x02 | 0x10, 0666, 0); // write, append
 149 |         } catch (e) {
 150 |             win.alert("Failed to:\n" + command);
 151 |             return false;
 152 |         }
 153 | 
 154 |         msg = "LYXCMD:lyz:" + command + "\n";
 155 |         pipein_stream.write(msg, msg.length);
 156 |         pipein_stream.close();
 157 | 
 158 |         data = "";
 159 |         str = {};
 160 | 
 161 |         // ----- open again
 162 |         var pipeout = Components.classes["@mozilla.org/file/local;1"]
 163 |                 .createInstance(Components.interfaces.nsIFile);
 164 |         var path = this.prefs.getCharPref("lyxserver");
 165 |         pipeout.initWithPath(path + ".out");
 166 |         if (!pipeout.exists()) {
 167 |             win.alert("The specified LyXServer pipe does not exist.");
 168 |             return null;
 169 |         }
 170 |         var pipeout_stream = Components.classes["@mozilla.org/network/file-input-stream;1"]
 171 |                 .createInstance(Components.interfaces.nsIFileInputStream);
 172 |         var cstream = Components.classes["@mozilla.org/intl/converter-input-stream;1"]
 173 |                 .createInstance(Components.interfaces.nsIConverterInputStream);
 174 |         pipeout_stream.init(pipeout, -1, 0, 0);
 175 |         cstream.init(pipeout_stream, "UTF-8", 0, 0);
 176 | 
 177 |         cstream.readString(-1, str); // read the whole file and put it in str.value
 178 |         data = str.value;
 179 |         cstream.close();
 180 |         return data;
 181 |     },
 182 |     
 183 |     lyxAskServer : function(command) {
 184 |         // Works in Windows
 185 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 186 | 
 187 |         try {
 188 |             return this.lyxPipeWriteAndRead(command);
 189 |         } catch (x) {
 190 |             win.alert("SERVER ERROR:\n" + x);
 191 |             return false;
 192 |         }
 193 |         return true;
 194 |     },
 195 |     
 196 |     _lyxPipeWriteAndRead: function(command,cstream){
 197 |         // Works in Linux 
 198 |         // writing to lyxpipe.in
 199 |         var pipein, pipein_stream, msg, str, data;
 200 |             
 201 |         var win = this.wm.getMostRecentWindow("navigator:browser"); 
 202 |         
 203 |         try {
 204 |             pipein = Components.classes["@mozilla.org/file/local;1"]
 205 |             .createInstance(Components.interfaces.nsIFile);
 206 |             pipein.initWithPath(this.prefs.getCharPref("lyxserver")+".in");
 207 |         } catch(e){
 208 |             win.alert("Wrong path to Lyx server:\n"+this.prefs.getCharPref("lyxserver")+"\n"+e);
 209 |             return false;
 210 |         }
 211 |         
 212 |         if(!pipein.exists()){
 213 |             win.alert("Wrong path to Lyx server.\nSet the path specified in Lyx preferences.");
 214 |             return false;
 215 |         }
 216 |         
 217 |         try {
 218 |             pipein_stream = Components.classes["@mozilla.org/network/file-output-stream;1"]
 219 |             .createInstance(Components.interfaces.nsIFileOutputStream);
 220 |             pipein_stream.init(pipein, 0x02| 0x10, 0666, 0); // write, append
 221 |         } catch(e){
 222 |             win.alert("Failed to:\n"+command);
 223 |             return false;
 224 |         }
 225 |         
 226 |         msg = "LYXCMD:lyz:"+command+"\n";
 227 |         pipein_stream.write(msg, msg.length);
 228 |         pipein_stream.close();
 229 |         
 230 |             data = "";
 231 |         str = {};
 232 |         cstream.readString(-1, str); // read the whole file and put it in str.value
 233 |         data = str.value;
 234 |         cstream.close();
 235 |         return data;
 236 |     },
 237 |     
 238 |     _lyxAskServer: function(command){
 239 |         // Works in Linux
 240 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 241 |         var cstream;
 242 |         try {
 243 |             cstream = this.lyxPipeInit();            
 244 |         } catch (x) {
 245 |             win.alert("SERVER ERROR:\n"+x);
 246 |             return null;
 247 |         }
 248 |         try {
 249 |             return this._lyxPipeWriteAndRead(command,cstream);    
 250 |         } catch (x) {
 251 |             win.alert("SERVER ERROR:\n"+x);
 252 |             return null;
 253 |         }
 254 |         return True;
 255 |     },
 256 | 
 257 |     settings: async function() {
 258 |         var translation = new Zotero.Translate("export")
 259 |         var translators = await translation.getTranslators()
 260 | 
 261 |         var params, inn, out;
 262 |         this.wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
 263 |                 .getService(Components.interfaces.nsIWindowMediator);
 264 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 265 |         params = {
 266 |             inn : {
 267 |                 citekey : this.prefs.getCharPref("citekey"),
 268 |                 createcitekey: this.prefs.getBoolPref("createCiteKey"),
 269 |                 lyxserver : this.prefs.getCharPref("lyxserver"),
 270 |                 selectedTranslator:this.prefs.getCharPref("selectedTranslator"),
 271 |                 translators: translators
 272 |             },
 273 |             out : null
 274 |         };
 275 |         win.openDialog("chrome://lyz/content/settings.xul", "",
 276 |                 "chrome, dialog, modal, centerscreen, resizable=yes", params);
 277 | 
 278 |         if (params.out) {
 279 |             this.prefs.setCharPref("citekey", params.out.citekey);
 280 |             this.prefs.setCharPref("lyxserver", params.out.lyxserver);
 281 |             this.prefs.setBoolPref("createCiteKey", params.out.createcitekey);
 282 |             this.prefs.setCharPref("selectedTranslator",params.out.selectedTranslator);
 283 |             this.prefs.setBoolPref("useJournalAbbreviation",params.out.useJournalAbbreviation);
 284 |         }
 285 |     },
 286 | 
 287 |     exportToBibliography : function(item) {
 288 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 289 |         var format = "bibliography=http://www.zotero.org/styles/chicago-author-date";
 290 |         var biblio = Zotero.QuickCopy.getContentFromItems([ item ], format);
 291 |         return biblio.text;
 292 |     },
 293 | 
 294 |     syncBibtexKeyFormat : function(doc, oldkeys, newkeys) {
 295 |         var cstream, outstream, re, lyxfile, oldpath, tmpfile;
 296 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 297 |         lyxfile = Components.classes["@mozilla.org/file/local;1"]
 298 |                 .createInstance(Components.interfaces.nsIFile);
 299 |         // LyX returns linux style paths, which don't work on Windows
 300 |         oldpath = doc;
 301 |         try {
 302 |             lyxfile.initWithPath(doc);
 303 |         } catch (e) {
 304 |             doc = doc.replace(/\//g, "\\");
 305 |             lyxfile.initWithPath(doc);
 306 |         }
 307 |         if (!lyxfile.exists()) {
 308 |             win.alert("The specified " + doc + " does not exist.");
 309 |             return;
 310 |         }
 311 |         //remove old backup file
 312 |         try {
 313 |             tmpfile = Components.classes["@mozilla.org/file/local;1"]
 314 |                     .createInstance(Components.interfaces.nsIFile);
 315 |             tmpfile.initWithPath(doc + ".lyz~");
 316 |             if (tmpfile.exists()) {
 317 |                 tmpfile.remove(1);
 318 |             }
 319 |         } catch (e) {
 320 |             win.alert("Please report the following error:\n" + e);
 321 |             return;
 322 |         }
 323 |         // make new backup
 324 |         lyxfile.copyTo(null, lyxfile.leafName + ".lyz~");
 325 |         // that main procedure
 326 |         win.alert("Updating " + doc);
 327 |         try {
 328 |             cstream = this.fileReadByLine(doc + ".lyz~");
 329 |             outstream = this.fileWrite(doc)[1];
 330 |             var line = {}, lines = [], hasmore;
 331 |             re = /key\s\"([^\"].*)\"/;
 332 |             do {
 333 |                 hasmore = cstream.readLine(line);
 334 |                 var tmp = line.value;
 335 |                 if (tmp.search('key') === 0) {
 336 |                     var tmpkeys = re.exec(tmp)[1].split(',');
 337 |                     for ( var i = 0; i < tmpkeys.length; i++) {
 338 |                         var o = tmpkeys[i];
 339 |                         var n = newkeys[oldkeys[tmpkeys[i]]];
 340 |                         // user can have citations from alternative bibtex file
 341 |                         // ignore those
 342 |                         if (n !== undefined)
 343 |                             tmp = tmp.replace(o, n);
 344 |                     }
 345 |                 }
 346 |                 outstream.writeString(tmp + "\n");
 347 |             } while (hasmore);
 348 | 
 349 |             cstream.close();
 350 |         } catch (e) {
 351 |             win.alert("Please report the following error:\n" + e);
 352 |             var oldfile = Components.classes["@mozilla.org/file/local;1"]
 353 |                     .createInstance(Components.interfaces.nsIFile);
 354 |             oldfile.initWithPath(doc);
 355 |             if (oldfile.exists()) {
 356 |                 oldfile.remove(1);
 357 |             }
 358 |             // make new backup
 359 |             tmpfile.copyTo(null, lyxfile.leafName);
 360 | 
 361 |         }
 362 |     },
 363 | 
 364 |     writeBib : function(bib, entries_text, zids) {
 365 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 366 |         if (!this.replace) {//will append to the file
 367 |             var bib_backup = this.fileBackup(bib);
 368 |             if (!bib_backup) {
 369 |                 win.alert("Backup failed.");
 370 |                 return;
 371 |             }
 372 |             cstream = this.fileReadByLine(bib_backup);
 373 |             outstream = this.fileWrite(bib)[1];
 374 |             var line = {}, lines = [], hasmore;
 375 |             cstream.readLine(line);
 376 |             outstream.writeString(line.value + " " + zids.join(" ") + "\n");
 377 |             do {
 378 |                 hasmore = cstream.readLine(line);
 379 |                 outstream.writeString(line.value + "\n");
 380 |             } while (hasmore);
 381 |             outstream.writeString(entries_text);
 382 |             outstream.close();
 383 |             cstream.close();
 384 |             return;
 385 |         }
 386 |         var fbibtex_stream, cstream;
 387 |         [ fbibtex_stream, cstream ] = this.fileWrite(bib);
 388 |         var data = zids.join(" ") + "\n" + entries_text;
 389 |         cstream.writeString(data);
 390 |         cstream.close();
 391 |         fbibtex_stream.close();
 392 |         this.replace = false;
 393 |     },
 394 | 
 395 |     objectMethods : function(obj) {
 396 |         var output = '';
 397 |         for (var property in object) {
 398 |             output += property + ': ' + object[property] + '\n';
 399 |         }
 400 |         return output;
 401 |     },
 402 | 
 403 |     getZoteroItem : function(key) {
 404 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 405 |         
 406 |         var keyhash = Zotero.Items.parseLibraryKeyHash(key);
 407 |         return Zotero.Items.getByLibraryAndKey(keyhash.libraryID, keyhash.key);
 408 |     },
 409 | 
 410 |     getFilePicker: async function() {
 411 |         const version = /^(\d+)\.(\d+)\.(\d+)/.exec(Zotero.version)
 412 |         const preFP = Zotero.platformMajorVersion < 60
 413 |         let fp;
 414 |         if (preFP) {
 415 |             var nsIFilePicker = Components.interfaces.nsIFilePicker
 416 |             fp = Components.classes["@mozilla.org/filepicker;1"]
 417 |                     .createInstance(nsIFilePicker)
 418 |         } else {
 419 |             let FilePicker;
 420 |             if (
 421 |                 version["1"] == "5" &&
 422 |                 version["2"] == "0" &&
 423 |                 parseInt(version["3"], 10) < 97
 424 |             ) {
 425 |               Services.console.logStringMessage("old system")
 426 |                 FilePicker = require('zotero/filePicker').default
 427 |             } else {
 428 |               Services.console.logStringMessage("new system")
 429 |                 FilePicker = require('zotero/modules/filePicker').default
 430 |             }
 431 |             fp = new FilePicker()
 432 |         }
 433 | 
 434 |         return [preFP, fp]
 435 |     },
 436 | 
 437 |     dialog_FilePickerOpen: async function(win, title, filter_title, filter) {
 438 |         var [preFP, fp] = await this.getFilePicker()
 439 |         fp.init(win, title, fp.modeOpen);
 440 |         fp.appendFilter(filter_title, filter);
 441 |         if (preFP) {
 442 |             var res = fp.show()
 443 |         } else {
 444 |             var res = await fp.show()
 445 |         }
 446 |         if (res == fp.returnOK) {
 447 |             if (preFP) {
 448 |                 return fp.file.path
 449 |             } else {
 450 |                 return fp.file
 451 |             }
 452 |         }
 453 |         return null;
 454 |     },
 455 | 
 456 |     dialog_FilePickerSave: async function(win, title, filter_title, filter) {
 457 |         var [preFP, fp] = await this.getFilePicker()
 458 |         fp.init(win, title, fp.modeSave);
 459 |         fp.appendFilter(filter_title, filter);
 460 |         if (preFP) {
 461 |             var res = fp.show()
 462 |         } else {
 463 |             var res = await fp.show()
 464 |         }
 465 |         var path
 466 |         if (res == fp.returnOK) {
 467 |             // add default extension, guess there must be other way to do it
 468 |             // but this is what came to my mind first
 469 |             if (preFP) {
 470 |                 path = fp.file.path
 471 |             } else {
 472 |                 path = fp.file
 473 |             }
 474 | 
 475 |             if (path.split(".").length < 2) {
 476 |                 // this is weird, but I don't know how to set new path
 477 |                 var file = Components.classes["@mozilla.org/file/local;1"]
 478 |                         .createInstance(Components.interfaces.nsIFile);
 479 |                 file.initWithPath(path + ".bib");
 480 |                 file.create(file.NORMAL_FILE_TYPE, 0666);
 481 |                 return file;
 482 |             } else {// overwrite the file if it exists
 483 |                 this.replace = true;
 484 |                 return path
 485 |             }
 486 |         } else if (res == fp.returnReplace) {
 487 |             this.replace = true;
 488 |             if (preFP) {
 489 |                 path = fp.file.path
 490 |             } else {
 491 |                 path = fp.file
 492 |             }
 493 |             return path
 494 |         } else {
 495 |             return false;
 496 |         }
 497 |     },
 498 | 
 499 |     fileReadByLine : function(path) {
 500 |         var file = Components.classes["@mozilla.org/file/local;1"]
 501 |                 .createInstance(Components.interfaces.nsIFile);
 502 |         file.initWithPath(path);
 503 |         if (!file.exists()) {
 504 |             win.alert("File " + path + " does not exist.");
 505 |             return;
 506 |         }
 507 |         var file_stream = Components.classes["@mozilla.org/network/file-input-stream;1"]
 508 |                 .createInstance(Components.interfaces.nsIFileInputStream);
 509 |         cstream = Components.classes["@mozilla.org/intl/converter-input-stream;1"]
 510 |                 .createInstance(Components.interfaces.nsIConverterInputStream);
 511 |         file_stream.init(file, -1, 0, 0);
 512 |         cstream.init(file_stream, "UTF-8", 1024, 0xFFFD);
 513 |         cstream.QueryInterface(Components.interfaces.nsIUnicharLineInputStream);
 514 |         return cstream;
 515 |     },
 516 | 
 517 |     fileBackup : function(path) {
 518 |         var oldfile = Components.classes["@mozilla.org/file/local;1"]
 519 |                 .createInstance(Components.interfaces.nsIFile);
 520 |         oldfile.initWithPath(path);
 521 | 
 522 |         var file = Components.classes["@mozilla.org/file/local;1"]
 523 |                 .createInstance(Components.interfaces.nsIFile);
 524 |         file.initWithPath(path + ".lyz~");
 525 |         if (file.exists()) {
 526 |             file.remove(1);
 527 |         }
 528 |         // make new backup
 529 |         oldfile.copyTo(null, oldfile.leafName + ".lyz~");
 530 |         return path + ".lyz~";
 531 |     },
 532 | 
 533 |     fileWrite : function(path) {
 534 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 535 |         var file = Components.classes["@mozilla.org/file/local;1"]
 536 |                 .createInstance(Components.interfaces.nsIFile);
 537 |         file.initWithPath(path);
 538 |         var file_stream = Components.classes["@mozilla.org/network/file-output-stream;1"]
 539 |                 .createInstance(Components.interfaces.nsIFileOutputStream);
 540 | 
 541 |         file_stream.init(file, 0x02 | 0x08 | 0x20, 0666, 0);// write , truncate
 542 |         //this comes from Zotero's translate.js
 543 |         var cstream = Components.classes["@mozilla.org/intl/converter-output-stream;1"]
 544 |                 .createInstance(Components.interfaces.nsIConverterOutputStream);
 545 |         cstream.init(file_stream, "UTF-8", 0, 0);//1024, "?".charCodeAt(0));
 546 |         file_stream.write("\xEF\xBB\xBF", "\xEF\xBB\xBF".length);
 547 |         return [ file_stream, cstream ];
 548 |     },
 549 | 
 550 |     test: function() {
 551 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 552 |         var t = prompt("Command", "server-get-filename");
 553 |         if (!t) {
 554 |             win.alert("Error: " + t);
 555 |             return;
 556 |         }
 557 |         try {
 558 |             if (this.os == "Win"){
 559 |                 t = this.lyxAskServer(t);
 560 |             } else {
 561 |                 t = this._lyxAskServer(t);
 562 |             }
 563 |             win.alert("RESPONSE: " + t);
 564 |         } catch (e) {
 565 |             win.alert("Error connecting to lyxserver...\n" + e +
 566 |                       "\nTry again.");
 567 |         }
 568 |         win.alert("DONE");
 569 |     },
 570 | 
 571 |     checkDocInDB: async function() {
 572 |         var doc, res;
 573 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 574 |         doc = this.lyxGetDoc();
 575 |         if (!doc) {
 576 |             win.alert("Could not retrieve document name.");
 577 |             return null;
 578 |         }
 579 |         res = await this.DB.queryAsync("SELECT doc,bib FROM docs WHERE doc = ?",[doc]);
 580 |         if (res.length === 0) {
 581 |             return [ res, doc ];
 582 |         }
 583 |         return [res[0].bib, doc];
 584 |     },
 585 | 
 586 |     addNewDocument: async function(doc, bib) {
 587 |         await this.DB.queryAsync("INSERT INTO docs (doc,bib) VALUES(?,?)",[doc,bib]);
 588 |     },
 589 | 
 590 |     exportToBibtex: Zotero.Promise.coroutine(function*(items, bib, zids) {
 591 |         // returns hash {id:[citekey,text]}
 592 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 593 |         var text;
 594 | 
 595 |         var callback = function(obj, worked) {
 596 |             text = obj.string;
 597 |         };
 598 | 
 599 |         var translation = new Zotero.Translate.Export;
 600 |         var translatorID = this.prefs.getCharPref("selectedTranslator");
 601 |         translation.setTranslator(translatorID);
 602 |         translation.setHandler("done", callback);
 603 |         
 604 |         if (this.prefs.getBoolPref("use_utf8")){
 605 |             translation.setDisplayOptions({"exportCharset" : "UTF-8"});
 606 |         } else {
 607 |             translation.setDisplayOptions({"exportCharset" : "escape"});
 608 |         }
 609 |         if (this.prefs.getBoolPref("useJournalAbbreviation")){
 610 |             translation.setDisplayOptions({"useJournalAbbreviation" : "True"});
 611 |         }
 612 | 
 613 |         var tmp = [];
 614 |         var newCitekeys = []
 615 |         for ( var i = 0; i < items.length; i++) {
 616 |             // TODO: change to libraryKey
 617 |             var id = Zotero.Items.getLibraryKeyHash(items[i]);
 618 |             translation.setItems([ items[i] ]);
 619 |             // XXX: Not setting value of text
 620 |             yield translation.translate();
 621 |             var ct;
 622 |             var itemOK = true;
 623 |             if (this.prefs.getBoolPref("createCiteKey")===true){
 624 |                 // Workaround entries that have been deleted and added again to Zotero, which means they will have 
 625 |                 // new zotero id and we can't identify them. 
 626 |                     ct = yield this.createCiteKey(id, text, bib, items[i].key, newCitekeys);
 627 |                     newCitekeys.push(ct[0])
 628 |             } else {
 629 |                 var ckre = /.*@[a-z]+\{([^,]+),{1}/;
 630 |                 var key = ckre.exec(text)[1];
 631 |                 ct = [key, text];
 632 |             }
 633 |             if (itemOK) tmp[id] = [ ct[0], ct[1] ];
 634 |         }
 635 | 
 636 |         return tmp;
 637 |     }),
 638 | 
 639 |     createCiteKey: Zotero.Promise.coroutine(function*(id, text, bib, obj_key, keyBlacklist) {
 640 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 641 |         var ckre = /.*@[a-z]+\{([^,]+),{1}/;
 642 |         // TODO if item has been deleted from Zotero and added again it will have a new key
 643 |         // basically no way to know.
 644 |         var oldkey = ckre.exec(text)[1];
 645 |         var dic = [];
 646 |         // current format is 0_XXXXXXX where 0 is "library id", not sure what that is for
 647 |         dic.zotero = id;
 648 |         var citekey;
 649 |         if (this.prefs.getCharPref("citekey") == "zotero") {
 650 |             citekey = id;
 651 |             text = text.replace(oldkey, citekey);
 652 |             return [ citekey, text ];
 653 |         }
 654 |         
 655 |         else if (this.prefs.getCharPref("citekey") == "zoteroShort"){
 656 |             citekey = obj_key;
 657 |             text = text.replace(oldkey,citekey);
 658 |             return [citekey,text];
 659 |         }
 660 | 
 661 |         var creators;
 662 |         var authors;
 663 |         var author;
 664 |         var c = "";
 665 |         var chars = "";
 666 |         var t;
 667 |         var title;
 668 |         var year;
 669 |         var p;
 670 |         citekey = "";
 671 | 
 672 |         // NAME
 673 |         ckre = /author\s?=\s?\{(.*)\},?\n/;
 674 |         creators = ckre.exec(text);
 675 |         if (!creators) {
 676 |             ckre = /editor\s?=\s?\{(.*)\},?\n/;
 677 |             creators = ckre.exec(text);
 678 |         }
 679 |         try {
 680 |             authors = creators[1];
 681 |         } catch (e) {
 682 |             authors = null;
 683 |         }
 684 | 
 685 |         var non_latin;
 686 |         if (authors) {
 687 |             if (authors.split(" and ").length > 1) {
 688 |                 author = authors.split(" and ")[0].split(",");
 689 |                 author = author[0].toLowerCase();
 690 |             } else {
 691 |                 author = authors.split(",");
 692 |                 author = author[0].toLowerCase();
 693 |             }
 694 |             // check for non-latin names
 695 |             if (author[0].charCodeAt() > 7929) {
 696 |                 non_latin = true;
 697 |                 author = author.toSource().split("\\u")[1];
 698 |             }
 699 |             
 700 |             var tmp = "";
 701 |             for ( var i in author) {
 702 |                 if (author[i] in lyz_charmap)
 703 |                     tmp += lyz_charmap[author[i]];
 704 |                 else
 705 |                     tmp += author[i];
 706 |             }
 707 |             author = tmp;
 708 | 
 709 |         } else {
 710 |             author = "";
 711 |         }
 712 | 
 713 |         dic.author = author;
 714 | 
 715 |         // TITLE
 716 |         if (non_latin) {
 717 |             title = "";
 718 |         } else {
 719 |             ckre = /title = \{(.*)\},\n/;
 720 |             t = ckre.exec(text)[1].toLowerCase();
 721 |             t = t.replace(/[^a-z0-9\s]/g, "");
 722 |             t = t.split(" ");
 723 |             t.reverse();
 724 |             title = t.pop();
 725 |             // the if statement is there because of short titles, e.g. Ema
 726 |             if (title < 6) {// the, a, on, about
 727 |                 if (t.length > 0)
 728 |                     title += t.pop();
 729 |             }
 730 |             if (title.length < 7) {
 731 |                 if (t.length > 0)
 732 |                     title += t.pop();
 733 |             }
 734 |         }
 735 |         dic.title = title;
 736 |         // YEAR
 737 |         ckre = /[\s,]+(year|date)\s*=\s*\{\D*(\d+)[^\}]*\},?/;
 738 |         try {
 739 |             year = ckre.exec(text)[2].replace(" ", "");
 740 |         } catch (e) {
 741 |             year = "";
 742 |         }
 743 |         dic.year = year;
 744 |         // custom cite key
 745 |         p = this.prefs.getCharPref("citekey").split(" ");
 746 |         for ( var i = 0; i < p.length; i++) {
 747 |             if (p[i] in dic) {
 748 |                 citekey += dic[p[i]];
 749 |             } else
 750 |                 citekey += p[i];
 751 |         }
 752 | 
 753 |         var re = /\\.\{/g;
 754 |         citekey = citekey.replace(re, "");
 755 |         re = /[^a-z0-9\!\$\&\*\+\-\.\/\:\;\<\>\?\[\]\^\_\`\|]+/g;
 756 |         citekey = citekey.replace(re, "");
 757 |         //check if cite key exists
 758 |         var testKey = citekey
 759 |         var count = 1
 760 |         while (true) {
 761 |             count = count + 1
 762 |             if (keyBlacklist.indexOf(testKey) != -1) {
 763 |                 testKey = citekey + count
 764 |                 continue
 765 |             } else {
 766 |                 var res = yield this.DB.queryAsync("SELECT key,zid FROM keys WHERE bib=? AND key=? AND zid<>?",[bib,testKey,id]);
 767 |                 if (res.length > 0) {
 768 |                     testKey = citekey + count
 769 |                     continue
 770 |                 } else {
 771 |                     citekey = testKey
 772 |                     break
 773 |                 }
 774 |             }
 775 |         }
 776 |         text = text.replace(oldkey, citekey);
 777 |         return [ citekey, text ];
 778 |     }),
 779 | 
 780 |     checkAndCite: async function() {
 781 |         // export citation to Bibtex
 782 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 783 |         var zitems = win.ZoteroPane.getSelectedItems();
 784 |         // FIXME: this should be called bellow, but it returns empty there (???)
 785 |         if (!zitems.length) {
 786 |             win.alert("Please select at least one citation.");
 787 |             return;
 788 |         }
 789 |         // check document name
 790 |         var res = await this.checkDocInDB();
 791 |         var bib = res[0];
 792 |         var doc = res[1];
 793 |         var items;
 794 |         var keys;
 795 |         var entries_text = "";
 796 |         var citekey;
 797 |         var text;
 798 |         if (bib.length === 0) {
 799 |             t = "Press OK to create new BibTeX database.\n";
 800 |             t += "Press Cancel to select from your existing databases\n";
 801 | 
 802 |             // FIXME: the buttons don't show correctly, STD_YES_NO_BUTTONS doesn't work
 803 |             res = win.confirm(t, "BibTex database selection");
 804 |             if (res) {
 805 |                 bib = await this.dialog_FilePickerSave(win,
 806 |                         "Select Bibtex file for " + doc, "Bibtex", "*.bib");
 807 |                 if (!bib)
 808 |                     return;
 809 | 
 810 |             } else {
 811 |                 bib = await this.dialog_FilePickerOpen(win,
 812 |                         "Select Bibtex file for " + doc, "Bibtex", "*.bib");
 813 |                 if (!bib)
 814 |                     return;
 815 |             }
 816 | 
 817 |             if (bib)
 818 |                 await this.addNewDocument(doc, bib);
 819 |             else
 820 |                 return;//file dialog canceled
 821 |         }
 822 |         items = await this.exportToBibtex(zitems, bib);
 823 |         keys = [];
 824 |         var zids = [];
 825 | 
 826 |         for ( var zid in items) {
 827 |             citekey = items[zid][0];
 828 |             text = items[zid][1];
 829 |             keys.push(citekey);
 830 |             //check database, if not in, append to entries_text
 831 |             //single key can be associated with several bibtex files
 832 |             res = await this.DB.queryAsync("SELECT key FROM keys WHERE bib=? AND zid=?",[bib,zid]);
 833 | 
 834 |             if (res.length === 0) {
 835 |                 await this.DB.queryAsync("INSERT INTO keys VALUES(null,?,?,?)",[citekey,bib,zid]);
 836 |                 zids.push(zid);
 837 |                 entries_text += text;
 838 |             } else if (res[0].key != citekey) {
 839 |                 var ask = win
 840 |                         .confirm(
 841 |                                 "Zotero record has been changed.\n" +
 842 |                                 "Press OK to run 'Update BibTeX' and insert the citation.\n" +
 843 |                                 "Press Cancel to refrain from any action.",
 844 |                                 "Zotero record changed!");
 845 |                 if (ask) {
 846 |                     // FIXME: started to act weird
 847 |                     var xy = this.lyxGetPos();
 848 |                     this.updateBibtexAll();
 849 |                     if (this.os == "Win"){
 850 |                         this.lyxAskServer("server-set-xy:" + xy);
 851 |                     } else {
 852 |                         this._lyxAskServer("server-set-xy:" + xy);
 853 |                     }
 854 |                 } else {
 855 |                     return;
 856 |                 }
 857 |             }
 858 |         }
 859 |         if (!entries_text == "") {
 860 |             this.writeBib(bib, entries_text, zids);
 861 |         }
 862 |         
 863 |         if (this.os == "Win"){
 864 |             res = this.lyxAskServer("citation-insert:" + keys.join(","));
 865 |         } else {
 866 |             res = this._lyxAskServer("citation-insert:" + keys.join(","));
 867 |         }
 868 |     },
 869 | 
 870 |     updateBibtexAll: Zotero.Promise.coroutine(function*() {
 871 |         //first update from the bibtex file
 872 |         
 873 |         yield this.updateFromBibtexFile();
 874 |         // update when zotero items are modified
 875 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 876 |         var res = yield this.checkDocInDB();
 877 |         var doc = res[1];
 878 |         var bib = res[0];
 879 |         if (!bib) {
 880 |             win.alert("There is no BibTeX database associated with the active LyX document: " +
 881 |                       doc);
 882 |             return;
 883 |         }
 884 |         var citekey = this.prefs.getCharPref("citekey");
 885 | 
 886 |         
 887 |         var p = win.confirm("You are going to update BibTeX database:\n\n" +
 888 |                             bib + "\n\nCurrent BibTex key format \"" + citekey +
 889 |                             "\" will be used.\nDo you want to continue?");
 890 |         if (p) {
 891 |             // get all ids for the bibtex file
 892 |             var ids_h = yield this.DB.queryAsync("SELECT zid,key FROM keys WHERE bib=? GROUP BY zid",[bib]);
 893 |             var ids = [];
 894 |             var zids = [];
 895 |             var oldkeys = [];
 896 |             var zid;
 897 |             for ( var i = 0; i < ids_h.length; i++) {
 898 |                 zid = ids_h[i].zid;
 899 |                 var item = this.getZoteroItem(zid);
 900 |                 ids.push(item);
 901 |                 zids.push(zid);
 902 |                 oldkeys[ids_h[i].key] = zid;
 903 |             }
 904 | 
 905 |             var ex = yield this.exportToBibtex(ids, bib, zids);
 906 |             zids = [];
 907 |             var newkeys = [];
 908 |             var text = "";
 909 |             for ( var id in ex) {
 910 |                 text += ex[id][1];
 911 |                 zids.push(id);
 912 |                 newkeys[id] = ex[id][0];
 913 |             }
 914 |             if (!(oldkeys.length == newkeys.length)) {
 915 |                 win.alert("Aborting");
 916 |                 return;
 917 |             }
 918 |             this.replace = true;
 919 | 
 920 |             // now is time to update db, bibtex and lyx
 921 |             for ( zid in newkeys) {
 922 |                 yield this.DB.queryAsync("UPDATE keys SET key=? WHERE zid=? AND bib=?",[newkeys[zid],zid,bib]);
 923 |             }
 924 |             this.writeBib(bib, text, zids);
 925 |             res = win
 926 |                     .confirm("Your BibTeX database " + bib +
 927 |                              " has been updated.\n" +
 928 |                              "Do you also want to update the associated LyX documents?\n" +
 929 |                              "This is only necessary when any author, title or year has been modified,\n" +
 930 |                              "or when the BibTex key format has been changed.");
 931 |             if (!res)
 932 |                 return;
 933 |             
 934 |             if (this.os == "Win"){
 935 |                 this.lyxAskServer("buffer-write");
 936 |                 this.lyxAskServer("buffer-close");
 937 |             } else {
 938 |                 this._lyxAskServer("buffer-write");
 939 |                 this._lyxAskServer("buffer-close");
 940 |             }
 941 |             
 942 |             this.syncBibtexKeyFormat(doc, oldkeys, newkeys);
 943 |             if (this.os == "Win"){
 944 |                 this.lyxAskServer("file-open:" + doc);
 945 |             } else {
 946 |                 this._lyxAskServer("file-open:" + doc);
 947 |             }
 948 |             
 949 |         }
 950 |     }),
 951 | 
 952 |     updateFromBibtexFile: Zotero.Promise.coroutine(function*() {
 953 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 954 |         var res = yield this.checkDocInDB();
 955 |         var doc = res[1];
 956 |         var bib = res[0];
 957 |         if (!bib) {
 958 |             win.alert("There is no BibTeX database associated with the active LyX document: "+ doc);
 959 |             return;
 960 |         }
 961 |         var cstream = this.fileReadByLine(bib);
 962 |         var line = {};
 963 |         cstream.readLine(line); // read the whole file and put it in str.value
 964 |         line = line.value;
 965 |         cstream.close();
 966 |         var ar = line.trim().split(" ");
 967 |         var info = 0;
 968 |         for ( var i = 0; i < ar.length; i++) {
 969 |             var zid = ar[i];
 970 |             res = yield this.DB.queryAsync("SELECT * FROM keys WHERE zid=? AND bib=?",[zid,bib]);
 971 | 
 972 |             if (res.length === 0) {
 973 |                 info+=1;
 974 |                 // key=zid is not right, but it will be updated when updateBibtex is run
 975 |                 yield this.DB.queryAsync("INSERT INTO keys VALUES(null,?,?,?)",[zid,bib,zid]);
 976 |             }
 977 |         }
 978 |         if (info > 0)
 979 |             win.alert(info + " item(s) changed or added.");
 980 |     }),
 981 | 
 982 |     dbDeleteBib: Zotero.Promise.coroutine(function*() {
 983 |         var win = this.wm.getMostRecentWindow("navigator:browser");
 984 |         var dic = yield this.DB.queryAsync("SELECT bib FROM keys GROUP BY bib");
 985 |         var params = {
 986 |             inn : {
 987 |                 items : dic,
 988 |                 type : "bib"
 989 |             },
 990 |             out : null
 991 |         };
 992 |         var res = win.openDialog("chrome://lyz/content/select.xul", "",
 993 |                 "chrome, dialog, modal, centerscreen, resizable=yes", params);
 994 |         if (!params.out)
 995 |             return;
 996 |         var bib;
 997 |         if (params.out) {
 998 |             bib = params.out.item;
 999 |         }
1000 |         if (!bib) {
1001 |             return
1002 |         }
1003 |         res = win.confirm("You are about to delete record of BibTeX database:\n" +
1004 |                           bib +
1005 |                           "\nRecord about associated documents will also be deleted.\n",
1006 |                           "Deleting LyZ database record");
1007 |         if (!res)
1008 |             return;
1009 |         yield this.DB.queryAsync("DELETE FROM docs WHERE bib=?",[bib]);
1010 |         yield this.DB.queryAsync("DELETE FROM keys WHERE bib=?",[bib]);
1011 |     }),
1012 | 
1013 |     dbDeleteDoc: Zotero.Promise.coroutine(function*(doc, bib) {
1014 |         var win = this.wm.getMostRecentWindow("navigator:browser");
1015 |         var dic = yield this.DB.queryAsync("SELECT doc FROM docs");
1016 |         var params = {
1017 |             inn : {
1018 |                 items : dic,
1019 |                 type : "doc"
1020 |             },
1021 |             out : null
1022 |         };
1023 |         var res = win.openDialog("chrome://lyz/content/select.xul", "",
1024 |                 "chrome, dialog, modal, centerscreen, resizable=yes", params);
1025 |         if (!params.out)
1026 |             return;
1027 | 
1028 |         if (params.out) {
1029 |             doc = params.out.item;
1030 |         }
1031 |         if (!doc) {
1032 |             return
1033 |         }
1034 |         res = win.confirm("Do you really want to delete the LyZ database record of the document\n" +
1035 |                           doc + "?");
1036 |         if (!res)
1037 |             return;
1038 |         yield this.DB.queryAsync("DELETE FROM docs WHERE doc=?",[doc]);
1039 |     }),
1040 | 
1041 |     dbRenameDoc: async function() {
1042 |         var win = this.wm.getMostRecentWindow("navigator:browser");
1043 |         var dic = await this.DB.queryAsync("SELECT id,doc FROM docs");
1044 |         var params = {
1045 |             inn : {
1046 |                 items : dic,
1047 |                 type : "doc"
1048 |             },
1049 |             out : null
1050 |         };
1051 |         var res = win.openDialog("chrome://lyz/content/select.xul", "",
1052 |                 "chrome, dialog, modal, centerscreen, resizable=yes", params);
1053 |         if (!params.out)
1054 |             return;
1055 |         var doc;
1056 |         if (params.out) {
1057 |             doc = params.out.item;
1058 |         }
1059 |         var newfname = await this.dialog_FilePickerOpen(win,
1060 |                 "Select LyX document for " + doc, "LyX", "*.lyx")
1061 |         // have to replace \ with / on windows because lyxserver returns unix style paths
1062 |         newfname = newfname.replace(/\\/g, "/");
1063 |         if (!newfname)
1064 |             return;
1065 |         await this.DB.queryAsync("UPDATE docs SET doc=? WHERE doc=?",[newfname,doc]);
1066 |     },
1067 | 
1068 |     dbRenameBib: async function() {
1069 |         var win = this.wm.getMostRecentWindow("navigator:browser");
1070 |         var dic = await this.DB.queryAsync("SELECT DISTINCT bib FROM docs");
1071 |         var params = {
1072 |             inn : {
1073 |                 items : dic,
1074 |                 type : "bib"
1075 |             },
1076 |             out : null
1077 |         };
1078 |         var res = win.openDialog("chrome://lyz/content/select.xul", "",
1079 |                 "chrome, dialog, modal, centerscreen, resizable=yes", params);
1080 |         if (!params.out)
1081 |             return;
1082 |         var bib;
1083 |         if (params.out) {
1084 |             bib = params.out.item;
1085 |         }
1086 |         newfname = await this.dialog_FilePickerOpen(win, "Select Bibtex file for " +
1087 |                                               bib, "Bibtex", "*.bib")
1088 |         if (!newfname)
1089 |             return;
1090 |         await this.DB.queryAsync("UPDATE docs SET bib=? WHERE bib=?",[newfname,bib]);
1091 |         await this.DB.queryAsync("UPDATE keys SET bib=? WHERE bib=?",[newfname,bib]);
1092 |     },
1093 | 
1094 |     shutdown: Zotero.Promise.coroutine(function*() {
1095 |         yield Zotero.Lyz.DB.closeDatabase(true)
1096 |     }),
1097 | 
1098 |     migrateToZotero5: Zotero.Promise.coroutine(function*(context) {
1099 |         yield Zotero.uiReadyPromise
1100 |         if (Zotero.Libraries.userLibraryID === 0) {
1101 |             this.prefs.setBoolPref('checkZotero5Migration', false)
1102 |             return
1103 |         }
1104 |         res = yield this.DB.queryAsync("SELECT key FROM keys WHERE zid GLOB '0_*'")
1105 |         if (res.length === 0) {
1106 |             this.prefs.setBoolPref('checkZotero5Migration', false)
1107 |             return
1108 |         }
1109 | 
1110 |         var prompts = Components.
1111 |             classes['@mozilla.org/embedcomp/prompt-service;1'].
1112 |             getService(Components.interfaces.nsIPromptService)
1113 | 
1114 |         var doNotShow = { value: false }
1115 |         var pressedOK = prompts.confirmCheck(
1116 |             null,
1117 |             'LyZ: legacy database detected',
1118 |             'LyZ has detected Zotero 4.0 entries in its database. These entries will prevent LyZ ' +
1119 |                 'from creating a .bib file. Do you want LyZ to try to update the ' +
1120 |                 'entries to match Zotero 5 items? Consider backing up your Zotero data directory ' +
1121 |                 'before doing so. It can be accessed from the "Files and Folders" in the ' +
1122 |                 'Advanced section of Zotero\'s preferences. Some cite keys may change during ' +
1123 |                 'this process.',
1124 |             'Do not show this prompt in the future',
1125 |             doNotShow)
1126 |         var win = this.wm.getMostRecentWindow("navigator:browser");
1127 |         if (!pressedOK) {
1128 |             if (doNotShow.value === true) {
1129 |                 win.alert('To show this dialog again in the future, reset ' +
1130 |                           'extensions.lyz.checkZotero5Migration in the config editor available ' +
1131 |                           'in Zotero\'s Advanced preferences section.')
1132 |                 this.prefs.setBoolPref('checkZotero5Migration', false)
1133 |             }
1134 |             return
1135 |         } else {
1136 |             win.alert('LyZ database migration will begin now. Do not exit Zotero until Lyz ' +
1137 |                       'indicates that the migration is complete.')
1138 |         }
1139 | 
1140 |         var results = yield this.DB.queryAsync("SELECT key,bib,zid FROM keys WHERE zid GLOB '0_*'")
1141 |         var newZid, conflicts, finalKey, tmpDroppedKeys
1142 |         var droppedKeys = []
1143 |         for (let idx = 0; idx < results.length; idx++) {
1144 |             newZid = String(Zotero.Libraries.userLibraryID) + results[idx].zid.slice(1)
1145 |             finalKey = results[idx].key
1146 |             conflicts = yield this.DB.queryAsync("SELECT key FROM keys WHERE zid=? AND bib=?",
1147 |                                                  [newZid, results[idx].bib])
1148 |             if (conflicts.length > 0) {
1149 |                 tmpDroppedKeys = []
1150 |                 for (let jdx = 0; jdx < conflicts.length; jdx++) {
1151 |                     if (finalKey > conflicts[jdx].key) {
1152 |                         tmpDroppedKeys.push(finalKey)
1153 |                         finalKey = conflicts[jdx].key
1154 |                     } else {
1155 |                         tmpDroppedKeys.push(conflicts[jdx].key)
1156 |                     }
1157 |                 }
1158 |                 yield this.DB.queryAsync("DELETE FROM keys WHERE zid=? AND bib=?",
1159 |                                          [newZid, results[idx].bib])
1160 |                 for (let jdx = 0; jdx < tmpDroppedKeys.length; jdx++) {
1161 |                     droppedKeys.push([results[idx].bib, tmpDroppedKeys[jdx], finalKey])
1162 |                 }
1163 |             }
1164 |             yield this.DB.queryAsync("UPDATE keys SET zid=?, key=? WHERE zid=? AND key=? AND bib=?",
1165 |                                      [newZid, finalKey, results[idx].zid, results[idx].key,
1166 |                                       results[idx].bib])
1167 |         }
1168 | 
1169 |         this.prefs.setBoolPref('checkZotero5Migration', false)
1170 |         if (droppedKeys.length > 0) {
1171 |             var report = 'Document,Old key,New key\r\n' + droppedKeys.join('\r\n')
1172 | 
1173 |             var reportPath = OS.Path.join(Zotero.DataDirectory.dir, 'lyz_migration.csv')
1174 |             var fbibtex_stream, cstream
1175 |             [ fbibtex_stream, cstream ] = this.fileWrite(reportPath)
1176 |             cstream.writeString(report)
1177 |             cstream.close()
1178 |             fbibtex_stream.close()
1179 | 
1180 |             win = this.wm.getMostRecentWindow("navigator:browser")
1181 |             win.openDialog('chrome://lyz/content/migration5.xul', 'lyz-migration-window',
1182 |                            'chrome, centerscreen',
1183 |                            report)
1184 |         } else {
1185 |             win = this.wm.getMostRecentWindow("navigator:browser")
1186 |             win.alert('Lyz migration complete. No citation keys were changed.')
1187 |         }
1188 |     })
1189 | };
1190 | 
1191 | 
1192 | var lyz_charmap = {
1193 |     "\u00A0" : "~", // NO-BREAK SPACE
1194 |     "\u00A1" : "{\\textexclamdown}", // INVERTED EXCLAMATION MARK
1195 |     "\u00A2" : "{\\textcent}", // CENT SIGN
1196 |     "\u00A3" : "{\\textsterling}", // POUND SIGN
1197 |     "\u00A5" : "{\\textyen}", // YEN SIGN
1198 |     "\u00A6" : "{\\textbrokenbar}", // BROKEN BAR
1199 |     "\u00A7" : "{\\textsection}", // SECTION SIGN
1200 |     "\u00A8" : "{\\textasciidieresis}", // DIAERESIS
1201 |     "\u00A9" : "{\\textcopyright}", // COPYRIGHT SIGN
1202 |     "\u00AA" : "{\\textordfeminine}", // FEMININE ORDINAL INDICATOR
1203 |     "\u00AB" : "{\\guillemotleft}", // LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
1204 |     "\u00AC" : "{\\textlnot}", // NOT SIGN
1205 |     "\u00AD" : "-", // SOFT HYPHEN
1206 |     "\u00AE" : "{\\textregistered}", // REGISTERED SIGN
1207 |     "\u00AF" : "{\\textasciimacron}", // MACRON
1208 |     "\u00B0" : "{\\textdegree}", // DEGREE SIGN
1209 |     "\u00B1" : "{\\textpm}", // PLUS-MINUS SIGN
1210 |     "\u00B2" : "{\\texttwosuperior}", // SUPERSCRIPT TWO
1211 |     "\u00B3" : "{\\textthreesuperior}", // SUPERSCRIPT THREE
1212 |     "\u00B4" : "{\\textasciiacute}", // ACUTE ACCENT
1213 |     "\u00B5" : "{\\textmu}", // MICRO SIGN
1214 |     "\u00B6" : "{\\textparagraph}", // PILCROW SIGN
1215 |     "\u00B7" : "{\\textperiodcentered}", // MIDDLE DOT
1216 |     "\u00B8" : "{\\c\\ }", // CEDILLA
1217 |     "\u00B9" : "{\\textonesuperior}", // SUPERSCRIPT ONE
1218 |     "\u00BA" : "{\\textordmasculine}", // MASCULINE ORDINAL INDICATOR
1219 |     "\u00BB" : "{\\guillemotright}", // RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
1220 |     "\u00BC" : "{\\textonequarter}", // VULGAR FRACTION ONE QUARTER
1221 |     "\u00BD" : "{\\textonehalf}", // VULGAR FRACTION ONE HALF
1222 |     "\u00BE" : "{\\textthreequarters}", // VULGAR FRACTION THREE QUARTERS
1223 |     "\u00BF" : "{\\textquestiondown}", // INVERTED QUESTION MARK
1224 |     "\u00C6" : "{\\AE}", // LATIN CAPITAL LETTER AE
1225 |     "\u00D0" : "{\\DH}", // LATIN CAPITAL LETTER ETH
1226 |     "\u00D7" : "{\\texttimes}", // MULTIPLICATION SIGN
1227 |     "\u00DE" : "{\\TH}", // LATIN CAPITAL LETTER THORN
1228 |     "\u00DF" : "{\\ss}", // LATIN SMALL LETTER SHARP S
1229 |     "\u00E6" : "{\\ae}", // LATIN SMALL LETTER AE
1230 |     "\u00F0" : "{\\dh}", // LATIN SMALL LETTER ETH
1231 |     "\u00F7" : "{\\textdiv}", // DIVISION SIGN
1232 |     "\u00FE" : "{\\th}", // LATIN SMALL LETTER THORN
1233 |     "\u0131" : "{\\i}", // LATIN SMALL LETTER DOTLESS I
1234 |     "\u0132" : "IJ", // LATIN CAPITAL LIGATURE IJ
1235 |     "\u0133" : "ij", // LATIN SMALL LIGATURE IJ
1236 |     "\u0138" : "k", // LATIN SMALL LETTER KRA
1237 |     "\u0149" : "'n", // LATIN SMALL LETTER N PRECEDED BY APOSTROPHE
1238 |     "\u014A" : "{\\NG}", // LATIN CAPITAL LETTER ENG
1239 |     "\u014B" : "{\\ng}", // LATIN SMALL LETTER ENG
1240 |     "\u0152" : "{\\OE}", // LATIN CAPITAL LIGATURE OE
1241 |     "\u0153" : "{\\oe}", // LATIN SMALL LIGATURE OE
1242 |     "\u017F" : "s", // LATIN SMALL LETTER LONG S
1243 |     "\u02B9" : "'", // MODIFIER LETTER PRIME
1244 |     "\u02BB" : "'", // MODIFIER LETTER TURNED COMMA
1245 |     "\u02BC" : "'", // MODIFIER LETTER APOSTROPHE
1246 |     "\u02BD" : "'", // MODIFIER LETTER REVERSED COMMA
1247 |     "\u02C6" : "{\\textasciicircum}", // MODIFIER LETTER CIRCUMFLEX ACCENT
1248 |     "\u02C8" : "'", // MODIFIER LETTER VERTICAL LINE
1249 |     "\u02C9" : "-", // MODIFIER LETTER MACRON
1250 |     "\u02CC" : ",", // MODIFIER LETTER LOW VERTICAL LINE
1251 |     "\u02D0" : ":", // MODIFIER LETTER TRIANGULAR COLON
1252 |     "\u02DA" : "o", // RING ABOVE
1253 |     "\u02DC" : "\\~{}", // SMALL TILDE
1254 |     "\u02DD" : "{\\textacutedbl}", // DOUBLE ACUTE ACCENT
1255 |     "\u0374" : "'", // GREEK NUMERAL SIGN
1256 |     "\u0375" : ",", // GREEK LOWER NUMERAL SIGN
1257 |     "\u037E" : ";", // GREEK QUESTION MARK
1258 |     "\u2000" : " ", // EN QUAD
1259 |     "\u2001" : "  ", // EM QUAD
1260 |     "\u2002" : " ", // EN SPACE
1261 |     "\u2003" : "  ", // EM SPACE
1262 |     "\u2004" : " ", // THREE-PER-EM SPACE
1263 |     "\u2005" : " ", // FOUR-PER-EM SPACE
1264 |     "\u2006" : " ", // SIX-PER-EM SPACE
1265 |     "\u2007" : " ", // FIGURE SPACE
1266 |     "\u2008" : " ", // PUNCTUATION SPACE
1267 |     "\u2009" : " ", // THIN SPACE
1268 |     "\u2010" : "-", // HYPHEN
1269 |     "\u2011" : "-", // NON-BREAKING HYPHEN
1270 |     "\u2012" : "-", // FIGURE DASH
1271 |     "\u2013" : "{\\textendash}", // EN DASH
1272 |     "\u2014" : "{\\textemdash}", // EM DASH
1273 |     "\u2015" : "{\\textemdash}", // HORIZONTAL BAR or QUOTATION DASH (not in LaTeX -- use EM DASH)
1274 |     "\u2016" : "{\\textbardbl}", // DOUBLE VERTICAL LINE
1275 |     "\u2017" : "{\\textunderscore}", // DOUBLE LOW LINE
1276 |     "\u2018" : "{\\textquoteleft}", // LEFT SINGLE QUOTATION MARK
1277 |     "\u2019" : "{\\textquoteright}", // RIGHT SINGLE QUOTATION MARK
1278 |     "\u201A" : "{\\quotesinglbase}", // SINGLE LOW-9 QUOTATION MARK
1279 |     "\u201B" : "'", // SINGLE HIGH-REVERSED-9 QUOTATION MARK
1280 |     "\u201C" : "{\\textquotedblleft}", // LEFT DOUBLE QUOTATION MARK
1281 |     "\u201D" : "{\\textquotedblright}", // RIGHT DOUBLE QUOTATION MARK
1282 |     "\u201E" : "{\\quotedblbase}", // DOUBLE LOW-9 QUOTATION MARK
1283 |     "\u201F" : "{\\quotedblbase}", // DOUBLE HIGH-REVERSED-9 QUOTATION MARK
1284 |     "\u2020" : "{\\textdagger}", // DAGGER
1285 |     "\u2021" : "{\\textdaggerdbl}", // DOUBLE DAGGER
1286 |     "\u2022" : "{\\textbullet}", // BULLET
1287 |     "\u2023" : ">", // TRIANGULAR BULLET
1288 |     "\u2024" : ".", // ONE DOT LEADER
1289 |     "\u2025" : "..", // TWO DOT LEADER
1290 |     "\u2026" : "{\\textellipsis}", // HORIZONTAL ELLIPSIS
1291 |     "\u2027" : "-", // HYPHENATION POINT
1292 |     "\u202F" : " ", // NARROW NO-BREAK SPACE
1293 |     "\u2030" : "{\\textperthousand}", // PER MILLE SIGN
1294 |     "\u2032" : "'", // PRIME
1295 |     "\u2033" : "'", // DOUBLE PRIME
1296 |     "\u2034" : "'''", // TRIPLE PRIME
1297 |     "\u2035" : "`", // REVERSED PRIME
1298 |     "\u2036" : "``", // REVERSED DOUBLE PRIME
1299 |     "\u2037" : "```", // REVERSED TRIPLE PRIME
1300 |     "\u2039" : "{\\guilsinglleft}", // SINGLE LEFT-POINTING ANGLE QUOTATION MARK
1301 |     "\u203A" : "{\\guilsinglright}", // SINGLE RIGHT-POINTING ANGLE QUOTATION MARK
1302 |     "\u203C" : "!!", // DOUBLE EXCLAMATION MARK
1303 |     "\u203E" : "-", // OVERLINE
1304 |     "\u2043" : "-", // HYPHEN BULLET
1305 |     "\u2044" : "{\\textfractionsolidus}", // FRACTION SLASH
1306 |     "\u2048" : "?!", // QUESTION EXCLAMATION MARK
1307 |     "\u2049" : "!?", // EXCLAMATION QUESTION MARK
1308 |     "\u204A" : "7", // TIRONIAN SIGN ET
1309 |     "\u2070" : "$^{0}$", // SUPERSCRIPT ZERO
1310 |     "\u2074" : "$^{4}$", // SUPERSCRIPT FOUR
1311 |     "\u2075" : "$^{5}$", // SUPERSCRIPT FIVE
1312 |     "\u2076" : "$^{6}$", // SUPERSCRIPT SIX
1313 |     "\u2077" : "$^{7}$", // SUPERSCRIPT SEVEN
1314 |     "\u2078" : "$^{8}$", // SUPERSCRIPT EIGHT
1315 |     "\u2079" : "$^{9}$", // SUPERSCRIPT NINE
1316 |     "\u207A" : "$^{+}$", // SUPERSCRIPT PLUS SIGN
1317 |     "\u207B" : "$^{-}$", // SUPERSCRIPT MINUS
1318 |     "\u207C" : "$^{=}$", // SUPERSCRIPT EQUALS SIGN
1319 |     "\u207D" : "$^{(}$", // SUPERSCRIPT LEFT PARENTHESIS
1320 |     "\u207E" : "$^{)}$", // SUPERSCRIPT RIGHT PARENTHESIS
1321 |     "\u207F" : "$^{n}$", // SUPERSCRIPT LATIN SMALL LETTER N
1322 |     "\u2080" : "$_{0}$", // SUBSCRIPT ZERO
1323 |     "\u2081" : "$_{1}$", // SUBSCRIPT ONE
1324 |     "\u2082" : "$_{2}$", // SUBSCRIPT TWO
1325 |     "\u2083" : "$_{3}$", // SUBSCRIPT THREE
1326 |     "\u2084" : "$_{4}$", // SUBSCRIPT FOUR
1327 |     "\u2085" : "$_{5}$", // SUBSCRIPT FIVE
1328 |     "\u2086" : "$_{6}$", // SUBSCRIPT SIX
1329 |     "\u2087" : "$_{7}$", // SUBSCRIPT SEVEN
1330 |     "\u2088" : "$_{8}$", // SUBSCRIPT EIGHT
1331 |     "\u2089" : "$_{9}$", // SUBSCRIPT NINE
1332 |     "\u208A" : "$_{+}$", // SUBSCRIPT PLUS SIGN
1333 |     "\u208B" : "$_{-}$", // SUBSCRIPT MINUS
1334 |     "\u208C" : "$_{=}$", // SUBSCRIPT EQUALS SIGN
1335 |     "\u208D" : "$_{(}$", // SUBSCRIPT LEFT PARENTHESIS
1336 |     "\u208E" : "$_{)}$", // SUBSCRIPT RIGHT PARENTHESIS
1337 |     "\u20AC" : "{\\texteuro}", // EURO SIGN
1338 |     "\u2100" : "a/c", // ACCOUNT OF
1339 |     "\u2101" : "a/s", // ADDRESSED TO THE SUBJECT
1340 |     "\u2103" : "{\\textcelsius}", // DEGREE CELSIUS
1341 |     "\u2105" : "c/o", // CARE OF
1342 |     "\u2106" : "c/u", // CADA UNA
1343 |     "\u2109" : "F", // DEGREE FAHRENHEIT
1344 |     "\u2113" : "l", // SCRIPT SMALL L
1345 |     "\u2116" : "{\\textnumero}", // NUMERO SIGN
1346 |     "\u2117" : "{\\textcircledP}", // SOUND RECORDING COPYRIGHT
1347 |     "\u2120" : "{\\textservicemark}", // SERVICE MARK
1348 |     "\u2121" : "TEL", // TELEPHONE SIGN
1349 |     "\u2122" : "{\\texttrademark}", // TRADE MARK SIGN
1350 |     "\u2126" : "{\\textohm}", // OHM SIGN
1351 |     "\u212A" : "K", // KELVIN SIGN
1352 |     "\u212B" : "A", // ANGSTROM SIGN
1353 |     "\u212E" : "{\\textestimated}", // ESTIMATED SYMBOL
1354 |     "\u2153" : " 1/3", // VULGAR FRACTION ONE THIRD
1355 |     "\u2154" : " 2/3", // VULGAR FRACTION TWO THIRDS
1356 |     "\u2155" : " 1/5", // VULGAR FRACTION ONE FIFTH
1357 |     "\u2156" : " 2/5", // VULGAR FRACTION TWO FIFTHS
1358 |     "\u2157" : " 3/5", // VULGAR FRACTION THREE FIFTHS
1359 |     "\u2158" : " 4/5", // VULGAR FRACTION FOUR FIFTHS
1360 |     "\u2159" : " 1/6", // VULGAR FRACTION ONE SIXTH
1361 |     "\u215A" : " 5/6", // VULGAR FRACTION FIVE SIXTHS
1362 |     "\u215B" : " 1/8", // VULGAR FRACTION ONE EIGHTH
1363 |     "\u215C" : " 3/8", // VULGAR FRACTION THREE EIGHTHS
1364 |     "\u215D" : " 5/8", // VULGAR FRACTION FIVE EIGHTHS
1365 |     "\u215E" : " 7/8", // VULGAR FRACTION SEVEN EIGHTHS
1366 |     "\u215F" : " 1/", // FRACTION NUMERATOR ONE
1367 |     "\u2160" : "I", // ROMAN NUMERAL ONE
1368 |     "\u2161" : "II", // ROMAN NUMERAL TWO
1369 |     "\u2162" : "III", // ROMAN NUMERAL THREE
1370 |     "\u2163" : "IV", // ROMAN NUMERAL FOUR
1371 |     "\u2164" : "V", // ROMAN NUMERAL FIVE
1372 |     "\u2165" : "VI", // ROMAN NUMERAL SIX
1373 |     "\u2166" : "VII", // ROMAN NUMERAL SEVEN
1374 |     "\u2167" : "VIII", // ROMAN NUMERAL EIGHT
1375 |     "\u2168" : "IX", // ROMAN NUMERAL NINE
1376 |     "\u2169" : "X", // ROMAN NUMERAL TEN
1377 |     "\u216A" : "XI", // ROMAN NUMERAL ELEVEN
1378 |     "\u216B" : "XII", // ROMAN NUMERAL TWELVE
1379 |     "\u216C" : "L", // ROMAN NUMERAL FIFTY
1380 |     "\u216D" : "C", // ROMAN NUMERAL ONE HUNDRED
1381 |     "\u216E" : "D", // ROMAN NUMERAL FIVE HUNDRED
1382 |     "\u216F" : "M", // ROMAN NUMERAL ONE THOUSAND
1383 |     "\u2170" : "i", // SMALL ROMAN NUMERAL ONE
1384 |     "\u2171" : "ii", // SMALL ROMAN NUMERAL TWO
1385 |     "\u2172" : "iii", // SMALL ROMAN NUMERAL THREE
1386 |     "\u2173" : "iv", // SMALL ROMAN NUMERAL FOUR
1387 |     "\u2174" : "v", // SMALL ROMAN NUMERAL FIVE
1388 |     "\u2175" : "vi", // SMALL ROMAN NUMERAL SIX
1389 |     "\u2176" : "vii", // SMALL ROMAN NUMERAL SEVEN
1390 |     "\u2177" : "viii", // SMALL ROMAN NUMERAL EIGHT
1391 |     "\u2178" : "ix", // SMALL ROMAN NUMERAL NINE
1392 |     "\u2179" : "x", // SMALL ROMAN NUMERAL TEN
1393 |     "\u217A" : "xi", // SMALL ROMAN NUMERAL ELEVEN
1394 |     "\u217B" : "xii", // SMALL ROMAN NUMERAL TWELVE
1395 |     "\u217C" : "l", // SMALL ROMAN NUMERAL FIFTY
1396 |     "\u217D" : "c", // SMALL ROMAN NUMERAL ONE HUNDRED
1397 |     "\u217E" : "d", // SMALL ROMAN NUMERAL FIVE HUNDRED
1398 |     "\u217F" : "m", // SMALL ROMAN NUMERAL ONE THOUSAND
1399 |     "\u2190" : "{\\textleftarrow}", // LEFTWARDS ARROW
1400 |     "\u2191" : "{\\textuparrow}", // UPWARDS ARROW
1401 |     "\u2192" : "{\\textrightarrow}", // RIGHTWARDS ARROW
1402 |     "\u2193" : "{\\textdownarrow}", // DOWNWARDS ARROW
1403 |     "\u2194" : "<->", // LEFT RIGHT ARROW
1404 |     "\u21D0" : "<=", // LEFTWARDS DOUBLE ARROW
1405 |     "\u21D2" : "=>", // RIGHTWARDS DOUBLE ARROW
1406 |     "\u21D4" : "<=>", // LEFT RIGHT DOUBLE ARROW
1407 |     "\u2212" : "-", // MINUS SIGN
1408 |     "\u2215" : "/", // DIVISION SLASH
1409 |     "\u2216" : "\\", // SET MINUS
1410 |     "\u2217" : "*", // ASTERISK OPERATOR
1411 |     "\u2218" : "o", // RING OPERATOR
1412 |     "\u2219" : ".", // BULLET OPERATOR
1413 |     "\u221E" : "$\\infty$", // INFINITY
1414 |     "\u2223" : "|", // DIVIDES
1415 |     "\u2225" : "||", // PARALLEL TO
1416 |     "\u2236" : ":", // RATIO
1417 |     "\u223C" : "\\~{}", // TILDE OPERATOR
1418 |     "\u2260" : "/=", // NOT EQUAL TO
1419 |     "\u2261" : "=", // IDENTICAL TO
1420 |     "\u2264" : "<=", // LESS-THAN OR EQUAL TO
1421 |     "\u2265" : ">=", // GREATER-THAN OR EQUAL TO
1422 |     "\u226A" : "<<", // MUCH LESS-THAN
1423 |     "\u226B" : ">>", // MUCH GREATER-THAN
1424 |     "\u2295" : "(+)", // CIRCLED PLUS
1425 |     "\u2296" : "(-)", // CIRCLED MINUS
1426 |     "\u2297" : "(x)", // CIRCLED TIMES
1427 |     //    "\u2298":"(/)", // CIRCLED DIVISION SLASH
1428 |     "\u22A2" : "|-", // RIGHT TACK
1429 |     "\u22A3" : "-|", // LEFT TACK
1430 |     "\u22A6" : "|-", // ASSERTION
1431 |     "\u22A7" : "|=", // MODELS
1432 |     "\u22A8" : "|=", // TRUE
1433 |     "\u22A9" : "||-", // FORCES
1434 |     "\u22C5" : ".", // DOT OPERATOR
1435 |     "\u22C6" : "*", // STAR OPERATOR
1436 |     "\u22D5" : "$\\#$", // EQUAL AND PARALLEL TO
1437 |     "\u22D8" : "<<<", // VERY MUCH LESS-THAN
1438 |     "\u22D9" : ">>>", // VERY MUCH GREATER-THAN
1439 |     "\u2329" : "{\\textlangle}", // LEFT-POINTING ANGLE BRACKET
1440 |     "\u232A" : "{\\textrangle}", // RIGHT-POINTING ANGLE BRACKET
1441 |     "\u2400" : "NUL", // SYMBOL FOR NULL
1442 |     "\u2401" : "SOH", // SYMBOL FOR START OF HEADING
1443 |     "\u2402" : "STX", // SYMBOL FOR START OF TEXT
1444 |     "\u2403" : "ETX", // SYMBOL FOR END OF TEXT
1445 |     "\u2404" : "EOT", // SYMBOL FOR END OF TRANSMISSION
1446 |     "\u2405" : "ENQ", // SYMBOL FOR ENQUIRY
1447 |     "\u2406" : "ACK", // SYMBOL FOR ACKNOWLEDGE
1448 |     "\u2407" : "BEL", // SYMBOL FOR BELL
1449 |     "\u2408" : "BS", // SYMBOL FOR BACKSPACE
1450 |     "\u2409" : "HT", // SYMBOL FOR HORIZONTAL TABULATION
1451 |     "\u240A" : "LF", // SYMBOL FOR LINE FEED
1452 |     "\u240B" : "VT", // SYMBOL FOR VERTICAL TABULATION
1453 |     "\u240C" : "FF", // SYMBOL FOR FORM FEED
1454 |     "\u240D" : "CR", // SYMBOL FOR CARRIAGE RETURN
1455 |     "\u240E" : "SO", // SYMBOL FOR SHIFT OUT
1456 |     "\u240F" : "SI", // SYMBOL FOR SHIFT IN
1457 |     "\u2410" : "DLE", // SYMBOL FOR DATA LINK ESCAPE
1458 |     "\u2411" : "DC1", // SYMBOL FOR DEVICE CONTROL ONE
1459 |     "\u2412" : "DC2", // SYMBOL FOR DEVICE CONTROL TWO
1460 |     "\u2413" : "DC3", // SYMBOL FOR DEVICE CONTROL THREE
1461 |     "\u2414" : "DC4", // SYMBOL FOR DEVICE CONTROL FOUR
1462 |     "\u2415" : "NAK", // SYMBOL FOR NEGATIVE ACKNOWLEDGE
1463 |     "\u2416" : "SYN", // SYMBOL FOR SYNCHRONOUS IDLE
1464 |     "\u2417" : "ETB", // SYMBOL FOR END OF TRANSMISSION BLOCK
1465 |     "\u2418" : "CAN", // SYMBOL FOR CANCEL
1466 |     "\u2419" : "EM", // SYMBOL FOR END OF MEDIUM
1467 |     "\u241A" : "SUB", // SYMBOL FOR SUBSTITUTE
1468 |     "\u241B" : "ESC", // SYMBOL FOR ESCAPE
1469 |     "\u241C" : "FS", // SYMBOL FOR FILE SEPARATOR
1470 |     "\u241D" : "GS", // SYMBOL FOR GROUP SEPARATOR
1471 |     "\u241E" : "RS", // SYMBOL FOR RECORD SEPARATOR
1472 |     "\u241F" : "US", // SYMBOL FOR UNIT SEPARATOR
1473 |     "\u2420" : "SP", // SYMBOL FOR SPACE
1474 |     "\u2421" : "DEL", // SYMBOL FOR DELETE
1475 |     "\u2423" : "{\\textvisiblespace}", // OPEN BOX
1476 |     "\u2424" : "NL", // SYMBOL FOR NEWLINE
1477 |     "\u2425" : "///", // SYMBOL FOR DELETE FORM TWO
1478 |     "\u2426" : "?", // SYMBOL FOR SUBSTITUTE FORM TWO
1479 |     "\u2460" : "(1)", // CIRCLED DIGIT ONE
1480 |     "\u2461" : "(2)", // CIRCLED DIGIT TWO
1481 |     "\u2462" : "(3)", // CIRCLED DIGIT THREE
1482 |     "\u2463" : "(4)", // CIRCLED DIGIT FOUR
1483 |     "\u2464" : "(5)", // CIRCLED DIGIT FIVE
1484 |     "\u2465" : "(6)", // CIRCLED DIGIT SIX
1485 |     "\u2466" : "(7)", // CIRCLED DIGIT SEVEN
1486 |     "\u2467" : "(8)", // CIRCLED DIGIT EIGHT
1487 |     "\u2468" : "(9)", // CIRCLED DIGIT NINE
1488 |     "\u2469" : "(10)", // CIRCLED NUMBER TEN
1489 |     "\u246A" : "(11)", // CIRCLED NUMBER ELEVEN
1490 |     "\u246B" : "(12)", // CIRCLED NUMBER TWELVE
1491 |     "\u246C" : "(13)", // CIRCLED NUMBER THIRTEEN
1492 |     "\u246D" : "(14)", // CIRCLED NUMBER FOURTEEN
1493 |     "\u246E" : "(15)", // CIRCLED NUMBER FIFTEEN
1494 |     "\u246F" : "(16)", // CIRCLED NUMBER SIXTEEN
1495 |     "\u2470" : "(17)", // CIRCLED NUMBER SEVENTEEN
1496 |     "\u2471" : "(18)", // CIRCLED NUMBER EIGHTEEN
1497 |     "\u2472" : "(19)", // CIRCLED NUMBER NINETEEN
1498 |     "\u2473" : "(20)", // CIRCLED NUMBER TWENTY
1499 |     "\u2474" : "(1)", // PARENTHESIZED DIGIT ONE
1500 |     "\u2475" : "(2)", // PARENTHESIZED DIGIT TWO
1501 |     "\u2476" : "(3)", // PARENTHESIZED DIGIT THREE
1502 |     "\u2477" : "(4)", // PARENTHESIZED DIGIT FOUR
1503 |     "\u2478" : "(5)", // PARENTHESIZED DIGIT FIVE
1504 |     "\u2479" : "(6)", // PARENTHESIZED DIGIT SIX
1505 |     "\u247A" : "(7)", // PARENTHESIZED DIGIT SEVEN
1506 |     "\u247B" : "(8)", // PARENTHESIZED DIGIT EIGHT
1507 |     "\u247C" : "(9)", // PARENTHESIZED DIGIT NINE
1508 |     "\u247D" : "(10)", // PARENTHESIZED NUMBER TEN
1509 |     "\u247E" : "(11)", // PARENTHESIZED NUMBER ELEVEN
1510 |     "\u247F" : "(12)", // PARENTHESIZED NUMBER TWELVE
1511 |     "\u2480" : "(13)", // PARENTHESIZED NUMBER THIRTEEN
1512 |     "\u2481" : "(14)", // PARENTHESIZED NUMBER FOURTEEN
1513 |     "\u2482" : "(15)", // PARENTHESIZED NUMBER FIFTEEN
1514 |     "\u2483" : "(16)", // PARENTHESIZED NUMBER SIXTEEN
1515 |     "\u2484" : "(17)", // PARENTHESIZED NUMBER SEVENTEEN
1516 |     "\u2485" : "(18)", // PARENTHESIZED NUMBER EIGHTEEN
1517 |     "\u2486" : "(19)", // PARENTHESIZED NUMBER NINETEEN
1518 |     "\u2487" : "(20)", // PARENTHESIZED NUMBER TWENTY
1519 |     "\u2488" : "1.", // DIGIT ONE FULL STOP
1520 |     "\u2489" : "2.", // DIGIT TWO FULL STOP
1521 |     "\u248A" : "3.", // DIGIT THREE FULL STOP
1522 |     "\u248B" : "4.", // DIGIT FOUR FULL STOP
1523 |     "\u248C" : "5.", // DIGIT FIVE FULL STOP
1524 |     "\u248D" : "6.", // DIGIT SIX FULL STOP
1525 |     "\u248E" : "7.", // DIGIT SEVEN FULL STOP
1526 |     "\u248F" : "8.", // DIGIT EIGHT FULL STOP
1527 |     "\u2490" : "9.", // DIGIT NINE FULL STOP
1528 |     "\u2491" : "10.", // NUMBER TEN FULL STOP
1529 |     "\u2492" : "11.", // NUMBER ELEVEN FULL STOP
1530 |     "\u2493" : "12.", // NUMBER TWELVE FULL STOP
1531 |     "\u2494" : "13.", // NUMBER THIRTEEN FULL STOP
1532 |     "\u2495" : "14.", // NUMBER FOURTEEN FULL STOP
1533 |     "\u2496" : "15.", // NUMBER FIFTEEN FULL STOP
1534 |     "\u2497" : "16.", // NUMBER SIXTEEN FULL STOP
1535 |     "\u2498" : "17.", // NUMBER SEVENTEEN FULL STOP
1536 |     "\u2499" : "18.", // NUMBER EIGHTEEN FULL STOP
1537 |     "\u249A" : "19.", // NUMBER NINETEEN FULL STOP
1538 |     "\u249B" : "20.", // NUMBER TWENTY FULL STOP
1539 |     "\u249C" : "(a)", // PARENTHESIZED LATIN SMALL LETTER A
1540 |     "\u249D" : "(b)", // PARENTHESIZED LATIN SMALL LETTER B
1541 |     "\u249E" : "(c)", // PARENTHESIZED LATIN SMALL LETTER C
1542 |     "\u249F" : "(d)", // PARENTHESIZED LATIN SMALL LETTER D
1543 |     "\u24A0" : "(e)", // PARENTHESIZED LATIN SMALL LETTER E
1544 |     "\u24A1" : "(f)", // PARENTHESIZED LATIN SMALL LETTER F
1545 |     "\u24A2" : "(g)", // PARENTHESIZED LATIN SMALL LETTER G
1546 |     "\u24A3" : "(h)", // PARENTHESIZED LATIN SMALL LETTER H
1547 |     "\u24A4" : "(i)", // PARENTHESIZED LATIN SMALL LETTER I
1548 |     "\u24A5" : "(j)", // PARENTHESIZED LATIN SMALL LETTER J
1549 |     "\u24A6" : "(k)", // PARENTHESIZED LATIN SMALL LETTER K
1550 |     "\u24A7" : "(l)", // PARENTHESIZED LATIN SMALL LETTER L
1551 |     "\u24A8" : "(m)", // PARENTHESIZED LATIN SMALL LETTER M
1552 |     "\u24A9" : "(n)", // PARENTHESIZED LATIN SMALL LETTER N
1553 |     "\u24AA" : "(o)", // PARENTHESIZED LATIN SMALL LETTER O
1554 |     "\u24AB" : "(p)", // PARENTHESIZED LATIN SMALL LETTER P
1555 |     "\u24AC" : "(q)", // PARENTHESIZED LATIN SMALL LETTER Q
1556 |     "\u24AD" : "(r)", // PARENTHESIZED LATIN SMALL LETTER R
1557 |     "\u24AE" : "(s)", // PARENTHESIZED LATIN SMALL LETTER S
1558 |     "\u24AF" : "(t)", // PARENTHESIZED LATIN SMALL LETTER T
1559 |     "\u24B0" : "(u)", // PARENTHESIZED LATIN SMALL LETTER U
1560 |     "\u24B1" : "(v)", // PARENTHESIZED LATIN SMALL LETTER V
1561 |     "\u24B2" : "(w)", // PARENTHESIZED LATIN SMALL LETTER W
1562 |     "\u24B3" : "(x)", // PARENTHESIZED LATIN SMALL LETTER X
1563 |     "\u24B4" : "(y)", // PARENTHESIZED LATIN SMALL LETTER Y
1564 |     "\u24B5" : "(z)", // PARENTHESIZED LATIN SMALL LETTER Z
1565 |     "\u24B6" : "(A)", // CIRCLED LATIN CAPITAL LETTER A
1566 |     "\u24B7" : "(B)", // CIRCLED LATIN CAPITAL LETTER B
1567 |     "\u24B8" : "(C)", // CIRCLED LATIN CAPITAL LETTER C
1568 |     "\u24B9" : "(D)", // CIRCLED LATIN CAPITAL LETTER D
1569 |     "\u24BA" : "(E)", // CIRCLED LATIN CAPITAL LETTER E
1570 |     "\u24BB" : "(F)", // CIRCLED LATIN CAPITAL LETTER F
1571 |     "\u24BC" : "(G)", // CIRCLED LATIN CAPITAL LETTER G
1572 |     "\u24BD" : "(H)", // CIRCLED LATIN CAPITAL LETTER H
1573 |     "\u24BE" : "(I)", // CIRCLED LATIN CAPITAL LETTER I
1574 |     "\u24BF" : "(J)", // CIRCLED LATIN CAPITAL LETTER J
1575 |     "\u24C0" : "(K)", // CIRCLED LATIN CAPITAL LETTER K
1576 |     "\u24C1" : "(L)", // CIRCLED LATIN CAPITAL LETTER L
1577 |     "\u24C2" : "(M)", // CIRCLED LATIN CAPITAL LETTER M
1578 |     "\u24C3" : "(N)", // CIRCLED LATIN CAPITAL LETTER N
1579 |     "\u24C4" : "(O)", // CIRCLED LATIN CAPITAL LETTER O
1580 |     "\u24C5" : "(P)", // CIRCLED LATIN CAPITAL LETTER P
1581 |     "\u24C6" : "(Q)", // CIRCLED LATIN CAPITAL LETTER Q
1582 |     "\u24C7" : "(R)", // CIRCLED LATIN CAPITAL LETTER R
1583 |     "\u24C8" : "(S)", // CIRCLED LATIN CAPITAL LETTER S
1584 |     "\u24C9" : "(T)", // CIRCLED LATIN CAPITAL LETTER T
1585 |     "\u24CA" : "(U)", // CIRCLED LATIN CAPITAL LETTER U
1586 |     "\u24CB" : "(V)", // CIRCLED LATIN CAPITAL LETTER V
1587 |     "\u24CC" : "(W)", // CIRCLED LATIN CAPITAL LETTER W
1588 |     "\u24CD" : "(X)", // CIRCLED LATIN CAPITAL LETTER X
1589 |     "\u24CE" : "(Y)", // CIRCLED LATIN CAPITAL LETTER Y
1590 |     "\u24CF" : "(Z)", // CIRCLED LATIN CAPITAL LETTER Z
1591 |     "\u24D0" : "(a)", // CIRCLED LATIN SMALL LETTER A
1592 |     "\u24D1" : "(b)", // CIRCLED LATIN SMALL LETTER B
1593 |     "\u24D2" : "(c)", // CIRCLED LATIN SMALL LETTER C
1594 |     "\u24D3" : "(d)", // CIRCLED LATIN SMALL LETTER D
1595 |     "\u24D4" : "(e)", // CIRCLED LATIN SMALL LETTER E
1596 |     "\u24D5" : "(f)", // CIRCLED LATIN SMALL LETTER F
1597 |     "\u24D6" : "(g)", // CIRCLED LATIN SMALL LETTER G
1598 |     "\u24D7" : "(h)", // CIRCLED LATIN SMALL LETTER H
1599 |     "\u24D8" : "(i)", // CIRCLED LATIN SMALL LETTER I
1600 |     "\u24D9" : "(j)", // CIRCLED LATIN SMALL LETTER J
1601 |     "\u24DA" : "(k)", // CIRCLED LATIN SMALL LETTER K
1602 |     "\u24DB" : "(l)", // CIRCLED LATIN SMALL LETTER L
1603 |     "\u24DC" : "(m)", // CIRCLED LATIN SMALL LETTER M
1604 |     "\u24DD" : "(n)", // CIRCLED LATIN SMALL LETTER N
1605 |     "\u24DE" : "(o)", // CIRCLED LATIN SMALL LETTER O
1606 |     "\u24DF" : "(p)", // CIRCLED LATIN SMALL LETTER P
1607 |     "\u24E0" : "(q)", // CIRCLED LATIN SMALL LETTER Q
1608 |     "\u24E1" : "(r)", // CIRCLED LATIN SMALL LETTER R
1609 |     "\u24E2" : "(s)", // CIRCLED LATIN SMALL LETTER S
1610 |     "\u24E3" : "(t)", // CIRCLED LATIN SMALL LETTER T
1611 |     "\u24E4" : "(u)", // CIRCLED LATIN SMALL LETTER U
1612 |     "\u24E5" : "(v)", // CIRCLED LATIN SMALL LETTER V
1613 |     "\u24E6" : "(w)", // CIRCLED LATIN SMALL LETTER W
1614 |     "\u24E7" : "(x)", // CIRCLED LATIN SMALL LETTER X
1615 |     "\u24E8" : "(y)", // CIRCLED LATIN SMALL LETTER Y
1616 |     "\u24E9" : "(z)", // CIRCLED LATIN SMALL LETTER Z
1617 |     "\u24EA" : "(0)", // CIRCLED DIGIT ZERO
1618 |     "\u2500" : "-", // BOX DRAWINGS LIGHT HORIZONTAL
1619 |     "\u2501" : "=", // BOX DRAWINGS HEAVY HORIZONTAL
1620 |     "\u2502" : "|", // BOX DRAWINGS LIGHT VERTICAL
1621 |     "\u2503" : "|", // BOX DRAWINGS HEAVY VERTICAL
1622 |     "\u2504" : "-", // BOX DRAWINGS LIGHT TRIPLE DASH HORIZONTAL
1623 |     "\u2505" : "=", // BOX DRAWINGS HEAVY TRIPLE DASH HORIZONTAL
1624 |     "\u2506" : "|", // BOX DRAWINGS LIGHT TRIPLE DASH VERTICAL
1625 |     "\u2507" : "|", // BOX DRAWINGS HEAVY TRIPLE DASH VERTICAL
1626 |     "\u2508" : "-", // BOX DRAWINGS LIGHT QUADRUPLE DASH HORIZONTAL
1627 |     "\u2509" : "=", // BOX DRAWINGS HEAVY QUADRUPLE DASH HORIZONTAL
1628 |     "\u250A" : "|", // BOX DRAWINGS LIGHT QUADRUPLE DASH VERTICAL
1629 |     "\u250B" : "|", // BOX DRAWINGS HEAVY QUADRUPLE DASH VERTICAL
1630 |     "\u250C" : "+", // BOX DRAWINGS LIGHT DOWN AND RIGHT
1631 |     "\u250D" : "+", // BOX DRAWINGS DOWN LIGHT AND RIGHT HEAVY
1632 |     "\u250E" : "+", // BOX DRAWINGS DOWN HEAVY AND RIGHT LIGHT
1633 |     "\u250F" : "+", // BOX DRAWINGS HEAVY DOWN AND RIGHT
1634 |     "\u2510" : "+", // BOX DRAWINGS LIGHT DOWN AND LEFT
1635 |     "\u2511" : "+", // BOX DRAWINGS DOWN LIGHT AND LEFT HEAVY
1636 |     "\u2512" : "+", // BOX DRAWINGS DOWN HEAVY AND LEFT LIGHT
1637 |     "\u2513" : "+", // BOX DRAWINGS HEAVY DOWN AND LEFT
1638 |     "\u2514" : "+", // BOX DRAWINGS LIGHT UP AND RIGHT
1639 |     "\u2515" : "+", // BOX DRAWINGS UP LIGHT AND RIGHT HEAVY
1640 |     "\u2516" : "+", // BOX DRAWINGS UP HEAVY AND RIGHT LIGHT
1641 |     "\u2517" : "+", // BOX DRAWINGS HEAVY UP AND RIGHT
1642 |     "\u2518" : "+", // BOX DRAWINGS LIGHT UP AND LEFT
1643 |     "\u2519" : "+", // BOX DRAWINGS UP LIGHT AND LEFT HEAVY
1644 |     "\u251A" : "+", // BOX DRAWINGS UP HEAVY AND LEFT LIGHT
1645 |     "\u251B" : "+", // BOX DRAWINGS HEAVY UP AND LEFT
1646 |     "\u251C" : "+", // BOX DRAWINGS LIGHT VERTICAL AND RIGHT
1647 |     "\u251D" : "+", // BOX DRAWINGS VERTICAL LIGHT AND RIGHT HEAVY
1648 |     "\u251E" : "+", // BOX DRAWINGS UP HEAVY AND RIGHT DOWN LIGHT
1649 |     "\u251F" : "+", // BOX DRAWINGS DOWN HEAVY AND RIGHT UP LIGHT
1650 |     "\u2520" : "+", // BOX DRAWINGS VERTICAL HEAVY AND RIGHT LIGHT
1651 |     "\u2521" : "+", // BOX DRAWINGS DOWN LIGHT AND RIGHT UP HEAVY
1652 |     "\u2522" : "+", // BOX DRAWINGS UP LIGHT AND RIGHT DOWN HEAVY
1653 |     "\u2523" : "+", // BOX DRAWINGS HEAVY VERTICAL AND RIGHT
1654 |     "\u2524" : "+", // BOX DRAWINGS LIGHT VERTICAL AND LEFT
1655 |     "\u2525" : "+", // BOX DRAWINGS VERTICAL LIGHT AND LEFT HEAVY
1656 |     "\u2526" : "+", // BOX DRAWINGS UP HEAVY AND LEFT DOWN LIGHT
1657 |     "\u2527" : "+", // BOX DRAWINGS DOWN HEAVY AND LEFT UP LIGHT
1658 |     "\u2528" : "+", // BOX DRAWINGS VERTICAL HEAVY AND LEFT LIGHT
1659 |     "\u2529" : "+", // BOX DRAWINGS DOWN LIGHT AND LEFT UP HEAVY
1660 |     "\u252A" : "+", // BOX DRAWINGS UP LIGHT AND LEFT DOWN HEAVY
1661 |     "\u252B" : "+", // BOX DRAWINGS HEAVY VERTICAL AND LEFT
1662 |     "\u252C" : "+", // BOX DRAWINGS LIGHT DOWN AND HORIZONTAL
1663 |     "\u252D" : "+", // BOX DRAWINGS LEFT HEAVY AND RIGHT DOWN LIGHT
1664 |     "\u252E" : "+", // BOX DRAWINGS RIGHT HEAVY AND LEFT DOWN LIGHT
1665 |     "\u252F" : "+", // BOX DRAWINGS DOWN LIGHT AND HORIZONTAL HEAVY
1666 |     "\u2530" : "+", // BOX DRAWINGS DOWN HEAVY AND HORIZONTAL LIGHT
1667 |     "\u2531" : "+", // BOX DRAWINGS RIGHT LIGHT AND LEFT DOWN HEAVY
1668 |     "\u2532" : "+", // BOX DRAWINGS LEFT LIGHT AND RIGHT DOWN HEAVY
1669 |     "\u2533" : "+", // BOX DRAWINGS HEAVY DOWN AND HORIZONTAL
1670 |     "\u2534" : "+", // BOX DRAWINGS LIGHT UP AND HORIZONTAL
1671 |     "\u2535" : "+", // BOX DRAWINGS LEFT HEAVY AND RIGHT UP LIGHT
1672 |     "\u2536" : "+", // BOX DRAWINGS RIGHT HEAVY AND LEFT UP LIGHT
1673 |     "\u2537" : "+", // BOX DRAWINGS UP LIGHT AND HORIZONTAL HEAVY
1674 |     "\u2538" : "+", // BOX DRAWINGS UP HEAVY AND HORIZONTAL LIGHT
1675 |     "\u2539" : "+", // BOX DRAWINGS RIGHT LIGHT AND LEFT UP HEAVY
1676 |     "\u253A" : "+", // BOX DRAWINGS LEFT LIGHT AND RIGHT UP HEAVY
1677 |     "\u253B" : "+", // BOX DRAWINGS HEAVY UP AND HORIZONTAL
1678 |     "\u253C" : "+", // BOX DRAWINGS LIGHT VERTICAL AND HORIZONTAL
1679 |     "\u253D" : "+", // BOX DRAWINGS LEFT HEAVY AND RIGHT VERTICAL LIGHT
1680 |     "\u253E" : "+", // BOX DRAWINGS RIGHT HEAVY AND LEFT VERTICAL LIGHT
1681 |     "\u253F" : "+", // BOX DRAWINGS VERTICAL LIGHT AND HORIZONTAL HEAVY
1682 |     "\u2540" : "+", // BOX DRAWINGS UP HEAVY AND DOWN HORIZONTAL LIGHT
1683 |     "\u2541" : "+", // BOX DRAWINGS DOWN HEAVY AND UP HORIZONTAL LIGHT
1684 |     "\u2542" : "+", // BOX DRAWINGS VERTICAL HEAVY AND HORIZONTAL LIGHT
1685 |     "\u2543" : "+", // BOX DRAWINGS LEFT UP HEAVY AND RIGHT DOWN LIGHT
1686 |     "\u2544" : "+", // BOX DRAWINGS RIGHT UP HEAVY AND LEFT DOWN LIGHT
1687 |     "\u2545" : "+", // BOX DRAWINGS LEFT DOWN HEAVY AND RIGHT UP LIGHT
1688 |     "\u2546" : "+", // BOX DRAWINGS RIGHT DOWN HEAVY AND LEFT UP LIGHT
1689 |     "\u2547" : "+", // BOX DRAWINGS DOWN LIGHT AND UP HORIZONTAL HEAVY
1690 |     "\u2548" : "+", // BOX DRAWINGS UP LIGHT AND DOWN HORIZONTAL HEAVY
1691 |     "\u2549" : "+", // BOX DRAWINGS RIGHT LIGHT AND LEFT VERTICAL HEAVY
1692 |     "\u254A" : "+", // BOX DRAWINGS LEFT LIGHT AND RIGHT VERTICAL HEAVY
1693 |     "\u254B" : "+", // BOX DRAWINGS HEAVY VERTICAL AND HORIZONTAL
1694 |     "\u254C" : "-", // BOX DRAWINGS LIGHT DOUBLE DASH HORIZONTAL
1695 |     "\u254D" : "=", // BOX DRAWINGS HEAVY DOUBLE DASH HORIZONTAL
1696 |     "\u254E" : "|", // BOX DRAWINGS LIGHT DOUBLE DASH VERTICAL
1697 |     "\u254F" : "|", // BOX DRAWINGS HEAVY DOUBLE DASH VERTICAL
1698 |     "\u2550" : "=", // BOX DRAWINGS DOUBLE HORIZONTAL
1699 |     "\u2551" : "|", // BOX DRAWINGS DOUBLE VERTICAL
1700 |     "\u2552" : "+", // BOX DRAWINGS DOWN SINGLE AND RIGHT DOUBLE
1701 |     "\u2553" : "+", // BOX DRAWINGS DOWN DOUBLE AND RIGHT SINGLE
1702 |     "\u2554" : "+", // BOX DRAWINGS DOUBLE DOWN AND RIGHT
1703 |     "\u2555" : "+", // BOX DRAWINGS DOWN SINGLE AND LEFT DOUBLE
1704 |     "\u2556" : "+", // BOX DRAWINGS DOWN DOUBLE AND LEFT SINGLE
1705 |     "\u2557" : "+", // BOX DRAWINGS DOUBLE DOWN AND LEFT
1706 |     "\u2558" : "+", // BOX DRAWINGS UP SINGLE AND RIGHT DOUBLE
1707 |     "\u2559" : "+", // BOX DRAWINGS UP DOUBLE AND RIGHT SINGLE
1708 |     "\u255A" : "+", // BOX DRAWINGS DOUBLE UP AND RIGHT
1709 |     "\u255B" : "+", // BOX DRAWINGS UP SINGLE AND LEFT DOUBLE
1710 |     "\u255C" : "+", // BOX DRAWINGS UP DOUBLE AND LEFT SINGLE
1711 |     "\u255D" : "+", // BOX DRAWINGS DOUBLE UP AND LEFT
1712 |     "\u255E" : "+", // BOX DRAWINGS VERTICAL SINGLE AND RIGHT DOUBLE
1713 |     "\u255F" : "+", // BOX DRAWINGS VERTICAL DOUBLE AND RIGHT SINGLE
1714 |     "\u2560" : "+", // BOX DRAWINGS DOUBLE VERTICAL AND RIGHT
1715 |     "\u2561" : "+", // BOX DRAWINGS VERTICAL SINGLE AND LEFT DOUBLE
1716 |     "\u2562" : "+", // BOX DRAWINGS VERTICAL DOUBLE AND LEFT SINGLE
1717 |     "\u2563" : "+", // BOX DRAWINGS DOUBLE VERTICAL AND LEFT
1718 |     "\u2564" : "+", // BOX DRAWINGS DOWN SINGLE AND HORIZONTAL DOUBLE
1719 |     "\u2565" : "+", // BOX DRAWINGS DOWN DOUBLE AND HORIZONTAL SINGLE
1720 |     "\u2566" : "+", // BOX DRAWINGS DOUBLE DOWN AND HORIZONTAL
1721 |     "\u2567" : "+", // BOX DRAWINGS UP SINGLE AND HORIZONTAL DOUBLE
1722 |     "\u2568" : "+", // BOX DRAWINGS UP DOUBLE AND HORIZONTAL SINGLE
1723 |     "\u2569" : "+", // BOX DRAWINGS DOUBLE UP AND HORIZONTAL
1724 |     "\u256A" : "+", // BOX DRAWINGS VERTICAL SINGLE AND HORIZONTAL DOUBLE
1725 |     "\u256B" : "+", // BOX DRAWINGS VERTICAL DOUBLE AND HORIZONTAL SINGLE
1726 |     "\u256C" : "+", // BOX DRAWINGS DOUBLE VERTICAL AND HORIZONTAL
1727 |     "\u256D" : "+", // BOX DRAWINGS LIGHT ARC DOWN AND RIGHT
1728 |     "\u256E" : "+", // BOX DRAWINGS LIGHT ARC DOWN AND LEFT
1729 |     "\u256F" : "+", // BOX DRAWINGS LIGHT ARC UP AND LEFT
1730 |     "\u2570" : "+", // BOX DRAWINGS LIGHT ARC UP AND RIGHT
1731 |     "\u2571" : "/", // BOX DRAWINGS LIGHT DIAGONAL UPPER RIGHT TO LOWER LEFT
1732 |     "\u2572" : "\\", // BOX DRAWINGS LIGHT DIAGONAL UPPER LEFT TO LOWER RIGHT
1733 |     "\u2573" : "X", // BOX DRAWINGS LIGHT DIAGONAL CROSS
1734 |     "\u257C" : "-", // BOX DRAWINGS LIGHT LEFT AND HEAVY RIGHT
1735 |     "\u257D" : "|", // BOX DRAWINGS LIGHT UP AND HEAVY DOWN
1736 |     "\u257E" : "-", // BOX DRAWINGS HEAVY LEFT AND LIGHT RIGHT
1737 |     "\u257F" : "|", // BOX DRAWINGS HEAVY UP AND LIGHT DOWN
1738 |     "\u25CB" : "o", // WHITE CIRCLE
1739 |     "\u25E6" : "{\\textopenbullet}", // WHITE BULLET
1740 |     "\u2605" : "*", // BLACK STAR
1741 |     "\u2606" : "*", // WHITE STAR
1742 |     "\u2612" : "X", // BALLOT BOX WITH X
1743 |     "\u2613" : "X", // SALTIRE
1744 |     "\u2639" : ":-(", // WHITE FROWNING FACE
1745 |     "\u263A" : ":-)", // WHITE SMILING FACE
1746 |     "\u263B" : "(-:", // BLACK SMILING FACE
1747 |     "\u266D" : "b", // MUSIC FLAT SIGN
1748 |     "\u266F" : "$\\#$", // MUSIC SHARP SIGN
1749 |     "\u2701" : "$\\%<$", // UPPER BLADE SCISSORS
1750 |     "\u2702" : "$\\%<$", // BLACK SCISSORS
1751 |     "\u2703" : "$\\%<$", // LOWER BLADE SCISSORS
1752 |     "\u2704" : "$\\%<$", // WHITE SCISSORS
1753 |     "\u270C" : "V", // VICTORY HAND
1754 |     "\u2713" : "v", // CHECK MARK
1755 |     "\u2714" : "V", // HEAVY CHECK MARK
1756 |     "\u2715" : "x", // MULTIPLICATION X
1757 |     "\u2716" : "x", // HEAVY MULTIPLICATION X
1758 |     "\u2717" : "X", // BALLOT X
1759 |     "\u2718" : "X", // HEAVY BALLOT X
1760 |     "\u2719" : "+", // OUTLINED GREEK CROSS
1761 |     "\u271A" : "+", // HEAVY GREEK CROSS
1762 |     "\u271B" : "+", // OPEN CENTRE CROSS
1763 |     "\u271C" : "+", // HEAVY OPEN CENTRE CROSS
1764 |     "\u271D" : "+", // LATIN CROSS
1765 |     "\u271E" : "+", // SHADOWED WHITE LATIN CROSS
1766 |     "\u271F" : "+", // OUTLINED LATIN CROSS
1767 |     "\u2720" : "+", // MALTESE CROSS
1768 |     "\u2721" : "*", // STAR OF DAVID
1769 |     "\u2722" : "+", // FOUR TEARDROP-SPOKED ASTERISK
1770 |     "\u2723" : "+", // FOUR BALLOON-SPOKED ASTERISK
1771 |     "\u2724" : "+", // HEAVY FOUR BALLOON-SPOKED ASTERISK
1772 |     "\u2725" : "+", // FOUR CLUB-SPOKED ASTERISK
1773 |     "\u2726" : "+", // BLACK FOUR POINTED STAR
1774 |     "\u2727" : "+", // WHITE FOUR POINTED STAR
1775 |     "\u2729" : "*", // STRESS OUTLINED WHITE STAR
1776 |     "\u272A" : "*", // CIRCLED WHITE STAR
1777 |     "\u272B" : "*", // OPEN CENTRE BLACK STAR
1778 |     "\u272C" : "*", // BLACK CENTRE WHITE STAR
1779 |     "\u272D" : "*", // OUTLINED BLACK STAR
1780 |     "\u272E" : "*", // HEAVY OUTLINED BLACK STAR
1781 |     "\u272F" : "*", // PINWHEEL STAR
1782 |     "\u2730" : "*", // SHADOWED WHITE STAR
1783 |     "\u2731" : "*", // HEAVY ASTERISK
1784 |     "\u2732" : "*", // OPEN CENTRE ASTERISK
1785 |     "\u2733" : "*", // EIGHT SPOKED ASTERISK
1786 |     "\u2734" : "*", // EIGHT POINTED BLACK STAR
1787 |     "\u2735" : "*", // EIGHT POINTED PINWHEEL STAR
1788 |     "\u2736" : "*", // SIX POINTED BLACK STAR
1789 |     "\u2737" : "*", // EIGHT POINTED RECTILINEAR BLACK STAR
1790 |     "\u2738" : "*", // HEAVY EIGHT POINTED RECTILINEAR BLACK STAR
1791 |     "\u2739" : "*", // TWELVE POINTED BLACK STAR
1792 |     "\u273A" : "*", // SIXTEEN POINTED ASTERISK
1793 |     "\u273B" : "*", // TEARDROP-SPOKED ASTERISK
1794 |     "\u273C" : "*", // OPEN CENTRE TEARDROP-SPOKED ASTERISK
1795 |     "\u273D" : "*", // HEAVY TEARDROP-SPOKED ASTERISK
1796 |     "\u273E" : "*", // SIX PETALLED BLACK AND WHITE FLORETTE
1797 |     "\u273F" : "*", // BLACK FLORETTE
1798 |     "\u2740" : "*", // WHITE FLORETTE
1799 |     "\u2741" : "*", // EIGHT PETALLED OUTLINED BLACK FLORETTE
1800 |     "\u2742" : "*", // CIRCLED OPEN CENTRE EIGHT POINTED STAR
1801 |     "\u2743" : "*", // HEAVY TEARDROP-SPOKED PINWHEEL ASTERISK
1802 |     "\u2744" : "*", // SNOWFLAKE
1803 |     "\u2745" : "*", // TIGHT TRIFOLIATE SNOWFLAKE
1804 |     "\u2746" : "*", // HEAVY CHEVRON SNOWFLAKE
1805 |     "\u2747" : "*", // SPARKLE
1806 |     "\u2748" : "*", // HEAVY SPARKLE
1807 |     "\u2749" : "*", // BALLOON-SPOKED ASTERISK
1808 |     "\u274A" : "*", // EIGHT TEARDROP-SPOKED PROPELLER ASTERISK
1809 |     "\u274B" : "*", // HEAVY EIGHT TEARDROP-SPOKED PROPELLER ASTERISK
1810 |     "\uFB00" : "ff", // LATIN SMALL LIGATURE FF
1811 |     "\uFB01" : "fi", // LATIN SMALL LIGATURE FI
1812 |     "\uFB02" : "fl", // LATIN SMALL LIGATURE FL
1813 |     "\uFB03" : "ffi", // LATIN SMALL LIGATURE FFI
1814 |     "\uFB04" : "ffl", // LATIN SMALL LIGATURE FFL
1815 |     "\uFB05" : "st", // LATIN SMALL LIGATURE LONG S T
1816 |     "\uFB06" : "st", // LATIN SMALL LIGATURE ST
1817 |     /* Derived accented characters */
1818 | 
1819 |     "\u00C0" : "\\`{A}", // LATIN CAPITAL LETTER A WITH GRAVE
1820 |     "\u00C1" : "\\'{A}", // LATIN CAPITAL LETTER A WITH ACUTE
1821 |     "\u00C2" : "\\^{A}", // LATIN CAPITAL LETTER A WITH CIRCUMFLEX
1822 |     "\u00C3" : "\\~{A}", // LATIN CAPITAL LETTER A WITH TILDE
1823 |     "\u00C4" : "\\\"{A}", // LATIN CAPITAL LETTER A WITH DIAERESIS
1824 |     "\u00C7" : "\\c{C}", // LATIN CAPITAL LETTER C WITH CEDILLA
1825 |     "\u00C8" : "\\`{E}", // LATIN CAPITAL LETTER E WITH GRAVE
1826 |     "\u00C9" : "\\'{E}", // LATIN CAPITAL LETTER E WITH ACUTE
1827 |     "\u00CA" : "\\^{E}", // LATIN CAPITAL LETTER E WITH CIRCUMFLEX
1828 |     "\u00CB" : "\\\"{E}", // LATIN CAPITAL LETTER E WITH DIAERESIS
1829 |     "\u00CC" : "\\`{I}", // LATIN CAPITAL LETTER I WITH GRAVE
1830 |     "\u00CD" : "\\'{I}", // LATIN CAPITAL LETTER I WITH ACUTE
1831 |     "\u00CE" : "\\^{I}", // LATIN CAPITAL LETTER I WITH CIRCUMFLEX
1832 |     "\u00CF" : "\\\"{I}", // LATIN CAPITAL LETTER I WITH DIAERESIS
1833 |     "\u00D1" : "\\~{N}", // LATIN CAPITAL LETTER N WITH TILDE
1834 |     "\u00D2" : "\\`{O}", // LATIN CAPITAL LETTER O WITH GRAVE
1835 |     "\u00D3" : "\\'{O}", // LATIN CAPITAL LETTER O WITH ACUTE
1836 |     "\u00D4" : "\\^{O}", // LATIN CAPITAL LETTER O WITH CIRCUMFLEX
1837 |     "\u00D5" : "\\~{O}", // LATIN CAPITAL LETTER O WITH TILDE
1838 |     "\u00D6" : "\\\"{O}", // LATIN CAPITAL LETTER O WITH DIAERESIS
1839 |     "\u00D9" : "\\`{U}", // LATIN CAPITAL LETTER U WITH GRAVE
1840 |     "\u00DA" : "\\'{U}", // LATIN CAPITAL LETTER U WITH ACUTE
1841 |     "\u00DB" : "\\^{U}", // LATIN CAPITAL LETTER U WITH CIRCUMFLEX
1842 |     "\u00DC" : "\\\"{U}", // LATIN CAPITAL LETTER U WITH DIAERESIS
1843 |     "\u00DD" : "\\'{Y}", // LATIN CAPITAL LETTER Y WITH ACUTE
1844 |     "\u00E0" : "\\`{a}", // LATIN SMALL LETTER A WITH GRAVE
1845 |     "\u00E1" : "\\'{a}", // LATIN SMALL LETTER A WITH ACUTE
1846 |     "\u00E2" : "\\^{a}", // LATIN SMALL LETTER A WITH CIRCUMFLEX
1847 |     "\u00E3" : "\\~{a}", // LATIN SMALL LETTER A WITH TILDE
1848 |     "\u00E4" : "\\\"{a}", // LATIN SMALL LETTER A WITH DIAERESIS
1849 |     "\u00E7" : "\\c{c}", // LATIN SMALL LETTER C WITH CEDILLA
1850 |     "\u00E8" : "\\`{e}", // LATIN SMALL LETTER E WITH GRAVE
1851 |     "\u00E9" : "\\'{e}", // LATIN SMALL LETTER E WITH ACUTE
1852 |     "\u00EA" : "\\^{e}", // LATIN SMALL LETTER E WITH CIRCUMFLEX
1853 |     "\u00EB" : "\\\"{e}", // LATIN SMALL LETTER E WITH DIAERESIS
1854 |     "\u00EC" : "\\`{i}", // LATIN SMALL LETTER I WITH GRAVE
1855 |     "\u00ED" : "\\'{i}", // LATIN SMALL LETTER I WITH ACUTE
1856 |     "\u00EE" : "\\^{i}", // LATIN SMALL LETTER I WITH CIRCUMFLEX
1857 |     "\u00EF" : "\\\"{i}", // LATIN SMALL LETTER I WITH DIAERESIS
1858 |     "\u00F1" : "\\~{n}", // LATIN SMALL LETTER N WITH TILDE
1859 |     "\u00F2" : "\\`{o}", // LATIN SMALL LETTER O WITH GRAVE
1860 |     "\u00F3" : "\\'{o}", // LATIN SMALL LETTER O WITH ACUTE
1861 |     "\u00F4" : "\\^{o}", // LATIN SMALL LETTER O WITH CIRCUMFLEX
1862 |     "\u00F5" : "\\~{o}", // LATIN SMALL LETTER O WITH TILDE
1863 |     "\u00F6" : "\\\"{o}", // LATIN SMALL LETTER O WITH DIAERESIS
1864 |     "\u00F9" : "\\`{u}", // LATIN SMALL LETTER U WITH GRAVE
1865 |     "\u00FA" : "\\'{u}", // LATIN SMALL LETTER U WITH ACUTE
1866 |     "\u00FB" : "\\^{u}", // LATIN SMALL LETTER U WITH CIRCUMFLEX
1867 |     "\u00FC" : "\\\"{u}", // LATIN SMALL LETTER U WITH DIAERESIS
1868 |     "\u00FD" : "\\'{y}", // LATIN SMALL LETTER Y WITH ACUTE
1869 |     "\u00FF" : "\\\"{y}", // LATIN SMALL LETTER Y WITH DIAERESIS
1870 |     "\u0100" : "\\={A}", // LATIN CAPITAL LETTER A WITH MACRON
1871 |     "\u0101" : "\\={a}", // LATIN SMALL LETTER A WITH MACRON
1872 |     "\u0102" : "\\u{A}", // LATIN CAPITAL LETTER A WITH BREVE
1873 |     "\u0103" : "\\u{a}", // LATIN SMALL LETTER A WITH BREVE
1874 |     "\u0104" : "\\k{A}", // LATIN CAPITAL LETTER A WITH OGONEK
1875 |     "\u0105" : "\\k{a}", // LATIN SMALL LETTER A WITH OGONEK
1876 |     "\u0106" : "\\'{C}", // LATIN CAPITAL LETTER C WITH ACUTE
1877 |     "\u0107" : "\\'{c}", // LATIN SMALL LETTER C WITH ACUTE
1878 |     "\u0108" : "\\^{C}", // LATIN CAPITAL LETTER C WITH CIRCUMFLEX
1879 |     "\u0109" : "\\^{c}", // LATIN SMALL LETTER C WITH CIRCUMFLEX
1880 |     "\u010A" : "\\.{C}", // LATIN CAPITAL LETTER C WITH DOT ABOVE
1881 |     "\u010B" : "\\.{c}", // LATIN SMALL LETTER C WITH DOT ABOVE
1882 |     "\u010C" : "\\v{C}", // LATIN CAPITAL LETTER C WITH CARON
1883 |     "\u010D" : "\\v{c}", // LATIN SMALL LETTER C WITH CARON
1884 |     "\u010E" : "\\v{D}", // LATIN CAPITAL LETTER D WITH CARON
1885 |     "\u010F" : "\\v{d}", // LATIN SMALL LETTER D WITH CARON
1886 |     "\u0112" : "\\={E}", // LATIN CAPITAL LETTER E WITH MACRON
1887 |     "\u0113" : "\\={e}", // LATIN SMALL LETTER E WITH MACRON
1888 |     "\u0114" : "\\u{E}", // LATIN CAPITAL LETTER E WITH BREVE
1889 |     "\u0115" : "\\u{e}", // LATIN SMALL LETTER E WITH BREVE
1890 |     "\u0116" : "\\.{E}", // LATIN CAPITAL LETTER E WITH DOT ABOVE
1891 |     "\u0117" : "\\.{e}", // LATIN SMALL LETTER E WITH DOT ABOVE
1892 |     "\u0118" : "\\k{E}", // LATIN CAPITAL LETTER E WITH OGONEK
1893 |     "\u0119" : "\\k{e}", // LATIN SMALL LETTER E WITH OGONEK
1894 |     "\u011A" : "\\v{E}", // LATIN CAPITAL LETTER E WITH CARON
1895 |     "\u011B" : "\\v{e}", // LATIN SMALL LETTER E WITH CARON
1896 |     "\u011C" : "\\^{G}", // LATIN CAPITAL LETTER G WITH CIRCUMFLEX
1897 |     "\u011D" : "\\^{g}", // LATIN SMALL LETTER G WITH CIRCUMFLEX
1898 |     "\u011E" : "\\u{G}", // LATIN CAPITAL LETTER G WITH BREVE
1899 |     "\u011F" : "\\u{g}", // LATIN SMALL LETTER G WITH BREVE
1900 |     "\u0120" : "\\.{G}", // LATIN CAPITAL LETTER G WITH DOT ABOVE
1901 |     "\u0121" : "\\.{g}", // LATIN SMALL LETTER G WITH DOT ABOVE
1902 |     "\u0122" : "\\c{G}", // LATIN CAPITAL LETTER G WITH CEDILLA
1903 |     "\u0123" : "\\c{g}", // LATIN SMALL LETTER G WITH CEDILLA
1904 |     "\u0124" : "\\^{H}", // LATIN CAPITAL LETTER H WITH CIRCUMFLEX
1905 |     "\u0125" : "\\^{h}", // LATIN SMALL LETTER H WITH CIRCUMFLEX
1906 |     "\u0128" : "\\~{I}", // LATIN CAPITAL LETTER I WITH TILDE
1907 |     "\u0129" : "\\~{i}", // LATIN SMALL LETTER I WITH TILDE
1908 |     "\u012A" : "\\={I}", // LATIN CAPITAL LETTER I WITH MACRON
1909 |     "\u012B" : "\\={i}", // LATIN SMALL LETTER I WITH MACRON
1910 |     "\u012C" : "\\u{I}", // LATIN CAPITAL LETTER I WITH BREVE
1911 |     "\u012D" : "\\u{i}", // LATIN SMALL LETTER I WITH BREVE
1912 |     "\u012E" : "\\k{I}", // LATIN CAPITAL LETTER I WITH OGONEK
1913 |     "\u012F" : "\\k{i}", // LATIN SMALL LETTER I WITH OGONEK
1914 |     "\u0130" : "\\.{I}", // LATIN CAPITAL LETTER I WITH DOT ABOVE
1915 |     "\u0134" : "\\^{J}", // LATIN CAPITAL LETTER J WITH CIRCUMFLEX
1916 |     "\u0135" : "\\^{j}", // LATIN SMALL LETTER J WITH CIRCUMFLEX
1917 |     "\u0136" : "\\c{K}", // LATIN CAPITAL LETTER K WITH CEDILLA
1918 |     "\u0137" : "\\c{k}", // LATIN SMALL LETTER K WITH CEDILLA
1919 |     "\u0139" : "\\'{L}", // LATIN CAPITAL LETTER L WITH ACUTE
1920 |     "\u013A" : "\\'{l}", // LATIN SMALL LETTER L WITH ACUTE
1921 |     "\u013B" : "\\c{L}", // LATIN CAPITAL LETTER L WITH CEDILLA
1922 |     "\u013C" : "\\c{l}", // LATIN SMALL LETTER L WITH CEDILLA
1923 |     "\u013D" : "\\v{L}", // LATIN CAPITAL LETTER L WITH CARON
1924 |     "\u013E" : "\\v{l}", // LATIN SMALL LETTER L WITH CARON
1925 |     "\u0141" : "\\L{}", //LATIN CAPITAL LETTER L WITH STROKE
1926 |     "\u0142" : "\\l{}", //LATIN SMALL LETTER L WITH STROKE
1927 |     "\u0143" : "\\'{N}", // LATIN CAPITAL LETTER N WITH ACUTE
1928 |     "\u0144" : "\\'{n}", // LATIN SMALL LETTER N WITH ACUTE
1929 |     "\u0145" : "\\c{N}", // LATIN CAPITAL LETTER N WITH CEDILLA
1930 |     "\u0146" : "\\c{n}", // LATIN SMALL LETTER N WITH CEDILLA
1931 |     "\u0147" : "\\v{N}", // LATIN CAPITAL LETTER N WITH CARON
1932 |     "\u0148" : "\\v{n}", // LATIN SMALL LETTER N WITH CARON
1933 |     "\u014C" : "\\={O}", // LATIN CAPITAL LETTER O WITH MACRON
1934 |     "\u014D" : "\\={o}", // LATIN SMALL LETTER O WITH MACRON
1935 |     "\u014E" : "\\u{O}", // LATIN CAPITAL LETTER O WITH BREVE
1936 |     "\u014F" : "\\u{o}", // LATIN SMALL LETTER O WITH BREVE
1937 |     "\u0150" : "\\H{O}", // LATIN CAPITAL LETTER O WITH DOUBLE ACUTE
1938 |     "\u0151" : "\\H{o}", // LATIN SMALL LETTER O WITH DOUBLE ACUTE
1939 |     "\u0154" : "\\'{R}", // LATIN CAPITAL LETTER R WITH ACUTE
1940 |     "\u0155" : "\\'{r}", // LATIN SMALL LETTER R WITH ACUTE
1941 |     "\u0156" : "\\c{R}", // LATIN CAPITAL LETTER R WITH CEDILLA
1942 |     "\u0157" : "\\c{r}", // LATIN SMALL LETTER R WITH CEDILLA
1943 |     "\u0158" : "\\v{R}", // LATIN CAPITAL LETTER R WITH CARON
1944 |     "\u0159" : "\\v{r}", // LATIN SMALL LETTER R WITH CARON
1945 |     "\u015A" : "\\'{S}", // LATIN CAPITAL LETTER S WITH ACUTE
1946 |     "\u015B" : "\\'{s}", // LATIN SMALL LETTER S WITH ACUTE
1947 |     "\u015C" : "\\^{S}", // LATIN CAPITAL LETTER S WITH CIRCUMFLEX
1948 |     "\u015D" : "\\^{s}", // LATIN SMALL LETTER S WITH CIRCUMFLEX
1949 |     "\u015E" : "\\c{S}", // LATIN CAPITAL LETTER S WITH CEDILLA
1950 |     "\u015F" : "\\c{s}", // LATIN SMALL LETTER S WITH CEDILLA
1951 |     "\u0160" : "\\v{S}", // LATIN CAPITAL LETTER S WITH CARON
1952 |     "\u0161" : "\\v{s}", // LATIN SMALL LETTER S WITH CARON
1953 |     "\u0162" : "\\c{T}", // LATIN CAPITAL LETTER T WITH CEDILLA
1954 |     "\u0163" : "\\c{t}", // LATIN SMALL LETTER T WITH CEDILLA
1955 |     "\u0164" : "\\v{T}", // LATIN CAPITAL LETTER T WITH CARON
1956 |     "\u0165" : "\\v{t}", // LATIN SMALL LETTER T WITH CARON
1957 |     "\u0168" : "\\~{U}", // LATIN CAPITAL LETTER U WITH TILDE
1958 |     "\u0169" : "\\~{u}", // LATIN SMALL LETTER U WITH TILDE
1959 |     "\u016A" : "\\={U}", // LATIN CAPITAL LETTER U WITH MACRON
1960 |     "\u016B" : "\\={u}", // LATIN SMALL LETTER U WITH MACRON
1961 |     "\u016C" : "\\u{U}", // LATIN CAPITAL LETTER U WITH BREVE
1962 |     "\u016D" : "\\u{u}", // LATIN SMALL LETTER U WITH BREVE
1963 |     "\u0170" : "\\H{U}", // LATIN CAPITAL LETTER U WITH DOUBLE ACUTE
1964 |     "\u0171" : "\\H{u}", // LATIN SMALL LETTER U WITH DOUBLE ACUTE
1965 |     "\u0172" : "\\k{U}", // LATIN CAPITAL LETTER U WITH OGONEK
1966 |     "\u0173" : "\\k{u}", // LATIN SMALL LETTER U WITH OGONEK
1967 |     "\u0174" : "\\^{W}", // LATIN CAPITAL LETTER W WITH CIRCUMFLEX
1968 |     "\u0175" : "\\^{w}", // LATIN SMALL LETTER W WITH CIRCUMFLEX
1969 |     "\u0176" : "\\^{Y}", // LATIN CAPITAL LETTER Y WITH CIRCUMFLEX
1970 |     "\u0177" : "\\^{y}", // LATIN SMALL LETTER Y WITH CIRCUMFLEX
1971 |     "\u0178" : "\\\"{Y}", // LATIN CAPITAL LETTER Y WITH DIAERESIS
1972 |     "\u0179" : "\\'{Z}", // LATIN CAPITAL LETTER Z WITH ACUTE
1973 |     "\u017A" : "\\'{z}", // LATIN SMALL LETTER Z WITH ACUTE
1974 |     "\u017B" : "\\.{Z}", // LATIN CAPITAL LETTER Z WITH DOT ABOVE
1975 |     "\u017C" : "\\.{z}", // LATIN SMALL LETTER Z WITH DOT ABOVE
1976 |     "\u017D" : "\\v{Z}", // LATIN CAPITAL LETTER Z WITH CARON
1977 |     "\u017E" : "\\v{z}", // LATIN SMALL LETTER Z WITH CARON
1978 |     "\u01CD" : "\\v{A}", // LATIN CAPITAL LETTER A WITH CARON
1979 |     "\u01CE" : "\\v{a}", // LATIN SMALL LETTER A WITH CARON
1980 |     "\u01CF" : "\\v{I}", // LATIN CAPITAL LETTER I WITH CARON
1981 |     "\u01D0" : "\\v{i}", // LATIN SMALL LETTER I WITH CARON
1982 |     "\u01D1" : "\\v{O}", // LATIN CAPITAL LETTER O WITH CARON
1983 |     "\u01D2" : "\\v{o}", // LATIN SMALL LETTER O WITH CARON
1984 |     "\u01D3" : "\\v{U}", // LATIN CAPITAL LETTER U WITH CARON
1985 |     "\u01D4" : "\\v{u}", // LATIN SMALL LETTER U WITH CARON
1986 |     "\u01E6" : "\\v{G}", // LATIN CAPITAL LETTER G WITH CARON
1987 |     "\u01E7" : "\\v{g}", // LATIN SMALL LETTER G WITH CARON
1988 |     "\u01E8" : "\\v{K}", // LATIN CAPITAL LETTER K WITH CARON
1989 |     "\u01E9" : "\\v{k}", // LATIN SMALL LETTER K WITH CARON
1990 |     "\u01EA" : "\\k{O}", // LATIN CAPITAL LETTER O WITH OGONEK
1991 |     "\u01EB" : "\\k{o}", // LATIN SMALL LETTER O WITH OGONEK
1992 |     "\u01F0" : "\\v{j}", // LATIN SMALL LETTER J WITH CARON
1993 |     "\u01F4" : "\\'{G}", // LATIN CAPITAL LETTER G WITH ACUTE
1994 |     "\u01F5" : "\\'{g}", // LATIN SMALL LETTER G WITH ACUTE
1995 |     "\u1E02" : "\\.{B}", // LATIN CAPITAL LETTER B WITH DOT ABOVE
1996 |     "\u1E03" : "\\.{b}", // LATIN SMALL LETTER B WITH DOT ABOVE
1997 |     "\u1E04" : "\\d{B}", // LATIN CAPITAL LETTER B WITH DOT BELOW
1998 |     "\u1E05" : "\\d{b}", // LATIN SMALL LETTER B WITH DOT BELOW
1999 |     "\u1E06" : "\\b{B}", // LATIN CAPITAL LETTER B WITH LINE BELOW
2000 |     "\u1E07" : "\\b{b}", // LATIN SMALL LETTER B WITH LINE BELOW
2001 |     "\u1E0A" : "\\.{D}", // LATIN CAPITAL LETTER D WITH DOT ABOVE
2002 |     "\u1E0B" : "\\.{d}", // LATIN SMALL LETTER D WITH DOT ABOVE
2003 |     "\u1E0C" : "\\d{D}", // LATIN CAPITAL LETTER D WITH DOT BELOW
2004 |     "\u1E0D" : "\\d{d}", // LATIN SMALL LETTER D WITH DOT BELOW
2005 |     "\u1E0E" : "\\b{D}", // LATIN CAPITAL LETTER D WITH LINE BELOW
2006 |     "\u1E0F" : "\\b{d}", // LATIN SMALL LETTER D WITH LINE BELOW
2007 |     "\u1E10" : "\\c{D}", // LATIN CAPITAL LETTER D WITH CEDILLA
2008 |     "\u1E11" : "\\c{d}", // LATIN SMALL LETTER D WITH CEDILLA
2009 |     "\u1E1E" : "\\.{F}", // LATIN CAPITAL LETTER F WITH DOT ABOVE
2010 |     "\u1E1F" : "\\.{f}", // LATIN SMALL LETTER F WITH DOT ABOVE
2011 |     "\u1E20" : "\\={G}", // LATIN CAPITAL LETTER G WITH MACRON
2012 |     "\u1E21" : "\\={g}", // LATIN SMALL LETTER G WITH MACRON
2013 |     "\u1E22" : "\\.{H}", // LATIN CAPITAL LETTER H WITH DOT ABOVE
2014 |     "\u1E23" : "\\.{h}", // LATIN SMALL LETTER H WITH DOT ABOVE
2015 |     "\u1E24" : "\\d{H}", // LATIN CAPITAL LETTER H WITH DOT BELOW
2016 |     "\u1E25" : "\\d{h}", // LATIN SMALL LETTER H WITH DOT BELOW
2017 |     "\u1E26" : "\\\"{H}", // LATIN CAPITAL LETTER H WITH DIAERESIS
2018 |     "\u1E27" : "\\\"{h}", // LATIN SMALL LETTER H WITH DIAERESIS
2019 |     "\u1E28" : "\\c{H}", // LATIN CAPITAL LETTER H WITH CEDILLA
2020 |     "\u1E29" : "\\c{h}", // LATIN SMALL LETTER H WITH CEDILLA
2021 |     "\u1E30" : "\\'{K}", // LATIN CAPITAL LETTER K WITH ACUTE
2022 |     "\u1E31" : "\\'{k}", // LATIN SMALL LETTER K WITH ACUTE
2023 |     "\u1E32" : "\\d{K}", // LATIN CAPITAL LETTER K WITH DOT BELOW
2024 |     "\u1E33" : "\\d{k}", // LATIN SMALL LETTER K WITH DOT BELOW
2025 |     "\u1E34" : "\\b{K}", // LATIN CAPITAL LETTER K WITH LINE BELOW
2026 |     "\u1E35" : "\\b{k}", // LATIN SMALL LETTER K WITH LINE BELOW
2027 |     "\u1E36" : "\\d{L}", // LATIN CAPITAL LETTER L WITH DOT BELOW
2028 |     "\u1E37" : "\\d{l}", // LATIN SMALL LETTER L WITH DOT BELOW
2029 |     "\u1E3A" : "\\b{L}", // LATIN CAPITAL LETTER L WITH LINE BELOW
2030 |     "\u1E3B" : "\\b{l}", // LATIN SMALL LETTER L WITH LINE BELOW
2031 |     "\u1E3E" : "\\'{M}", // LATIN CAPITAL LETTER M WITH ACUTE
2032 |     "\u1E3F" : "\\'{m}", // LATIN SMALL LETTER M WITH ACUTE
2033 |     "\u1E40" : "\\.{M}", // LATIN CAPITAL LETTER M WITH DOT ABOVE
2034 |     "\u1E41" : "\\.{m}", // LATIN SMALL LETTER M WITH DOT ABOVE
2035 |     "\u1E42" : "\\d{M}", // LATIN CAPITAL LETTER M WITH DOT BELOW
2036 |     "\u1E43" : "\\d{m}", // LATIN SMALL LETTER M WITH DOT BELOW
2037 |     "\u1E44" : "\\.{N}", // LATIN CAPITAL LETTER N WITH DOT ABOVE
2038 |     "\u1E45" : "\\.{n}", // LATIN SMALL LETTER N WITH DOT ABOVE
2039 |     "\u1E46" : "\\d{N}", // LATIN CAPITAL LETTER N WITH DOT BELOW
2040 |     "\u1E47" : "\\d{n}", // LATIN SMALL LETTER N WITH DOT BELOW
2041 |     "\u1E48" : "\\b{N}", // LATIN CAPITAL LETTER N WITH LINE BELOW
2042 |     "\u1E49" : "\\b{n}", // LATIN SMALL LETTER N WITH LINE BELOW
2043 |     "\u1E54" : "\\'{P}", // LATIN CAPITAL LETTER P WITH ACUTE
2044 |     "\u1E55" : "\\'{p}", // LATIN SMALL LETTER P WITH ACUTE
2045 |     "\u1E56" : "\\.{P}", // LATIN CAPITAL LETTER P WITH DOT ABOVE
2046 |     "\u1E57" : "\\.{p}", // LATIN SMALL LETTER P WITH DOT ABOVE
2047 |     "\u1E58" : "\\.{R}", // LATIN CAPITAL LETTER R WITH DOT ABOVE
2048 |     "\u1E59" : "\\.{r}", // LATIN SMALL LETTER R WITH DOT ABOVE
2049 |     "\u1E5A" : "\\d{R}", // LATIN CAPITAL LETTER R WITH DOT BELOW
2050 |     "\u1E5B" : "\\d{r}", // LATIN SMALL LETTER R WITH DOT BELOW
2051 |     "\u1E5E" : "\\b{R}", // LATIN CAPITAL LETTER R WITH LINE BELOW
2052 |     "\u1E5F" : "\\b{r}", // LATIN SMALL LETTER R WITH LINE BELOW
2053 |     "\u1E60" : "\\.{S}", // LATIN CAPITAL LETTER S WITH DOT ABOVE
2054 |     "\u1E61" : "\\.{s}", // LATIN SMALL LETTER S WITH DOT ABOVE
2055 |     "\u1E62" : "\\d{S}", // LATIN CAPITAL LETTER S WITH DOT BELOW
2056 |     "\u1E63" : "\\d{s}", // LATIN SMALL LETTER S WITH DOT BELOW
2057 |     "\u1E6A" : "\\.{T}", // LATIN CAPITAL LETTER T WITH DOT ABOVE
2058 |     "\u1E6B" : "\\.{t}", // LATIN SMALL LETTER T WITH DOT ABOVE
2059 |     "\u1E6C" : "\\d{T}", // LATIN CAPITAL LETTER T WITH DOT BELOW
2060 |     "\u1E6D" : "\\d{t}", // LATIN SMALL LETTER T WITH DOT BELOW
2061 |     "\u1E6E" : "\\b{T}", // LATIN CAPITAL LETTER T WITH LINE BELOW
2062 |     "\u1E6F" : "\\b{t}", // LATIN SMALL LETTER T WITH LINE BELOW
2063 |     "\u1E7C" : "\\~{V}", // LATIN CAPITAL LETTER V WITH TILDE
2064 |     "\u1E7D" : "\\~{v}", // LATIN SMALL LETTER V WITH TILDE
2065 |     "\u1E7E" : "\\d{V}", // LATIN CAPITAL LETTER V WITH DOT BELOW
2066 |     "\u1E7F" : "\\d{v}", // LATIN SMALL LETTER V WITH DOT BELOW
2067 |     "\u1E80" : "\\`{W}", // LATIN CAPITAL LETTER W WITH GRAVE
2068 |     "\u1E81" : "\\`{w}", // LATIN SMALL LETTER W WITH GRAVE
2069 |     "\u1E82" : "\\'{W}", // LATIN CAPITAL LETTER W WITH ACUTE
2070 |     "\u1E83" : "\\'{w}", // LATIN SMALL LETTER W WITH ACUTE
2071 |     "\u1E84" : "\\\"{W}", // LATIN CAPITAL LETTER W WITH DIAERESIS
2072 |     "\u1E85" : "\\\"{w}", // LATIN SMALL LETTER W WITH DIAERESIS
2073 |     "\u1E86" : "\\.{W}", // LATIN CAPITAL LETTER W WITH DOT ABOVE
2074 |     "\u1E87" : "\\.{w}", // LATIN SMALL LETTER W WITH DOT ABOVE
2075 |     "\u1E88" : "\\d{W}", // LATIN CAPITAL LETTER W WITH DOT BELOW
2076 |     "\u1E89" : "\\d{w}", // LATIN SMALL LETTER W WITH DOT BELOW
2077 |     "\u1E8A" : "\\.{X}", // LATIN CAPITAL LETTER X WITH DOT ABOVE
2078 |     "\u1E8B" : "\\.{x}", // LATIN SMALL LETTER X WITH DOT ABOVE
2079 |     "\u1E8C" : "\\\"{X}", // LATIN CAPITAL LETTER X WITH DIAERESIS
2080 |     "\u1E8D" : "\\\"{x}", // LATIN SMALL LETTER X WITH DIAERESIS
2081 |     "\u1E8E" : "\\.{Y}", // LATIN CAPITAL LETTER Y WITH DOT ABOVE
2082 |     "\u1E8F" : "\\.{y}", // LATIN SMALL LETTER Y WITH DOT ABOVE
2083 |     "\u1E90" : "\\^{Z}", // LATIN CAPITAL LETTER Z WITH CIRCUMFLEX
2084 |     "\u1E91" : "\\^{z}", // LATIN SMALL LETTER Z WITH CIRCUMFLEX
2085 |     "\u1E92" : "\\d{Z}", // LATIN CAPITAL LETTER Z WITH DOT BELOW
2086 |     "\u1E93" : "\\d{z}", // LATIN SMALL LETTER Z WITH DOT BELOW
2087 |     "\u1E94" : "\\b{Z}", // LATIN CAPITAL LETTER Z WITH LINE BELOW
2088 |     "\u1E95" : "\\b{z}", // LATIN SMALL LETTER Z WITH LINE BELOW
2089 |     "\u1E96" : "\\b{h}", // LATIN SMALL LETTER H WITH LINE BELOW
2090 |     "\u1E97" : "\\\"{t}", // LATIN SMALL LETTER T WITH DIAERESIS
2091 |     "\u1EA0" : "\\d{A}", // LATIN CAPITAL LETTER A WITH DOT BELOW
2092 |     "\u1EA1" : "\\d{a}", // LATIN SMALL LETTER A WITH DOT BELOW
2093 |     "\u1EB8" : "\\d{E}", // LATIN CAPITAL LETTER E WITH DOT BELOW
2094 |     "\u1EB9" : "\\d{e}", // LATIN SMALL LETTER E WITH DOT BELOW
2095 |     "\u1EBC" : "\\~{E}", // LATIN CAPITAL LETTER E WITH TILDE
2096 |     "\u1EBD" : "\\~{e}", // LATIN SMALL LETTER E WITH TILDE
2097 |     "\u1ECA" : "\\d{I}", // LATIN CAPITAL LETTER I WITH DOT BELOW
2098 |     "\u1ECB" : "\\d{i}", // LATIN SMALL LETTER I WITH DOT BELOW
2099 |     "\u1ECC" : "\\d{O}", // LATIN CAPITAL LETTER O WITH DOT BELOW
2100 |     "\u1ECD" : "\\d{o}", // LATIN SMALL LETTER O WITH DOT BELOW
2101 |     "\u1EE4" : "\\d{U}", // LATIN CAPITAL LETTER U WITH DOT BELOW
2102 |     "\u1EE5" : "\\d{u}", // LATIN SMALL LETTER U WITH DOT BELOW
2103 |     "\u1EF2" : "\\`{Y}", // LATIN CAPITAL LETTER Y WITH GRAVE
2104 |     "\u1EF3" : "\\`{y}", // LATIN SMALL LETTER Y WITH GRAVE
2105 |     "\u1EF4" : "\\d{Y}", // LATIN CAPITAL LETTER Y WITH DOT BELOW
2106 |     "\u1EF5" : "\\d{y}", // LATIN SMALL LETTER Y WITH DOT BELOW
2107 |     "\u1EF8" : "\\~{Y}", // LATIN CAPITAL LETTER Y WITH TILDE
2108 |     "\u1EF9" : "\\~{y}" // LATIN SMALL LETTER Y WITH TILDE
2109 | };
2110 | 


--------------------------------------------------------------------------------