com.github.csabasulyok.gradlelatex.LatexArtifact.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-latex Show documentation

This Gradle plugin allows automation of compiling PDFs using LaTeX and BiBTeX.

The newest version!

package com.github.csabasulyok.gradlelatex

import org.gradle.api.file.FileCollection

/**
 * Represents a TeX artifact which will can be compiled into a PDF.
 * Used to maintain a graph of dependencies.
 * 
 * @author csabasulyok
 */
class LatexArtifact {
  
  /**
   * Name of artifact - derived from the name of the input TeX file,
   * without its extension.
   * 
   * Must be unique per project, and multiple Gradle tasks are created
   * dynamically based on its value.
   */
  String name
  
  /**
   * Represents tex file which is used to call bibtex, pdflatex
   * Must be set.
   */
  File tex
  
  /**
   * Represents bib file used to call bibtex.
   */
  File bib
  
  /**
   * Represents output pdf file.
   */
  File pdf
  
  /**
   * Collection of dependencies which have to be compiled
   * in order for this one to work (e.g. used with \input). 
   */
  Collection dependsOn
  
  /**
   * Collection of image files or directories with images
   * which have to be transformed because LaTeX cannot use them directly (e.g. svg, emf).
   * These are transformed to PDFs which then can be included in pdflatex. 
   */
  FileCollection img
  
  /**
   * Collection of dependencies which do not have to be compiled
   * for this one. Not taken into consideration at all during compilation,
   * but added to set of input files, so that up-to-date checks and continuous build
   * are triggered when they change.
   */
  FileCollection aux
  
  /**
   * Extra arguments to be passed to pdflatex when building this artifact.
   */
  String extraArgs
}