Package eu.simuline.m2latex.core

Class Settings

  • public class Settings
extends Object
    The settings for a maven plugin and for an ant task. These are the elements of the maven pom in element settings and accordingly for the ant build file.

    • Field Detail

      • SST

        static final String SST
        On unix src/site/tex, on other operating systems accordingly.

      • texSrcDirectory

        @Parameter(name="texSrcDirectory",
           defaultValue="src${file.separator}site${file.separator}tex")
private String texSrcDirectory
        The latex source directory as a string relative to baseDirectory, containing texSrcProcDirectory. This directory determines also the subdirectory of outputDirectory to lay down the generated artifacts. The according file is given by texSrcDirectoryFile. The default value is SST.

      • texSrcProcDirectory

        @Parameter(name="texSrcProcDirectory",
           defaultValue=".")
private String texSrcProcDirectory
        The latex source processing directory as a string relative to texSrcDirectory containing all tex main documents and the graphic files to be processed and also to be cleaned. Whether this is done recursively in subfolders is specified by readTexSrcProcDirRec. The according file is given by texSrcProcDirectoryFile. The default value is ., i.e. the latex souce processing directory is the latex source directory.

      • readTexSrcProcDirRec

        @Parameter(name="readTexSrcProcDirRec",
           defaultValue="true")
private boolean readTexSrcProcDirRec
        Whether the tex source directory texSrcProcDirectory shall be read recursively, i.e. including the subdirectories recursively. This is set to false only during information development. The default value is true.

      • targets

        @Parameter(name="targets",
           defaultValue="pdf, html")
private String targets
        A comma separated list of targets returned as a set by getTargetSet(). For allowed values see Target. The default value is pdf, html.

      • patternLatexMainFile

        @Parameter(name="patternLatexMainFile")
private String patternLatexMainFile
        The pattern to be applied to the beginning of the contents of tex-files which identifies a latex main file. The default value is choosen to match quite exactly the latex main files. Here we assume that the latex main file should contain the declaration `\documentclass' or the old fashioned `documentstyle' preceeded by a few constucts. Strictly speaking, this is not necessary. For a more thorough discussion, and for an alternative approach, consult the manual.

        The default value is choosen to match quite exactly the latex main files, no more no less. Since the pattern is chosen according to documentation collected from the internet, one can never be sure whether the pattern is perfect.

        If the current default value is not appropriate, please overwrite it in the configuration and notify the developer of this plugin of the deficiency.

      • texPath

        @Parameter(name="texPath")
private File texPath
        Path to the TeX scripts or null. In the latter case, the scripts must be on the system path. Note that in the pom, <texPath/> and even <texPath> </texPath> represent the null-File. The default value is null.

      • cleanUp

        @Parameter(name="cleanUp",
           defaultValue="true")
private boolean cleanUp
        Clean up the working directory in the end? May be used for debugging when setting to false. The default value is true.

      • patternCreatedFromLatexMain

        @Parameter(name="patternCreatedFromLatexMain")
private String patternCreatedFromLatexMain
        This pattern is applied to file names and matching shall accept all the files which were created from a latex main file xxx.tex. It is neither applied to directories nor to xxx.tex itself. It shall not comprise neither graphic files to be processed nor files created from those graphic files.

        This pattern is applied in the course of processing graphic files to decide which graphic files should be processed (those rejected by this pattern) and to log warnings if there is a risk, that graphic files to be processed are skipped or that processing a latex main file overwrites the result of graphic preprocessing.

        When clearing the tex source directory texSrcProcDirectory, i.e. all generated files should be removed, first those created from latex main files. As an approximation, those are removed which match this pattern.

        The sequence T$T is replaced by the prefix xxx. The sequence T$T must always be replaced: The symbol $ occurs as end-sign as )$ or as literal symbol as \$. Thus T$T is no regular occurrence and must always be replaced with xxx.

        Spaces and newlines are removed from that pattern before matching.

        This pattern may never be ensured to be complete, because any package may create files with names matching its own patterns and so any new package may break completeness.

        If the current default value is not appropriate, please overwrite it in the configuration and notify the developer of this plugin of the deficiency. The default value is given below.

      • fig2devCommand

        @Parameter(name="fig2devCommand",
           defaultValue="fig2dev")
private String fig2devCommand
        The fig2dev command for conversion of fig-files into various formats. Currently only pdf combined with pdf_t is supported. Note that preprocessing one fig-file requires two invocations of fig2devCommand, one for each part. The default value is fig2dev.
        See Also:
        fig2devGenOptions, fig2devPtxOptions, fig2devPdfEpsOptions

      • fig2devGenOptions

        @Parameter(name="fig2devGenOptions",
           defaultValue="")
