LaTeX Coding Standards
By Didier Verna on Tuesday, July 19 2011, 17:02 - LaTeX - Permalink
EDIT: the paper is now freely available for non TUG members.
I'm happy to announce that my contribution to TUG 2011, the next TeX Users Group International conference, has been accepted. Please find the title and abstract below.
Towards LaTeX Coding Standards
Because LaTeX (and ultimately TeX) is only a macro-expansion system, the language does not impose any kind of good software engineering practice, program structure or coding style whatsoever. As a consequence, writing beautiful code (for some definition of "beautiful") requires a lot of self-discipline from the programmer.
Maybe because in the LaTeX world, collaboration is not so widespread (most packages are single-authored), the idea of some LaTeX Coding Standards is not so pressing as with other programming languages. Some people may, and probably have developed their own programming habits, but when it comes to the LaTeX world as a whole, the situation is close to anarchy.
Over the years, the permanent flow of personal development experiences contributed to shape my own taste in terms of coding style. The issues involved are numerous and their spectrum is very large: they range from simple code layout (formatting, indentation, naming schemes etc.), mid-level concerns such as modularity and encapsulation, to very high-level concerns like package interaction/conflict management and even some rules for proper social behavior.
In this talk, I will report on all these experiences and describe what I think are good (or at least better) programming practices. I believe that such practices do help in terms of code readability, maintainability and extensibility, all key factors in software evolution. They help me, perhaps they will help you too.
Comments
My relatives always say that I am wasting my time here at net, however I know
I am getting knowledge every day by reading such nice posts.
Incredible! This blog looks just like my old one!
It's on a totally different subject but it has pretty much the same page layout and design.
Wonderful choice of colors!
It's a shame you don't have a donate button! I'd definitely donate to this superb blog!
I guess for now i'll settle for book-marking and
adding your RSS feed to my Google account.
I look forward to fresh updates and will talk about this website with my
Facebook group. Talk soon!