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,
  • some parsing of displayed equations for detection of included “normal” text and of interpunction problems,
  • support of multi-language documents (experimental).

A complete description is available at the GitHub page.

The sample Python application script yalafi/shell/shell.py 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, and 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.

Source Distribution

yalafi-1.3.0.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

yalafi-1.3.0-py3-none-any.whl (82.3 kB view details)

Uploaded Python 3

File details

Details for the file yalafi-1.3.0.tar.gz.

File metadata

  • Download URL: yalafi-1.3.0.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.6.9

File hashes

Hashes for yalafi-1.3.0.tar.gz
Algorithm Hash digest
SHA256 9cad9a78300d29536d6cc8e304d855617ebb1c718b541654e7183c81d2047be0
MD5 0b4539be20014e3a64840ceec0089d58
BLAKE2b-256 9e41db0ec0eb28a0a8b6d61b47af4360d86f9788ae5eb7028cbe0864cba3badd

See more details on using hashes here.

File details

Details for the file yalafi-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: yalafi-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 82.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.6.9

File hashes

Hashes for yalafi-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae65e72c6522ddb6596b9fe5fd80967b6ed98c6ff92bbb0bf333f4abea838374
MD5 0dc2b31cefec1f8f6740daa151e9dc06
BLAKE2b-256 9ef02cee2f0d2cd3dc29906b19e9db4ce47989d0faa94657762e09bd3b16ee32

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page