Fixed version to 1.3.2, adjusted links, and updated readme.

mronkko · Dec 1, 2017 · 02ba80f · 02ba80f
1 parent a220f5e
commit 02ba80f
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,75 @@ ZoteroQuickLook
 
 This open source project implements QuickLook in Zotero.
 
-This is a fork of the extension developed by Mikko Rönkkö to maintain compatibility with Zotero 5.
+# Installing
 
-Please post any questions or bugs to the Zotero forums.
+To install ZoteroQuickLook, download the latest version of `zoteroquicklook.xpi` from the Releases section of this GitHub repo. In **Zotero** (not in Firefox), open Tools -> Add-ons. Then drag the `zoteroquicklook.xpi` file onto the Zotero Add-ons window.
 
-For installation and support information, see [this repo's wiki](https://github.com/bwiernik/ZoteroQuickLook/wiki).
+## Installing on Mac
+On Mac, ZoteroQuickLook uses macOS's native QuickLook functionality. No additional steps are needed.
+
+## Installing on Linux
+
+On Linux, you must install [Gloobus-Preview](https://launchpad.net/gloobus-preview), a QuickLook-like preview software. On Ubuntu you can do this by running the following commands in terminal:
+
+```
+sudo add-apt-repository ppa:gloobus-dev/gloobus-preview
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get install gloobus-preview
+```
+
+For other distributions and versions the installation might be different.
+
+If you do not like Gloobus, you can define a custom QuickLook command:
+ 1. Install the software you want to use for previewing files. The software must be able to take a file name as a command line parameter.
+ 1. Open the Config Editor in Zotero's Advanced preferences pane.
+ 1. Search for `extensions.zoteroquicklook.customviewcommand`. Set the value for this config to the full path of the executable that you want to use to show the files.
+
+## Installing on Windows
+
+On Windows, you must first install a QuickLook tool. By default, ZoteroQuickLook is set up to work with [MaComfort](https://leonardo.re/macomfort/). However, this is a paid software and can be quite resource intensive and buggy. Several free, open source, and more stable tools exist. Available QuickLook tools for Windows include [QuickLook](http://pooi.moe/QuickLook/), [Seer](1218.io), and [WinQuickLook](https://github.com/shibayan/WinQuickLook). You can choose another QuickLook program if you like. The software must be able to take a file name as a command line parameter.
+
+After installing a QuickLook program, set ZoteroQuickLook to use this program:
+ 1. Open the Config Editor in Zotero's Advanced preferences pane.
+ 1. Search for `extensions.zoteroquicklook.customviewcommand`. Set the value for this config to the full path of the executable that you want to use to show the files.
+
+### Alternative build for Windows
+
+Installing the extension on Windows sometimes fails with the error message: "ZoteroQuickLook cannot be installed because Zotero cannot modify the needed file." This is a Windows specific problem caused by the 256 character filename length limitation. This limit is reached during unpacking the xpi archive when installing the extension. Mozilla has fixed the issue by eliminating unpacking of extensions by default and running them directly from the xpi archive. However, this solution does not work for ZoteroQuickLook because on Mac and Linux, the extension uses executable files that need to be unpacked so that they can be run. These files are not used on Windows and there is a parallel version of ZoteroQuickLook that supports running directly from the xpi file. This version is called `zoteroquicklook-windows.xpi` and is available from the Releases section of this GitHub repo. 
+
+You can read more about the problem on [Stack Overflow](http://stackoverflow.com/questions/7872489/addon-cannot-be-installed-by-an-error-of-not-be-able-to-modify-the-needed-file) and the pages linked to from there. 
+
+# Getting support
+
+I have limited experience with the full ZoteroQuickLook code, so I may be limited in my ability to fix bugs, but I will do my best to help.
+
+Please post any questions or bugs to the Zotero forums. Include "ZoteroQuickLook" in the thread title. Also include the following information:
+ - Operating system and version (e.g., macOS 10.13.2)
+ - Zotero version
+ - ZoteroQuickLook version
+ - Detailed description of your problem
+ - A link to a log file (see the next section)
+ - If on windows, whether loading the alternative Windows build fixes the issue
+
+## Log files
+
+Log file will sometimes be helpful in diagnosing possible issues, so you need to submit a log file when asking for support. 
+
+To create a log file, in Zotero, follow these steps:
+ 1. Click Help -> Debug Output Logging -> Restart with Logging Enabled….
+ 1. After Zotero restarts, click Help -> View Output.
+ 1. Copy the content of the log that appears and paste it to (gist.github.com).
+ 1. Click "Create secret gist", then copy paste the URL of the gist to your thread on the Zotero forums.
+
+The important information is in the beginning of the log. Here are example lines from the beginning of a log file. Make sure that your log file starts with similar lines to ensure that the log is complete.
+
+```
+zotero(3): Using data directory /Users/user/Zotero/
+
+zotero(3): IPC: Initializing pipe at /Users/user/Zotero/pipes/1376326753918
+
+zotero(3): Loading in full mode
+
+zotero(3): Opening database 'zotero'
+```
diff --git a/install-altwindows.rdf b/install-altwindows.rdf
@@ -4,11 +4,11 @@
     <em:id>[email protected]</em:id>
     <em:type>2</em:type> <!-- type=extension -->
     <em:name>ZoteroQuickLook</em:name>
-    <em:version>1.4.0</em:version>
+    <em:version>1.3.2</em:version>
     <em:creator>Mikko Ronkko</em:creator>
     <em:contributor>Brenton M. Wiernik</em:contributor>
     <em:description>Quick Look Utility for Zotero.</em:description>
-    <em:updateURL>https://raw.githubusercontent.com/bwiernik/ZoteroQuickLook/master/update-altwindows.rdf</em:updateURL>
+    <em:updateURL>https://raw.githubusercontent.com/mronkko/ZoteroQuickLook/master/update-altwindows.rdf</em:updateURL>
     <em:targetPlatform>WINNT</em:targetPlatform> 
     <em:targetApplication>
       <Description>

diff --git a/install.rdf b/install.rdf
@@ -4,11 +4,11 @@
 		<em:id>[email protected]</em:id>
 		<em:type>2</em:type> <!-- type=extension -->
 		<em:name>ZoteroQuickLook</em:name>
-		<em:version>1.4.0</em:version>
+		<em:version>1.3.2</em:version>
 		<em:creator>Mikko Ronkko</em:creator>
 		<em:contributor>Brenton M. Wiernik</em:contributor>
 		<em:description>Quick Look Utility for Zotero.</em:description>
-    <em:updateURL>https://raw.githubusercontent.com/bwiernik/ZoteroQuickLook/master/update.rdf</em:updateURL>
+    <em:updateURL>https://raw.githubusercontent.com/mronkko/ZoteroQuickLook/master/update.rdf</em:updateURL>
     <em:unpack>true</em:unpack>
     <em:targetApplication>
       <Description>

diff --git a/update-altwindows.rdf b/update-altwindows.rdf
@@ -5,21 +5,21 @@
       <rdf:Seq>
         <rdf:li>
           <rdf:Description>
-            <em:version>1.4.0</em:version>
+            <em:version>1.3.2</em:version>
             <em:targetApplication>
               <rdf:Description>
                 <em:id>[email protected]</em:id>
                 <em:minVersion>4.0</em:minVersion>
                 <em:maxVersion>5.*</em:maxVersion>
-                <em:updateLink>https://github.com/bwiernik/ZoteroQuickLook/releases/download/v1.4.0/zoteroquicklook-altwindows.xpi</em:updateLink>
+                <em:updateLink>https://github.com/mronkko/ZoteroQuickLook/releases/download/v1.3.2/zoteroquicklook-altwindows.xpi</em:updateLink>
               </rdf:Description>
             </em:targetApplication>
             <em:targetApplication>
               <rdf:Description>
                 <em:id>[email protected]</em:id>
                 <em:minVersion>4.0</em:minVersion>
                 <em:maxVersion>5.*</em:maxVersion>
-                <em:updateLink>https://github.com/bwiernik/ZoteroQuickLook/releases/download/v1.4.0/zoteroquicklook-altwindows.xpi</em:updateLink>
+                <em:updateLink>https://github.com/mronkko/ZoteroQuickLook/releases/download/v1.3.2/zoteroquicklook-altwindows.xpi</em:updateLink>
               </rdf:Description>
             </em:targetApplication>
           </rdf:Description>

diff --git a/update.rdf b/update.rdf
@@ -5,21 +5,21 @@
       <rdf:Seq>
         <rdf:li>
           <rdf:Description>
-            <em:version>1.4.0</em:version>
+            <em:version>1.3.2</em:version>
             <em:targetApplication>
               <rdf:Description>
                 <em:id>[email protected]</em:id>
                 <em:minVersion>4.0</em:minVersion>
                 <em:maxVersion>5.*</em:maxVersion>
-                <em:updateLink>https://github.com/bwiernik/ZoteroQuickLook/releases/download/v1.4.0/zoteroquicklook.xpi</em:updateLink>
+                <em:updateLink>https://github.com/mronkko/ZoteroQuickLook/releases/download/v1.3.2/zoteroquicklook.xpi</em:updateLink>
               </rdf:Description>
             </em:targetApplication>
             <em:targetApplication>
               <rdf:Description>
                 <em:id>[email protected]</em:id>
                 <em:minVersion>4.0</em:minVersion>
                 <em:maxVersion>5.*</em:maxVersion>
-                <em:updateLink>https://github.com/bwiernik/ZoteroQuickLook/releases/download/v1.4.0/zoteroquicklook.xpi</em:updateLink>
+                <em:updateLink>https://github.com/mronkko/ZoteroQuickLook/releases/download/v1.3.2/zoteroquicklook.xpi</em:updateLink>
               </rdf:Description>
             </em:targetApplication>
           </rdf:Description>