");
55 | });
56 | highlight.call(this);
57 | } else {
58 | searchResults.html('');
59 | $('.search-results li').text('No Results Found for "' + this.value + '"');
60 | }
61 | } else {
62 | unhighlight();
63 | searchResults.removeClass('visible');
64 | }
65 | }
66 |
67 | function highlight() {
68 | if (this.value) content.highlight(this.value, highlightOpts);
69 | }
70 |
71 | function unhighlight() {
72 | content.unhighlight(highlightOpts);
73 | }
74 | })();
75 |
--------------------------------------------------------------------------------
/source/javascripts/app/_toc.js:
--------------------------------------------------------------------------------
1 | //= require ../lib/_jquery_ui
2 | //= require ../lib/_jquery.tocify
3 | //= require ../lib/_imagesloaded.min
4 | (function (global) {
5 | 'use strict';
6 |
7 | var closeToc = function() {
8 | $(".tocify-wrapper").removeClass('open');
9 | $("#nav-button").removeClass('open');
10 | };
11 |
12 | var makeToc = function() {
13 | global.toc = $("#toc").tocify({
14 | selectors: 'h1, h2',
15 | extendPage: false,
16 | theme: 'none',
17 | smoothScroll: false,
18 | showEffectSpeed: 0,
19 | hideEffectSpeed: 180,
20 | ignoreSelector: '.toc-ignore',
21 | highlightOffset: 60,
22 | scrollTo: -1,
23 | scrollHistory: true,
24 | hashGenerator: function (text, element) {
25 | return element.prop('id');
26 | }
27 | }).data('toc-tocify');
28 |
29 | $("#nav-button").click(function() {
30 | $(".tocify-wrapper").toggleClass('open');
31 | $("#nav-button").toggleClass('open');
32 | return false;
33 | });
34 |
35 | $(".page-wrapper").click(closeToc);
36 | $(".tocify-item").click(closeToc);
37 | };
38 |
39 | // Hack to make already open sections to start opened,
40 | // instead of displaying an ugly animation
41 | function animate() {
42 | setTimeout(function() {
43 | toc.setOption('showEffectSpeed', 180);
44 | }, 50);
45 | }
46 |
47 | $(function() {
48 | makeToc();
49 | animate();
50 | $('.content').imagesLoaded( function() {
51 | global.toc.calculateHeights();
52 | });
53 | });
54 | })(window);
55 |
56 |
--------------------------------------------------------------------------------
/source/javascripts/lib/_energize.js:
--------------------------------------------------------------------------------
1 | /**
2 | * energize.js v0.1.0
3 | *
4 | * Speeds up click events on mobile devices.
5 | * https://github.com/davidcalhoun/energize.js
6 | */
7 |
8 | (function() { // Sandbox
9 | /**
10 | * Don't add to non-touch devices, which don't need to be sped up
11 | */
12 | if(!('ontouchstart' in window)) return;
13 |
14 | var lastClick = {},
15 | isThresholdReached, touchstart, touchmove, touchend,
16 | click, closest;
17 |
18 | /**
19 | * isThresholdReached
20 | *
21 | * Compare touchstart with touchend xy coordinates,
22 | * and only fire simulated click event if the coordinates
23 | * are nearby. (don't want clicking to be confused with a swipe)
24 | */
25 | isThresholdReached = function(startXY, xy) {
26 | return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
27 | };
28 |
29 | /**
30 | * touchstart
31 | *
32 | * Save xy coordinates when the user starts touching the screen
33 | */
34 | touchstart = function(e) {
35 | this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
36 | this.threshold = false;
37 | };
38 |
39 | /**
40 | * touchmove
41 | *
42 | * Check if the user is scrolling past the threshold.
43 | * Have to check here because touchend will not always fire
44 | * on some tested devices (Kindle Fire?)
45 | */
46 | touchmove = function(e) {
47 | // NOOP if the threshold has already been reached
48 | if(this.threshold) return false;
49 |
50 | this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
51 | };
52 |
53 | /**
54 | * touchend
55 | *
56 | * If the user didn't scroll past the threshold between
57 | * touchstart and touchend, fire a simulated click.
58 | *
59 | * (This will fire before a native click)
60 | */
61 | touchend = function(e) {
62 | // Don't fire a click if the user scrolled past the threshold
63 | if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
64 | return;
65 | }
66 |
67 | /**
68 | * Create and fire a click event on the target element
69 | * https://developer.mozilla.org/en/DOM/event.initMouseEvent
70 | */
71 | var touch = e.changedTouches[0],
72 | evt = document.createEvent('MouseEvents');
73 | evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
74 | evt.simulated = true; // distinguish from a normal (nonsimulated) click
75 | e.target.dispatchEvent(evt);
76 | };
77 |
78 | /**
79 | * click
80 | *
81 | * Because we've already fired a click event in touchend,
82 | * we need to listed for all native click events here
83 | * and suppress them as necessary.
84 | */
85 | click = function(e) {
86 | /**
87 | * Prevent ghost clicks by only allowing clicks we created
88 | * in the click event we fired (look for e.simulated)
89 | */
90 | var time = Date.now(),
91 | timeDiff = time - lastClick.time,
92 | x = e.clientX,
93 | y = e.clientY,
94 | xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
95 | target = closest(e.target, 'A') || e.target, // needed for standalone apps
96 | nodeName = target.nodeName,
97 | isLink = nodeName === 'A',
98 | standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
99 |
100 | lastClick.time = time;
101 | lastClick.x = x;
102 | lastClick.y = y;
103 |
104 | /**
105 | * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
106 | * so we have to add more logic to determine the time of the last click. Not perfect...
107 | *
108 | * Older, simpler check: if((!e.simulated) || standAlone)
109 | */
110 | if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
111 | e.preventDefault();
112 | e.stopPropagation();
113 | if(!standAlone) return false;
114 | }
115 |
116 | /**
117 | * Special logic for standalone web apps
118 | * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119 | */
120 | if(standAlone) {
121 | window.location = target.getAttribute("href");
122 | }
123 |
124 | /**
125 | * Add an energize-focus class to the targeted link (mimics :focus behavior)
126 | * TODO: test and/or remove? Does this work?
127 | */
128 | if(!target || !target.classList) return;
129 | target.classList.add("energize-focus");
130 | window.setTimeout(function(){
131 | target.classList.remove("energize-focus");
132 | }, 150);
133 | };
134 |
135 | /**
136 | * closest
137 | * @param {HTMLElement} node current node to start searching from.
138 | * @param {string} tagName the (uppercase) name of the tag you're looking for.
139 | *
140 | * Find the closest ancestor tag of a given node.
141 | *
142 | * Starts at node and goes up the DOM tree looking for a
143 | * matching nodeName, continuing until hitting document.body
144 | */
145 | closest = function(node, tagName){
146 | var curNode = node;
147 |
148 | while(curNode !== document.body) { // go up the dom until we find the tag we're after
149 | if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
150 | curNode = curNode.parentNode; // not found, so keep going up
151 | }
152 |
153 | return null; // not found
154 | };
155 |
156 | /**
157 | * Add all delegated event listeners
158 | *
159 | * All the events we care about bubble up to document,
160 | * so we can take advantage of event delegation.
161 | *
162 | * Note: no need to wait for DOMContentLoaded here
163 | */
164 | document.addEventListener('touchstart', touchstart, false);
165 | document.addEventListener('touchmove', touchmove, false);
166 | document.addEventListener('touchend', touchend, false);
167 | document.addEventListener('click', click, true); // TODO: why does this use capture?
168 |
169 | })();
--------------------------------------------------------------------------------
/source/javascripts/lib/_imagesloaded.min.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * imagesLoaded PACKAGED v3.1.8
3 | * JavaScript is all like "You images are done yet or what?"
4 | * MIT License
5 | */
6 |
7 | (function(){function e(){}function t(e,t){for(var n=e.length;n--;)if(e[n].listener===t)return n;return-1}function n(e){return function(){return this[e].apply(this,arguments)}}var i=e.prototype,r=this,o=r.EventEmitter;i.getListeners=function(e){var t,n,i=this._getEvents();if("object"==typeof e){t={};for(n in i)i.hasOwnProperty(n)&&e.test(n)&&(t[n]=i[n])}else t=i[e]||(i[e]=[]);return t},i.flattenListeners=function(e){var t,n=[];for(t=0;e.length>t;t+=1)n.push(e[t].listener);return n},i.getListenersAsObject=function(e){var t,n=this.getListeners(e);return n instanceof Array&&(t={},t[e]=n),t||n},i.addListener=function(e,n){var i,r=this.getListenersAsObject(e),o="object"==typeof n;for(i in r)r.hasOwnProperty(i)&&-1===t(r[i],n)&&r[i].push(o?n:{listener:n,once:!1});return this},i.on=n("addListener"),i.addOnceListener=function(e,t){return this.addListener(e,{listener:t,once:!0})},i.once=n("addOnceListener"),i.defineEvent=function(e){return this.getListeners(e),this},i.defineEvents=function(e){for(var t=0;e.length>t;t+=1)this.defineEvent(e[t]);return this},i.removeListener=function(e,n){var i,r,o=this.getListenersAsObject(e);for(r in o)o.hasOwnProperty(r)&&(i=t(o[r],n),-1!==i&&o[r].splice(i,1));return this},i.off=n("removeListener"),i.addListeners=function(e,t){return this.manipulateListeners(!1,e,t)},i.removeListeners=function(e,t){return this.manipulateListeners(!0,e,t)},i.manipulateListeners=function(e,t,n){var i,r,o=e?this.removeListener:this.addListener,s=e?this.removeListeners:this.addListeners;if("object"!=typeof t||t instanceof RegExp)for(i=n.length;i--;)o.call(this,t,n[i]);else for(i in t)t.hasOwnProperty(i)&&(r=t[i])&&("function"==typeof r?o.call(this,i,r):s.call(this,i,r));return this},i.removeEvent=function(e){var t,n=typeof e,i=this._getEvents();if("string"===n)delete i[e];else if("object"===n)for(t in i)i.hasOwnProperty(t)&&e.test(t)&&delete i[t];else delete this._events;return this},i.removeAllListeners=n("removeEvent"),i.emitEvent=function(e,t){var n,i,r,o,s=this.getListenersAsObject(e);for(r in s)if(s.hasOwnProperty(r))for(i=s[r].length;i--;)n=s[r][i],n.once===!0&&this.removeListener(e,n.listener),o=n.listener.apply(this,t||[]),o===this._getOnceReturnValue()&&this.removeListener(e,n.listener);return this},i.trigger=n("emitEvent"),i.emit=function(e){var t=Array.prototype.slice.call(arguments,1);return this.emitEvent(e,t)},i.setOnceReturnValue=function(e){return this._onceReturnValue=e,this},i._getOnceReturnValue=function(){return this.hasOwnProperty("_onceReturnValue")?this._onceReturnValue:!0},i._getEvents=function(){return this._events||(this._events={})},e.noConflict=function(){return r.EventEmitter=o,e},"function"==typeof define&&define.amd?define("eventEmitter/EventEmitter",[],function(){return e}):"object"==typeof module&&module.exports?module.exports=e:this.EventEmitter=e}).call(this),function(e){function t(t){var n=e.event;return n.target=n.target||n.srcElement||t,n}var n=document.documentElement,i=function(){};n.addEventListener?i=function(e,t,n){e.addEventListener(t,n,!1)}:n.attachEvent&&(i=function(e,n,i){e[n+i]=i.handleEvent?function(){var n=t(e);i.handleEvent.call(i,n)}:function(){var n=t(e);i.call(e,n)},e.attachEvent("on"+n,e[n+i])});var r=function(){};n.removeEventListener?r=function(e,t,n){e.removeEventListener(t,n,!1)}:n.detachEvent&&(r=function(e,t,n){e.detachEvent("on"+t,e[t+n]);try{delete e[t+n]}catch(i){e[t+n]=void 0}});var o={bind:i,unbind:r};"function"==typeof define&&define.amd?define("eventie/eventie",o):e.eventie=o}(this),function(e,t){"function"==typeof define&&define.amd?define(["eventEmitter/EventEmitter","eventie/eventie"],function(n,i){return t(e,n,i)}):"object"==typeof exports?module.exports=t(e,require("wolfy87-eventemitter"),require("eventie")):e.imagesLoaded=t(e,e.EventEmitter,e.eventie)}(window,function(e,t,n){function i(e,t){for(var n in t)e[n]=t[n];return e}function r(e){return"[object Array]"===d.call(e)}function o(e){var t=[];if(r(e))t=e;else if("number"==typeof e.length)for(var n=0,i=e.length;i>n;n++)t.push(e[n]);else t.push(e);return t}function s(e,t,n){if(!(this instanceof s))return new s(e,t);"string"==typeof e&&(e=document.querySelectorAll(e)),this.elements=o(e),this.options=i({},this.options),"function"==typeof t?n=t:i(this.options,t),n&&this.on("always",n),this.getImages(),a&&(this.jqDeferred=new a.Deferred);var r=this;setTimeout(function(){r.check()})}function f(e){this.img=e}function c(e){this.src=e,v[e]=this}var a=e.jQuery,u=e.console,h=u!==void 0,d=Object.prototype.toString;s.prototype=new t,s.prototype.options={},s.prototype.getImages=function(){this.images=[];for(var e=0,t=this.elements.length;t>e;e++){var n=this.elements[e];"IMG"===n.nodeName&&this.addImage(n);var i=n.nodeType;if(i&&(1===i||9===i||11===i))for(var r=n.querySelectorAll("img"),o=0,s=r.length;s>o;o++){var f=r[o];this.addImage(f)}}},s.prototype.addImage=function(e){var t=new f(e);this.images.push(t)},s.prototype.check=function(){function e(e,r){return t.options.debug&&h&&u.log("confirm",e,r),t.progress(e),n++,n===i&&t.complete(),!0}var t=this,n=0,i=this.images.length;if(this.hasAnyBroken=!1,!i)return this.complete(),void 0;for(var r=0;i>r;r++){var o=this.images[r];o.on("confirm",e),o.check()}},s.prototype.progress=function(e){this.hasAnyBroken=this.hasAnyBroken||!e.isLoaded;var t=this;setTimeout(function(){t.emit("progress",t,e),t.jqDeferred&&t.jqDeferred.notify&&t.jqDeferred.notify(t,e)})},s.prototype.complete=function(){var e=this.hasAnyBroken?"fail":"done";this.isComplete=!0;var t=this;setTimeout(function(){if(t.emit(e,t),t.emit("always",t),t.jqDeferred){var n=t.hasAnyBroken?"reject":"resolve";t.jqDeferred[n](t)}})},a&&(a.fn.imagesLoaded=function(e,t){var n=new s(this,e,t);return n.jqDeferred.promise(a(this))}),f.prototype=new t,f.prototype.check=function(){var e=v[this.img.src]||new c(this.img.src);if(e.isConfirmed)return this.confirm(e.isLoaded,"cached was confirmed"),void 0;if(this.img.complete&&void 0!==this.img.naturalWidth)return this.confirm(0!==this.img.naturalWidth,"naturalWidth"),void 0;var t=this;e.on("confirm",function(e,n){return t.confirm(e.isLoaded,n),!0}),e.check()},f.prototype.confirm=function(e,t){this.isLoaded=e,this.emit("confirm",this,t)};var v={};return c.prototype=new t,c.prototype.check=function(){if(!this.isChecked){var e=new Image;n.bind(e,"load",this),n.bind(e,"error",this),e.src=this.src,this.isChecked=!0}},c.prototype.handleEvent=function(e){var t="on"+e.type;this[t]&&this[t](e)},c.prototype.onload=function(e){this.confirm(!0,"onload"),this.unbindProxyEvents(e)},c.prototype.onerror=function(e){this.confirm(!1,"onerror"),this.unbindProxyEvents(e)},c.prototype.confirm=function(e,t){this.isConfirmed=!0,this.isLoaded=e,this.emit("confirm",this,t)},c.prototype.unbindProxyEvents=function(e){n.unbind(e.target,"load",this),n.unbind(e.target,"error",this)},s});
--------------------------------------------------------------------------------
/source/javascripts/lib/_jquery.highlight.js:
--------------------------------------------------------------------------------
1 | /*
2 | * jQuery Highlight plugin
3 | *
4 | * Based on highlight v3 by Johann Burkard
5 | * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
6 | *
7 | * Code a little bit refactored and cleaned (in my humble opinion).
8 | * Most important changes:
9 | * - has an option to highlight only entire words (wordsOnly - false by default),
10 | * - has an option to be case sensitive (caseSensitive - false by default)
11 | * - highlight element tag and class names can be specified in options
12 | *
13 | * Usage:
14 | * // wrap every occurrance of text 'lorem' in content
15 | * // with (default options)
16 | * $('#content').highlight('lorem');
17 | *
18 | * // search for and highlight more terms at once
19 | * // so you can save some time on traversing DOM
20 | * $('#content').highlight(['lorem', 'ipsum']);
21 | * $('#content').highlight('lorem ipsum');
22 | *
23 | * // search only for entire word 'lorem'
24 | * $('#content').highlight('lorem', { wordsOnly: true });
25 | *
26 | * // don't ignore case during search of term 'lorem'
27 | * $('#content').highlight('lorem', { caseSensitive: true });
28 | *
29 | * // wrap every occurrance of term 'ipsum' in content
30 | * // with
31 | * $('#content').highlight('ipsum', { element: 'em', className: 'important' });
32 | *
33 | * // remove default highlight
34 | * $('#content').unhighlight();
35 | *
36 | * // remove custom highlight
37 | * $('#content').unhighlight({ element: 'em', className: 'important' });
38 | *
39 | *
40 | * Copyright (c) 2009 Bartek Szopka
41 | *
42 | * Licensed under MIT license.
43 | *
44 | */
45 |
46 | jQuery.extend({
47 | highlight: function (node, re, nodeName, className) {
48 | if (node.nodeType === 3) {
49 | var match = node.data.match(re);
50 | if (match) {
51 | var highlight = document.createElement(nodeName || 'span');
52 | highlight.className = className || 'highlight';
53 | var wordNode = node.splitText(match.index);
54 | wordNode.splitText(match[0].length);
55 | var wordClone = wordNode.cloneNode(true);
56 | highlight.appendChild(wordClone);
57 | wordNode.parentNode.replaceChild(highlight, wordNode);
58 | return 1; //skip added node in parent
59 | }
60 | } else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children
61 | !/(script|style)/i.test(node.tagName) && // ignore script and style nodes
62 | !(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted
63 | for (var i = 0; i < node.childNodes.length; i++) {
64 | i += jQuery.highlight(node.childNodes[i], re, nodeName, className);
65 | }
66 | }
67 | return 0;
68 | }
69 | });
70 |
71 | jQuery.fn.unhighlight = function (options) {
72 | var settings = { className: 'highlight', element: 'span' };
73 | jQuery.extend(settings, options);
74 |
75 | return this.find(settings.element + "." + settings.className).each(function () {
76 | var parent = this.parentNode;
77 | parent.replaceChild(this.firstChild, this);
78 | parent.normalize();
79 | }).end();
80 | };
81 |
82 | jQuery.fn.highlight = function (words, options) {
83 | var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false };
84 | jQuery.extend(settings, options);
85 |
86 | if (words.constructor === String) {
87 | words = [words];
88 | }
89 | words = jQuery.grep(words, function(word, i){
90 | return word != '';
91 | });
92 | words = jQuery.map(words, function(word, i) {
93 | return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
94 | });
95 | if (words.length == 0) { return this; };
96 |
97 | var flag = settings.caseSensitive ? "" : "i";
98 | var pattern = "(" + words.join("|") + ")";
99 | if (settings.wordsOnly) {
100 | pattern = "\\b" + pattern + "\\b";
101 | }
102 | var re = new RegExp(pattern, flag);
103 |
104 | return this.each(function () {
105 | jQuery.highlight(this, re, settings.element, settings.className);
106 | });
107 | };
108 |
109 |
--------------------------------------------------------------------------------
/source/javascripts/lib/_jquery.tocify.js:
--------------------------------------------------------------------------------
1 | /* jquery Tocify - v1.8.0 - 2013-09-16
2 | * http://www.gregfranko.com/jquery.tocify.js/
3 | * Copyright (c) 2013 Greg Franko; Licensed MIT
4 | * Modified lightly by Robert Lord to fix a bug I found,
5 | * and also so it adds ids to headers
6 | * also because I want height caching, since the
7 | * height lookup for h1s and h2s was causing serious
8 | * lag spikes below 30 fps */
9 |
10 | // Immediately-Invoked Function Expression (IIFE) [Ben Alman Blog Post](http://benalman.com/news/2010/11/immediately-invoked-function-expression/) that calls another IIFE that contains all of the plugin logic. I used this pattern so that anyone viewing this code would not have to scroll to the bottom of the page to view the local parameters that were passed to the main IIFE.
11 | (function(tocify) {
12 |
13 | // ECMAScript 5 Strict Mode: [John Resig Blog Post](http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/)
14 | "use strict";
15 |
16 | // Calls the second IIFE and locally passes in the global jQuery, window, and document objects
17 | tocify(window.jQuery, window, document);
18 |
19 | }
20 |
21 | // Locally passes in `jQuery`, the `window` object, the `document` object, and an `undefined` variable. The `jQuery`, `window` and `document` objects are passed in locally, to improve performance, since javascript first searches for a variable match within the local variables set before searching the global variables set. All of the global variables are also passed in locally to be minifier friendly. `undefined` can be passed in locally, because it is not a reserved word in JavaScript.
22 | (function($, window, document, undefined) {
23 |
24 | // ECMAScript 5 Strict Mode: [John Resig Blog Post](http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/)
25 | "use strict";
26 |
27 | var tocClassName = "tocify",
28 | tocClass = "." + tocClassName,
29 | tocFocusClassName = "tocify-focus",
30 | tocHoverClassName = "tocify-hover",
31 | hideTocClassName = "tocify-hide",
32 | hideTocClass = "." + hideTocClassName,
33 | headerClassName = "tocify-header",
34 | headerClass = "." + headerClassName,
35 | subheaderClassName = "tocify-subheader",
36 | subheaderClass = "." + subheaderClassName,
37 | itemClassName = "tocify-item",
38 | itemClass = "." + itemClassName,
39 | extendPageClassName = "tocify-extend-page",
40 | extendPageClass = "." + extendPageClassName;
41 |
42 | // Calling the jQueryUI Widget Factory Method
43 | $.widget("toc.tocify", {
44 |
45 | //Plugin version
46 | version: "1.8.0",
47 |
48 | // These options will be used as defaults
49 | options: {
50 |
51 | // **context**: Accepts String: Any jQuery selector
52 | // The container element that holds all of the elements used to generate the table of contents
53 | context: "body",
54 |
55 | // **ignoreSelector**: Accepts String: Any jQuery selector
56 | // A selector to any element that would be matched by selectors that you wish to be ignored
57 | ignoreSelector: null,
58 |
59 | // **selectors**: Accepts an Array of Strings: Any jQuery selectors
60 | // The element's used to generate the table of contents. The order is very important since it will determine the table of content's nesting structure
61 | selectors: "h1, h2, h3",
62 |
63 | // **showAndHide**: Accepts a boolean: true or false
64 | // Used to determine if elements should be shown and hidden
65 | showAndHide: true,
66 |
67 | // **showEffect**: Accepts String: "none", "fadeIn", "show", or "slideDown"
68 | // Used to display any of the table of contents nested items
69 | showEffect: "slideDown",
70 |
71 | // **showEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
72 | // The time duration of the show animation
73 | showEffectSpeed: "medium",
74 |
75 | // **hideEffect**: Accepts String: "none", "fadeOut", "hide", or "slideUp"
76 | // Used to hide any of the table of contents nested items
77 | hideEffect: "slideUp",
78 |
79 | // **hideEffectSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
80 | // The time duration of the hide animation
81 | hideEffectSpeed: "medium",
82 |
83 | // **smoothScroll**: Accepts a boolean: true or false
84 | // Determines if a jQuery animation should be used to scroll to specific table of contents items on the page
85 | smoothScroll: true,
86 |
87 | // **smoothScrollSpeed**: Accepts Number (milliseconds) or String: "slow", "medium", or "fast"
88 | // The time duration of the smoothScroll animation
89 | smoothScrollSpeed: "medium",
90 |
91 | // **scrollTo**: Accepts Number (pixels)
92 | // The amount of space between the top of page and the selected table of contents item after the page has been scrolled
93 | scrollTo: 0,
94 |
95 | // **showAndHideOnScroll**: Accepts a boolean: true or false
96 | // Determines if table of contents nested items should be shown and hidden while scrolling
97 | showAndHideOnScroll: true,
98 |
99 | // **highlightOnScroll**: Accepts a boolean: true or false
100 | // Determines if table of contents nested items should be highlighted (set to a different color) while scrolling
101 | highlightOnScroll: true,
102 |
103 | // **highlightOffset**: Accepts a number
104 | // The offset distance in pixels to trigger the next active table of contents item
105 | highlightOffset: 40,
106 |
107 | // **theme**: Accepts a string: "bootstrap", "jqueryui", or "none"
108 | // Determines if Twitter Bootstrap, jQueryUI, or Tocify classes should be added to the table of contents
109 | theme: "bootstrap",
110 |
111 | // **extendPage**: Accepts a boolean: true or false
112 | // If a user scrolls to the bottom of the page and the page is not tall enough to scroll to the last table of contents item, then the page height is increased
113 | extendPage: true,
114 |
115 | // **extendPageOffset**: Accepts a number: pixels
116 | // How close to the bottom of the page a user must scroll before the page is extended
117 | extendPageOffset: 100,
118 |
119 | // **history**: Accepts a boolean: true or false
120 | // Adds a hash to the page url to maintain history
121 | history: true,
122 |
123 | // **scrollHistory**: Accepts a boolean: true or false
124 | // Adds a hash to the page url, to maintain history, when scrolling to a TOC item
125 | scrollHistory: false,
126 |
127 | // **hashGenerator**: How the hash value (the anchor segment of the URL, following the
128 | // # character) will be generated.
129 | //
130 | // "compact" (default) - #CompressesEverythingTogether
131 | // "pretty" - #looks-like-a-nice-url-and-is-easily-readable
132 | // function(text, element){} - Your own hash generation function that accepts the text as an
133 | // argument, and returns the hash value.
134 | hashGenerator: "compact",
135 |
136 | // **highlightDefault**: Accepts a boolean: true or false
137 | // Set's the first TOC item as active if no other TOC item is active.
138 | highlightDefault: true
139 |
140 | },
141 |
142 | // _Create
143 | // -------
144 | // Constructs the plugin. Only called once.
145 | _create: function() {
146 |
147 | var self = this;
148 |
149 | self.tocifyWrapper = $('.tocify-wrapper');
150 | self.extendPageScroll = true;
151 |
152 | // Internal array that keeps track of all TOC items (Helps to recognize if there are duplicate TOC item strings)
153 | self.items = [];
154 |
155 | // Generates the HTML for the dynamic table of contents
156 | self._generateToc();
157 |
158 | // Caches heights and anchors
159 | self.cachedHeights = [],
160 | self.cachedAnchors = [];
161 |
162 | // Adds CSS classes to the newly generated table of contents HTML
163 | self._addCSSClasses();
164 |
165 | self.webkit = (function() {
166 |
167 | for(var prop in window) {
168 |
169 | if(prop) {
170 |
171 | if(prop.toLowerCase().indexOf("webkit") !== -1) {
172 |
173 | return true;
174 |
175 | }
176 |
177 | }
178 |
179 | }
180 |
181 | return false;
182 |
183 | }());
184 |
185 | // Adds jQuery event handlers to the newly generated table of contents
186 | self._setEventHandlers();
187 |
188 | // Binding to the Window load event to make sure the correct scrollTop is calculated
189 | $(window).load(function() {
190 |
191 | // Sets the active TOC item
192 | self._setActiveElement(true);
193 |
194 | // Once all animations on the page are complete, this callback function will be called
195 | $("html, body").promise().done(function() {
196 |
197 | setTimeout(function() {
198 |
199 | self.extendPageScroll = false;
200 |
201 | },0);
202 |
203 | });
204 |
205 | });
206 |
207 | },
208 |
209 | // _generateToc
210 | // ------------
211 | // Generates the HTML for the dynamic table of contents
212 | _generateToc: function() {
213 |
214 | // _Local variables_
215 |
216 | // Stores the plugin context in the self variable
217 | var self = this,
218 |
219 | // All of the HTML tags found within the context provided (i.e. body) that match the top level jQuery selector above
220 | firstElem,
221 |
222 | // Instantiated variable that will store the top level newly created unordered list DOM element
223 | ul,
224 | ignoreSelector = self.options.ignoreSelector;
225 |
226 | // If the selectors option has a comma within the string
227 | if(this.options.selectors.indexOf(",") !== -1) {
228 |
229 | // Grabs the first selector from the string
230 | firstElem = $(this.options.context).find(this.options.selectors.replace(/ /g,"").substr(0, this.options.selectors.indexOf(",")));
231 |
232 | }
233 |
234 | // If the selectors option does not have a comman within the string
235 | else {
236 |
237 | // Grabs the first selector from the string and makes sure there are no spaces
238 | firstElem = $(this.options.context).find(this.options.selectors.replace(/ /g,""));
239 |
240 | }
241 |
242 | if(!firstElem.length) {
243 |
244 | self.element.addClass(hideTocClassName);
245 |
246 | return;
247 |
248 | }
249 |
250 | self.element.addClass(tocClassName);
251 |
252 | // Loops through each top level selector
253 | firstElem.each(function(index) {
254 |
255 | //If the element matches the ignoreSelector then we skip it
256 | if($(this).is(ignoreSelector)) {
257 | return;
258 | }
259 |
260 | // Creates an unordered list HTML element and adds a dynamic ID and standard class name
261 | ul = $("
", {
262 | "id": headerClassName + index,
263 | "class": headerClassName
264 | }).
265 |
266 | // Appends a top level list item HTML element to the previously created HTML header
267 | append(self._nestElements($(this), index));
268 |
269 | // Add the created unordered list element to the HTML element calling the plugin
270 | self.element.append(ul);
271 |
272 | // Finds all of the HTML tags between the header and subheader elements
273 | $(this).nextUntil(this.nodeName.toLowerCase()).each(function() {
274 |
275 | // If there are no nested subheader elemements
276 | if($(this).find(self.options.selectors).length === 0) {
277 |
278 | // Loops through all of the subheader elements
279 | $(this).filter(self.options.selectors).each(function() {
280 |
281 | //If the element matches the ignoreSelector then we skip it
282 | if($(this).is(ignoreSelector)) {
283 | return;
284 | }
285 |
286 | self._appendSubheaders.call(this, self, ul);
287 |
288 | });
289 |
290 | }
291 |
292 | // If there are nested subheader elements
293 | else {
294 |
295 | // Loops through all of the subheader elements
296 | $(this).find(self.options.selectors).each(function() {
297 |
298 | //If the element matches the ignoreSelector then we skip it
299 | if($(this).is(ignoreSelector)) {
300 | return;
301 | }
302 |
303 | self._appendSubheaders.call(this, self, ul);
304 |
305 | });
306 |
307 | }
308 |
309 | });
310 |
311 | });
312 |
313 | },
314 |
315 | _setActiveElement: function(pageload) {
316 |
317 | var self = this,
318 |
319 | hash = window.location.hash.substring(1),
320 |
321 | elem = self.element.find("li[data-unique='" + hash + "']");
322 |
323 | if(hash.length) {
324 |
325 | // Removes highlighting from all of the list item's
326 | self.element.find("." + self.focusClass).removeClass(self.focusClass);
327 |
328 | // Highlights the current list item that was clicked
329 | elem.addClass(self.focusClass);
330 |
331 | // If the showAndHide option is true
332 | if(self.options.showAndHide) {
333 |
334 | // Triggers the click event on the currently focused TOC item
335 | elem.click();
336 |
337 | }
338 |
339 | }
340 |
341 | else {
342 |
343 | // Removes highlighting from all of the list item's
344 | self.element.find("." + self.focusClass).removeClass(self.focusClass);
345 |
346 | if(!hash.length && pageload && self.options.highlightDefault) {
347 |
348 | // Highlights the first TOC item if no other items are highlighted
349 | self.element.find(itemClass).first().addClass(self.focusClass);
350 |
351 | }
352 |
353 | }
354 |
355 | return self;
356 |
357 | },
358 |
359 | // _nestElements
360 | // -------------
361 | // Helps create the table of contents list by appending nested list items
362 | _nestElements: function(self, index) {
363 |
364 | var arr, item, hashValue;
365 |
366 | arr = $.grep(this.items, function (item) {
367 |
368 | return item === self.text();
369 |
370 | });
371 |
372 | // If there is already a duplicate TOC item
373 | if(arr.length) {
374 |
375 | // Adds the current TOC item text and index (for slight randomization) to the internal array
376 | this.items.push(self.text() + index);
377 |
378 | }
379 |
380 | // If there not a duplicate TOC item
381 | else {
382 |
383 | // Adds the current TOC item text to the internal array
384 | this.items.push(self.text());
385 |
386 | }
387 |
388 | hashValue = this._generateHashValue(arr, self, index);
389 |
390 | // ADDED BY ROBERT
391 | // actually add the hash value to the element's id
392 | // self.attr("id", "link-" + hashValue);
393 |
394 | // Appends a list item HTML element to the last unordered list HTML element found within the HTML element calling the plugin
395 | item = $("", {
396 |
397 | // Sets a common class name to the list item
398 | "class": itemClassName,
399 |
400 | "data-unique": hashValue
401 |
402 | }).append($("", {
403 |
404 | "text": self.text()
405 |
406 | }));
407 |
408 | // Adds an HTML anchor tag before the currently traversed HTML element
409 | self.before($("", {
410 |
411 | // Sets a name attribute on the anchor tag to the text of the currently traversed HTML element (also making sure that all whitespace is replaced with an underscore)
412 | "name": hashValue,
413 |
414 | "data-unique": hashValue
415 |
416 | }));
417 |
418 | return item;
419 |
420 | },
421 |
422 | // _generateHashValue
423 | // ------------------
424 | // Generates the hash value that will be used to refer to each item.
425 | _generateHashValue: function(arr, self, index) {
426 |
427 | var hashValue = "",
428 | hashGeneratorOption = this.options.hashGenerator;
429 |
430 | if (hashGeneratorOption === "pretty") {
431 | // remove weird characters
432 |
433 |
434 | // prettify the text
435 | hashValue = self.text().toLowerCase().replace(/\s/g, "-");
436 |
437 | // ADDED BY ROBERT
438 | // remove weird characters
439 | hashValue = hashValue.replace(/[^\x00-\x7F]/g, "");
440 |
441 | // fix double hyphens
442 | while (hashValue.indexOf("--") > -1) {
443 | hashValue = hashValue.replace(/--/g, "-");
444 | }
445 |
446 | // fix colon-space instances
447 | while (hashValue.indexOf(":-") > -1) {
448 | hashValue = hashValue.replace(/:-/g, "-");
449 | }
450 |
451 | } else if (typeof hashGeneratorOption === "function") {
452 |
453 | // call the function
454 | hashValue = hashGeneratorOption(self.text(), self);
455 |
456 | } else {
457 |
458 | // compact - the default
459 | hashValue = self.text().replace(/\s/g, "");
460 |
461 | }
462 |
463 | // add the index if we need to
464 | if (arr.length) { hashValue += ""+index; }
465 |
466 | // return the value
467 | return hashValue;
468 |
469 | },
470 |
471 | // _appendElements
472 | // ---------------
473 | // Helps create the table of contents list by appending subheader elements
474 |
475 | _appendSubheaders: function(self, ul) {
476 |
477 | // The current element index
478 | var index = $(this).index(self.options.selectors),
479 |
480 | // Finds the previous header DOM element
481 | previousHeader = $(self.options.selectors).eq(index - 1),
482 |
483 | currentTagName = +$(this).prop("tagName").charAt(1),
484 |
485 | previousTagName = +previousHeader.prop("tagName").charAt(1),
486 |
487 | lastSubheader;
488 |
489 | // If the current header DOM element is smaller than the previous header DOM element or the first subheader
490 | if(currentTagName < previousTagName) {
491 |
492 | // Selects the last unordered list HTML found within the HTML element calling the plugin
493 | self.element.find(subheaderClass + "[data-tag=" + currentTagName + "]").last().append(self._nestElements($(this), index));
494 |
495 | }
496 |
497 | // If the current header DOM element is the same type of header(eg. h4) as the previous header DOM element
498 | else if(currentTagName === previousTagName) {
499 |
500 | ul.find(itemClass).last().after(self._nestElements($(this), index));
501 |
502 | }
503 |
504 | else {
505 |
506 | // Selects the last unordered list HTML found within the HTML element calling the plugin
507 | ul.find(itemClass).last().
508 |
509 | // Appends an unorderedList HTML element to the dynamic `unorderedList` variable and sets a common class name
510 | after($("
", {
511 |
512 | "class": subheaderClassName,
513 |
514 | "data-tag": currentTagName
515 |
516 | })).next(subheaderClass).
517 |
518 | // Appends a list item HTML element to the last unordered list HTML element found within the HTML element calling the plugin
519 | append(self._nestElements($(this), index));
520 | }
521 |
522 | },
523 |
524 | // _setEventHandlers
525 | // ----------------
526 | // Adds jQuery event handlers to the newly generated table of contents
527 | _setEventHandlers: function() {
528 |
529 | // _Local variables_
530 |
531 | // Stores the plugin context in the self variable
532 | var self = this,
533 |
534 | // Instantiates a new variable that will be used to hold a specific element's context
535 | $self,
536 |
537 | // Instantiates a new variable that will be used to determine the smoothScroll animation time duration
538 | duration;
539 |
540 | // Event delegation that looks for any clicks on list item elements inside of the HTML element calling the plugin
541 | this.element.on("click.tocify", "li", function(event) {
542 |
543 | if(self.options.history) {
544 |
545 | window.location.hash = $(this).attr("data-unique");
546 |
547 | }
548 |
549 | // Removes highlighting from all of the list item's
550 | self.element.find("." + self.focusClass).removeClass(self.focusClass);
551 |
552 | // Highlights the current list item that was clicked
553 | $(this).addClass(self.focusClass);
554 |
555 | // If the showAndHide option is true
556 | if(self.options.showAndHide) {
557 |
558 | var elem = $('li[data-unique="' + $(this).attr("data-unique") + '"]');
559 |
560 | self._triggerShow(elem);
561 |
562 | }
563 |
564 | self._scrollTo($(this));
565 |
566 | });
567 |
568 | // Mouseenter and Mouseleave event handlers for the list item's within the HTML element calling the plugin
569 | this.element.find("li").on({
570 |
571 | // Mouseenter event handler
572 | "mouseenter.tocify": function() {
573 |
574 | // Adds a hover CSS class to the current list item
575 | $(this).addClass(self.hoverClass);
576 |
577 | // Makes sure the cursor is set to the pointer icon
578 | $(this).css("cursor", "pointer");
579 |
580 | },
581 |
582 | // Mouseleave event handler
583 | "mouseleave.tocify": function() {
584 |
585 | if(self.options.theme !== "bootstrap") {
586 |
587 | // Removes the hover CSS class from the current list item
588 | $(this).removeClass(self.hoverClass);
589 |
590 | }
591 |
592 | }
593 | });
594 |
595 | // Reset height cache on scroll
596 |
597 | $(window).on('resize', function() {
598 | self.calculateHeights();
599 | });
600 |
601 | // Window scroll event handler
602 | $(window).on("scroll.tocify", function() {
603 |
604 | // Once all animations on the page are complete, this callback function will be called
605 | $("html, body").promise().done(function() {
606 |
607 | // Local variables
608 |
609 | // Stores how far the user has scrolled
610 | var winScrollTop = $(window).scrollTop(),
611 |
612 | // Stores the height of the window
613 | winHeight = $(window).height(),
614 |
615 | // Stores the height of the document
616 | docHeight = $(document).height(),
617 |
618 | scrollHeight = $("body")[0].scrollHeight,
619 |
620 | // Instantiates a variable that will be used to hold a selected HTML element
621 | elem,
622 |
623 | lastElem,
624 |
625 | lastElemOffset,
626 |
627 | currentElem;
628 |
629 | if(self.options.extendPage) {
630 |
631 | // If the user has scrolled to the bottom of the page and the last toc item is not focused
632 | if((self.webkit && winScrollTop >= scrollHeight - winHeight - self.options.extendPageOffset) || (!self.webkit && winHeight + winScrollTop > docHeight - self.options.extendPageOffset)) {
633 |
634 | if(!$(extendPageClass).length) {
635 |
636 | lastElem = $('div[data-unique="' + $(itemClass).last().attr("data-unique") + '"]');
637 |
638 | if(!lastElem.length) return;
639 |
640 | // Gets the top offset of the page header that is linked to the last toc item
641 | lastElemOffset = lastElem.offset().top;
642 |
643 | // Appends a div to the bottom of the page and sets the height to the difference of the window scrollTop and the last element's position top offset
644 | $(self.options.context).append($("", {
645 |
646 | "class": extendPageClassName,
647 |
648 | "height": Math.abs(lastElemOffset - winScrollTop) + "px",
649 |
650 | "data-unique": extendPageClassName
651 |
652 | }));
653 |
654 | if(self.extendPageScroll) {
655 |
656 | currentElem = self.element.find('li.active');
657 |
658 | self._scrollTo($("div[data-unique=" + currentElem.attr("data-unique") + "]"));
659 |
660 | }
661 |
662 | }
663 |
664 | }
665 |
666 | }
667 |
668 | // The zero timeout ensures the following code is run after the scroll events
669 | setTimeout(function() {
670 |
671 | // _Local variables_
672 |
673 | // Stores the distance to the closest anchor
674 | var // Stores the index of the closest anchor
675 | closestAnchorIdx = null,
676 | anchorText;
677 |
678 | // if never calculated before, calculate and cache the heights
679 | if (self.cachedHeights.length == 0) {
680 | self.calculateHeights();
681 | }
682 |
683 | var scrollTop = $(window).scrollTop();
684 |
685 | // Determines the index of the closest anchor
686 | self.cachedAnchors.each(function(idx) {
687 | if (self.cachedHeights[idx] - scrollTop < 0) {
688 | closestAnchorIdx = idx;
689 | } else {
690 | return false;
691 | }
692 | });
693 |
694 | anchorText = $(self.cachedAnchors[closestAnchorIdx]).attr("data-unique");
695 |
696 | // Stores the list item HTML element that corresponds to the currently traversed anchor tag
697 | elem = $('li[data-unique="' + anchorText + '"]');
698 |
699 | // If the `highlightOnScroll` option is true and a next element is found
700 | if(self.options.highlightOnScroll && elem.length && !elem.hasClass(self.focusClass)) {
701 |
702 | // Removes highlighting from all of the list item's
703 | self.element.find("." + self.focusClass).removeClass(self.focusClass);
704 |
705 | // Highlights the corresponding list item
706 | elem.addClass(self.focusClass);
707 |
708 | // Scroll to highlighted element's header
709 | var tocifyWrapper = self.tocifyWrapper;
710 | var scrollToElem = $(elem).closest('.tocify-header');
711 |
712 | var elementOffset = scrollToElem.offset().top,
713 | wrapperOffset = tocifyWrapper.offset().top;
714 | var offset = elementOffset - wrapperOffset;
715 |
716 | if (offset >= $(window).height()) {
717 | var scrollPosition = offset + tocifyWrapper.scrollTop();
718 | tocifyWrapper.scrollTop(scrollPosition);
719 | } else if (offset < 0) {
720 | tocifyWrapper.scrollTop(0);
721 | }
722 | }
723 |
724 | if(self.options.scrollHistory) {
725 |
726 | // IF STATEMENT ADDED BY ROBERT
727 |
728 | if(window.location.hash !== "#" + anchorText && anchorText !== undefined) {
729 |
730 | if(history.replaceState) {
731 | history.replaceState({}, "", "#" + anchorText);
732 | // provide a fallback
733 | } else {
734 | scrollV = document.body.scrollTop;
735 | scrollH = document.body.scrollLeft;
736 | location.hash = "#" + anchorText;
737 | document.body.scrollTop = scrollV;
738 | document.body.scrollLeft = scrollH;
739 | }
740 |
741 | }
742 |
743 | }
744 |
745 | // If the `showAndHideOnScroll` option is true
746 | if(self.options.showAndHideOnScroll && self.options.showAndHide) {
747 |
748 | self._triggerShow(elem, true);
749 |
750 | }
751 |
752 | }, 0);
753 |
754 | });
755 |
756 | });
757 |
758 | },
759 |
760 | // calculateHeights
761 | // ----
762 | // ADDED BY ROBERT
763 | calculateHeights: function() {
764 | var self = this;
765 | self.cachedHeights = [];
766 | self.cachedAnchors = [];
767 | var anchors = $(self.options.context).find("div[data-unique]");
768 | anchors.each(function(idx) {
769 | var distance = (($(this).next().length ? $(this).next() : $(this)).offset().top - self.options.highlightOffset);
770 | self.cachedHeights[idx] = distance;
771 | });
772 | self.cachedAnchors = anchors;
773 | },
774 |
775 | // Show
776 | // ----
777 | // Opens the current sub-header
778 | show: function(elem, scroll) {
779 |
780 | // Stores the plugin context in the `self` variable
781 | var self = this,
782 | element = elem;
783 |
784 | // If the sub-header is not already visible
785 | if (!elem.is(":visible")) {
786 |
787 | // If the current element does not have any nested subheaders, is not a header, and its parent is not visible
788 | if(!elem.find(subheaderClass).length && !elem.parent().is(headerClass) && !elem.parent().is(":visible")) {
789 |
790 | // Sets the current element to all of the subheaders within the current header
791 | elem = elem.parents(subheaderClass).add(elem);
792 |
793 | }
794 |
795 | // If the current element does not have any nested subheaders and is not a header
796 | else if(!elem.children(subheaderClass).length && !elem.parent().is(headerClass)) {
797 |
798 | // Sets the current element to the closest subheader
799 | elem = elem.closest(subheaderClass);
800 |
801 | }
802 |
803 | //Determines what jQuery effect to use
804 | switch (self.options.showEffect) {
805 |
806 | //Uses `no effect`
807 | case "none":
808 |
809 | elem.show();
810 |
811 | break;
812 |
813 | //Uses the jQuery `show` special effect
814 | case "show":
815 |
816 | elem.show(self.options.showEffectSpeed);
817 |
818 | break;
819 |
820 | //Uses the jQuery `slideDown` special effect
821 | case "slideDown":
822 |
823 | elem.slideDown(self.options.showEffectSpeed);
824 |
825 | break;
826 |
827 | //Uses the jQuery `fadeIn` special effect
828 | case "fadeIn":
829 |
830 | elem.fadeIn(self.options.showEffectSpeed);
831 |
832 | break;
833 |
834 | //If none of the above options were passed, then a `jQueryUI show effect` is expected
835 | default:
836 |
837 | elem.show();
838 |
839 | break;
840 |
841 | }
842 |
843 | }
844 |
845 | // If the current subheader parent element is a header
846 | if(elem.parent().is(headerClass)) {
847 |
848 | // Hides all non-active sub-headers
849 | self.hide($(subheaderClass).not(elem));
850 |
851 | }
852 |
853 | // If the current subheader parent element is not a header
854 | else {
855 |
856 | // Hides all non-active sub-headers
857 | self.hide($(subheaderClass).not(elem.closest(headerClass).find(subheaderClass).not(elem.siblings())));
858 |
859 | }
860 |
861 | // Maintains chainablity
862 | return self;
863 |
864 | },
865 |
866 | // Hide
867 | // ----
868 | // Closes the current sub-header
869 | hide: function(elem) {
870 |
871 | // Stores the plugin context in the `self` variable
872 | var self = this;
873 |
874 | //Determines what jQuery effect to use
875 | switch (self.options.hideEffect) {
876 |
877 | // Uses `no effect`
878 | case "none":
879 |
880 | elem.hide();
881 |
882 | break;
883 |
884 | // Uses the jQuery `hide` special effect
885 | case "hide":
886 |
887 | elem.hide(self.options.hideEffectSpeed);
888 |
889 | break;
890 |
891 | // Uses the jQuery `slideUp` special effect
892 | case "slideUp":
893 |
894 | elem.slideUp(self.options.hideEffectSpeed);
895 |
896 | break;
897 |
898 | // Uses the jQuery `fadeOut` special effect
899 | case "fadeOut":
900 |
901 | elem.fadeOut(self.options.hideEffectSpeed);
902 |
903 | break;
904 |
905 | // If none of the above options were passed, then a `jqueryUI hide effect` is expected
906 | default:
907 |
908 | elem.hide();
909 |
910 | break;
911 |
912 | }
913 |
914 | // Maintains chainablity
915 | return self;
916 | },
917 |
918 | // _triggerShow
919 | // ------------
920 | // Determines what elements get shown on scroll and click
921 | _triggerShow: function(elem, scroll) {
922 |
923 | var self = this;
924 |
925 | // If the current element's parent is a header element or the next element is a nested subheader element
926 | if(elem.parent().is(headerClass) || elem.next().is(subheaderClass)) {
927 |
928 | // Shows the next sub-header element
929 | self.show(elem.next(subheaderClass), scroll);
930 |
931 | }
932 |
933 | // If the current element's parent is a subheader element
934 | else if(elem.parent().is(subheaderClass)) {
935 |
936 | // Shows the parent sub-header element
937 | self.show(elem.parent(), scroll);
938 |
939 | }
940 |
941 | // Maintains chainability
942 | return self;
943 |
944 | },
945 |
946 | // _addCSSClasses
947 | // --------------
948 | // Adds CSS classes to the newly generated table of contents HTML
949 | _addCSSClasses: function() {
950 |
951 | // If the user wants a jqueryUI theme
952 | if(this.options.theme === "jqueryui") {
953 |
954 | this.focusClass = "ui-state-default";
955 |
956 | this.hoverClass = "ui-state-hover";
957 |
958 | //Adds the default styling to the dropdown list
959 | this.element.addClass("ui-widget").find(".toc-title").addClass("ui-widget-header").end().find("li").addClass("ui-widget-content");
960 |
961 | }
962 |
963 | // If the user wants a twitterBootstrap theme
964 | else if(this.options.theme === "bootstrap") {
965 |
966 | this.element.find(headerClass + "," + subheaderClass).addClass("nav nav-list");
967 |
968 | this.focusClass = "active";
969 |
970 | }
971 |
972 | // If a user does not want a prebuilt theme
973 | else {
974 |
975 | // Adds more neutral classes (instead of jqueryui)
976 |
977 | this.focusClass = tocFocusClassName;
978 |
979 | this.hoverClass = tocHoverClassName;
980 |
981 | }
982 |
983 | //Maintains chainability
984 | return this;
985 |
986 | },
987 |
988 | // setOption
989 | // ---------
990 | // Sets a single Tocify option after the plugin is invoked
991 | setOption: function() {
992 |
993 | // Calls the jQueryUI Widget Factory setOption method
994 | $.Widget.prototype._setOption.apply(this, arguments);
995 |
996 | },
997 |
998 | // setOptions
999 | // ----------
1000 | // Sets a single or multiple Tocify options after the plugin is invoked
1001 | setOptions: function() {
1002 |
1003 | // Calls the jQueryUI Widget Factory setOptions method
1004 | $.Widget.prototype._setOptions.apply(this, arguments);
1005 |
1006 | },
1007 |
1008 | // _scrollTo
1009 | // ---------
1010 | // Scrolls to a specific element
1011 | _scrollTo: function(elem) {
1012 |
1013 | var self = this,
1014 | duration = self.options.smoothScroll || 0,
1015 | scrollTo = self.options.scrollTo;
1016 |
1017 | // Once all animations on the page are complete, this callback function will be called
1018 | $("html, body").promise().done(function() {
1019 |
1020 | // Animates the html and body element scrolltops
1021 | $("html, body").animate({
1022 |
1023 | // Sets the jQuery `scrollTop` to the top offset of the HTML div tag that matches the current list item's `data-unique` tag
1024 | "scrollTop": $('div[data-unique="' + elem.attr("data-unique") + '"]').next().offset().top - ($.isFunction(scrollTo) ? scrollTo.call() : scrollTo) + "px"
1025 |
1026 | }, {
1027 |
1028 | // Sets the smoothScroll animation time duration to the smoothScrollSpeed option
1029 | "duration": duration
1030 |
1031 | });
1032 |
1033 | });
1034 |
1035 | // Maintains chainability
1036 | return self;
1037 |
1038 | }
1039 |
1040 | });
1041 |
1042 | })); //end of plugin
1043 |
--------------------------------------------------------------------------------
/source/javascripts/lib/_jquery_ui.js:
--------------------------------------------------------------------------------
1 | /*! jQuery UI - v1.11.3 - 2015-02-12
2 | * http://jqueryui.com
3 | * Includes: widget.js
4 | * Copyright 2015 jQuery Foundation and other contributors; Licensed MIT */
5 |
6 | (function( factory ) {
7 | if ( typeof define === "function" && define.amd ) {
8 |
9 | // AMD. Register as an anonymous module.
10 | define([ "jquery" ], factory );
11 | } else {
12 |
13 | // Browser globals
14 | factory( jQuery );
15 | }
16 | }(function( $ ) {
17 | /*!
18 | * jQuery UI Widget 1.11.3
19 | * http://jqueryui.com
20 | *
21 | * Copyright jQuery Foundation and other contributors
22 | * Released under the MIT license.
23 | * http://jquery.org/license
24 | *
25 | * http://api.jqueryui.com/jQuery.widget/
26 | */
27 |
28 |
29 | var widget_uuid = 0,
30 | widget_slice = Array.prototype.slice;
31 |
32 | $.cleanData = (function( orig ) {
33 | return function( elems ) {
34 | var events, elem, i;
35 | for ( i = 0; (elem = elems[i]) != null; i++ ) {
36 | try {
37 |
38 | // Only trigger remove when necessary to save time
39 | events = $._data( elem, "events" );
40 | if ( events && events.remove ) {
41 | $( elem ).triggerHandler( "remove" );
42 | }
43 |
44 | // http://bugs.jquery.com/ticket/8235
45 | } catch ( e ) {}
46 | }
47 | orig( elems );
48 | };
49 | })( $.cleanData );
50 |
51 | $.widget = function( name, base, prototype ) {
52 | var fullName, existingConstructor, constructor, basePrototype,
53 | // proxiedPrototype allows the provided prototype to remain unmodified
54 | // so that it can be used as a mixin for multiple widgets (#8876)
55 | proxiedPrototype = {},
56 | namespace = name.split( "." )[ 0 ];
57 |
58 | name = name.split( "." )[ 1 ];
59 | fullName = namespace + "-" + name;
60 |
61 | if ( !prototype ) {
62 | prototype = base;
63 | base = $.Widget;
64 | }
65 |
66 | // create selector for plugin
67 | $.expr[ ":" ][ fullName.toLowerCase() ] = function( elem ) {
68 | return !!$.data( elem, fullName );
69 | };
70 |
71 | $[ namespace ] = $[ namespace ] || {};
72 | existingConstructor = $[ namespace ][ name ];
73 | constructor = $[ namespace ][ name ] = function( options, element ) {
74 | // allow instantiation without "new" keyword
75 | if ( !this._createWidget ) {
76 | return new constructor( options, element );
77 | }
78 |
79 | // allow instantiation without initializing for simple inheritance
80 | // must use "new" keyword (the code above always passes args)
81 | if ( arguments.length ) {
82 | this._createWidget( options, element );
83 | }
84 | };
85 | // extend with the existing constructor to carry over any static properties
86 | $.extend( constructor, existingConstructor, {
87 | version: prototype.version,
88 | // copy the object used to create the prototype in case we need to
89 | // redefine the widget later
90 | _proto: $.extend( {}, prototype ),
91 | // track widgets that inherit from this widget in case this widget is
92 | // redefined after a widget inherits from it
93 | _childConstructors: []
94 | });
95 |
96 | basePrototype = new base();
97 | // we need to make the options hash a property directly on the new instance
98 | // otherwise we'll modify the options hash on the prototype that we're
99 | // inheriting from
100 | basePrototype.options = $.widget.extend( {}, basePrototype.options );
101 | $.each( prototype, function( prop, value ) {
102 | if ( !$.isFunction( value ) ) {
103 | proxiedPrototype[ prop ] = value;
104 | return;
105 | }
106 | proxiedPrototype[ prop ] = (function() {
107 | var _super = function() {
108 | return base.prototype[ prop ].apply( this, arguments );
109 | },
110 | _superApply = function( args ) {
111 | return base.prototype[ prop ].apply( this, args );
112 | };
113 | return function() {
114 | var __super = this._super,
115 | __superApply = this._superApply,
116 | returnValue;
117 |
118 | this._super = _super;
119 | this._superApply = _superApply;
120 |
121 | returnValue = value.apply( this, arguments );
122 |
123 | this._super = __super;
124 | this._superApply = __superApply;
125 |
126 | return returnValue;
127 | };
128 | })();
129 | });
130 | constructor.prototype = $.widget.extend( basePrototype, {
131 | // TODO: remove support for widgetEventPrefix
132 | // always use the name + a colon as the prefix, e.g., draggable:start
133 | // don't prefix for widgets that aren't DOM-based
134 | widgetEventPrefix: existingConstructor ? (basePrototype.widgetEventPrefix || name) : name
135 | }, proxiedPrototype, {
136 | constructor: constructor,
137 | namespace: namespace,
138 | widgetName: name,
139 | widgetFullName: fullName
140 | });
141 |
142 | // If this widget is being redefined then we need to find all widgets that
143 | // are inheriting from it and redefine all of them so that they inherit from
144 | // the new version of this widget. We're essentially trying to replace one
145 | // level in the prototype chain.
146 | if ( existingConstructor ) {
147 | $.each( existingConstructor._childConstructors, function( i, child ) {
148 | var childPrototype = child.prototype;
149 |
150 | // redefine the child widget using the same prototype that was
151 | // originally used, but inherit from the new version of the base
152 | $.widget( childPrototype.namespace + "." + childPrototype.widgetName, constructor, child._proto );
153 | });
154 | // remove the list of existing child constructors from the old constructor
155 | // so the old child constructors can be garbage collected
156 | delete existingConstructor._childConstructors;
157 | } else {
158 | base._childConstructors.push( constructor );
159 | }
160 |
161 | $.widget.bridge( name, constructor );
162 |
163 | return constructor;
164 | };
165 |
166 | $.widget.extend = function( target ) {
167 | var input = widget_slice.call( arguments, 1 ),
168 | inputIndex = 0,
169 | inputLength = input.length,
170 | key,
171 | value;
172 | for ( ; inputIndex < inputLength; inputIndex++ ) {
173 | for ( key in input[ inputIndex ] ) {
174 | value = input[ inputIndex ][ key ];
175 | if ( input[ inputIndex ].hasOwnProperty( key ) && value !== undefined ) {
176 | // Clone objects
177 | if ( $.isPlainObject( value ) ) {
178 | target[ key ] = $.isPlainObject( target[ key ] ) ?
179 | $.widget.extend( {}, target[ key ], value ) :
180 | // Don't extend strings, arrays, etc. with objects
181 | $.widget.extend( {}, value );
182 | // Copy everything else by reference
183 | } else {
184 | target[ key ] = value;
185 | }
186 | }
187 | }
188 | }
189 | return target;
190 | };
191 |
192 | $.widget.bridge = function( name, object ) {
193 | var fullName = object.prototype.widgetFullName || name;
194 | $.fn[ name ] = function( options ) {
195 | var isMethodCall = typeof options === "string",
196 | args = widget_slice.call( arguments, 1 ),
197 | returnValue = this;
198 |
199 | if ( isMethodCall ) {
200 | this.each(function() {
201 | var methodValue,
202 | instance = $.data( this, fullName );
203 | if ( options === "instance" ) {
204 | returnValue = instance;
205 | return false;
206 | }
207 | if ( !instance ) {
208 | return $.error( "cannot call methods on " + name + " prior to initialization; " +
209 | "attempted to call method '" + options + "'" );
210 | }
211 | if ( !$.isFunction( instance[options] ) || options.charAt( 0 ) === "_" ) {
212 | return $.error( "no such method '" + options + "' for " + name + " widget instance" );
213 | }
214 | methodValue = instance[ options ].apply( instance, args );
215 | if ( methodValue !== instance && methodValue !== undefined ) {
216 | returnValue = methodValue && methodValue.jquery ?
217 | returnValue.pushStack( methodValue.get() ) :
218 | methodValue;
219 | return false;
220 | }
221 | });
222 | } else {
223 |
224 | // Allow multiple hashes to be passed on init
225 | if ( args.length ) {
226 | options = $.widget.extend.apply( null, [ options ].concat(args) );
227 | }
228 |
229 | this.each(function() {
230 | var instance = $.data( this, fullName );
231 | if ( instance ) {
232 | instance.option( options || {} );
233 | if ( instance._init ) {
234 | instance._init();
235 | }
236 | } else {
237 | $.data( this, fullName, new object( options, this ) );
238 | }
239 | });
240 | }
241 |
242 | return returnValue;
243 | };
244 | };
245 |
246 | $.Widget = function( /* options, element */ ) {};
247 | $.Widget._childConstructors = [];
248 |
249 | $.Widget.prototype = {
250 | widgetName: "widget",
251 | widgetEventPrefix: "",
252 | defaultElement: "
9 |
10 | *The example above was created with Slate. Check it out at [tripit.github.io/slate](http://tripit.github.io/slate).*
11 |
12 | Features
13 | ------------
14 |
15 | * **Clean, intuitive design** — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even print.
16 |
17 | * **Everything on a single page** — gone are the days where your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.
18 |
19 | * **Slate is just Markdown** — when you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks!
20 |
21 | * **Write code samples in multiple languages** — if your API has bindings in multiple programming languages, you easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown!
22 |
23 | * **Out-of-the-box syntax highlighting** for [almost 60 languages](http://rouge.jayferd.us/demo), no configuration required.
24 |
25 | * **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.
26 |
27 | * **Let your users update your documentation for you** — by default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it's simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to, you're welcome to not use Github and host your docs elsewhere!
28 |
29 | Getting starting with Slate is super easy! Simply fork this repository, and then follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://tripit.github.io/slate).
30 |
31 |
32 |
33 | Getting Started with Slate
34 | ------------------------------
35 |
36 | ### Prerequisites
37 |
38 | You're going to need:
39 |
40 | - **Linux or OS X** — Windows may work, but is unsupported.
41 | - **Ruby, version 1.9.3 or newer**
42 | - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
43 |
44 | ### Getting Set Up
45 |
46 | 1. Fork this repository on Github.
47 | 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git`
48 | 3. `cd slate`
49 | 4. Install all dependencies: `bundle install`
50 | 5. Start the test server: `bundle exec middleman server`
51 |
52 | Or use the included Dockerfile! (must install Docker first)
53 |
54 | ```shell
55 | docker build -t slate .
56 | docker run -d -p 4567:4567 slate
57 | ```
58 |
59 | You can now see the docs at