private String fig2devGenOptions
        The options for the command fig2devCommand common to both output languages. For the options specific for the two output langugages pdftex and pdftex_t, see fig2devPtxOptions and fig2devPdfEpsOptions, respectively. The default value is the empty string.

        Possible are the following options:

        • -D +/-rangelist Export layers selectively (+) or exclude layers from export (-). E.g. -D +10,40,55:70,80 means keep only layers 10, 40, 55 through 70, and 80.
        • -j i18n (internationalization feature)
        • -m mag Set the magnification at which the figure is rendered to mag. The default is 1.0. This is not usable within latex; not even 1.0.
        • -s fsize Set the default font size (in points) for text objects to fsize. Refers to the latex-fonts only.
        • -b width specify width of blank border around figure (1/72 inch).
        Except for the option -j, all these options take parameters and it may make sense to use them with different parameters for the two output languages. In this case include them in fig2devPtxOptions and in fig2devPdfEpsOptions.

      • fig2devPtxOptions

        @Parameter(name="fig2devPtxOptions",
           defaultValue="")
private String fig2devPtxOptions
        The options for the command fig2devCommand specific for the output languages pdftex_t and pstex_t which are the same. Note that in addition to these options, the option -L pdftex_t specifies the language, fig2devGenOptions specifies the options common for the two output langugages pdftex and pdftex_t and -p xxx specifies the full path of the pdf/eps-file to be included without extension.

        The default value for this option is the empty string.

        Possible options are the following: (These seem to work for tex only although according to documentation for all languages. )

        • options specified for fig2devGenOptions
        • -E num Set encoding for latex text translation (0 no translation, 1 ISO-8859-1, 2 ISO-8859-2), others allowed also, effect not clear.
        • -F don't set font family/series/shape, so you can set it from latex.
        • -v Verbose mode.

      • fig2devPdfEpsOptions

        @Parameter(name="fig2devPdfEpsOptions",
           defaultValue="")
private String fig2devPdfEpsOptions
        The options for the command fig2devCommand specific for the output language pdftex. Note that in addition to these options, the option -L pdftex specifies the language and fig2devGenOptions specifies the options common for the two output langugages pdftex and pdftex_t. The default value for this option is the empty string.

        Possible options are the following: (These seem to work specifically for pdf although according to documentation for all languages. )

        • options specified for fig2devGenOptions
        • -G minor[:major][unit] Draws a grid on the page. e.g. "-G .25:1cm" draws a thin line every .25 cm and a thicker line every 1 cm. Default unit is in. Allowable units are: i, in, inch, f, ft, feet, c, cm, mm, and m.
        • -A Add an ASCII (EPSI) preview.
        • -c centers the figure on the page. (default) seems not to have an effect...
        • -e puts the figure against the edge (not centered) of the page. seems not to have an effect...
        • -F Use correct font sizes (points) instead of the traditional size
        • -g color Use color for the background. FIXME: Not clear how to specify the color.
        • -N Convert all colors to grayscale. (not available for latex fonts)
        • -n name Set the /Title(xxx) of the PostScript output to name. without it is just the filename xxx.fig.

      • gnuplotCommand

        @Parameter(name="gnuplotCommand",
           defaultValue="gnuplot")
private String gnuplotCommand
        The command for conversion of gnuplot-files into various formats. Currently only pdf (graphics) combined with pdf_t (latex-texts) is supported. The default value is gnuplot.

      • gnuplotOptions

        @Parameter(name="gnuplotOptions",
           defaultValue="")
private String gnuplotOptions
        The options specific for gnuplotCommand's output terminal cairolatex, used for mixed latex/pdf-creation.

        Possible values are:

        • {standalone | input}
        • {blacktext | colortext | colourtext} Specifies whether for text colors are taken into account or not. For all but text see separate options.
        • {header
          | noheader}
        • {mono|color} Specifies whether colors are taken into account or not. Refers to all but text (for text see separate options)
        • {{no}transparent} {{no}crop} {background }
        • {font }
        • {fontscale }
        • {linewidth } {rounded|butt|square} {dashlength
          }
        • {size {unit},{unit}} The size of this picture. This is not usable, because it imposes deformation. Default unit is inch (in).
        Note that the option pdf|eps of the terminal cairolatex is not available, because it is set internally. The default option string is empty.

      • metapostCommand

        @Parameter(name="metapostCommand",
           defaultValue="mpost")
private String metapostCommand
        The command for conversion of gnuplot-files into metapost's postscript. The default value is mpost.

      • metapostOptions

        @Parameter(name="metapostOptions",
           defaultValue="-interaction=nonstopmode -recorder -s prologues=2")
private String metapostOptions
        The options for the command metapostCommand. Leading and trailing blanks are ignored. A sequence of at least one blank separate the proper options. The default value comprises the following options:
        • -interaction=nonstopmode prevents metapost from stopping at the first error.
        • -recorder makes metapost create an fls-file specifying all inputted files.
        • -s prologues=2 makes metapost create a postscript file which is viewable by ghostscript viewer.
        -debug creates intermediate files mp3mnuvD.dvi and mp3mnuvD.tex No info available about the details.

      • svg2devCommand

        @Parameter(name="svg2devCommand",
           defaultValue="inkscape")
private String svg2devCommand
        The command for conversion of svg-files into a mixed format FIXME, synchronize with fig2devCommand. The default value is inkscape.

      • svg2devOptions

        @Parameter(name="svg2devOptions",
           defaultValue="-z -D --export-latex")
