new Book("/path/to/book.epub", {})
+
+ new Book({ replacements: "blobUrl" })
+
@@ -2069,6 +2078,72 @@
+
+
+
+
+
+ Report the current location
+Get the Current Location CFI
-EpubCFI:
+ location (may be a promise)
+
+
+
+
diff --git a/documentation/md/API.md b/documentation/md/API.md
index 8f1ca8d..b532e8b 100644
--- a/documentation/md/API.md
+++ b/documentation/md/API.md
@@ -41,7 +41,7 @@ Creates a new Book
- `options.requestCredentials` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** send the xhr request withCredentials (optional, default `undefined`)
- `options.requestHeaders` **\[[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** send the xhr request headers (optional, default `undefined`)
- `options.encoding` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** optional to pass 'binary' or base64' for archived Epubs (optional, default `binary`)
- - `options.replacements` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** use base64, blobs, or none for replacing assets in archived Epubs (optional, default `base64`)
+ - `options.replacements` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** use base64, blobUrl, or none for replacing assets in archived Epubs (optional, default `base64`)
**Examples**
@@ -49,6 +49,10 @@ Creates a new Book
new Book("/path/to/book.epub", {})
```
+```javascript
+new Book({ replacements: "blobUrl" })
+```
+
Returns **[Book](#book)**
## opened
@@ -170,6 +174,16 @@ Find a DOM Range for a given CFI Range
Returns **[Range](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input)**
+## key
+
+Generates the Book Key using the identifer in the manifest or other string provided
+
+**Parameters**
+
+- `identifier` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** to use instead of metadata identifier
+
+Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** key
+
# Url
creates a uri object
@@ -765,9 +779,11 @@ Adjust if the rendition uses spreads
- `spread` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** none | auto (TODO: implement landscape, portrait, both)
- `min` **int** min width to use spreads at
-## reportLocation
+## currentLocation
-Report the current location
+Get the Current Location CFI
+
+Returns **[EpubCFI](#epubcfi)** location (may be a promise)
## destroy
diff --git a/test/epub.js b/test/epub.js
index e063ee5..a18897e 100644
--- a/test/epub.js
+++ b/test/epub.js
@@ -9,8 +9,8 @@ describe('ePub', function() {
/*
// var packageContents = fs.readFileSync(__dirname + '/../books/moby-dick/OPS/package.opf', 'utf8');
// var tocContents = fs.readFileSync(__dirname + '/../books/moby-dick/OPS/toc.xhtml', 'utf8');
- var packageContents = require('raw!./fixtures/moby-dick/OPS/package.opf');
- var tocContents = require('raw!./fixtures/moby-dick/OPS/toc.xhtml');
+ var packageContents = require('raw-loader!./fixtures/moby-dick/OPS/package.opf');
+ var tocContents = require('raw-loader!./fixtures/moby-dick/OPS/toc.xhtml');
server = sinon.fakeServer.create();
server.autoRespond = true;
diff --git a/test/epubcfi.js b/test/epubcfi.js
index 7af3dac..10acb05 100644
--- a/test/epubcfi.js
+++ b/test/epubcfi.js
@@ -137,7 +137,7 @@ describe('EpubCFI', function() {
describe('#fromNode()', function() {
var base = "/6/4[chap01ref]";
// var contents = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
- var contents = require('raw!./fixtures/chapter1-highlights.xhtml');
+ var contents = require('raw-loader!./fixtures/chapter1-highlights.xhtml');
// var serializer = new XMLSerializer();
// var doc = serializer.serializeToString(contents);
@@ -186,16 +186,16 @@ describe('EpubCFI', function() {
var base = "/6/4[chap01ref]";
// var contentsClean = fs.readFileSync(__dirname + '/fixtures/chapter1.xhtml', 'utf8');
- var contentsClean = require('raw!./fixtures/chapter1.xhtml');
+ var contentsClean = require('raw-loader!./fixtures/chapter1.xhtml');
var doc = new DOMParser().parseFromString(contentsClean, "application/xhtml+xml");
// var contentsHighlights = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
- var contentsHighlights = require('raw!./fixtures/chapter1-highlights.xhtml');
+ var contentsHighlights = require('raw-loader!./fixtures/chapter1-highlights.xhtml');
var docHighlights = new DOMParser().parseFromString(contentsHighlights, "application/xhtml+xml");
// var highlightContents = fs.readFileSync(__dirname + '/fixtures/highlight.xhtml', 'utf8');
- var highlightContents = require('raw!./fixtures/highlight.xhtml');
+ var highlightContents = require('raw-loader!./fixtures/highlight.xhtml');
var docHighlightsAlice = new DOMParser().parseFromString(highlightContents, "application/xhtml+xml");
it('get a cfi from a collapsed range', function() {
@@ -302,7 +302,7 @@ describe('EpubCFI', function() {
describe('#toRange()', function() {
var base = "/6/4[chap01ref]";
// var contents = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
- var contents = require('raw!./fixtures/chapter1-highlights.xhtml');
+ var contents = require('raw-loader!./fixtures/chapter1-highlights.xhtml');
var doc = new DOMParser().parseFromString(contents, "application/xhtml+xml");
// var serializer = new XMLSerializer();