Permalink
Browse files

More installation instructions

Installing the Spotlight importer's a bit tricky, or at least persuading it to start indexing stuff is.

The IPDF also capitalises the file format, so ePub should be EPUB.
  • Loading branch information...
1 parent 88ae4c1 commit 2cf1ba945e24a4f58cd88931db590109b4281d27 @chrisridd committed Mar 4, 2012
Showing with 8 additions and 4 deletions.
  1. +8 −4 README.markdown
View
@@ -1,19 +1,23 @@
# An EPUB QuickLook generator and Spotlight importer for Mac OS X
-The epub.qlgenerator plugin is designed to extract the cover images from ePub files to use as the file icon, and present a nice overview of the ePub in QuickLook.
+The epub.qlgenerator plugin is designed to extract the cover images from EPUB files to use as the file icon, and present a nice overview of the EPUB in QuickLook.
-The epub.mdimporter plugin is designed to extract information from ePub files (including text content) and index it so that Spotlight can search it.
+The epub.mdimporter plugin is designed to extract information from EPUB files (metadata as well as text content) and index it so that Spotlight can search it.
-These plugins read the various information directly from the ePub contents - so will work on books that haven't been imported into iTunes.
+These plugins read the various information directly from the EPUB contents - so will work on books that haven't been imported into iTunes.
-**Note**: When used on DRM protected files (Adobe, iBooks, Kobo, Barnes & Noble), metadata will only be read from the unencrypted part of the ePub. Typically this means no cover image will be shown. Spotlight is unable to index the text in DRM protected files.
+**Note**: When used on DRM protected files (Adobe, iBooks, Kobo, Barnes & Noble), metadata will only be read from the unencrypted part of the EPUB. Typically this means no cover image will be shown. Spotlight is also unable to index the text in DRM protected files, though it can still search the metadata in DRM protected files.
## Installation
Place the epub.qlgenerator file into `/Library/QuickLook` (for all users) or `~/Library/QuickLook` (for the current user only).
+The Mac should notice the plugin appearing and start using it automatically. If it doesn't seem to, try logging out and in again, or run Terminal.app and enter this command: `qlmanage -r` and press return.
+
Place the epub.mdimporter file into `/Library/Spotlight` (for all users) or `~/Library/Spotlight` (for the current user only).
+To use the new Spotlight plugin you have to first make it index your EPUB files. Run Terminal.app and enter this command: `mdimport -r /Library/Spotlight/epub.mdimporter` (or `mdimport -r ~/Library/Spotlight/epub.mdimporter` if you installed it for the current user only) and press return. Spotlight will begin indexing your EPUB files in the background.
+
### Conflict with other QuickLook generators
Under some circumstances, epub.qlgenerator can conflict with other quicklook generators (notably BetterZipQL under OS X 10.6 and earlier). To fix this, rename epub.qlgenerator to come before the conflicting plugin alphabetically (AA_epub.qlgenerator should work).

0 comments on commit 2cf1ba9

Please sign in to comment.