From f89aa2086172564e725770abfc20a7c79f148f21 Mon Sep 17 00:00:00 2001 From: Jay Bryant Date: Wed, 27 Jul 2022 17:31:17 -0500 Subject: [PATCH] Use spring-asciidoctor-backends for documentation generation Resolves #3865 --- pom.xml | 2 +- spring-batch-docs/pom.xml | 60 +++++------------- spring-batch-docs/src/assembly/dist.xml | 9 +-- spring-batch-docs/src/assembly/docs.xml | 1 + .../src/main/asciidoc/js/DocumentToggle.js | 3 - .../main/asciidoc/jsfiles/DocumentToggle.js | 62 ------------------- 6 files changed, 22 insertions(+), 115 deletions(-) delete mode 100644 spring-batch-docs/src/main/asciidoc/jsfiles/DocumentToggle.js diff --git a/pom.xml b/pom.xml index 2eb81d5d4c..ebde1a3a34 100644 --- a/pom.xml +++ b/pom.xml @@ -144,7 +144,7 @@ 3.2.0 3.2.2 3.3.0 - 0.0.32 + 0.0.34 diff --git a/spring-batch-docs/pom.xml b/spring-batch-docs/pom.xml index 493fedc63c..680ae2cd9b 100644 --- a/spring-batch-docs/pom.xml +++ b/spring-batch-docs/pom.xml @@ -10,15 +10,6 @@ Spring Batch Docs Spring Batch documentation - - - io.spring.docresources - spring-doc-resources - ${spring-doc-resources.version} - zip - - - @@ -30,36 +21,10 @@ - - org.apache.maven.plugins - maven-resources-plugin - ${maven-resources-plugin.version} - - - org.apache.maven.plugins - maven-dependency-plugin - ${maven-dependency-plugin.version} - - - unpack-resources - pre-site - - unpack-dependencies - - - io.spring.docresources - spring-doc-resources - zip - true - ${project.build.directory}/asciidoc - - - - org.asciidoctor asciidoctor-maven-plugin - ${asciidoctor-maven-plugin.version} + 2.1.0 org.asciidoctor @@ -71,6 +36,11 @@ asciidoctorj-epub3 ${asciidoctorj-epub.version} + + io.spring.asciidoctor.backends + spring-asciidoctor-backends + 0.0.3 + ${project.basedir}/src/main/asciidoc @@ -84,13 +54,13 @@ process-asciidoc - html5 + spring-html book ${project.build.directory}/asciidoc shared css/ - spring.css + site.css true font @@ -215,13 +185,13 @@ - spring-releases - Spring Releases - https://repo.spring.io/libs-release - - false - - + spring-release + Spring Releases + https://repo.spring.io/release + + false + + diff --git a/spring-batch-docs/src/assembly/dist.xml b/spring-batch-docs/src/assembly/dist.xml index ac94746ea0..5fe9e8a75a 100644 --- a/spring-batch-docs/src/assembly/dist.xml +++ b/spring-batch-docs/src/assembly/dist.xml @@ -15,6 +15,7 @@ css/*.* images/*.* + img/*.* js/**/*.* *.html @@ -77,13 +78,13 @@ docs/reference/pdf - target/classes/license.txt + src/dist/license.txt - target/classes/notice.txt + src/dist/notice.txt - target/classes/readme.txt + src/dist/readme.txt - \ No newline at end of file + diff --git a/spring-batch-docs/src/assembly/docs.xml b/spring-batch-docs/src/assembly/docs.xml index b8f3a1b971..7bf5caa613 100644 --- a/spring-batch-docs/src/assembly/docs.xml +++ b/spring-batch-docs/src/assembly/docs.xml @@ -13,6 +13,7 @@ css/*.* images/*.* + img/*.* js/**/*.* *.html diff --git a/spring-batch-docs/src/main/asciidoc/js/DocumentToggle.js b/spring-batch-docs/src/main/asciidoc/js/DocumentToggle.js index ca720afbe0..c2941f3580 100644 --- a/spring-batch-docs/src/main/asciidoc/js/DocumentToggle.js +++ b/spring-batch-docs/src/main/asciidoc/js/DocumentToggle.js @@ -52,7 +52,6 @@ $(document).ready(function(){ $javaContentAll.addClass("js-toc-ignore"); $xmlContentAll.removeClass("js-toc-ignore"); window.dispatchEvent(new Event("tocRefresh")); - tocbot.refresh(); window.localStorage.setItem('docToggle', 'xml'); } @@ -62,7 +61,6 @@ $(document).ready(function(){ $xmlContentAll.addClass("js-toc-ignore"); $javaContentAll.removeClass("js-toc-ignore"); window.dispatchEvent(new Event("tocRefresh")); - tocbot.refresh(); window.localStorage.setItem('docToggle', 'java'); } @@ -72,7 +70,6 @@ $(document).ready(function(){ $javaContentAll.removeClass("js-toc-ignore"); $xmlContentAll.removeClass("js-toc-ignore"); window.dispatchEvent(new Event("tocRefresh")); - tocbot.refresh(); window.localStorage.setItem('docToggle', 'both'); } diff --git a/spring-batch-docs/src/main/asciidoc/jsfiles/DocumentToggle.js b/spring-batch-docs/src/main/asciidoc/jsfiles/DocumentToggle.js deleted file mode 100644 index 9402920d87..0000000000 --- a/spring-batch-docs/src/main/asciidoc/jsfiles/DocumentToggle.js +++ /dev/null @@ -1,62 +0,0 @@ -$(document).ready(function(){ - - // Make Java the default - setJava(); - - // Initial cookie handler. This part remembers the reader's choice and sets the toggle - // accordingly. - var docToggleCookieString = Cookies.get("docToggle"); - if (docToggleCookieString != null) { - if (docToggleCookieString === "xml") { - $("#xmlButton").prop("checked", true); - setXml(); - } else if (docToggleCookieString === "java") { - $("#javaButton").prop("checked", true); - setJava(); - } else if (docToggleCookieString === "both") { - $("#bothButton").prop("checked", true); - setBoth(); - } - } - - // Click handlers - $("#xmlButton").on("click", function() { - setXml(); - }); - $("#javaButton").on("click", function() { - setJava(); - }); - $("#bothButton").on("click", function() { - setBoth(); - }); - - // Functions to do the work of handling the reader's choice, whether through a click - // or through a cookie. 3652 days is 10 years, give or take a leap day. - function setXml() { - $("*.xmlContent").show(); - $("*.javaContent").hide(); - $("*.javaContent > *").addClass("js-toc-ignore"); - $("*.xmlContent > *").removeClass("js-toc-ignore"); - window.dispatchEvent(new Event("tocRefresh")); - Cookies.set('docToggle', 'xml', { expires: 3652 }); - }; - - function setJava() { - $("*.javaContent").show(); - $("*.xmlContent").hide(); - $("*.xmlContent > *").addClass("js-toc-ignore"); - $("*.javaContent > *").removeClass("js-toc-ignore"); - window.dispatchEvent(new Event("tocRefresh")); - Cookies.set('docToggle', 'java', { expires: 3652 }); - }; - - function setBoth() { - $("*.javaContent").show(); - $("*.xmlContent").show(); - $("*.javaContent > *").removeClass("js-toc-ignore"); - $("*.xmlContent > *").removeClass("js-toc-ignore"); - window.dispatchEvent(new Event("tocRefresh")); - Cookies.set('docToggle', 'both', { expires: 3652 }); - }; - -});