chore: replace Anakia printable docs with CSS @media print

The printable documentation was generated by a separate Anakia/Velocity
pipeline, but its only differences from the regular site (no sidebar,
no social widgets, no ¶ anchors, full-width content) are trivially
achieved with @media print CSS rules that already existed in
new-style.css. Remove the Anakia infrastructure and its dependencies
so the project has a single XSLT-based doc pipeline instead of two.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: GPT 5.4 <codex@openai.com>

Author: 3 people

.gitignore

@@ -20,6 +20,7 @@
 /dist/
 /docs/
 /local/
+# We no longer use printable_docs folder, however, keep it here so everybody else do not acidentally commit it
 /printable_docs/
 /reports/
 /site/

.ratignore

@@ -26,7 +26,6 @@ lib/aareadme.txt
 lib/opt/README.txt
 src/licenses/licenses/*/CC0-1.0.txt
 #local/**
-#printable_docs/**
 #reports/**
 src/launcher/src/main/resources/org/apache/jmeter/jmeter_as_ascii_art.txt
 src/core/src/main/resources/org/apache/jmeter/help.txt

README.md

@@ -136,8 +136,8 @@ a JMX file onto:
 ## Documentation
 
 The documentation available as of the date of this release is
-also included, in HTML format, in the [printable_docs](printable_docs) directory,
-and it may be browsed starting from the file called [index.html](printable_docs/index.html).
+also included, in HTML format, in the [docs](docs) directory,
+and it may be browsed starting from the file called [index.html](docs/index.html).
 
 ## Reporting a bug/enhancement
 

bin/jmeter.properties

@@ -33,7 +33,7 @@
 # JMeter properties are described in the file
 # http://jmeter.apache.org/usermanual/properties_reference.html
 # A local copy can be found in
-# printable_docs/usermanual/properties_reference.html
+# docs/usermanual/properties_reference.html
 
 #Preferred GUI language. Comment out to use the JVM default locale's language.
 #language=en

renovate.json

@@ -128,14 +128,6 @@
         "org.eclipse.jetty{/,}**"
       ]
     },
-    {
-      "groupName": "org.jdom",
-      "description": "Velocity Anakia uses JDOM 1.0",
-      "allowedVersions": "< 2.0",
-      "matchPackageNames": [
-        "org.jdom{/,}**"
-      ]
-    },
     {
       "groupName": "org.jetbrains.lets-plot",
       "matchPackageNames": [

src/core/src/main/java/org/apache/jmeter/gui/action/Help.java

@@ -49,7 +49,7 @@ public class Help extends AbstractAction {
 
     private static final String HELP_DOCS = "file:///"  // $NON-NLS-1$
         + JMeterUtils.getJMeterHome()
-        + "/printable_docs/usermanual/"; // $NON-NLS-1$
+        + "/docs/usermanual/"; // $NON-NLS-1$
 
     private static final String HELP_COMPONENTS = HELP_DOCS + "component_reference.html"; // $NON-NLS-1$
 

src/dist/build.gradle.kts

@@ -59,9 +59,6 @@ inline fun <reified T : Named> AttributeContainer.attribute(attr: Attribute<T>,
     attribute(attr, objects.named<T>(value))
 
 // isCanBeConsumed = false ==> other modules must not use the configuration as a dependency
-val buildDocs by configurations.creating {
-    isCanBeConsumed = false
-}
 val generatorJar by configurations.creating {
     isCanBeConsumed = false
 }
@@ -109,12 +106,6 @@ dependencies {
     srcLicense(project(":src:licenses", "srcLicense"))
     generatorJar(project(":src:generator", "archives"))
     junitSampleJar(project(":src:protocol:junit-sample"))
-
-    buildDocs(platform(projects.src.bomThirdparty))
-    buildDocs("org.apache.velocity:velocity")
-    buildDocs("commons-lang:commons-lang")
-    buildDocs("org.apache.commons:commons-collections4")
-    buildDocs("org.jdom:jdom")
 }
 
 node {
@@ -338,89 +329,6 @@ val createDist by tasks.registering {
 // source/binary artifacts with the appropriate eol/executable file flags
 val gitProps by rootProject.tasks.existing(FindGitAttributes::class)
 
-fun createAnakiaTask(
-    taskName: String,
-    baseDir: Directory,
-    extension: String = ".html",
-    style: String,
-    velocityProperties: String,
-    projectFile: String,
-    excludes: Array<String>,
-    includes: Array<String>
-): TaskProvider<Task> {
-    val outputDir = layout.buildDirectory.dir("docs/$taskName").get().asFile
-
-    val prepareProps = tasks.register("prepareProperties$taskName") {
-        // AnakiaTask can't use relative paths, and it forbids ../, so we create a dedicated
-        // velocity.properties file that contains absolute path
-        inputs.file(velocityProperties)
-        val outputProps = layout.buildDirectory.file("docProps/$taskName/velocity.properties").get().asFile
-        outputs.file(outputProps)
-        doLast {
-            // Unfortunately, Velocity does not use Java properties format.
-            // For instance, Properties escape : as \:, however Velocity does not understand that.
-            // Thus it tries to use c\:\path\to\workspace which does not work
-            val p = `java.util`.Properties()
-            file(velocityProperties).reader().use {
-                p.load(it)
-            }
-            p["resource.loader"] = "file"
-            p["file.resource.loader.path"] = baseDir.asFile.absolutePath
-            p["file.resource.loader.class"] = "org.apache.velocity.runtime.resource.loader.FileResourceLoader"
-            val specials = Regex("""([,\\])""")
-            val lines = p.entries
-                .map { (it.key as String) + "=" + ((it.value as String).replace(specials, """\\$1""")) }
-                .sorted()
-            file(outputProps).apply {
-                parentFile.run { isDirectory || mkdirs() } || throw IllegalStateException("Unable to create directory $parentFile")
-
-                writer().use {
-                    it.appendLine("# Auto-generated from $velocityProperties to pass absolute path to Velocity")
-                    for (line in lines) {
-                        it.appendLine(line)
-                    }
-                }
-            }
-        }
-    }
-
-    return tasks.register(taskName) {
-        inputs.file("$baseDir/$style").withPathSensitivity(PathSensitivity.RELATIVE).withPropertyName("styleDir")
-        inputs.file("$baseDir/$projectFile").withPathSensitivity(PathSensitivity.RELATIVE).withPropertyName("projectDir")
-        inputs.files(
-            fileTree(baseDir) {
-                include(*includes)
-                exclude(*excludes)
-            }
-        ).withPathSensitivity(PathSensitivity.RELATIVE).withPropertyName("baseDir")
-        inputs.property("extension", extension)
-        outputs.dir(outputDir)
-        outputs.cacheIf { true }
-        dependsOn(prepareProps)
-
-        doLast {
-            ant.withGroovyBuilder {
-                "taskdef"(
-                    "name" to "anakia",
-                    "classname" to "org.apache.velocity.anakia.AnakiaTask",
-                    "classpath" to buildDocs.asPath
-                )
-                "anakia"(
-                    "basedir" to baseDir,
-                    "destdir" to outputDir,
-                    "extension" to extension,
-                    "style" to style,
-                    "projectFile" to projectFile,
-                    "excludes" to excludes.joinToString(" "),
-                    "includes" to includes.joinToString(" "),
-                    "lastModifiedCheck" to "true",
-                    "velocityPropertiesFile" to prepareProps.get().outputs.files.singleFile
-                )
-            }
-        }
-    }
-}
-
 val xdocs = rootProject.layout.projectDirectory.dir("xdocs")
 
 fun CopySpec.docCssAndImages() {
@@ -439,13 +347,34 @@ fun CopySpec.manuals() {
     }
 }
 
-fun CopySpec.printableDocumentation() {
-    into("docs") {
-        docCssAndImages()
+fun CopySpec.docFontsAndCss() {
+    into("fonts") {
+        from(
+            fileTree(xdocs.dir("node_modules/@fontsource/merriweather/files")) {
+                builtBy(yarn_install)
+            }
+        ) {
+            include("*400*normal*.woff2")
+        }
+        from(xdocs.dir("node_modules/@fortawesome/fontawesome-free/webfonts")) {
+            include("fa-brands*.woff2")
+        }
     }
-    into("printable_docs") {
-        from(buildPrintableDoc)
-        manuals()
+    into("css") {
+        from(xdocs.dir("node_modules/@fontsource/merriweather")) {
+            include("400.css")
+            rename { "merriweather.css" }
+            filter {
+                it.replace("./files", "../fonts")
+            }
+        }
+        from(xdocs.dir("node_modules/@fortawesome/fontawesome-free/css")) {
+            include("fontawesome.min.css")
+            include("brands.min.css")
+            filter {
+                it.replace("../webfonts", "../fonts")
+            }
+        }
     }
 }
 
@@ -465,25 +394,6 @@ val yarn_install = tasks.named<YarnTask>("yarn_install") {
     outputs.dir(xdocs.dir("node_modules")).withPropertyName("node_modules")
 }
 
-val buildPrintableDoc = createAnakiaTask(
-    "buildPrintableDoc", baseDir = xdocs,
-    style = "stylesheets/site_printable.vsl",
-    velocityProperties = "$xdocs/velocity.properties",
-    projectFile = "stylesheets/printable_project.xml",
-    excludes = arrayOf("**/stylesheets/**", "extending.xml", "extending/*.xml", "node_modules", "package.json", "package-lock.json", "yarn.lock"),
-    includes = arrayOf("**/*.xml")
-)
-
-val previewPrintableDocs by tasks.registering(Copy::class) {
-    group = JavaBasePlugin.DOCUMENTATION_GROUP
-    description = "Creates preview of a printable documentation to build/docs/printable_preview"
-    into(layout.buildDirectory.dir("docs/printable_preview"))
-    CrLfSpec().run {
-        gitattributes(gitProps)
-        printableDocumentation()
-    }
-}
-
 val lastEditYear: String by rootProject.extra
 
 fun xslt(
@@ -542,34 +452,7 @@ fun CopySpec.siteLayout() {
     from(processSiteXslt)
     docCssAndImages()
     manuals()
-    into("fonts") {
-        from(
-            fileTree(xdocs.dir("node_modules/@fontsource/merriweather/files")) {
-                builtBy(yarn_install)
-            }
-        ) {
-            include("*400*normal*.woff2")
-        }
-        from(xdocs.dir("node_modules/@fortawesome/fontawesome-free/webfonts")) {
-            include("fa-brands*.woff2")
-        }
-    }
-    into("css") {
-        from(xdocs.dir("node_modules/@fontsource/merriweather")) {
-            include("400.css")
-            rename { "merriweather.css" }
-            filter {
-                it.replace("./files", "../fonts")
-            }
-        }
-        from(xdocs.dir("node_modules/@fortawesome/fontawesome-free/css")) {
-            include("fontawesome.min.css")
-            include("brands.min.css")
-            filter {
-                it.replace("../webfonts", "../fonts")
-            }
-        }
-    }
+    docFontsAndCss()
 }
 
 // See https://github.com/gradle/gradle/issues/10960
@@ -628,7 +511,12 @@ fun CrLfSpec.binaryLayout() = copySpec {
                 with(libsExt)
             }
         }
-        printableDocumentation()
+        into("docs") {
+            from(processSiteXslt)
+            docCssAndImages()
+            manuals()
+            docFontsAndCss()
+        }
         into("docs/api") {
             javadocs()
         }

xdocs/css/new-style.css

@@ -619,7 +619,7 @@ table {
 }
 
 @media print {
-  .nav, .header, .footer, .pagelinks, .go-top, .social-media, .share-links {
+  .nav, .header, .footer, .pagelinks, .go-top, .social-media, .share-links, .sectionlink {
     display: none;
   }