private String svg2devOptions
        The options for the command svg2devCommand for exporting svg-figures into latex compatible files.

        The following options are mandatory:

        • -z or --without-gui process files from console.
        • -D or --export-area-drawing Export the drawing (not the page)
        • --export-latex Export PDF/PS/EPS without text. Besides the PDF/PS/EPS, a LaTeX file is exported, putting the text on top of the PDF/PS/EPS file. Include the result in LaTeX like: \input{latexfile.tex}. Note that the latter option is necessary, to create the expected files. It is also conceivable to export text as pdf/eps

        The following options are prohibited, because they are automatically added by the software:

        • -A=FILENAME or --export-pdf=FILENAME Export document to a PDF file.
        • -E=FILENAME or --export-eps=FILENAME Export document to an EPS file.
            The default value is the minimal value, -z -D --export-latex.

      • ebbCommand

        @Parameter(name="ebbCommand",
           defaultValue="ebb")
private String ebbCommand
        The command to create bounding box information from jpg-files and from png-files. This is run twice: once with parameter -m to create .bb-files for driver dvipdfm and once with parameter -x to create .xbb-files for driver dvipdfmx. The default value is ebb.

      • ebbOptions

        @Parameter(name="ebbOptions",
           defaultValue="-v")
private String ebbOptions
        The options for the command ebbCommand except -m and -x which are added automatically. The default value is -v.

      • latex2pdfCommand

        @Parameter(name="latex2pdfCommand",
           defaultValue="pdflatex")
private String latex2pdfCommand
        The LaTeX command to create a pdf-file or a dvi-file. FIXME: documentation must be updated. Possible values are e.g. pdflatex, lualatex and xelatex. The default value (for which this software is also tested) is pdflatex.

      • latex2pdfOptions

        @Parameter(name="latex2pdfOptions",
           defaultValue="-interaction=nonstopmode -synctex=1 -src-specials -recorder -shell-escape")
private String latex2pdfOptions
        The options for the command latex2pdfCommand. Leading and trailing blanks are ignored. The setter method setLatex2pdfOptions(String) ensures, that exactly one blank separate the proper options.

        The default value comprises the following options:

        • -interaction=nonstopmode prevents latex from stopping at the first error.
        • -synctex=1 makes latex create a pdf file which synchronizes with an editor supporting synchtex.
        • -src-specials includes source specials into the output. dvi only?
        • -recorder makes latex create an fls-file specifying all inputted files.
        • -shell-escape allows to use write18-mechanism for shell commands (why needed?)

      • patternErrLatex

        @Parameter(name="patternErrLatex",
           defaultValue="(^! )")
private String patternErrLatex
        The pattern is applied linewise to the log-file and matching indicates an error emitted by the command latex2pdfCommand.

        The default value is choosen to match quite exactly the latex errors in the log file, no more no less. Since no official documentation was found, the default pattern may be incomplete. In fact it presupposes, that $latex2pdfOptions does not contain `-file-line-error-style'.

        If the current default value is not appropriate, please overwrite it in the configuration and notify the developer of this plugin of the deficiency. The default value is `(^! )' (note the space).

      • patternWarnLatex

        @Parameter(name="patternWarnLatex",
           defaultValue="^(LaTeX Warning: |LaTeX Font Warning: |(Package|Class) .+ Warning: |pdfTeX warning( \\((\\d|\\w)+\\))?: |\\* fontspec warning: |Missing character: There is no .* in font .*!$|A space is missing\\. (No warning)\\.)")
private String patternWarnLatex
        The pattern is applied linewise to the log-file and matching indicates a warning emitted by the command latex2pdfCommand, disragarding warnings on bad boxes provided debugWarnings is set.

        This pattern may never be ensured to be complete, because any package may indicate a warning with its own pattern any new package may break completeness. Nevertheless, the default value aims completeness while be restrictive enough not to indicate a warning where none was emitted.

        If the current default value is not appropriate, please overwrite it in the configuration and notify the developer of this plugin of the deficiency. The default value is given below.

        See Also:
        debugBadBoxes

      • debugBadBoxes

        @Parameter(name="debugBadBoxes",
           defaultValue="true")
private boolean debugBadBoxes
        Whether debugging of overfull/underfull hboxes/vboxes is on: If so, a bad box occurs in the last LaTeX run, a warning is displayed. For details, set $cleanUp to false, rerun LaTeX and have a look at the log-file. The default value is true.

      • debugWarnings

        @Parameter(name="debugWarnings",
           defaultValue="true")
private boolean debugWarnings
        Whether debugging of warnings is on: If so, a warning in the last LaTeX run is displayed. For details, set $cleanUp to false, rerun LaTeX and have a look at the log-file. The default value is true.

      • pdfViaDvi

        @Parameter(name="pdfViaDvi",
           defaultValue="false")
