Bump version to 1.3.3

Bug fix for issue#493: 2-level or more deep relative links go wrong when in win32

CHANGES.md

@@ -1,5 +1,14 @@
 # Release notes
 
+## 1.3.3
+- Fix parsing of lexed content using the client library
+
+## 1.3.2
+- ePub files are now passing validation from epubcheck
+- Fix replacement of multiple glossary terms in a single sentence
+- Fix on windows deep relative links
+- Fix search indexer
+
 ## 1.3.1
 - Fix error with links in markdown
 

Gruntfile.js

@@ -118,7 +118,7 @@ module.exports = function (grunt) {
 
     // Bundle the library
     grunt.registerTask('bundle', [
-        'bower-install',
+        'browserify',
         'uglify'
     ]);
 

README.md

@@ -236,6 +236,8 @@ Plugins can be used to extend your book's functionality. Read [GitbookIO/plugin]
 | [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik) | Piwik Open Analytics tracking for your book |
 | [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors) | Add linkable Github-style anchors to headings |
 | [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin) | Embedded jsbin frame into your book |
+| [gitbook-grvis](https://github.com/romanlytkin/gitbook-grvis) | Gitbook GrViz plugin is used to select from markdown dot and converting it into a picture format svg |
+| [gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml) | Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg |
 
 #### Debugging
 

gitbook.js

@@ -427,8 +427,10 @@ function parsePage(src, options) {
     options = options || {};
 
     // Lex if not already lexed
-    return (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
-    .map(function(section) {
+    var parsed = {
+        lexed: (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
+    };
+    parsed.sections = parsed.lexed.map(function(section) {
         // Transform given type
         if(section.type === 'exercise') {
             var nonCodeNodes = _.reject(section, {
@@ -526,6 +528,8 @@ function parsePage(src, options) {
             content: render(section, options)
         };
     });
+
+    return parsed;
 }
 
 // Exports
@@ -628,6 +632,7 @@ module.exports = parseReadme;
 
 },{"kramed":134,"kramed-text-renderer":133,"lodash":135}],13:[function(require,module,exports){
 var url = require('url');
+var _ = require('lodash');
 var inherits = require('util').inherits;
 var links = require('../utils').links;
 var kramed = require('kramed');
@@ -677,7 +682,7 @@ GitBookRenderer.prototype.link = function(href, title, text) {
     // Parsed version of the url
     var parsed = url.parse(href);
     var o = this._extra_options;
-    var extname = _.last(parsed.path.split("."));
+    var extname = parsed.path? _.last(parsed.path.split(".")) : "";
 
     // Relative link, rewrite it to point to github repo
     if(links.isRelative(_href) && extname == "md") {
@@ -768,7 +773,7 @@ GitBookRenderer.prototype.heading = function(text, level, raw) {
 // Exports
 module.exports = GitBookRenderer;
 
-},{"../utils":15,"kramed":134,"url":25,"util":27}],14:[function(require,module,exports){
+},{"../utils":15,"kramed":134,"lodash":135,"url":25,"util":27}],14:[function(require,module,exports){
 var _ = require('lodash');
 var kramed = require('kramed');
 

lib/generate/json/index.js

@@ -29,8 +29,9 @@ Generator.prototype.convertFile = function(content, input) {
             dir: path.dirname(input) || '/'
         });
     })
-    .then(function(sections) {
-        json.sections = sections;
+    .then(function(parsed) {
+        json.lexed = parsed.lexed;
+        json.sections = parsed.sections;
     })
     .then(function() {
         return fs.writeFile(

lib/generate/site/index.js

@@ -134,8 +134,9 @@ Generator.prototype.prepareFile  = function(content, _input) {
             ], path.join, fs.readFileSync)
         });
     })
-    .then(function(sections) {
-        page.sections = sections;
+    .then(function(parsed) {
+        page.lexed = parsed.lexed;
+        page.sections = parsed.sections;
 
         // Use plugin hook
         return _callHook("page");
@@ -153,7 +154,12 @@ Generator.prototype.convertFile = function(content, _input) {
     if (_output == "README.html") _output = "index.html";
     var output = path.join(this.options.output, _output);
     var basePath = path.relative(path.dirname(output), this.options.output) || ".";
-
+	
+	// Bug fix for issue #493 which would occur when relative-links are 2-level or more deep in win32
+	if (process.platform === 'win32') {
+		basePath = basePath.replace(/\\/g, '/');
+	}
+	
     return this.prepareFile(content, _input)
     .then(function(page) {
         // Index page in search

lib/parse/page.js

@@ -51,8 +51,10 @@ function parsePage(src, options) {
     options = options || {};
 
     // Lex if not already lexed
-    return (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
-    .map(function(section) {
+    var parsed = {
+        lexed: (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
+    };
+    parsed.sections = parsed.lexed.map(function(section) {
         // Transform given type
         if(section.type === 'exercise') {
             var nonCodeNodes = _.reject(section, {
@@ -150,6 +152,8 @@ function parsePage(src, options) {
             content: render(section, options)
         };
     });
+
+    return parsed;
 }
 
 // Exports

package.json

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

test/includes.js

@@ -9,7 +9,7 @@ var FIXTURES_DIR = path.join(__dirname, './fixtures/');
 
 function loadPage (name, options) {
     var CONTENT = fs.readFileSync(FIXTURES_DIR + name + '.md', 'utf8');
-    return page(CONTENT, options);
+    return page(CONTENT, options).sections;
 }
 
 

test/page.js

@@ -6,7 +6,7 @@ var page = require('../').parse.page;
 
 function loadPage (name, options) {
     var CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/' + name + '.md'), 'utf8');
-    return page(CONTENT, options);
+    return page(CONTENT, options).sections;
 }
 
 var LEXED = loadPage('PAGE', {
@@ -80,9 +80,6 @@ describe('Page parsing', function() {
 describe('Relative links', function() {
     it('should replace link to .md by link to .html', function() {
         var LEXED = loadPage('MARKDOWN_LINKS', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'course',
             outdir: 'course'
@@ -96,9 +93,6 @@ describe('Relative links', function() {
 describe('Relative images', function() {
     it('should keep image relative with considering output directory in site format', function() {
         var LEXED = loadPage('IMAGES', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'syntax',
             outdir: 'syntax'
@@ -110,9 +104,6 @@ describe('Relative images', function() {
 
     it('should keep image relative with considering output directory in page format', function() {
         var LEXED = loadPage('IMAGES', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'syntax',
             outdir: './'

theme/javascript/core/glossary.js

@@ -31,21 +31,57 @@ define([
         return d.promise();
     }
 
+    $.fn.replaceText = function( search, replace, text_only ) {
+        return this.each(function(){
+            var node = this.firstChild,
+                val,
+                new_val,
 
+                // Elements to be removed at the end.
+                remove = [];
+
+            // Only continue if firstChild exists.
+            if ( node ) {
+
+                // Loop over all childNodes.
+                do {
+
+                    // Only process text nodes.
+                    if ( node.nodeType === 3 ) {
+
+                        // The original node value.
+                        val = node.nodeValue;
+
+                        // The new value.
+                        new_val = val.replace( search, replace );
+
+                        // Only replace text if the new value is actually different!
+                        if ( new_val !== val ) {
+
+                            if ( !text_only && /</.test( new_val ) ) {
+                                // The new value contains HTML, set it in a slower but far more
+                                // robust way.
+                                $(node).before( new_val );
+
+                                // Don't remove the node yet, or the loop will lose its place.
+                                remove.push( node );
+                            } else {
+                                // The new value contains no HTML, so it can be set in this
+                                // very fast, simple way.
+                                node.nodeValue = new_val;
+                            }
+                        }
+                    }
+
+                } while ( node = node.nextSibling );
+            }
+
+            // Time to remove those elements!
+            remove.length && $(remove).remove();
+        });
+    };
 
     var pregQuote = function( str ) {
-        // http://kevin.vanzonneveld.net
-        // +   original by: booeyOH
-        // +   improved by: Ates Goral (http://magnetiq.com)
-        // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
-        // +   bugfixed by: Onno Marsman
-        // *     example 1: preg_quote("$40");
-        // *     returns 1: '\$40'
-        // *     example 2: preg_quote("*RRRING* Hello?");
-        // *     returns 2: '\*RRRING\* Hello\?'
-        // *     example 3: preg_quote("\\.+*?[^]$(){}=!<>|:");
-        // *     returns 3: '\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:'
-
         return (str+'').replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, "\\$1");
     };
 
@@ -58,48 +94,13 @@ define([
         });
     };
 
-    var matchText = function(node, regex, callback, excludeElements) {
-        excludeElements || (excludeElements = ['script', 'style', 'iframe', 'canvas']);
-        var child = node.firstChild;
-
-        if (!child) return;
-
-        do {
-            switch (child.nodeType) {
-            case 1:
-                if (excludeElements.indexOf(child.tagName.toLowerCase()) > -1) {
-                    continue;
-                }
-                matchText(child, regex, callback, excludeElements);
-                break;
-            case 3:
-               child.data.replace(regex, function(all) {
-                    var args = [].slice.call(arguments),
-                        offset = args[args.length - 2],
-                        newTextNode = child.splitText(offset);
-
-                    newTextNode.data = newTextNode.data.substr(all.length);
-                    callback.apply(window, [child].concat(args));
-                    child = newTextNode;
-                });
-                break;
-            }
-        } while (child = child.nextSibling);
-
-        return node;
-    };
-
     var replaceTerm = function($el, term) {
         var r =  new RegExp( "\\b(" + pregQuote(term.name.toLowerCase()) + ")\\b" , 'gi' );
 
-        matchText($el.get(0), r, function(node, match, offset) {
-            var span = document.createElement("span");
-            span.className = "glossary-term";
-            span.textContent = match;
-            span.setAttribute("data-glossary-term", term.id);
-            span.setAttribute("title", term.description);
-            node.parentNode.insertBefore(span, node.nextSibling);
+        $el.find("*").replaceText(r, function(match) {
+            return "<span class='glossary-term' data-glossary-term='"+term.id+"' title='"+term.description+"'>"+match+"</span>";
         });
+
     };
 
     var prepare = function() {

theme/templates/ebook/layout.html

@@ -0,0 +1,22 @@
+<!DOCTYPE HTML>
+<html lang="en-US" {% block htmlTag %}{% endblock %}>
+    {{ htmlSnippet("html:start")|default("") }}
+    <head>
+        {{ htmlSnippet("head:start")|default("") }}
+        <meta charset="UTF-8">
+        <title>{% block title %}{% endblock %}</title>
+        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+        <meta name="description" content="{% block description %}{% endblock %}">
+        <meta name="generator" content="GitBook {{ gitbook.version }}">
+        {% block head %}{% endblock %}
+        {{ htmlSnippet("head:end")|default("") }}
+    </head>
+    <body>
+        {{ htmlSnippet("body:start")|default("") }}
+        {% block style %}{% endblock %}
+        {% block content %}{% endblock %}
+        {% block javascript %}{% endblock %}
+        {{ htmlSnippet("body:end")|default("") }}
+    </body>
+    {{ htmlSnippet("html:end")|default("") }}
+</html>

theme/templates/ebook/page.html

@@ -1,4 +1,4 @@
-{% extends "../layout.html" %}
+{% extends "./layout.html" %}
 
 {% block title %}{{ progress.current.title }} | {{ title }}{% endblock %}
 
@@ -17,7 +17,7 @@
 <div class="page">
     <h1 class="book-chapter book-chapter-{{ progress.current.level|lvl }}">{{ progress.current.title }}</h1>
     {% for section in content %}
-        <section class="{{ section.type }}" id="section-{{ section.id }}">
+        <div class="{{ section.type }}" id="section-{{ section.id }}">
         {% if section.type == "normal" %}
             {% autoescape false %}{{ section.content }}{% endautoescape %}
         {% elif section.type == "exercise" %}
@@ -25,7 +25,7 @@
         {% elif section.type == "quiz" %}
             {% include "./includes/quiz.html" with {section: section} %}
         {% endif %}
-        </section>
+        </div>
     {% endfor %}
 </div>
 {% endblock %}

theme/templates/ebook/summary.html

@@ -1,4 +1,4 @@
-{% extends "../layout.html" %}
+{% extends "./layout.html" %}
 
 {% block title %}Table of Contents | {{ title }}{% endblock %}