Skip to main content

Yet another LaTeX filter

Project description

YaLafi: Yet another LaTeX filter

This Python package extracts plain text from LaTeX documents. The software may be integrated with a proofreading tool and an editor. It provides

  • mapping of character positions between LaTeX and plain text,
  • simple inclusion of own LaTeX macros and environments with tailored treatment,
  • careful conservation of text flows,
  • replacement of equations with detection of trailing interpunction.

A complete description is available at the GitHub page.

The sample Python application script yalafi/shell/ integrates the LaTeX filter with the proofreading software LanguageTool. It

  • sends the extracted plain text to the proofreader,
  • maps position information in returned messages back to the LaTeX text,
  • generates results in different formats.

You may easily

  • create a proofreading report in text or HTML format for a complete document tree,
  • check LaTeX texts in the editors Emacs and Vim via several plug-ins,
  • run the script as emulation of a LanguageTool server with integrated LaTeX filtering.

For instance, the LaTeX input

Only few people\footnote{We use
\textcolor{red}{redx colour.}}
is lazy.

will lead to the text report

1.) Line 2, column 17, Rule ID: MORFOLOGIK_RULE_EN_GB
Message: Possible spelling mistake found
Suggestion: red; Rex; reds; redo; Red; Rede; redox; red x
Only few people is lazy.    We use redx colour. 
2.) Line 3, column 1, Rule ID: PEOPLE_VBZ[1]
Message: If 'people' is plural here, don't use the third-person singular verb.
Suggestion: am; are; aren
Only few people is lazy.    We use redx colour. 

This is the corresponding HTML report:

HTML report

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yalafi, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size yalafi-1.1.1-py3-none-any.whl (55.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size yalafi-1.1.1.tar.gz (30.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page