Merge pull request #772 from GitbookIO/feature/glossary_order

Fix #768: sort glossary, start with longest matchs

lib/utils/page.js

@@ -237,13 +237,16 @@ function normalizeHtml(src, options) {
     });
 
     // Replace glossary terms
-    _.each(options.glossary, function(term) {
+    var glossary = _.sortBy(options.glossary, function(term) {
+        return -term.name.length;
+    });
+    _.each(glossary, function(term) {
         var r =  new RegExp( "\\b(" + pregQuote(term.name.toLowerCase()) + ")\\b" , 'gi' );
         var includedInFiles = false;
 
         $("*").each(function() {
             // Ignore codeblocks
-            if (_.contains(["code", "pre"], this.name.toLowerCase())) return;
+            if (_.contains(["code", "pre", "a"], this.name.toLowerCase())) return;
 
             replaceText($, this, r, function(match) {
                 // Add to files index in glossary

test/books/glossary/GLOSSARY.md

@@ -7,3 +7,7 @@ Just a simple and easy to understand test.
 ## hakunamatata
 
 This word is not present in the content.
+
+## test long
+
+This is a test with a longer text that the first entry to test order.

test/books/glossary/README.md

@@ -6,3 +6,5 @@ The word test should be replaced by a glossary link.
 But the word test should not be replaced in code blocks
 ```
 
+The two words test long should be replaced by the correct glossary links.
+

test/glossary.js

@@ -14,7 +14,7 @@ describe('Glossary', function () {
 
         it('should correctly list items', function() {
             book.should.have.property("glossary");
-            book.glossary.should.have.lengthOf(2);
+            book.glossary.should.have.lengthOf(3);
         });
     });
 
@@ -73,6 +73,15 @@ describe('Glossary', function () {
                     }
                 });
             });
+
+            it('should correctly select the longest term', function() {
+                readme.should.be.html({
+                    ".page-inner a[href='GLOSSARY.html#test_long']": {
+                        count: 1,
+                        text: "test long"
+                    }
+                });
+            });
         });
     });
 });