Bump version to 1.3.4

add X-UA-Compatible meta tag for IE

CHANGES.md

@@ -1,5 +1,10 @@
 # Release notes
 
+## 1.3.4
+- Add glossary to ebooks
+- Fix autocover with new hook "finish:before"
+- Add X-UA-Compatible meta tag for IE
+
 ## 1.3.3
 - Fix parsing of lexed content using the client library
 

README.md

@@ -132,7 +132,10 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb
 GitBook can generate your book in the following formats:
 
 * **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
-* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed. The output format could be **PDF**, **ePub** or **MOBI**.
+* **eBook**: A complete eBook with exercise solutions at the end of the book.  You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.  You can specify the eBook filename with the `-o` option, otherwise `book` will be used.
+  * Generate a **PDF** using:  `gitbook pdf ./myrepo`
+  * Generate a **ePub** using: `gitbook epub ./myrepo`
+  * Generate a **MOBI** using: `gitbook mobi ./myrepo`
 * **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
 
 ## Book Format

lib/generate/index.js

@@ -64,7 +64,7 @@ var generate = function(options) {
         try {
             var _config = require(path.resolve(options.input, options.configFile));
 
-            options = _.merge(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins'));
+            options = _.merge(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins', 'generator'));
         }
         catch(err) {
             // No config file: not a big deal
@@ -297,6 +297,9 @@ var generateBook = function(options) {
         })
 
         // Finish generation
+        .then(function() {
+            return generator.callHook("finish:before");
+        })
         .then(function() {
             return generator.finish();
         })

lib/generate/page/index.js

@@ -26,6 +26,9 @@ Generator.prototype.loadTemplates = function() {
     this.summaryTemplate = swig.compileFile(
         this.plugins.template("ebook:sumary") || path.resolve(this.options.theme, 'templates/ebook/summary.html')
     );
+    this.glossaryTemplate = swig.compileFile(
+        this.plugins.template("ebook:glossary") || path.resolve(this.options.theme, 'templates/ebook/glossary.html')
+    );
 };
 
 // Generate table of contents
@@ -46,7 +49,7 @@ Generator.prototype.finish = function() {
     var output = path.join(this.options.output, "index.html");
 
     var progress = parse.progress(this.options.navigation, "README.md");
-
+    
     return Q()
 
     // Write table of contents
@@ -54,6 +57,11 @@ Generator.prototype.finish = function() {
         return that.writeToc();
     })
 
+    // Write glossary
+    .then(function() {
+        return that.writeGlossary();
+    })
+
     // Copy cover
     .then(function() {
         return that.copyCover();

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "1.3.3",
+    "version": "1.3.4",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",

theme/templates/ebook/glossary.html

@@ -0,0 +1,15 @@
+{% extends "./layout.html" %}
+
+{% block title %}Glossary | {{ title }}{% endblock %}
+
+{% block content %}
+<div class="page page-toc">
+    <h1>Glossary</h1>
+	{% for item in glossaryIndex %}
+	<section class="normal glossary" id="{{ item.id }}">
+	    <h2><a href="#{{ item.id }}">{{ item.name }}</a></h2>
+	    <p>{{ item.description }}</p>
+	</section>
+	{% endfor %}
+</div>
+{% endblock %}

theme/templates/ebook/summary.html

@@ -40,6 +40,10 @@
     <h1>Table of Contents</h1>
     <ol>
     {{ articles(summary.chapters) }}
+
+    {% if glossary.length > 0 %}
+    <li><a href="{{ basePath }}/GLOSSARY.html">Glossary</a></li>
+    {% endif %}
     </ol>
 </div>
 {% endblock %}

theme/templates/layout.html

@@ -4,6 +4,7 @@
     <head>
         {{ htmlSnippet("head:start")|default("") }}
         <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=11; IE=10; IE=9; IE=8; IE=7; IE=EDGE" />
         <title>{% block title %}{% endblock %}</title>
         <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
         <meta name="description" content="{% block description %}{% endblock %}">