• Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Chapter 14. LaTeX Package Documentation ... > 14.3. ltxdoc—A simple LaTeX document...

14.3. ltxdoc—A simple LaTeX documentation class

The ltxdoc class was designed for documenting the core LaTeX source files, which are used to build the LaTeX format and all packages distributed as part of the core distribution. This class is built on the article class, but extends it slightly with a few commands helpful for documenting LaTeX code. It also includes some layout settings specially tailored to accommodate the typical requirements of a source file in doc style (e.g., a line width to hold 72 characters in typewriter fonts and a wider left margin to allow for long macro names to be placed into it).

A special feature is that the class can be used to produce a single document from a larger number of source files in doc style. This has the advantage that one can produce a full index of macro usage across all source files. For example, the driver file source2e.tex generates the documented source listing of the 40 files that make up the LaTeX kernel. It generates a document with nearly 600 pages including an index and a change history (reaching back to the early 1990s).


PREVIEW

                                                                          

Not a subscriber?

Start A Free Trial


  
  • Creative Edge
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint