/* TableOfContents Plugin for jQuery Programmed by Doug Neiner Version: 0.8 Based on code and concept by Janko Jovanovic in his article: http://www.jankoatwarpspeed.com/post/2009/08/20/Table-of-contents-using-jQuery.aspx This plugin is offered under the MIT license: (c) 2009 by Doug Neiner, http://dougneiner.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ (function($){ $.TableOfContents = function(el, scope, options){ // To avoid scope issues, use 'base' instead of 'this' // to reference this class from internal events and functions. var base = this; // Access to jQuery and DOM versions of element base.$el = $(el); base.el = el; base.toc = ""; // We use this to build our TOC; base.listStyle = null; // This will store the type of list base.tags = ["h1","h2","h3","h4","h5","h6"]; // The six header tags base.init = function(){ // Merge the defaultOptions with any options passed in base.options = $.extend({},$.TableOfContents.defaultOptions, options); // Gets the scope. Defaults to the entire document if not specified if(typeof(scope) == "undefined" || scope == null) scope = document.body; base.$scope = $(scope); // Quick validation on depth if(base.options.depth < 1) base.options.depth = 1; // Get only the tags starting with startLevel, and counting the depth var filtered_tags = base.tags.splice(base.options.startLevel - 1, base.options.depth); // Find the first heading withing the scope var $first = base.$scope.find(filtered_tags.join(', ')).filter(':first'); // If no headings were found, stop building the TOC if($first.length != 1) return; // Set the starting depth base.starting_depth = base.options.startLevel; // Cache all the headings that match our new filter base.$headings = base.$scope.find(filtered_tags.join(', ')); // If topLinks is enabled, set/get an id for the body element if(base.options.topLinks !== false){ var id = $(document.body).attr('id'); if(id == "") { id = base.options.topBodyId; document.body.id = id; }; // Cache the id locally base.topLinkId = id; }; // Find out which list style to use if(base.$el.is('ul')){ base.listStyle = 'ul'; } else if (base.$el.is('ol')){ base.listStyle = 'ol'; }; base.buildTOC(); if(base.options.proportionateSpacing === true && !base.tieredList()){ base.addSpacing(); }; return base; // Return this object for memory cleanup }; // Helper function that returns true for both OL and UL lists base.tieredList = function(){ return (base.listStyle == 'ul' || base.listStyle == 'ol'); }; base.buildTOC = function(){ base.current_depth = base.starting_depth; base.$headings.each(function(i,element){ // Get current depth base on h1, h2, h3, etc. var depth = this.nodeName.toLowerCase().substr(1,1); // This changes depth, or adds separators, only if not the first item if(i > 0 || ( i == 0 && depth != base.current_depth)){ base.changeDepth(depth) }; // Add the TOC link base.toc += base.formatLink(this, depth, i) + "\n"; // Add the topLink if enabled if(base.options.topLinks !== false) base.addTopLink(this); }); // Close up any nested list base.changeDepth(base.starting_depth, true); // Wrap entire TOC in an LI if item was nested. if(base.tieredList()) base.toc = "
  • \n" + base.toc + "
    • \n"; // Update the TOC element with the completed TOC base.$el.html(base.toc); }; base.addTopLink = function(element){ // Get the text for the link (if topLinks === true, it defaults to "Top") var text = (base.options.topLinks === true ? "Top" : base.options.topLinks ); var $a = $("").html(text); // Append to the current Header element $(element).append($a); }; base.formatLink = function(element, depth, index){ // Get the current id of the header element var id = element.id; // If no id exisits, create a unique one if(id == ""){ id = base.buildSlug($(element).text()); element.id = id; }; // Start building the a link var a = "'; return a; }; base.changeDepth = function(new_depth, last){ if(last !== true) last = false; // If straight links, just change depth and return if(!base.tieredList()){ base.current_depth = new_depth; return true; }; // If nested if(new_depth > base.current_depth){ // Add enough opening tags to step into the heading // as it is possible that a poorly built document // steps from h1 to h3 without an h2 var opening_tags = []; for(var i = base.current_depth; i < new_depth; i++){ opening_tags.push('<' + base.listStyle + '>' + "\n"); }; var li = "
  • \n"; // Add the code to our TOC and an opening LI base.toc += opening_tags.join(li) + li; } else if (new_depth < base.current_depth){ // Close all the loops var closing_tags = []; for(var i = base.current_depth; i > new_depth; i--){ closing_tags.push('' + "\n"); }; // Add closing LI and any additional closing tags base.toc += "
    • \n" + closing_tags.join('' + "\n"); // Open next block if (!last) { base.toc += "\n
  • \n"; } } else { // Just close a tag and open a new one // since the depth has not changed if (!last) { base.toc += "
    • \n
  • \n"; } }; // Store the new depth base.current_depth = new_depth; }; base.buildSlug = function(text){ text = text.toLowerCase().replace(/[^a-z0-9 -]/gi,'').replace(/ /gi,'-'); text = text.substr(0,50); return text; }; base.depthClass = function(depth){ // Normalizes the depths to always start at 1, even if the starting tier is a h4 return base.options.levelClass.replace('%', (depth - ( base.starting_depth - 1 ) ) ); }; base.addSpacing = function(){ var start = base.$headings.filter(':first').position().top; base.$headings.each(function(i,el){ var $a = base.$el.find('a:eq(' + i + ')'); var pos = ( ( $(this).position().top - start ) / ( base.$scope.height() - start ) ) * base.$el.height(); $a.css({ position: "absolute", top: pos }); }); }; return base.init(); }; $.TableOfContents.defaultOptions = { // One option is set by the container element, and not by changing // a setting here. That is the type of TOC to output. For a nested ordered list // make sure your wrapping element is an
      . For a nested bulleted list // make sure your wrapping element is an
        . For a straight outputting of links // use any other element. // Which H tags should be the root items. h1 = 1, h2 = 2, etc. startLevel: 1, // How many levels of H tags should be shown, including the startLevel // startLevel: 1, depth: 3 = h1, h2, h3 // startLevel: 2, depth: 3 = h2, h3, h4 depth: 3, // Each link in a straight set is give a class designating how deep it is. // You can change the class by changing this option, // but you must include a % sign where you want the number to go. // Nested lists do not add classes, as you can determine their depth with straight css levelClass: "toc-depth-%", // When each link is formed, you can supply additional html or text to be formatted // with the text of the header. % represents the text of the header levelText: "%", // This plugin can add "To Top" links to each header element if you want. // Set topLinks to true to use the text "Top" or set it to some text or html // content you wish to use as the body of the link topLinks: false, // If topLinks is either true or a text/html value, you can also set the following options: // Class of the link that is added to the headers topLinkClass: "toc-top-link", // Which class should be added to the body element if it does not // already have an id associated with it topBodyId: "toc-top", // To have the TOC spaced proportionatly to the spacing of the headings, // you must have a fixed height on the TOC wrapper, and it must "haveLayout" // either position = fixed | absolute | relative // Finally, the TOC wrapper must not be a UL or an LI or this setting will // have no effect proportionateSpacing: false }; $.fn.tableOfContents = function(scope, options){ return this.each(function(){ var toc = new $.TableOfContents(this, scope, options); delete toc; // Free memory }); }; })(jQuery);