/docbook-reference-plugin

Primary LanguageXSLT

DocBook Plugin for Gradle

Small plugin used internally by the Spring Team to create documentation from docbook sources.

Configuration

See tags to determine the latest available version. Then configure the plugin in your project as follows, using spring-framework/build.gradle as an example:

buildscript {
    repositories {
        maven { url 'http://repo.springsource.org/plugins-release' }
    }
    dependencies {
        classpath 'io.spring.gradle:docbook-reference-plugin:0.3.0'
    }
}

// ...

configure(rootproject) {
    apply plugin: 'docbook-reference'

    reference {
        sourceDir = file('src/reference/docbook')
        pdfFilename = 'spring-framework-reference.pdf'

        // optionally

        // configure fop for pdf generation
        fopUserConfig = file('src/reference/fop/fop-userconfig.xml')

        // Configure which files have ${} expanded
        expandPlaceholders = '**/index.xml, **/other.xml'
    }

    task docsZip(type: Zip) {
        group = 'Distribution'
        baseName = 'spring-framework'
        classifier = 'docs'

        // ...

        from (reference) {
            into 'reference'
        }
    }

    // ...

    artifacts {
        archives docsZip
    }
}

See contents of the spring-framework/src/reference/docbook for details.

Usage

$ gradle referenceHtmlMulti
$ gradle referenceHtmlSingle
$ gradle referencePdf
$ gradle referenceEpub
$ gradle reference  # all of the above
$ gradle build      # depends on `reference` because of "artifacts" arrangement

Output

$ open build/reference/html/index.html
$ open build/reference/htmlsingle/index.html
$ open build/reference/pdf/spring-framework-reference.pdf
$ open build/reference/epub/spring-framework-reference.epub

Maintenance

See How to release the docbook reference plugin wiki page.