diff options
| author | Kristian Høgsberg <krh@bitplanet.net> | 2010-11-30 09:29:17 -0500 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2010-11-30 09:29:17 -0500 |
| commit | ae300160f4ab3cae8b049970870ae911cf80cb6d (patch) | |
| tree | e4b5ee2afb20df4696c2d2fa2db6403da0e84435 | |
| parent | f66d28f106a046887d09871b7ba76ddbb9faec92 (diff) | |
Add script to generate faq table of contents
| -rw-r--r-- | faq.html | 3 | ||||
| -rw-r--r-- | generated-toc.js | 211 |
2 files changed, 214 insertions, 0 deletions
@@ -4,6 +4,7 @@ <head> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <link href="wayland.css" rel="stylesheet" type="text/css"> +<script type="text/javascript" src="generated-toc.js"></script> <title>Wayland</title> </head> @@ -12,6 +13,8 @@ <h2>Wayland FAQ</h2> +<div id="generated-toc" class="generate_from_h3"></div> + <h3>Why fork the X server?</h3> <p> diff --git a/generated-toc.js b/generated-toc.js new file mode 100644 index 0000000..3247368 --- /dev/null +++ b/generated-toc.js @@ -0,0 +1,211 @@ +/* MIT Licensed toc script from + * http://www.kryogenix.org/code/browser/generated-toc/ + * Minor edits to make it simlper. + */ + +/** Generated TOC + Stuart Langridge, July 2007 + + Generate a table of contents, based on headings in the page. + + To place the TOC on the page, add + + <div id="generated-toc"></div> + + to the page where you want the TOC to appear. If this element + is not present, the TOC will not appear. + + The TOC defaults to displaying all headings that are contained within + the same element as it itself is contained in (or all headings on the + page if you did not provide a generated-toc container). To override this, + provide a "highest heading" value by adding class="generate_from_h3" + (or h2, h4, etc) to the container. (If unspecified, this will display all + headings, as if class="generate_from_h1" was specified.) + + The TOC defaults to operating only on headings contained within the same + element as it itself, i.e., in a page like this: + + <div> + <div> + <div id="generated-toc"></div> + <h1>foo</h1> + <h2>bar</h2> + </div> + <h1>quux</h1> + </div> + + The "quux" heading will not appear in the TOC. To override this, + add class="generate_for_page" to the container, which will process + all headings on the page wheresoever they may be. + +*/ + +generated_toc = { + generate: function() { + // Identify our TOC element, and what it applies to + generate_from = '0'; + generate_for = 'unset'; + tocparent = document.getElementById('generated-toc'); + if (tocparent) { + // there is a div class="generated-toc" in the document + // dictating where the TOC should appear + classes = tocparent.className.split(/\s+/); + for (var i=0; i<classes.length; i++) { + // if it specifies which heading level to generate from, + // or what level to generate for, save these specifications + if (classes[i].match(/^generate_from_h[1-6]$/)) { + generate_from = classes[i].substr(classes[i].length-1,1); + } else if (classes[i].match(/^generate_for_[a-z]+$/)) { + generate_for = classes[i].match(/^generate_for_([a-z])+$/)[1]; + } + } + } else { + // They didn't specify a TOC element; exit + return; + } + + // set top_node to be the element in the document under which + // we'll be analysing headings + if (generate_for == 'page') { + top_node = document.getElementsByTagName('body'); + } else { + // i.e., explicitly set to "parent", left blank (so "unset"), + // or some invalid value + top_node = tocparent.parentNode; + } + + // If there isn't a specified header level to generate from, work + // out what the first header level inside top_node is + // and make that the specified header level + if (generate_from == 0) { + first_header_found = generated_toc.findFirstHeader(top_node); + if (!first_header_found) { + // there were no headers at all inside top_node! + return; + } else { + generate_from = first_header_found.toLowerCase().substr(1); + } + } + + // add all levels of heading we're paying attention to to the + // headings_to_treat dictionary, ready to be filled in later + headings_to_treat = {"h6":''}; + for (var i=5; i>= parseInt(generate_from); i--) { + headings_to_treat["h" + i] = ''; + } + + // get headings. We can't say + // getElementsByTagName("h1" or "h2" or "h3"), etc, so get all + // elements and filter them ourselves + // need to use .all here because IE doesn't support gEBTN('*') + nodes = top_node.all ? top_node.all : top_node.getElementsByTagName('*'); + + // put all the headings we care about in headings + headings = []; + for (var i=0; i<nodes.length;i++) { + if (nodes[i].nodeName.toLowerCase() in headings_to_treat) { + // if heading has class no-TOC, skip it + if ((' ' + nodes[i].className + ' ').indexOf('no-TOC') != -1) { + continue; + } + headings.push(nodes[i]); + } + } + + cur_head_lvl = "h" + generate_from; + cur_list_el = document.createElement('ul'); + tocparent.appendChild(cur_list_el); + + // now walk through our saved heading nodes + for (var i=0; i<headings.length; i++) { + this_head_el = headings[i]; + this_head_lvl = headings[i].nodeName.toLowerCase(); + if (!this_head_el.id) { + // if heading doesn't have an ID, give it one + this_head_el.id = 'heading_toc_j_' + i; + this_head_el.setAttribute('tabindex','-1'); + } + + while(this_head_lvl > cur_head_lvl) { + // this heading is at a lower level than the last one; + // create additional nested lists to put it at the right level + + // get the *last* LI in the current list, and add our new UL to it + var last_listitem_el = null; + for (var j=0; j<cur_list_el.childNodes.length; j++) { + if (cur_list_el.childNodes[j].nodeName.toLowerCase() == 'li') { + last_listitem_el = cur_list_el.childNodes[j]; + } + } + if (!last_listitem_el) { + // there aren't any LIs, so create a new one to add the UL to + last_listitem_el = document.createElement('li'); + } + new_list_el = document.createElement('ul'); + last_listitem_el.appendChild(new_list_el); + cur_list_el.appendChild(last_listitem_el); + cur_list_el = new_list_el; + cur_head_lvl = 'h' + (parseInt(cur_head_lvl.substr(1,1)) + 1); + } + + while (this_head_lvl < cur_head_lvl) { + // this heading is at a higher level than the last one; + // go back up the TOC to put it at the right level + cur_list_el = cur_list_el.parentNode.parentNode; + cur_head_lvl = 'h' + (parseInt(cur_head_lvl.substr(1,1)) - 1); + } + + // create a link to this heading, and add it to the TOC + li = document.createElement('li'); + a = document.createElement('a'); + a.href = '#' + this_head_el.id; + a.appendChild(document.createTextNode(generated_toc.innerText(this_head_el))); + li.appendChild(a); + cur_list_el.appendChild(li); + } + }, + + innerText: function(el) { + return (typeof(el.innerText) != 'undefined') ? el.innerText : + (typeof(el.textContent) != 'undefined') ? el.textContent : + el.innerHTML.replace(/<[^>]+>/g, ''); + }, + + findFirstHeader: function(node) { + // a recursive function which returns the first header it finds inside + // node, or null if there are no functions inside node. + var nn = node.nodeName.toLowerCase(); + if (nn.match(/^h[1-6]$/)) { + // this node is itself a header; return our name + return nn; + } else { + for (var i=0; i<node.childNodes.length; i++) { + var subvalue = generated_toc.findFirstHeader(node.childNodes[i]); + // if one of the subnodes finds a header, abort the loop and return it + if (subvalue) return subvalue; + } + // no headers in this node at all + return null; + } + }, + + init: function() { + // quit if this function has already been called + if (arguments.callee.done) return; + + // flag this function so we don't do the same thing twice + arguments.callee.done = true; + + generated_toc.generate(); + } +}; + +(function(i) {var u =navigator.userAgent;var e=/*@cc_on!@*/false; var st = +setTimeout;if(/webkit/i.test(u)){st(function(){var dr=document.readyState; +if(dr=="loaded"||dr=="complete"){i()}else{st(arguments.callee,10);}},10);} +else if((/mozilla/i.test(u)&&!/(compati)/.test(u)) || (/opera/i.test(u))){ +document.addEventListener("DOMContentLoaded",i,false); } else if(e){ ( +function(){var t=document.createElement('doc:rdy');try{t.doScroll('left'); +i();t=null;}catch(e){st(arguments.callee,0);}})();}else{window.onload=i;}})(generated_toc.init); + + |