Giter Club home page Giter Club logo

texerr's Introduction

TeXerr

Run a LaTeX binary and filter output for relevant information.

About this program

This program aims to middleman between the user and their LaTeX program, e.g. pdflatex. Its main goal is to read the standard output of LaTeX programs and format it in a nice and more readable way.

How to use

TeXerr can be used by simply writing texerr in front of every call of pdflatex, xelatex, etc. It works by executing everything given as command line arguments and reading the output of that command. The output is filtered and then formatted to be more readable. One usage example could be:

texerr pdflatex -output-directory=build -recorder report.tex

This makes it also very easy to use, e.g., with latexmk. Just put the following into your .latexmkrc:

$pdflatex = "max_print_line=1000000 texerr pdflatex %O %S";

Please note from this example two things:

  1. Environment variables need to be set before calling TeXerr and will be passed through.
  2. You should definitively set max_print_line to a high value, otherwise the heuristics and matchings done by TeXerr might fail.

Roadmap

There are several things on the roadmap:

  • More warnings / errors / notices that can be highlighted. If you encounter specific messages you would like to include, please do not hesitate to open an issue or even submit a pull request. Please include relevant information to your best ability, such as the relevant package, part of the LaTeX output, and a minimal example which produces this output.
  • Make it more modular: This could mean having a subdirectory with python files, each containing the specific patterns and actions.
  • Different color styles.
  • Tests. I still need to think how they should look like and what they should actually test.

texerr's People

Contributors

jonasc avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.