From 1d9fbe768b81dede68d8e341fb306291287d62b2 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Thu, 25 Apr 2024 11:36:32 +0200 Subject: [PATCH] WIP 309 Extend Manuals - Add Gradle Plugin manual - Fix links in manuals/READMEs --- README.adoc | 6 ++++-- asciidoctor-config.ad | 2 +- htmlSanityCheck-gradle-plugin/README.adoc | 10 ++++++++-- src/docs/manual/01_gradle-plugin.adoc | 10 ++++++++++ src/docs/manual/01_manual.adoc | 4 +++- 5 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 src/docs/manual/01_gradle-plugin.adoc diff --git a/README.adoc b/README.adoc index 59284994..a00740ee 100644 --- a/README.adoc +++ b/README.adoc @@ -2,6 +2,8 @@ // ifndef::sourceDir[:sourcedir: .] include::asciidoctor-config.ad[] +ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/README.adoc] + [.lead] ==== This project provides some basic sanity checking on html files. @@ -14,7 +16,7 @@ or broken links. It can be currently used * Programmatically from Java (or other JVM languages), or -* As a xref:htmlSanityCheck-gradle-plugin/README.adoc[Gradle plugin]. +* As a xref:{xrefToGradlePlugin}[Gradle plugin]. Standalone Java (CLI) executable and a https://maven.apache.org[Apache Maven] Plugin are planned for future releases. @@ -322,6 +324,6 @@ Some day we'll unify that :-) == Kudos -Big thanx to image:./structure101-logo.png[alt='Structure-101',link="https://structure101.com"] for helping us analyze and restructure our code. +Big thanx to image:structure101-logo.png[alt='Structure-101',link="https://structure101.com"] for helping us analyze and restructure our code. diff --git a/asciidoctor-config.ad b/asciidoctor-config.ad index 760e2cec..464be636 100644 --- a/asciidoctor-config.ad +++ b/asciidoctor-config.ad @@ -1,6 +1,6 @@ :icons: font :toc: left -:imagesdir: . +ifndef::imagesdir[:imagesdir: .] // :outfilesuffix: adoc diff --git a/htmlSanityCheck-gradle-plugin/README.adoc b/htmlSanityCheck-gradle-plugin/README.adoc index 1a7a2dda..8d65864c 100644 --- a/htmlSanityCheck-gradle-plugin/README.adoc +++ b/htmlSanityCheck-gradle-plugin/README.adoc @@ -1,9 +1,15 @@ :doctype: book include::../asciidoctor-config.ad[] +ifndef::xrefToManual[:xrefToManual: ../README.adoc] +:gradleProperties: link:../gradle.properties[] +ifdef::jbake-type[] +:gradleProperties: {project-url}/gradle.properties[] +endif::jbake-type[] + = HSC Gradle Plugin -The {gradle-url}[Gradle] plugin of HTML Sanity Check (xref:../README.adoc[HSC]) enables to check generated or native HTML documentation from the Gradle build. +The {gradle-url}[Gradle] plugin of HTML Sanity Check (xref:{xrefToManual}[HSC]) enables to check generated or native HTML documentation from the Gradle build. [[sec:installation]] == Installation (Gradle Plugin) @@ -63,7 +69,7 @@ apply plugin: 'org.aim42.{project}' [IMPORTANT] .Latest (development) version ==== -The current development version is defined in link:../gradle.properties[] +The current development version is defined in {gradleProperties} [source] ---- diff --git a/src/docs/manual/01_gradle-plugin.adoc b/src/docs/manual/01_gradle-plugin.adoc new file mode 100644 index 00000000..01b35865 --- /dev/null +++ b/src/docs/manual/01_gradle-plugin.adoc @@ -0,0 +1,10 @@ +:filename: manual/01_gradle-plugin.adoc +:imagesdir: ../images +:jbake-menu: Manual +:jbake-order: 30 +:jbake-title: HTML Sanity Check (Gradle Plugin) + +ifndef::projectRootDir[:projectRootDir: ../../..] +:xrefToManual: 01_manual.adoc + +include::{projectRootDir}/htmlSanityCheck-gradle-plugin/README.adoc[leveloffset=+1] \ No newline at end of file diff --git a/src/docs/manual/01_manual.adoc b/src/docs/manual/01_manual.adoc index 01e2a2af..57837191 100644 --- a/src/docs/manual/01_manual.adoc +++ b/src/docs/manual/01_manual.adoc @@ -1,8 +1,10 @@ :filename: manual/01_manual.adoc :imagesdir: ../images :jbake-menu: Manual -:jbake-title: HTML Sanity Check +:jbake-order: 10 +:jbake-title: HTML Sanity Check (Generic) ifndef::projectRootDir[:projectRootDir: ../../..] +:xrefToGradlePlugin: 01_gradle-plugin.adoc include::{projectRootDir}/README.adoc[leveloffset=+1] \ No newline at end of file