Documentation

<Most packages come with some form of documentation. To makeFit easier for users to find this documentation, the TDS specifies thatCdocumentation shall be stored in a structure that parallels to someextent the fonts!and macros directories.

@There was much discussion about where documentation files shouldBreside. One option was to place them in the same directory as thesource files for the packages, 7but we felt it was important that users be able to findDdocumentation in one place, not mixed in with the source files; most"users have no interest in sources.Therefore, the TWG feltDthat a separate, but parallel, structure for documentation would (1)Bkeep the documentation together and (2) make it as straightforwardas possible for users to 2find the particular documentation they were after.

IThe TDS specifies that documentation files shall be organized as follows:

/texmf/doc/category/...

category

@ identifies the general topic of documentation that resides below it:

> In the case of TeX formats, this will be the name of the- format: latex, plain,D amstex, etc. Within the category tree, the directoryB base is reserved for base documentation distributed by the format's authors.

: Other categories include utility names, for example:) bibtex, makeindx.

, The following categories are reserved:

help

B is reserved for meta-information, such as FAQ's, David$ Jones' macro index, etc.

general

R is reserved for stand-alone documents not part of any package: Michael7 Doob's A Gentle Introduction to TeX,; Joachim Schrod's Components of TeX, etc.

man

D is reserved for manual pages (Unix-style documentation).

info

7 is reserved for processed Texinfo documents.

html

+ is reserved for HTML documents.

-The documentation directories may contain TeX=sources, DVI files, PostScript files, text files, or=whatever form of documentation will best explain the package.

>A skeleton of the TDS directory tree under texmf/doc:

"  help/           meta-informationA  . ctan/         info about CTAN sites, TeX-index, etc.6  . faq/          FAQs of comp.text.tex, etc.*  general/	  across programs, generalities*  . texcomp/      Components of TeX7  . errata/       errata, errata[1-8]I  <format>/       name of a format (latex example follows)%  . base/         for the base format7  . misc/         for single-file package documentationD  . <package>/    for package (amslatex, etc.)  latex/9  . base/         ltnews*, *guide, etc.#  . graphics/     grfguide1  generic/	  for non-format specific TeX packages"  . german/       germdoc  . babel/      C  <program>/      TeX applications, by name (examples follow)=  tex/            texbook.tex, gentle, etc.L  metafont/       mfbook.tex, metafont-for-beginners, etc.7  metapost/       mpman, manfig, etc.  ams/9  . amsfonts/     amsfonts.faq, amfndoc4  . amstex/       amsguide, joyerr9  . amslatex/     amslatex.faq, amsldoc3  web/            webman, cwebman0  fontname/       Filenames for TeX fonts  fonts/#  . oldgerm/      corkpapr  . malvern/)  man/            Unix-style manual pages  html/           HTML files;  info/           GNU Info files, made from Texinfo sources