latex:inj

Full name:

eu.simuline.m2latex:latex-maven-plugin:2.1-SNAPSHOT:inj

Description:

Creates rc file .latexmkrc for latexmk and .chktexrc for chktex and further files for various use cases. The goal is tied to the lifecycle phase validate by default.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
<injections> Set<Injection> - Indicates the files injected by the goal inj. This is a comma separated list of eu.simuline.m2latex.core.Injections without blanks. The injections are in one of three categories: representing
  • configuration files:
    • latexmkrc represents the config file .latexmkrc of latexmk
    • chktexrc represents the config file .chktexrc of chktex
  • header files to be input into TEX files:
    • header represents the file header.tex which is intended to be included in any latex main file.
    • headerGrp represents the file headerGrp.tex which shall be included in latex main files using the graphicx pacakge.
    • headerSuppressMetaPDF represents the file headerSuppressMetaPDF.tex which serves to suppress meta info of a latex main file which may be considered a safety risk.
  • script files:
    • vscodeExt represents the file instVScode4tex.sh installing all extensions on VS Code recommended for development of latex documents.
    • ntlatex represents the file ntlatex performing latex compilation with epoch time 0.
    • pythontexW represents the file pythontexW which essentially invokes pythontex and redirects output to a log file
    • vmdiff represents the file vmdiff which performs a diff based on the visual diff diff-pdf-visually and on the diff on meta-data given by pdfinfo.

The default value is latexmkrc,chktexrc.


Default: latexmkrc,chktexrc
User Property: latex.injections
<settings> Settings - Comprises all parameters for executing this maven plugin. If not set in the pom prior to execution, is set in initialize().
<targetSiteDirectory> File - The target site directory of this maven project. Reinitializes eu.simuline.m2latex.core.Settings.baseDirectory via initialize().
Default: ${project.reporting.outputDirectory}

Parameter Details

<injections>

Indicates the files injected by the goal inj. This is a comma separated list of eu.simuline.m2latex.core.Injections without blanks. The injections are in one of three categories: representing
  • configuration files:
    • latexmkrc represents the config file .latexmkrc of latexmk
    • chktexrc represents the config file .chktexrc of chktex
  • header files to be input into TEX files:
    • header represents the file header.tex which is intended to be included in any latex main file.
    • headerGrp represents the file headerGrp.tex which shall be included in latex main files using the graphicx pacakge.
    • headerSuppressMetaPDF represents the file headerSuppressMetaPDF.tex which serves to suppress meta info of a latex main file which may be considered a safety risk.
  • script files:
    • vscodeExt represents the file instVScode4tex.sh installing all extensions on VS Code recommended for development of latex documents.
    • ntlatex represents the file ntlatex performing latex compilation with epoch time 0.
    • pythontexW represents the file pythontexW which essentially invokes pythontex and redirects output to a log file
    • vmdiff represents the file vmdiff which performs a diff based on the visual diff diff-pdf-visually and on the diff on meta-data given by pdfinfo.

The default value is latexmkrc,chktexrc.

  • Type: java.util.Set<eu.simuline.m2latex.core.Injection>
  • Required: No
  • User Property: latex.injections
  • Default: latexmkrc,chktexrc

<settings>

Comprises all parameters for executing this maven plugin. If not set in the pom prior to execution, is set in initialize().
  • Type: eu.simuline.m2latex.core.Settings
  • Required: No

<targetSiteDirectory>

The target site directory of this maven project. Reinitializes eu.simuline.m2latex.core.Settings.baseDirectory via initialize().
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}