Package: latexsuite
Latex SuiteThis suite of little programs is intended to support creating latex documents that are being written in editor
and console.If you want to change the default behaviour create a configuration file.
SeeTask: confon how to create a config file and seeConfigurationon the
parameters and their defaults.InstallationInstallation with Pip$python3-mpipinstalllatexsuiteManual Installation$gitclonehttps://github.com/jbuerman/latexsuite$cdlatexsuite$pythonsetup.pyinstallAutocompleteLatexSuite usesargcompletefor argument autocompletion and is
set up for global completion. See argcomplete'spypi siteorgithubto activate global completion.TasksThe suite's different capabilities are determined by the first argument thetask.
The different tasks are:make: Typeset the default texcmake: Typeset any texbibfile: Create bibliography file from required citations.clean: Remove typesetting side files.lang: Check common language errors in a document.conf: Write the default config file.Task: make and cmakeTypeset one or several tex files. Themakecommand will initiate
the typesetting of the main tex file or all compilable tex. Thecmakecommand will initiate the typesetting of any specified tex.ParametertexfilePositional argument that accepts any compilable tex file in the current directory.
If no argument is supplied the default tex file is compiles. (Ignored if--allis given.)--allCompile all latex files in the current directory which are deemed self-compilable.
Self-compilable tex files that contain a\documentclassin the first non comment/empty line.
(Not available for cmake.)-b/--bibAlso process the bibliography. Will process the tex file twice.
Once before and once after the bibliography file processing.-v/--verbosePrint the cmd output of the latex and bib engine.-l/--listStatusList the compilation status of file typesetting when--allis given.
(Ignored if--allis not given. Not available for cmake.)-n/--numberNumber of latex error to ignore.
Override thenumber_ignore_latex_compile_errorsconfiguration value for the current run.-d/--doubleTranslate the tex document twice. If the '--bib' flag is set the file will be translated three times.
Once before the bibliography processing and twice after.Task: bibfileCreates a bibliography based on the citations in the main tex file. The assumption is that there is
a "database" of bibtex files, i.e. a folder that contains one or several bibtex files.
The task reads in the aux file and searches in the database for all bibliographic blocks for citations
listed in the aux file. The task then writes a local bibliography file with the needed references.Parameter-a/--auxFileThe aux file to use. If not supplied the aux file of the main tex file is used.-b/--bibsFolderThe folder where the bibliography files are located.-o/--outputThe output file where the local bibliography is written to.Task: cleanRemoves the temporary files from the latex typesetting
process based on the configured file extensions.Parameter-dDepth of search into sub-folders for the files.
Overridesclean_depthconfiguration value for the current run.-lOnly list the files and do not delete them.-fForce delete and not ask for confirmation for every fileTask: langAllows checking a text file for textual errors. The default behaviour is that every line
gets tested for all errors. However, error types can be ignored using the associated flag.
The task tests for the following errors.'An' not in front of a vowel or 'a' in front of a vowel, e.g. 'an car' or 'a apple'. Will also list 'false positives' like 'a hour'.Extra space.Lists occasions where a space is followed by one or more spaces.Named reference with lower case.Occasions where a reference is not capitalised,
e.g. "figure 4" instead of "Figure 4".Doubled word.Occasions where a word is repeated, e.g. "John had a carand anda house."Citation with name and not shortcite.Flag for exclusion '-c'.Every sentence in a line.Checks that every sentence is in its own line.Flag for exclusion '-l'.ParameterfilePositional argument that accepts any text file.-lIgnore (do not list) "Every sentence in a line" errors.-cIgnore (do not list) "Citation with name and not shortcite" errors.Task: confWrite the config file for the suite with the default parameters.Parameter-fOverriding the config file if it already exists.ConfigurationThe configuration parameters, their meaning and their default
values.engineThe program to use to typeset the tex file (default value: pdflatex).bib_engineThe program to use to process the bibliography (default value: biber).main_texThe main tex file to compile (default value: main.tex).clean_file_extensionsThe file extensions to use when searching for temporary
            files to delete (default value: [".log", ".aux", ".bbl", ".blg"]).clean_depthThe depth (sub-folder traversal) used to search for
            temporary files. 0 means current dir, 1 means include
            sub-folder, 2 means sub-folder of sub-folders, etc. (default value: 0).bib_files_folderThe folder where bibliography files are stored
            that shall be parsed when compiling a bib file of relevant
            references (default value: . [i.e. current  dir]).main_bibliography_fileThe file to write the relevant references blocks to
            (default value: bibliography.bib").bibliography_fields_to_removeThe bibliography blocks fields that are to be removed
            before adding the block to the file of relevant
            references (default value: ["abstract", "file",
            "keywords", "url"]).number_ignore_latex_compile_errorsNumber of times the latex typesetting program
            should try to ignore un-ended environments
            (default value: 1).language_errorsErrors that are checked during the text error check. All errors are matches of the specified
            regular expression.
            Every error must have the following required and can have the following optional parameter.message (required)The error message.regex (required)The regular expression used to search for this error.identifier (optional)Used to create a command line arg to exclude the error during 
                    a check for text errors. Uniqueness should be ensured.exclude_words (optional)First words for which a match should be ignored. For example, an error checking for capitalisation
                    of references, e.g. 'figure 1' instead of 'Figure 1', should ignore a match with an 'and', e.g.
                    'and 1' out of 'Figure 1 and 2' should not be a match.split_character (optional)The character to split a match of the regex into substrings.
                    Used in conjunction with exclude_words to determine the first word (default: ' ', i.e. space).