Use Tocbot for Table of Contents

Author: rstoyanchev

gradle/docs.gradle

@@ -83,6 +83,11 @@ asciidoctor {
 	sources {
 		include '*.adoc'
 	}
+	resources {
+		from(sourceDir) {
+			include 'images/**', 'tocbot-3.0.2/**'
+		}
+	}
 	logDocuments = true
 	backends = ["html5"]
 	// only ouput PDF documentation for non-SNAPSHOT builds

src/docs/asciidoc/core.adoc

@@ -3,7 +3,7 @@
 :doc-root: https://docs.spring.io
 :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 This part of the reference documentation covers all of those technologies that are

src/docs/asciidoc/data-access.adoc

@@ -3,7 +3,7 @@
 :doc-root: https://docs.spring.io
 :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 This part of the reference documentation is concerned with data access and the

src/docs/asciidoc/docinfo-footer.html

@@ -1,10 +1,46 @@
+<script src="tocbot-3.0.2/tocbot.js"></script>
 <script>
-    var rootLink = document.createElement("a");
-    rootLink.setAttribute("href", "index.html");
-    rootLink.innerHTML = "<i class=\"fa fa-chevron-left\" aria-hidden=\"true\"></i>&nbsp;&nbsp;Back to index";
+
+    // Tocbot dynamic TOC, works with tocbot 3.0.2
+    // Source: https://github.com/asciidoctor/asciidoctor/issues/699#issuecomment-321066006
+
+    var oldtoc = document.getElementById('toctitle').nextElementSibling;
+    var newtoc = document.createElement('div');
+    newtoc.setAttribute('id', 'tocbot');
+    newtoc.setAttribute('class', 'js-toc');
+    oldtoc.parentNode.replaceChild(newtoc, oldtoc);
+    tocbot.init({ contentSelector: '#content',
+        headingSelector: 'h1, h2, h3, h4, h5',
+        smoothScroll: false });
+    var handleTocOnResize = function() {
+        var width = window.innerWidth
+                    || document.documentElement.clientWidth
+                    || document.body.clientWidth;
+        if (width < 768) {
+            tocbot.refresh({ contentSelector: '#content',
+                headingSelector: 'h1, h2, h3, h4, h5',
+                collapseDepth: 6,
+                activeLinkClass: 'ignoreactive',
+                throttleTimeout: 1000,
+                smoothScroll: false });
+        }
+        else {
+            tocbot.refresh({ contentSelector: '#content',
+                headingSelector: 'h1, h2, h3, h4, h5',
+                smoothScroll: false });
+        }
+    };
+    window.addEventListener('resize', handleTocOnResize);
+    handleTocOnResize();
+
+
+    var link = document.createElement("a");
+    link.setAttribute("href", "index.html");
+    link.innerHTML = "<i class=\"fa fa-chevron-left\" aria-hidden=\"true\"></i>&nbsp;&nbsp;Back to index";
     var p = document.createElement("p");
-    p.appendChild(rootLink);
+    p.appendChild(link);
     var toc = document.getElementById('toc')
-    var sectlevel1 = toc.getElementsByClassName("sectlevel1")[0]
-    toc.insertBefore(p,  sectlevel1);
+    var next = document.getElementById('toctitle').nextElementSibling;
+    toc.insertBefore(p, next);
+
 </script>

src/docs/asciidoc/integration.adoc

@@ -5,7 +5,7 @@
 :doc-spring-amqp: {doc-root}/spring-amqp/docs/current/reference
 :doc-spring-gemfire: {doc-root}/spring-gemfire/docs/current/reference
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 This part of the reference documentation covers the Spring Framework's integration with

src/docs/asciidoc/kotlin.adoc

@@ -3,7 +3,7 @@
 :doc-root: https://docs.spring.io
 :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 [[introduction]]

src/docs/asciidoc/stylesheets/spring.css

@@ -1,4 +1,23 @@
 @import url(https://fonts.googleapis.com/css?family=Varela+Round|Montserrat:400,700);
+@import url('../tocbot-3.0.2/tocbot.css');
+
+/* See https://github.com/asciidoctor/asciidoctor/issues/699#issuecomment-321066006 */
+/* ================================================================================ */
+#tocbot a.toc-link.node-name--H1{ font-style: italic }
+@media screen{
+#tocbot > ul.toc-list{ margin-bottom: 0.5em; margin-left: 0.125em }
+#tocbot ul.sectlevel0, #tocbot a.toc-link.node-name--H1 + ul{
+  padding-left: 0 }
+#tocbot a.toc-link{ height:100% }
+.is-collapsible{ max-height:3000px; overflow:hidden; }
+.is-collapsed{ max-height:0 }
+.is-active-link{ font-weight:700 }
+}
+@media print{
+#tocbot a.toc-link.node-name--H4{ display:none }
+}
+/* ================================================================================ */
+
 /*! normalize.css v2.1.2 | MIT License | git.io/normalize */
 /* ========================================================================== HTML5 display definitions ========================================================================== */
 /** Correct `block` display not defined in IE 8/9. */

src/docs/asciidoc/testing.adoc

@@ -4,7 +4,7 @@
 :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
 :doc-spring-boot: {doc-root}/spring-boot/docs/current/reference
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 The adoption of the test-driven-development (TDD) approach to software

src/docs/asciidoc/tocbot-3.0.2/styles.css

@@ -3,7 +3,7 @@
 :doc-root: https://docs.spring.io
 :api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
 :toc: left
-:toclevels: 2
+:toclevels: 4
 :docinfo1:
 
 This part of the documentation covers support for Servlet stack, web applications built on the