Skip to content

vvcogo/style-check-html

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

style-check-html

The style-check-html tool is a patch for the style-check.rb.

The original style-check.rb tool identifies common writing mistakes in LaTeX files and suggests possible corrections. This patch only modifies the code that displays these suggestions to the user. Instead of obtaining the output in text-mode, users have now the "-w" option to receive the output in HTML format.

The installation process is exactly the same as the original tool. Execute the following commands to obtain it:

wget https://github.com/vvcogo/style-check-html/releases/download/v0.14-2/style-check-html-0.14-2.tar.gz
tar -zxvf style-check-html-0.14-2.tar.gz 

And the following to install it system-wide:

sudo make install

or user-wide:

make user-install

You are ready to use the patched version of the style-check.rb tool and to obtain the output in HTML format:

style-check.rb -w test-dirty.tex > test-dirty.html

Opening the resulting file in your Web browser is the last step:

firefox test-dirty.html

The resulting HTML file contains a header with checkboxes and the number of suggestions being presented from the total. Deselecting the checkbox for some category will remove the respective suggestions from the view. The entry for each suggestion contains the file where the suggestion matched, the original sentence, the reason it was issued, a possible solution, and the pattern that triggered the suggestion. Additionally, one may remove one entry at time by clicking on the "X" button at the right-side as it is corrected in the text.

Additional information about the style-check.rb tool is available in its original page.

About

Reports from style-check.rb in HTML format

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages