tex-gradle-plugin's Introduction

📄 tex-gradle-plugin^α

Gradle plugin for building TeX/LaTeX projects.

Gradle Dependency

The plugin is available from the Gradle plugin portal.
Add this in your build.gradle.kts or build.gradle file:

Kotlin

plugins {
  id("dev.reimer.tex") version "<version>"
}

Groovy

plugins {
  id "dev.reimer.tex" version "<version>"
}

Usage

Configuring builds

Build TeX files by registering tasks:

Kotlin

tasks.register<TexCompile>("buildTexFile") {
    source("sample.tex")
}

Groovy

task buildTexFile(type: TexCompile) {
    source("sample.tex")
}

(You may need to import TexCompile)

This configuration autodetects if a sample.bib is present, and builds the resulting sample.pdf. Compiled PDFs are stored in the out/ directory under the project root. Setting the destinationDir property overwrites the default output directory.

You can register as many tex compile tasks as you like. Alternatively, reference a directory, file tree or more, using the source() task configuration.

And don't worry about a messy out/ directory, as the folder structure will be preserved.

Options

Global options can be specified directly in the tex block.

Kotlin

tex {
    quiet.set(true)
    overwrite.set(true)
    texCompiler.set(TexCompilerType.PDFLATEX)
    bibliographyCompiler.set(BibliographyCompilerType.BIBTEX)
    imageConverter.set(ImageConverterType.INKSCAPE_PDF)
}

Groovy

tex {
    quiet = true
    overwrite = true
    texCompiler = TexCompilerType.PDFLATEX
    bibliographyCompiler = BibliographyCompilerType.BIBTEX
    imageConverter = ImageConverterType.INKSCAPE_PDF
}

All options can also be applied to each task individually.

Building multiple projects in order

Task dependencies (dependsOn) can be used to specify dependencies among TeX tasks. In the following example, project1.tex and project2.tex can get built in parallel, while project3.tex build can start only after both the former completed successfully.

Kotlin

tasks.register<TexCompile>("buildTexProject1") {
    source("project1/")
}
tasks.register<TexCompile>("buildTexProject2") {
    source("project2/")
}
tasks.register<TexCompile>("buildTexProject3") {
    source("project3/")
    dependsOn("buildTexProject1", "buildTexProject2")
}

Groovy

task buildTexProject1(type: TexCompile) {
    source("project1/")
}
task buildTexProject2(type: TexCompile) {
    source("project2/")
}
task buildTexProject3(type: TexCompile) {
    source("project3/")
    dependsOn buildTexProject1, buildTexProject2
}

Development

When building and testing this library, make sure to clone the submodules. Those are TeX projects, used for integration tests.

Thanks

I am grateful to @DanySK for his work on the forked library, which was licensed under the Apache License 2.0.

Status α

⚠️ Warning: This project is in an experimental alpha stage:

The API may be changed at any time without further notice.
Development still happens on master.
Pull Requests are highly appreciated!

tex-gradle-plugin's People

Contributors

Stargazers

Watchers

tex-gradle-plugin's Issues

Build using Latexmk

Is your feature request related to a problem? Please describe.

Running the basic TeX commands manually is prone to errors. Latexmk was developed as dedicated build tool for TeX, and is included in every TeX distribution.

Describe the solution you'd like

Instead of running commands manually, we could instead copy sources to a temporary build directory, add a latexmkrc RC file including commands and configuration, and then run the latexmk command there.
Alternatively, we can pass the plugin's RC file via specifying the -r option on the command line.

Describe alternatives you've considered

Continue running TeX and bibliography compilation commands manually, as we did before.

Additional context

We have to be aware of Latexmk's search paths for latexmkrc, if we want to merge user's configuration corrrectly. The -r option seems to be a better fit, as it simply overrides any configuration in the default search paths. User's options would not be ignored, unless we specifically overwrite it in the file passed with -r.

Mark \input sources as task inputs

Currently, only the directly referenced .tex file is marked as source input.
We should be able to resolve \input or \include references and mark the included sources as task inputs too,
so that the task is no longer UP-TO-DATE, when those change.

Continuous build

Is your feature request related to a problem? Please describe.

When writing LaTeX, watching for changes and recompiling would be a huge benefit.
Typographic and compilation errors would be noticed earlier, improving the source quality.

Describe the solution you'd like

Implement Gradle's continuous build feature, by watching for changes of TeX sources.

Describe alternatives you've considered

Latexmk has a built in continuous mode. See its -pvc flag.

Additional context

For continuous builds, finding file dependencies in LaTeX documents (like in #1) is important.

Recommend Projects

janheinrichmerker / tex-gradle-plugin Goto Github PK

tex-gradle-plugin's Introduction

📄 tex-gradle-pluginα

Gradle Dependency

Usage

Configuring builds

Options

Building multiple projects in order

Development

Thanks

Status α

tex-gradle-plugin's People

Contributors

Stargazers

Watchers

tex-gradle-plugin's Issues

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Recommend Projects

Recommend Topics

Recommend Org

📄 tex-gradle-plugin^α