StartingPoint RecentChanges

QuickNotesForDevelopers

This page is a shorter version covering some of the same ground as the page DeveloperCorner. If you read that page, don't bother reading this one. If you want more detail than this page, see that one.

Modularity

Please note that new transformations can be added without altering the easylatex.pl program itself. Just put additional files in the user's .easylatex/transformations directory, or the /usr/lib/easylatex directory (beware; if the user's .easylatex directory exists, then the /usr/lib/easylatex directory is ignored. So, if a user wants to make their own .easylatex directory, they must first copy the system easylatex directory to ~/.easylatex. Creating a new, empty .easylatex directory won't work.

Most additions that people will want to write are probably new transformations. So, just write it as a separate file and put it in the transforms directory. Note that the numbers preceding the filename control the order in which the transformations are applied.

If you write additional transformations, please submit them to the easylatex project so that they can be considered for inclusion in the standard distribution.

Transformations or patches that break the unit tests generally won't be accepted. If you think the "correct" version specified by a unit test isn't optimal, though, feel free to suggest a change to the unit tests, or to the testing framework.

Unit tests

The folder testFiles contains unit tests which test various features of easylatex. For example, if you run "easylatex testFiles/identityMatrix.txt", the result should be the same as the file "testFiles/identityMatrix.tex.correct".

The shell script unitTestDiffs.sh runs easylatex on each file in testFiles/*.txt, and diffs the results against the appropriate ".correct" files

If all goes well, you should see a bunch of lines which each start with '***' -- these are just unitTestDiffs.sh reporting what it's doing.

If either easylatex crashes or if it creates a file which doesn't match the appropriate ".correct" file, you should see some lines which DON'T start with '***'; either error messages, or output from diff. If this happens, then your modified code has failed one or more unit tests.

Misc notes

-- BayleShanks