private boolean pdfViaDvi
        Whether creation of pdf-files from latex-files goes via dvi-files.

        If pdfViaDvi is set and the latex processor needs repetitions, these are all done creating dvi and then pdf is created in a final step invoking the command dvi2pdfCommand. If pdfViaDvi is not set, latex is directly converted into pdf.

        Currently, not only conversion of latex-files is affected, but also conversion of graphic files into graphic formats which allow inclusion in the tex-file. If it goes via latex, then the formats are more based on (encapsulated) postscript; else on pdf.

        Of course, the target dvi is not affected: This uses always the dvi-format. What is also affected are the tasks creating html, odt or docs: Although these are based on htlatex which is always dvi-based, the preprocessing is done in dvi or in pdf. Also the task txt is affected.

        The default value is false.

      • dvi2pdfCommand

        @Parameter(name="dvi2pdfCommand",
           defaultValue="dvipdfmx")
private String dvi2pdfCommand
        The driver to convert dvi into pdf-files. Note that this must fit the options of the packages xcolor and graphicx. Sensible values are dvipdf, dvipdfm, dvipdfmx, and dvipdft (which is dvipdfm with option -t). The default value is dvipdfmx.

      • dvi2pdfOptions

        @Parameter(name="dvi2pdfOptions",
           defaultValue="")
private String dvi2pdfOptions
        The options for the command dvi2pdfCommand. The default value is the empty string.

      • patternReRunLatex

        @Parameter(name="patternReRunLatex",
           defaultValue="^(LaTeX Warning: Label\\(s\\) may have changed\\. Rerun to get cross-references right\\.$|Package \\w+ Warning: .*Rerun( .*|\\.)$|Package \\w+ Warning: .*$^\\(\\w+\\) .*Rerun .*$|LaTeX Warning: Etaremune labels have changed\\.$|\\(rerunfilecheck\\)                Rerun to get outlines right$)")
private String patternReRunLatex
        The pattern is applied linewise to the log-file and matching triggers rerunning latex2pdfCommand if maxNumReRunsLatex is not yet reached to ensure termination.

        This pattern may never be ensured to be complete, because any package may indicate the need to rerun latex2pdfCommand with its own pattern any new package may break completeness. Nevertheless, the default value aims completeness while be tight enough not to trigger a superfluous rerun.

        If the current default value is not appropriate, please overwrite it in the configuration and notify the developer of this plugin of the deficiency. The default value is given below.

      • maxNumReRunsLatex

        @Parameter(name="maxNumReRunsLatex",
           defaultValue="5")
private int maxNumReRunsLatex
        The maximal allowed number of reruns of latex2pdfCommand. This is to avoid endless repetitions. The default value is 5. This shall be non-negative or -1 which signifies that there is no threshold.

      • bibtexCommand

        @Parameter(name="bibtexCommand",
           defaultValue="bibtex")
private String bibtexCommand
        The BibTeX command to create a bbl-file from an aux-file and a bib-file (using a bst-style file). The default value is bibtex.

      • bibtexOptions

        @Parameter(name="bibtexOptions",
           defaultValue="")
private String bibtexOptions
        The options for the command bibtexCommand. The default value is the empty string.

      • patternErrBibtex

        @Parameter(name="patternErrBibtex",
           defaultValue="error message")
private String patternErrBibtex
        The Pattern in the blg-file indicating that bibtexCommand failed. The default value is chosen according to the bibtex documentation.

      • patternWarnBibtex

        @Parameter(name="patternWarnBibtex",
           defaultValue="^Warning--")
private String patternWarnBibtex
        The Pattern in the blg-file indicating a warning bibtexCommand emitted. The default value is chosen according to the bibtex documentation.

      • makeIndexCommand

        @Parameter(name="makeIndexCommand",
           defaultValue="makeindex")
private String makeIndexCommand
        The MakeIndex command to create an ind-file from an idx-file logging on an ilg-file. The default value is makeindex.

      • makeIndexOptions

        @Parameter(name="makeIndexOptions",
           defaultValue="")
private String makeIndexOptions
        The options for the command makeIndexCommand. Note that the option -o xxx.ind to specify the output file is not allowed because this plugin expects the output for the latex main file xxx.tex xxx.ind. Likewise, the option -t xxx.ilg to specify the logging file is not allowed, because this software uses the standard logging file to detect failures processing the idx-file. Also the option -i which specifies reading the raw index from standard input is not allowed. Specifying a style file with option -s yyy.ist is possible if only an index is used but no glossary. FIXME: rethink what about multiple indices.

        Note that the options specified here are also used to create glossaries. In addition for glossaries, the options -s, -o and -t are used. Thus also these options should not be used. The default value is the empty string. Useful options in this context are

        • -c remove blanks from index entries
        • -g german ordering
        • -l letter ordering
        • -r without collecting index entries on 3 or more successive pages.

      • patternErrMakeIndex

        @Parameter(name="patternErrMakeIndex",
           defaultValue="(!! Input index error )")
private String patternErrMakeIndex
        The Pattern in the ilg-file indicating that makeIndexCommand failed. The default value (!! Input index error ) is chosen according to the makeindex documentation.

      • patternWarnMakeIndex

        @Parameter(name="patternWarnMakeIndex",
           defaultValue="(## Warning )")
private String patternWarnMakeIndex
        The Pattern in the ilg-file indicating a warning makeIndexCommand emitted. The default value (## Warning ) is chosen according to the makeindex documentation.

      • patternReRunMakeIndex

        @Parameter(name="patternReRunMakeIndex",
           defaultValue="^\\(rerunfilecheck\\) +Rerun LaTeX/makeindex to get index right\\.$")
private String patternReRunMakeIndex
        The pattern in the log-file which triggers rerunning makeIndexCommand followed by latex2pdfCommand. This pattern only occurs, if package rerunfilecheck is used with option index. The default value is chosen according to the package documentation. If the user finds that default value is not appropriate, (s)he is asked to contribute and to notify the developer of this plugin.

      • splitIndexCommand

        @Parameter(name="splitIndexCommand",
           defaultValue="splitindex")
private String splitIndexCommand
        The SplitIndex command to create ind-files from an idx-file logging on ilg-files. This command invokes makeIndexCommand. The default value is splitindex.

      • splitIndexOptions

        @Parameter(name="splitIndexOptions",
           defaultValue="-V")
private String splitIndexOptions
        The options for splitIndexCommand. Here, one has to distinguish between the options processed by splitIndexCommand and those passed to makeIndexCommand. The second category cannot be specified here, it is already given by makeIndexOptions. In the first category is the option -m to specify the makeIndexCommand. This is used automatically and cannot be specified here. Since splitIndexCommand is used in conjunction with package splitidx, which hardcodes various parameters which are the default values for splitIndexCommand and because the option may not alter certain interfaces, the only option which may be given explicitly is -V, the short cut for --verbose. Do not use --verbose either for sake of portability. The default value is -V; it could also be empty.

      • makeGlossariesCommand

        @Parameter(name="makeGlossariesCommand",
           defaultValue="makeglossaries")
private String makeGlossariesCommand
        The MakeGlossaries command to create a gls-file from a glo-file (invoked without file ending) also taking ist-file or xdy-file into account logging on a glg-file. The default value is makeglossaries.

      • makeGlossariesOptions

        @Parameter(name="makeGlossariesOptions",
           defaultValue="")
private String makeGlossariesOptions
        The options for the command makeGlossariesCommand. These are the options for makeindex (not for makeIndexCommand) and for xindy (also hardcoded). The aux-file decides on whether program is executed and consequently which options are used.

        The default value is the empty option string. Nevertheless, xindy is invoked as xindy -L english -I xindy -M .... With option -L german, this is added. Options -M for xindy -s for makeindex and -t and -o for both, xindy and makeindex.

      • patternErrMakeGlossaries

        @Parameter(name="patternErrMakeGlossaries",
           defaultValue="^\\*\\*\\* unable to execute: ")
private String patternErrMakeGlossaries
        The Pattern in the glg-file indicating that makeGlossariesCommand failed. The default value is (^\*\*\* unable to execute: ). If this is not appropriate, please modify and notify the developer of this plugin.

      • patternErrXindy

        @Parameter(name="patternErrXindy",
           defaultValue="(^ERROR: )")
private String patternErrXindy
        The pattern in the glg-file indicating that running xindy via makeGlossariesCommand failed. The default value is (^ERROR: ) (note the space). If this is not appropriate, please modify and notify the developer of this plugin. FIXME: This is not used.

      • patternWarnXindy

        @Parameter(name="patternWarnXindy",
           defaultValue="(^WARNING: )")
private String patternWarnXindy
        The pattern in the glg-file indicating a warning when running xindy via makeGlossariesCommand. The default value is (^WARNING: ) (note the space and the brackets). If this is not appropriate, please modify and notify the developer of this plugin.

      • patternReRunMakeGlossaries

        @Parameter(name="patternReRunMakeGlossaries",
           defaultValue="^\\(rerunfilecheck\\) +Rerun LaTeX/makeindex to get glossary right\\.$")
private String patternReRunMakeGlossaries
        The pattern in the log-file which triggers rerunning makeGlossariesCommand followed by latex2pdfCommand. This pattern only occurs, if package rerunfilecheck is used with option glossary. The default value is chosen according to the package documentation. If the user finds that default value is not appropriate, (s)he is asked to contribute and to notify the developer of this plugin.

      • tex4htCommand

        @Parameter(name="tex4htCommand",
           defaultValue="htlatex")
private String tex4htCommand
        The tex4ht command. Possible values are e.g. htlatex and htxelatex. The default value (for which this software is also tested) is htlatex.

      • tex4htStyOptions

        @Parameter(name="tex4htStyOptions",
           defaultValue="html,2")
private String tex4htStyOptions
        The options for the tex4ht-style which creates a dvi-file or a pdf-file with information to create sgml, e.g. html or odt or something like that. The default value is html,2.

      • tex4htOptions

        @Parameter(name="tex4htOptions",
           defaultValue="")
private String tex4htOptions
        The options for tex4ht which extracts information from a dvi-file or from a pdf-file into the according lg-file and idv-file producing html-files and by need and if configured accordingly svg-files, 4ct-files and 4tc-files and a css-file and a tmp-file. The former two are used by t4ht which is configured via t4htOptions.

      • t4htOptions

        @Parameter(name="t4htOptions",
           defaultValue="")
private String t4htOptions
        The options for t4ht which converts idv-file and lg-file into css-files, tmp-file and, by need and if configured accordingly into png files. The value -p prevents creation of png-pictures. The default value is the empty string.

      • patternT4htOutputFiles

        @Parameter(name="patternT4htOutputFiles",
           defaultValue="")
private String patternT4htOutputFiles
        The pattern for the target files of goal Target.html for a given latex main file xxx.tex. The patterns for the other targets are hardcoded and take the form ^T$T\.yyy$, where yyy may be an ending or an alternative of endings.

        For an explanation of the pattern T$T, see patternCreatedFromLatexMain. Spaces and newlines are removed from that pattern before processing.

        The default value has the following components:

        • ^T$T\.x?html?$ is the main file.
        • ^T$Tli\d+\.x?html?$ are lists: toc, lof, lot, indices, glossaries, NOT the bibliography.
        • ^T$T(ch|se|su|ap)\d+\.x?html?$ are chapters, sections and subsections or below and appendices.
        • ^T$T\d+\.x?html?$ are footnotes.
        • ^T$T\.css$ are cascaded stylesheets.
        • ^T$T-\d+\.svg$ and ^T$T\d+x\.png$ are svg/png-files representing figures.
        • ^(cmsy)\d+(-c)?-\d+c?\.png$ represents special symbols.
        Note that the patterns for the html-files can be summarized as ^T$T((ch|se|su|ap|li)?\d+)?\.x?html?$. Adding the patterns for the css-file and the svg-files, we obtain 
         ^T$T(((ch|se|su|ap|li)?\d+)?\.x?html?|
 \.css|
 \d+x\.x?bb|
 \d+x\.png|
 -\d+\.svg)$
        .

        The pattern is designed to match quite exactly the files to be copied to targetSiteDirectory, for the goal Target.html, not much more and at any case not less. since tex4htCommand is not well documented, and still subject to development, this pattern cannot be guaranteed to be final. If the user finds an extension, (s)he is asked to contribute and to notify the developer of this plugin. Then the default value will be extended.

      • latex2rtfCommand

        @Parameter(name="latex2rtfCommand",
           defaultValue="latex2rtf")
private String latex2rtfCommand
        The latex2rtf command to create rtf from latex directly. The default value is latex2rtf.

      • latex2rtfOptions

        @Parameter(name="latex2rtfOptions",
           defaultValue="")
private String latex2rtfOptions
        The options of the command latex2rtfCommand. The default value is the empty string.

      • odt2docCommand

        @Parameter(name="odt2docCommand",
           defaultValue="odt2doc")
private String odt2docCommand
        The odt2doc command to create MS word-formats from otd-files. The default value is odt2doc; equivalent here is unoconv. Note that odt2doc just calls unoconv with odt-files as input and doc-file as default output.
        See Also:
        odt2docOptions

      • odt2docOptions

        @Parameter(name="odt2docOptions",
           defaultValue="-fdocx")
private String odt2docOptions
        The options of the command odt2docCommand. Above all specification of output format via the option -f. Invocation is odt2doc -f<format> <file>.odt. All output formats are shown by odt2doc --show but the formats interesting in this context are doc, doc6, doc95,docbook, docx, docx7, ooxml, rtf. Interesting also the verbosity options -v, -vv, -vvv the timeout -T=secs and --preserve to keep permissions and timestamp of the original document. The default value is -fdocx.
        See Also:
        odt2docCommand

      • pdf2txtCommand

        @Parameter(name="pdf2txtCommand",
           defaultValue="pdftotext")
private String pdf2txtCommand
        The pdf2txt-command for converting pdf-files into plain text files. The default value is pdftotext.
        See Also:
        pdf2txtOptions

      • pdf2txtOptions

        @Parameter(name="pdf2txtOptions",
           defaultValue="-q")
private String pdf2txtOptions
        The options of the command pdf2txtCommand. The default value is the empty string.
        See Also:
        pdf2txtCommand

      • chkTexCommand

        @Parameter(name="chkTexCommand",
           defaultValue="chktex")
private String chkTexCommand
        The chktex-command for checking latex main files. The default value is chktex.
        See Also:
        chkTexOptions

      • chkTexOptions

        @Parameter(name="chkTexOptions",
           defaultValue="")
private String chkTexOptions
        The options of the command chkTexCommand, except -o output-file specifying the output file which is added automatically.

        Here is a list of options useful in this context. The first group of these are muting options:

        • -w, -e, -m, Make the message number passed as parameter a warning/an error/a message and turns it on. Messages are not counted.
        • -n Turns the warning/error number passed as a parameter off.
        • -L Turns off suppression of messages on a per line basis.
        The next group of interesting options are for output control:
        • -q Shuts up about copyright information.
        • -o output-file Specifies the output file. This is added automatically and shall thus not be specified by the user.
        • -b[0|1] If you use the -o switch, and the named outputfile exists, it will be renamed to filename.bak.
        • -f format Specifies the format of the output via a format similar to printf(). For details consult the manual.
        • -vd Verbosity level followed by a number d specifying the format of the output. The verbosity number is resolved as a pattern as if given by the option -f format. Thus the option -v is ignored if the option -f format is specified.
        The default value is -q -b0 avoiding verbose output and backing up the output log-file.
        See Also:
        chkTexCommand

    • Constructor Detail

      • Settings

        public Settings()

    • Method Detail

      • getReadTexSrcProcDirRec

        public boolean getReadTexSrcProcDirRec()

      • getPatternLatexMainFile

        public String getPatternLatexMainFile()

      • getTexPath

        public File getTexPath()

      • isCleanUp

        public boolean isCleanUp()

      • getPatternCreatedFromLatexMain

        public String getPatternCreatedFromLatexMain()

      • getFig2devCommand

        public String getFig2devCommand()

      • getFig2devGenOptions

        public String getFig2devGenOptions()

      • getFig2devPtxOptions

        public String getFig2devPtxOptions()

      • getFig2devPdfEpsOptions

        public String getFig2devPdfEpsOptions()

      • getGnuplotCommand

        public String getGnuplotCommand()

      • getGnuplotOptions

        public String getGnuplotOptions()

      • getMetapostCommand

        public String getMetapostCommand()

      • getMetapostOptions

        public String getMetapostOptions()

      • getSvg2devCommand

        public String getSvg2devCommand()

      • getSvg2devOptions

        public String getSvg2devOptions()

      • getEbbCommand

        public String getEbbCommand()

      • getEbbOptions

        public String getEbbOptions()

      • getLatex2pdfCommand

        public String getLatex2pdfCommand()

      • getLatex2pdfOptions

        public String getLatex2pdfOptions()

      • getPatternErrLatex

        public String getPatternErrLatex()

      • getPatternErrMPost

        public String getPatternErrMPost()

      • getPatternWarnLatex

        public String getPatternWarnLatex()

      • getDebugBadBoxes

        public boolean getDebugBadBoxes()

      • getDebugWarnings

        public boolean getDebugWarnings()

      • getPdfViaDvi

        public LatexDev getPdfViaDvi()

      • getDvi2pdfCommand

        public String getDvi2pdfCommand()

      • getDvi2pdfOptions

        public String getDvi2pdfOptions()

      • getPatternReRunLatex

        public String getPatternReRunLatex()

      • getMaxNumReRunsLatex

        public int getMaxNumReRunsLatex()

      • getBibtexCommand

        public String getBibtexCommand()

      • getBibtexOptions

        public String getBibtexOptions()

      • getPatternErrBibtex

        public String getPatternErrBibtex()

      • getPatternWarnBibtex

        public String getPatternWarnBibtex()

      • getMakeIndexCommand

        public String getMakeIndexCommand()

      • getMakeIndexOptions

        public String getMakeIndexOptions()

      • getPatternErrMakeIndex

        public String getPatternErrMakeIndex()

      • getPatternWarnMakeIndex

        public String getPatternWarnMakeIndex()

      • getPatternReRunMakeIndex

        public String getPatternReRunMakeIndex()

      • getSplitIndexCommand

        public String getSplitIndexCommand()

      • getSplitIndexOptions

        public String getSplitIndexOptions()

      • getMakeGlossariesCommand

        public String getMakeGlossariesCommand()

      • getMakeGlossariesOptions

        public String getMakeGlossariesOptions()

      • getPatternErrMakeGlossaries

        public String getPatternErrMakeGlossaries()

      • getPatternWarnXindy

        public String getPatternWarnXindy()

      • getPatternReRunMakeGlossaries

        public String getPatternReRunMakeGlossaries()

      • getTex4htCommand

        public String getTex4htCommand()

      • getTex4htStyOptions

        public String getTex4htStyOptions()

      • getTex4htOptions

        public String getTex4htOptions()

      • getT4htOptions

        public String getT4htOptions()

      • getPatternT4htOutputFiles

        public String getPatternT4htOutputFiles()

      • getLatex2rtfCommand

        public String getLatex2rtfCommand()

      • getLatex2rtfOptions

        public String getLatex2rtfOptions()

      • getOdt2docCommand

        public String getOdt2docCommand()

      • getOdt2docOptions

        public String getOdt2docOptions()

      • getPdf2txtCommand

        public String getPdf2txtCommand()

      • getPdf2txtOptions

        public String getPdf2txtOptions()

      • getChkTexCommand

        public String getChkTexCommand()

      • getChkTexOptions

        public String getChkTexOptions()

      • setTargetDirectory

        public void setTargetDirectory​(File targetDirectory)
        Sets targetDirectory.

      • setReadTexSrcProcDirRec

        public void setReadTexSrcProcDirRec​(boolean readTexSrcDirProcRec)

      • setTargets

        public void setTargets​(String targets)

      • setPatternLatexMainFile

        public void setPatternLatexMainFile​(String patternLatexMainFile)

      • setTexPath

        public void setTexPath​(File texPath)

      • setCleanUp

        public void setCleanUp​(boolean cleanUp)

      • setPatternCreatedFromLatexMain

        public void setPatternCreatedFromLatexMain​(String pattern)

      • setFig2devCommand

        public void setFig2devCommand​(String fig2devCommand)

      • setFig2devGenOptions

        public void setFig2devGenOptions​(String fig2devGenOptions)

      • setFig2devPtxOptions

        public void setFig2devPtxOptions​(String fig2devPtxOptions)

      • setFig2devPdfEpsOptions

        public void setFig2devPdfEpsOptions​(String fig2devPdfEpsOptions)

      • setGnuplotCommand

        public void setGnuplotCommand​(String gnuplotCommand)

      • setGnuplotOptions

        public void setGnuplotOptions​(String gnuplotOptions)

      • setMetapostCommand

        public void setMetapostCommand​(String metapostCommand)

      • setMetapostOptions

        public void setMetapostOptions​(String metapostOptions)

      • setSvg2devCommand

        public void setSvg2devCommand​(String svg2devCommand)

      • setSvg2devOptions

        public void setSvg2devOptions​(String svg2dev)

      • setEbbCommand

        public void setEbbCommand​(String ebbCommand)

      • setEbbOptions

        public void setEbbOptions​(String ebbOptions)

      • setLatex2pdfCommand

        public void setLatex2pdfCommand​(String latex2pdfCommand)

      • setLatex2pdfOptions

        public void setLatex2pdfOptions​(String args)
        Sets the argument string of the latex command given by latex2pdfCommand. It is ensured that latex2pdfOptions consist of proper options separated by a single blank.
        Parameters:
        args - The arguments string to use when calling LaTeX via latex2pdfCommand. Leading and trailing blank and newline are ignored. Proper arguments are separated by blank and newline.

      • setPatternErrLatex

        public void setPatternErrLatex​(String patternErrLatex)

      • setPatternWarnLatex

        public void setPatternWarnLatex​(String patternWarnLatex)

      • setDebugBadBoxes

        public void setDebugBadBoxes​(boolean debugBadBoxes)

      • setDebugWarnings

        public void setDebugWarnings​(boolean debugWarnings)

      • setPdfViaDvi

        public void setPdfViaDvi​(boolean pdfViaDvi)

      • setDvi2pdfCommand

        public void setDvi2pdfCommand​(String dvi2pdfCommand)

      • setDvi2pdfOptions

        public void setDvi2pdfOptions​(String dvi2pdfOptions)

      • setPatternReRunLatex

        public void setPatternReRunLatex​(String pattern)

      • setMaxNumReRunsLatex

        public void setMaxNumReRunsLatex​(int maxNumReRunsLatex)

      • setBibtexCommand

        public void setBibtexCommand​(String bibtexCommand)

      • setBibtexOptions

        public void setBibtexOptions​(String bibtexOptions)

      • setPatternErrBibtex

        public void setPatternErrBibtex​(String patternErrBibtex)

      • setPatternWarnBibtex

        public void setPatternWarnBibtex​(String patternWarnBibtex)

      • setMakeIndexCommand

        public void setMakeIndexCommand​(String makeIndexCommand)

      • setMakeIndexOptions

        public void setMakeIndexOptions​(String makeIndexOptions)

      • setPatternErrMakeIndex

        public void setPatternErrMakeIndex​(String patternErrMakeIndex)

      • setPatternWarnMakeIndex

        public void setPatternWarnMakeIndex​(String patternWarnMakeIndex)

      • setPatternReRunMakeIndex

        public void setPatternReRunMakeIndex​(String pattern)

      • setSplitIndexCommand

        public void setSplitIndexCommand​(String splitIndexCommand)

      • setSplitIndexOptions

        public void setSplitIndexOptions​(String splitIndexOptions)

      • setMakeGlossariesCommand

        public void setMakeGlossariesCommand​(String makeGlossariesCommand)

      • setMakeGlossariesOptions

        public void setMakeGlossariesOptions​(String makeGlossariesOptions)

      • setPatternErrMakeGlossaries

        public void setPatternErrMakeGlossaries​(String patternErrMakeGlossaries)

      • setPatternWarnXindy

        public void setPatternWarnXindy​(String patternWarnXindy)

      • setPatternReRunMakeGlossaries

        public void setPatternReRunMakeGlossaries​(String pattern)

      • setTex4htCommand

        public void setTex4htCommand​(String tex4htCommand)

      • setTex4htStyOptions

        public void setTex4htStyOptions​(String tex4htStyOptions)

      • setTex4htOptions

        public void setTex4htOptions​(String tex4htOptions)

      • setT4htOptions

        public void setT4htOptions​(String t4htOptions)

      • setPatternT4htOutputFiles

        public void setPatternT4htOutputFiles​(String patternT4htOutputFiles)

      • setLatex2rtfCommand

        public void setLatex2rtfCommand​(String latex2rtfCommand)

      • setLatex2rtfOptions

        public void setLatex2rtfOptions​(String latex2rtfOptions)

      • setOdt2docCommand

        public void setOdt2docCommand​(String odt2docCommand)

      • setOdt2docOptions

        public void setOdt2docOptions​(String odt2docOptions)

      • setPdf2txtCommand

        public void setPdf2txtCommand​(String pdf2txtCommand)

      • setPdf2txtOptions

        public void setPdf2txtOptions​(String pdf2txtOptions)

      • setChkTexCommand

        public void setChkTexCommand​(String chkTexCommand)

      • setChkTexOptions

        public void setChkTexOptions​(String chkTexOptions)

      • main

        public static void main​(String[] args)