Test jyjeanne/dita-ot-gradle

[infotexture]

Description

Test jyjeanne/dita-ot-gradle per dita-ot/discussions/4722 & jyjeanne/dita-ot-gradle#quick-migration-tldr.

Motivation and Context

Confirm whether the new jyjeanne/dita-ot-gradle Gradle plugin works in our environment to take advantage of recent Gradle features that are not supported by the original eerohele/dita-ot-gradle plugin.

How Has This Been Tested?

1. Update build.gradle in Refactor for Gradle 9 compatibility #644
2. Update modified build.gradle@e11be3b to use jyjeanne/dita-ot-gradle

Result

❌ Build fails:

FAILURE: Build failed with an exception.

* Where:
Build file '/path/to/docs/build.gradle' line: 45

* What went wrong:
A problem occurred evaluating root project 'docs'.
> Could not get unknown property 'ditaOt' for root project 'docs' of type org.gradle.api.Project.

[jyjeanne]

@infotexture i made some improvment on latest version 2.30 and solve problem on cache configuration , can you try with this new version of the plugin : https://github.com/jyjeanne/dita-ot-gradle/releases/tag/v2.3.0 ?

[infotexture]

@jyjeanne Thanks, tried again with the new v2.3.0 as you suggested.

Build proceeds and announces success in the (new) transformation report summaries, so the explicit directory config in 567d0a3 works, and v2.3.0 seems to solve the AntClassLoader error from 2.2.0:

> Task :html
Starting DITA-OT transformation

═══════════════════════════════════════════════════════
DITA-OT Transformation Report
═══════════════════════════════════════════════════════
Status:           SUCCESS
DITA-OT version:  unknown
Files processed:  1
Formats:          html5
Output size:      2.12 MB
Duration:         9.82s
═══════════════════════════════════════════════════════

> Task :pdf
Starting DITA-OT transformation

═══════════════════════════════════════════════════════
DITA-OT Transformation Report
═══════════════════════════════════════════════════════
Status:           SUCCESS
DITA-OT version:  unknown
Files processed:  1
Formats:          pdf
Output size:      4.60 MB
Duration:         15.21s
═══════════════════════════════════════════════════════

However, the properties in the html and pdf tasks are apparently ignored.

For example:

• HTML output does not respect the CSS parameters on build.gradle#L125-L128
• PDF output is generated with the default PDF transformation and filename instead of the outputFile.base and theme from build.gradle#L111-L112

[jyjeanne]

@infotexture Hi, I finally find a solution :

Root Cause

The properties { } closure syntax that worked in v2.2.x no longer functions correctly in v2.3.0:

// ❌ BROKEN in v2.3.0 - Properties are silently ignored
properties {
    property name: 'args.copycss', value: 'yes'
    property name: 'args.css', value: 'dita-ot-doc.css'
}

Solution: Use ditaProperties.put() Directly

The v2.3.0 plugin exposes a ditaProperties MapProperty that must be used directly:

// ✅ WORKS in v2.3.0 - Properties are correctly applied
ditaProperties.put('args.copycss', 'yes')
ditaProperties.put('args.css', 'dita-ot-doc.css')
ditaProperties.put('args.csspath', 'css')
ditaProperties.put('args.cssroot', "${projectDirPath}/resources/")

Updated Task Examples for v2.3.0

html task:

task html(type: DitaOtTask, dependsOn: autoGenerate) {
    ditaOt file(findProperty('ditaHome') ?: ditaHome)
    input "${projectDirPath}/userguide.ditamap"
    output outputDir
    transtype 'html5'
    filter "${projectDirPath}/resources/html.ditaval"

    // Use ditaProperties MapProperty directly for v2.3.0 compatibility
    ditaProperties.put('args.copycss', 'yes')
    ditaProperties.put('args.css', 'dita-ot-doc.css')
    ditaProperties.put('args.csspath', 'css')
    ditaProperties.put('args.cssroot', "${projectDirPath}/resources/")
    ditaProperties.put('args.gen.task.lbl', 'YES')
    ditaProperties.put('args.hdr', "${projectDirPath}/resources/header.xml")
    ditaProperties.put('args.rellinks', 'noparent')
    ditaProperties.put('html5.toc.generate', 'no')
    ditaProperties.put('nav-toc', 'partial')
}

pdf task:

task pdf(type: DitaOtTask, dependsOn: autoGenerate) {
    ditaOt file(findProperty('ditaHome') ?: ditaHome)
    input "${projectDirPath}/userguide-book.ditamap"
    output outputDir
    transtype 'pdf'
    filter "${projectDirPath}/resources/pdf.ditaval"

    // Use ditaProperties MapProperty directly for v2.3.0 compatibility
    ditaProperties.put('args.chapter.layout', 'BASIC')
    ditaProperties.put('args.gen.task.lbl', 'YES')
    ditaProperties.put('include.rellinks', '#default external')
    ditaProperties.put('outputFile.base', 'userguide')
    ditaProperties.put('theme', "${projectDirPath}/samples/themes/dita-ot-docs-theme.yaml")
}

site task (with conditional property):

task site(type: DitaOtTask) {
    ditaOt file(findProperty('ditaHome') ?: ditaHome)
    // ...

    def includeCommitMeta = !providers.gradleProperty('noCommitMeta')
        .map { Boolean.parseBoolean(it) }.getOrElse(false)

    // Use ditaProperties MapProperty directly for v2.3.0 compatibility
    ditaProperties.put('args.gen.task.lbl', 'YES')
    ditaProperties.put('args.rellinks', 'noparent')
    if (includeCommitMeta) {
        ditaProperties.put('commit', gitCommitHash)
    }
}

Verification

After applying the fix, the build correctly applies all properties:

$ ./gradlew -PditaHome='C:\dita-ot\dita-ot-4.3.5' html

> Task :html
Starting DITA-OT transformation
Status:           SUCCESS
Output size:      5.02 MB
Duration:         69.65s

BUILD SUCCESSFUL in 1m 12s

CSS verification:

$ ls out/css/
commonltr.css
commonrtl.css
dita-ot-doc.css    ← Custom CSS correctly copied!

[jyjeanne]

I will update plugin documentation about this bug and add workaround . I also add new test case to prevent this bug.

I wanted to thank you for your assistance in identifying and resolving the recent issue. Your insights were valuable in addressing the bug efficiently

Best regards

[infotexture]

@jyjeanne Thanks for your persistence here, it works with the ditaProperties.put() syntax.

I'll switch the status of this PR to Ready for review, run a few more tests, and discuss with the team before merging, but looks like this could work well for our purposes. 🙏

[jyjeanne]

hi, i also make a bug fix into version 2.3.1 to allow user to use two groovy syntax :

• ditaProperties.put()

OR

• properties {
  property name: 'args.copycss', value: 'yes'
  property name: 'args.css', value: 'dita-ot-doc.css'
  }

Best regards