diff --git a/README.adoc b/README.adoc index b2978782..96bde4c4 100644 --- a/README.adoc +++ b/README.adoc @@ -5,9 +5,9 @@ ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/RE [.lead] ==== -This project provides some basic sanity checking on html files. +This project provides some basic sanity checking on HTML files. -It can be helpful in case of html generated from, e.g., {asciidoc-url}[Asciidoctor], +It can be helpful in case of HTML generated from, e.g., {asciidoc-url}[Asciidoctor], Markdown or other formats -- as converters usually don't check for missing images or broken links. ==== @@ -68,7 +68,7 @@ showing eventual errors within HTML files - as shown in the adjoining figure. === Broken Cross References (aka Broken Internal Links) -Finds all '<a href="XYZ">' where XYZ is not defined. +Find all '<a href="XYZ">' where XYZ is not defined. .src/broken.html [source,html] @@ -97,7 +97,7 @@ Use checkerClass _DuplicateIdChecker_. === Missing Local Resources -All files, (e.g., downloads) referenced from html. +All files, (e.g., downloads) referenced from HTML. Use checkerClass _MissingLocalResourcesChecker_. @@ -122,7 +122,7 @@ Use checkerClass _BrokenHttpLinksChecker_. === Other types of external links -*planned*: ftp, ntp or other protocols are currently not checked, but should... +`ftp`, `ntp` or other protocols are currently not checked, but should... == Technical Documentation @@ -144,13 +144,12 @@ This tiny piece rests on incredible groundwork: * The plugin heavily relies on code provided by {gradle-url}[Gradle]. -* Inspiration on code organization, implementation and testing of the plugin came from the {asciidoctor-gradle-plugin-url}[Asciidoctor-Gradle-Plugin] by [@AAlmiray]. +* Inspiration on code organization, implementation and testing of the plugin came from the {asciidoctor-gradle-plugin-url}[Asciidoctor-Gradle-Plugin] by https://github.com/aalmiray[Andres Almiray]. * Code for string similarity calculation by https://github.com/rrice/java-string-similarity[Ralph Rice]. * Implementation, maintenance and documentation by -* Current implementation, main ** Initially: {gernotstarke}[Gernot Starke], ** Currently: {gerdaschemann}[Gerd Aschemann] and several other contributors. @@ -164,7 +163,7 @@ In case you want to check out, fork and/or contribute, take a look into our http It creates a simple text file report and might be a complement to this `HtmlSanityChecker`. * https://bmuschko.com/blog/golang-with-gradle/[Benjamin Muschko] has created a (Go-based) command-line tool to check links, called https://github.com/bmuschko/link-verifier[link verifier]. * https://github.com/gjtorikian/html-proofer[html-proofer] is written in Ruby and provides different usage scenarios (programmatically, CLI, and Docker). -* https://github.com/wjdp/htmltest[htmltest] is also written in Go(Lang) and claims to be rapid compared to `html-proofer` (stay tuned; we have plans for HSC to run with Graal in a quick way). +* https://github.com/wjdp/htmltest[htmltest] is also written in Go(Lang) and claims to be rapid compared to `html-proofer` (stay tuned; we have plans for HSC to run with Graal quickly). == Contributing @@ -176,7 +175,7 @@ Fork our {project-url}[repository] and send a pull request. == Licence Currently, code is published under the Apache-2.0 licence, documentation under Creative-Commons-Sharealike-4.0. -Some day we'll unify that :-) +Some day we'll unify that 😬. == Kudos diff --git a/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/HtmlReporter.java b/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/HtmlReporter.java index 1b3ebcbe..cca23366 100644 --- a/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/HtmlReporter.java +++ b/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/HtmlReporter.java @@ -369,7 +369,7 @@ protected void reportSingleCheckDetails(SingleCheckResults checkResults) { * Tries to find a writable directory. First tries dirName, * if that does not work takes User.dir as second choice. * - * @param dirName : e.g. /Users/aim42/projects/htmlsc/build/report/htmlchecks + * @param dirName : e.g. /Users/aim42/projects/htmlsc/build/reports/htmlchecks * @return complete path to a writable file that does not currently exist. */ private File createOutputFile(String dirName) { diff --git a/htmlSanityCheck-gradle-plugin/README.adoc b/htmlSanityCheck-gradle-plugin/README.adoc index b7d4a400..c23fe968 100644 --- a/htmlSanityCheck-gradle-plugin/README.adoc +++ b/htmlSanityCheck-gradle-plugin/README.adoc @@ -228,7 +228,8 @@ https://plugins.gradle.org/plugin/org.aim42.htmlSanityCheck[Old versions] (< `2. [[sec:development-versions]] === Development versions -In case you want to use a current development (or arbitrary branch or tag) version from Github, add the following to your `settings.gradle`: +In case you want to use a current development (or arbitrary branch or tag) version from GitHub, +add the following to your `settings.gradle`: .settings.gradle [source,groovy,subs="attributes+"] diff --git a/src/docs/arc42/chapters/chap-01-Requirements.adoc b/src/docs/arc42/chapters/chap-01-Requirements.adoc index 04a06b9b..534837a2 100644 --- a/src/docs/arc42/chapters/chap-01-Requirements.adoc +++ b/src/docs/arc42/chapters/chap-01-Requirements.adoc @@ -55,7 +55,7 @@ See {xrefAlgorithmMissingLocalResourcesChecker} Duplicate link targets:: link-targets can occur several times with the same name - so the browser cannot know which is the desired target. See {xrefAlgorithmDuplicateIdChecker}. -.Illegal links:: The links (aka anchors or URIs) can contain illegal characters or violate HTML link syntax. See {xrefAlgorithmIllegalLinkChecker}. +Illegal links:: The links (aka anchors or URIs) can contain illegal characters or violate HTML link syntax. See {xrefAlgorithmIllegalLinkChecker}. Broken external links:: External http links can be broken due to myriads of reasons: misspelled, link-target currently offline, illegal link syntax. See {xrefAlgorithmBrokenHttpLinksChecker}. diff --git a/src/docs/arc42/hsc_arc42.adoc b/src/docs/arc42/hsc_arc42.adoc index 4aa71240..6498cbd6 100644 --- a/src/docs/arc42/hsc_arc42.adoc +++ b/src/docs/arc42/hsc_arc42.adoc @@ -13,7 +13,7 @@ include::chapters/_config.adoc[] // --------------------------------- -<<<< +<<< image:arc42-logo.png[arc42, link={arc42-url}, float=left] @@ -23,7 +23,7 @@ template^], freely available at {arc42-url}[{arc42-url}^]. [small]#This material is open source and provided under the Creative Commons Sharealike 4.0 license. It comes *without any guarantee*. Use on your own risk. arc42 and its structure by Dr. Peter Hruschka and Dr. Gernot Starke. -Asciidoc version initiated by Markus Schärtel and Jürgen Krey, +AsciiDoc version initiated by Markus Schärtel and Jürgen Krey, completed and maintained by Ralf Müller and Gernot Starke.# [small]#Version {hsc-version} of {docdate}# @@ -45,39 +45,39 @@ abbreviated with HSC include::About-This-Docu.adoc[] -<<<< +<<< include::chapters/chap-01-Requirements.adoc[] -<<<< +<<< include::chapters/chap-02-Constraints.adoc[] -<<<< +<<< include::chapters/chap-03-Context.adoc[] -<<<< +<<< include::chapters/chap-04-SolutionStrategy.adoc[] -<<<< +<<< include::chapters/chap-05-BuildingBlocks.adoc[] -<<<< +<<< include::chapters/chap-06-Runtime.adoc[] -<<<< +<<< include::chapters/chap-07-Deployment.adoc[] -<<<< +<<< include::chapters/chap-08-Concepts.adoc[] -<<<< +<<< include::chapters/chap-09-Decisions.adoc[] diff --git a/src/docs/landingpage.gsp b/src/docs/landingpage.gsp index 52f8bc41..57822230 100644 --- a/src/docs/landingpage.gsp +++ b/src/docs/landingpage.gsp @@ -2,11 +2,13 @@ <main class="col-12 col-md-12 col-xl-12 pl-md-12" role="main"> <div class="bg-light p-5 rounded"> <h1>Html Sanity Check (HSC)</h1> + <p class="lead"> This project provides some basic sanity checking on html files. </p> + <p> - It can be helpful in case of html generated from e.g. Asciidoctor, Markdown or other formats - as converters usually don’t check for missing images or broken links. + It can be helpful in case of HTML generated from e.g. Asciidoctor, Markdown or other formats - as converters usually don’t check for missing images or broken links. <br> HSC can be used programmatically or as <a href="https://gradle.org">Gradle</a> plugin. A standalone Java command line interface (CLI) version is planned as well as a <a href="https://maven.apache.org">Maven</a> plugin for future releases.