eah13 / bdt_latex Goto Github PK

BDT_latex.py is a program that automates the Belcher Diagnostic Test for LaTeX documents. The Belcher Diagnostic Test was invented to improve academic writing by Wendy Laura Belcher in her book Writing Your Journal Article in Twelve Weeks: A Guide to Academic Publishing Success and is copyrighted by her. The program is designed to implement the test on projects that use multiple files, such as TeX files or images. Instructions on using the test to improve writing are in Belcher’s book.

python BDT_latex.py examples.tex

The script creates new TeX files with suffix _BDT (e.g., examples_BDT.tex) in the same directory of the original file. The new files can be compiled with LaTeX to proceed with the Belched Diagnostic Test.

The full documentation of the code is available at here.

The code can be executed with Python 2.7 or later. The program requires the LaTeX package xcolor.

Contributions are welcome. To make modifications fork the repository and clone it in your computer to make changes with

$ git clone {Repository_URL}

Once you have pushed changes to your local directory, you can make a pull request from GitHub.

Please do not publish any explanation of the Belcher Diagnostic Test without Belcher's permission because 1) the book gives a detailed explanation of the method; and 2) that might lead to a copyright infringement.

The contents of this repository are covered under the MIT License.