Documentation: https://texplain.readthedocs.io

Usage

command-line

texindent: Automatic indentation and formatting of a TeX-file.
texcleanup: Apply any of the following options to a TeX-file:
- Remove all comments or comment-lines.
- Modify all occurrences of a command, for example to change \TG{deleted}{inserted} to inserted.
- Rename a label.
- Ensure common prefixes for all labels.
- Ensure usage of \cref instead of \ref.
texplain: Create a directory with a TeX-file and only its dependencies (those figure-files and references that are actually included). This is particularly useful to create a clean version to submit to a journal.

pre-commit

repos:
- repo: https://github.com/tdegeus/texplain
  rev: v0.8.0
  hooks:
  - id: texcleanup
    args: [--format-labels, --use-cleveref]

texindent:

repos:
- repo: https://github.com/tdegeus/texplain
  rev: v0.8.0
  hooks:
  - id: texindent
    args: []

Python

All of these tools wrap around a Python module that you can use just as well!

Disclaimer

This library is free to use under the MIT license. Any additions are very much appreciated, in terms of suggested functionality, code, documentation, testimonials, word-of-mouth advertisement, etc. Bug reports or feature requests can be filed on GitHub. As always, the code comes with no guarantee. None of the developers can be held responsible for possible mistakes.

Download: .zip file | .tar.gz file.

(c - MIT) T.W.J. de Geus (Tom) | tom@geus.me | www.geus.me | github.com/tdegeus/texplain

Getting texplain

Using conda

conda install -c conda-forge texplain

Using PyPi

python -m pip install texplain

From source

# Download texplain
git checkout https://github.com/tdegeus/texplain.git
cd texplain

# Install
python -m pip install .

Metadata

Release files for texplain 0.8.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for texplain 0.8.11
File	Size	Uploaded
texplain-0.8.11.tar.gz	141.6 kB	Jan 5, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for texplain 0.8.11
File	Interpreter	ABI	Platform	Reset
texplain-0.8.11-py3-none-any.whl 24.1 kB Jan 5, 2024	Python 3	none	any	Details

Total release size: 165.7 kB

Release files / texplain-0.8.11.tar.gz

Download URL	texplain-0.8.11.tar.gz
Size	141.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`12c30a7f68d05523c9394a2a885e7588de50b2f1a8c2077df52261b52a6c21ef`
BLAKE2b-256 checksum How to use checksums	`4a3200dee518f1b9188251a9f0462dd022ef9fb6d4a17f35127ad83069ee60a3`
Upload date	Jan 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.7`

Release files / texplain-0.8.11-py3-none-any.whl

Download URL	texplain-0.8.11-py3-none-any.whl
Size	24.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`cf025fa1b1c4b9c391275c9fdb6f689b99b2cdb3bd80c5afebd25fd8ae6ad2ea`
BLAKE2b-256 checksum How to use checksums	`e4c26978ab770230704ff6afea0545bb9623fca3ede92f2ef809154e98f1c0c6`
Upload date	Jan 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.7`