[Tex/LaTex] Keep track of changes in LaTeX document

changes

I see that in documentation for many LaTeX packages authors keep track of changes with a \changes{} macro, which then produces a nice index style list of changes. I would like to do the same for edits to my PhD thesis. Is there a way to use this facility, or a similar one, outside the ltxdoc document class?

Best Answer

The ltxdoc document class loads the doc package for the core functionality. The package can be used in other document classes too:

\documentclass{article}

\usepackage{doc}
\RecordChanges

\begin{document}

\changes{v1}{2011/03/24}{Initial version}
Test

\PrintChanges

\end{document}

Process the .glo file with:

> makeindex -s gglo.ist -o <name>.gls <name>.glo

For more information refer to the doc manual (it can be compiled from the LaTeX2e sources).

Related Solutions

[Tex/LaTex] How to track changes between PDFs

I've made a quick comparison between some of the methods suggested here. This answer will be a community wiki, and I will made this the accepted one. Hopefully nobody will mind the loss of 15 rep. I upvoted all useful answers, and I urge you to do the same -- all of them were ideas with potential.

Adobe Acrobat Professional -- Compare files

I've used Acrobat 8 for this test (this is probably the first time I thank the Powers-That-Be that my organization is Windows-mostly shop). Setting this up is easy enough -- Go to Advanced->Compare documents..., and fill in the blanks. That was easy, I thought. Well..

Pro tip -- Don't choose Detailed analysis (slow). You'll thank me later. I did the first time around, and this thing had been running for 10 minutes, and let's just say that Acrobat is now the proud owner of the World Prize of Ridiculous Memory Consumption, with the whopping 750 (seven hundred and fifty, not a typo) MB. This only reminded me there's a reason I don't use Acrobat except for proof-reading just before printing.

I tried side-by-side report with Normal analysis, and that could have worked well if only my revised version didn't have 8 pages or so more than the original. It didn't recognize that the same text is somewhere down in the document -- as far as I can tell, it just put the two documents side by side, more or less, with some fancy useless colouring. Oh dear. I could have done that myself without whipping out Liberia's deficit for a license. At this point I wasn't inclined to try again with the detailed analysis, which supposedly would detect such things.

I'd give it a -1/10, for having an useless option that doesn't really work, and spectacularly so.

Update: Geoffrey had different experience with Acrobat in what seems a similar document, and I tried to repeat what he did. On the first try I have used the Page by page comparison option, which was so unsatisfactory, while now I tried the Textual differences. This works as he suggests, although the diff result is kind of useless if one chooses the Consolidated report option, and still difficult to interpret with the Side by side report . It still does not show side-to-side the equal text portions in each document, as one would expect when accustomed to diff format, but rather highliting differently the common text, and text unique to each version. At least, there's a comment on which page of the other document you'd find the matching text, so that's useful, although not exactly user-friendly. Also, I noticed it got confused in some places, matching seemingly random words and word fragments.

This would improve significantly the score of Acrobat, and I think a 7/10 is appropriate, with two whole points deducted for the non-trivial license fee -- the formula I use is:

licensePenalty = max(0, len(str(licenseFeeInUSD))-1).

Otherwise, it works good and the performance is also similar to what Geoffrey observed.
Adobe Acrobat Professional -- Export in .txt format. + diff

This works kind of. You'd get most of the text right, if it wasn't for the annoying mangling of ligatured glyphs. Also, my text is in Swedish, and has a decent amount of diacritics which also got lost. Hyphenation sneaked through as well (rather annoying -- Swedes have very long words sometimes). The formatting is abysmal, but could probably be fixed with an intelligent $FAVOURITE_INTERPRETED_LANGUAGE script.

I'd give a 6/10 for the effort, but only because diffing acually works. The text is not quite readable at places, for example words like träff looks like tr".
diffpdf

I found this little gem when looking for diff-like programs to install on Ubuntu. Available from http://www.qtrac.eu/diffpdf.html. Needs Qt and Poppler.

This is actually superior to Acrobat's Normal analysis mode -- the differences are nicely highlighted and obvious. It does page-by-page comparison as Acrobat, and there seems to be a way to make better comparisons if you know where you've inserted additional pages, but that wasn't very straight-forward to do, and I couldn't be bothered to look through the document to find which pages exactly were added -- that's kind of the point of using a tool to do it, no?

I'd give it a 4/10 for this particular problem, although for others with small changes it will work great, and would deserve an 8/10 (the user interface could be a bit confusing).
pdftotext+diff

For those that don't know, pdftotext is part of the xpdf collection, available from here: http://www.foolabs.com/xpdf/home.html. I used the Linux version on Ubuntu.

This works better than (2), but ligatured glyphs are substituted with what looks like UTF-8 symbols representing them, like fi, ff, ffl, etc. Quotes got mangled as well, again replaced with an UTF symbol (when writing, I always use the "proper" TeX `` and '' quotes). Text search works perfectly, though, even when using such combinations. The readability is much better, if your favourite text editor understands and renders UTF-8, and the formatting is improved, albeit slightly. Hyphenation, however, got taken care of, which is quite nice. One annoying thing, though -- headers and footers, together with page numbers, find their way into the text document, which could be frustrating when comparing the versions.

This one deserves a hard 9/10, with points deducted for UTF-8 symbols mangling, and the header and footer issue during conversion (the last creates a lot of "false positives" for diff).

[Tex/LaTex] “Track changes” in LaTeX

You can process your TeX files with the Perl program latexdiff that is included with most LaTeX distributions.

From the manual:

Briefly, latexdiff is a utility program to aid in the management of revisions of latex documents. It compares two valid latex files, here called old.tex and new.tex, finds significant differences between them (i.e., ignoring the number of white spaces and position of line breaks), and adds special commands to highlight the differences.

Best Answer

Related Solutions

[Tex/LaTex] How to track changes between PDFs

[Tex/LaTex] “Track changes” in LaTeX

Related Question