[toc2] option to skip h1 headings for use as notebook title

rename option, add yaml entry for configurator, limit to h1 rather than just the first heading

Author: jcb91

src/jupyter_contrib_nbextensions/nbextensions/toc2/README.md

@@ -29,7 +29,7 @@ The initial configuration can be given using the IPython-contrib nbextensions fa
 - Widening the display area to fit the browser window (may be useful with sidebar option; default: true)    
 - The numbering of headers (true by default)
 - Moving header title and menus on the left (default: true)
-- Skipping the first header (useful if you want to display a title): set `skipTitle` to true in the notebook's metadata (default: false)
+- Skipping h1 headers, useful if you want to use h1 as unnumbered notebook title (default: false)
 - Customization of highlighting the title of currently selected/running sections.  
 - Customization of background, fonts, border and highlighting colors in the toc window and navigation menus (as third demo).
 
@@ -103,3 +103,5 @@ This option requires the IPython kernel and is not present with other kernels.
      - Updated README to please @KadeG in #871
 - @hiiwave, april 2017.
      - Support customization of background, fonts, border and highlighting colors in the toc window and navigation menus with PR [#969](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/969)
+- @louisabraham, @jcb91 July 2017. Add support for skipping h1 headings,
+  enabling their use as unnumbered notebook titles

src/jupyter_contrib_nbextensions/nbextensions/toc2/main.js

@@ -33,7 +33,7 @@ define(["require", "jquery", "base/js/namespace",  'services/config',
                 'navigate_text': '#333333',
                 'navigate_num': '#000000',
               },
-              'skipTitle': false
+              skip_h1_title: false,
 }
 
 //.....................global variables....

src/jupyter_contrib_nbextensions/nbextensions/toc2/toc2.js

@@ -534,17 +534,15 @@ var table_of_contents = function (cfg,st) {
     var depth = 1; //var depth = ol_depth(ol);
     var li= ul;//yes, initialize li with ul! 
     var all_headers= $("#notebook").find(":header");
-    var min_lvl=1, lbl_ary= [];
+    var min_lvl = 1 + Number(Boolean(cfg.skip_h1_title)), lbl_ary = [];
     for(; min_lvl <= 6; min_lvl++){ if(all_headers.is('h'+min_lvl)){break;} }
     for(var i= min_lvl; i <= 6; i++){ lbl_ary[i - min_lvl]= 0; }
 
     //loop over all headers
     all_headers.each(function (i, h) {
       var level = parseInt(h.tagName.slice(1), 10) - min_lvl + 1;
-      // skip title if necessary
-      if (cfg.skipTitle &&!i){ return; }
-      // skip below threshold
-      if (level > cfg.threshold){ return; }
+      // skip below threshold, or h1 ruled out by cfg.skip_h1_title
+      if (level < 1 || level > cfg.threshold){ return; }
       // skip headings with no ID to link to
       if (!h.id){ return; }
       // skip toc cell if present

src/jupyter_contrib_nbextensions/nbextensions/toc2/toc2.yaml

@@ -16,6 +16,13 @@ Parameters:
   min: -1
   step: 1
   default: 4
+
+- name: toc2.skip_h1_title
+  description: |
+    Skip h1 headings from numbering, so that they can serve as a notebook title
+  input_type: checkbox
+  default: false
+
 - name: toc2.toc_cell
   description: Add a Table of Contents cell at the top of the notebook
   input_type: checkbox