summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/base/doc.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-08-27 18:16:22 +0000
committerKarl Berry <karl@freefriends.org>2006-08-27 18:16:22 +0000
commit4ab3220f33f1983f5aff7b7253ad229e44c952fe (patch)
treec9d2408cfe8c113537c0031bc7e50bda98a262dc /Master/texmf-dist/source/latex/base/doc.dtx
parent6e05e1819838930d7f7e4eb36620d2994a45b97b (diff)
latex core update from latex-tds (27aug06)
git-svn-id: svn://tug.org/texlive/trunk@2043 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/base/doc.dtx')
-rw-r--r--Master/texmf-dist/source/latex/base/doc.dtx32
1 files changed, 19 insertions, 13 deletions
diff --git a/Master/texmf-dist/source/latex/base/doc.dtx b/Master/texmf-dist/source/latex/base/doc.dtx
index cb658e0c800..582fac5ad33 100644
--- a/Master/texmf-dist/source/latex/base/doc.dtx
+++ b/Master/texmf-dist/source/latex/base/doc.dtx
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
-% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
+% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
% The LaTeX3 Project and any individual authors listed elsewhere
% in this file.
%
@@ -8,12 +8,12 @@
% -------------------------------------------
%
% It may be distributed and/or modified under the
-% conditions of the LaTeX Project Public License, either version 1.3
+% conditions of the LaTeX Project Public License, either version 1.3c
% of this license or (at your option) any later version.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
-% and version 1.3 or later is part of all distributions of LaTeX
-% version 2003/12/01 or later.
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
%
% This file has the LPPL maintenance status "maintained".
%
@@ -35,7 +35,7 @@
%<+package|shortvrb>\NeedsTeXFormat{LaTeX2e}[1994/12/01]
%<+package> \ProvidesPackage{doc}
%<+shortvrb>\ProvidesPackage{shortvrb}
-%<+package|shortvrb> [2004/02/09 v2.1b
+%<+package|shortvrb> [2006/02/02 v2.1d
%<+package|shortvrb> Standard LaTeX documentation package (FMi)]
%\catcode`\<=12
%
@@ -959,6 +959,8 @@
% \textsf{makeindex} program directly (on our MicroVAX) but the final
% result was worth the trouble.}
%
+% \changes{v2.1d}{2006/02/02}{Corrected description of \cs{changes}
+% macro.}
% \DescribeMacro\changes
% To maintain a change history within the file, the |\changes|
% command may be placed amongst the description part of the changed
@@ -969,15 +971,19 @@
% \end{quote}
% The changes may be used to produce an auxiliary file (\LaTeX's
% |\glossary| mechanism is used for this) which may be printed
-% after suitable formatting. The |\changes| macro encloses the
-% \meta{date} in parentheses and appends the \meta{text} to form the
+% after suitable formatting. The |\changes| macro generates the
% printed entry in such a change history; because old
% versions\footnote{Before 2.6.} of the \textsf{makeindex}
% program limit such fields to 64 characters, care should be taken
-% not to exceed this limit when describing the change. When
+% not to exceed this limit when describing the change. The actual
+% entry consists of the \meta{version}, the |\actualchar|, the current
+% macro name, a colon, the |\levelchar|, and, finally, the \meta{text}.
+% The result is a glossaryentry for the \meta{version}, with the name of
+% the current macro as subitem. Outside the |macro| environment, the
+% text |\generalname| is used instead of the macro name. When
% referring to macros in change descriptions it is conventional to use
-% "`"\meta{macroname} rather than attempting to format it properly and
-% using up valuable characters in the entry with old \textsf{makeindex}
+% |\cs{|\meta{macroname}|}| rather than attempting to format it properly
+% and using up valuable characters in the entry with old \textsf{makeindex}
% versions.
%
% \changes{v1.7a}{1992/02/26}{Description of \cs{RecordChanges} etc.
@@ -3316,7 +3322,7 @@
% by using \cs{special@index} not \cs{index} (PR/2928).}
% \changes{v2.0e}{1998/12/28}{Use \cs{string}, not \cs{protect} in argument to
% \cs{special@index}.}
-% \changes{v2.1b}{2004/02/09}{environment names incorrectly sorted in
+% \changes{v2.1c}{2004/07/23}{environment names incorrectly sorted in
% index (pr/3615)}
% \begin{macrocode}
\def\SpecialMainEnvIndex#1{\@bsphack\special@index{%
@@ -3363,7 +3369,7 @@
% \changes{v2.1b}{2004/02/09}{environment names incorrectly sorted in
% index (pr/3615)}
% \begin{macrocode}
- \index{environments:#1\actualchar\levelchar{\protect\ttfamily#1}\encapchar
+ \index{environments:\levelchar#1\actualchar{\protect\ttfamily#1}\encapchar
usage}\@esphack}
% \end{macrocode}
% Because both entries correspond to `descriptions' of the
@@ -3796,7 +3802,7 @@
% To provide a change history log, the |\changes| command has
% been introduced. This takes three arguments, respectively, the
% version number of the file, the date of the change, and some detail
-% regarding what change has been made. The first of these arguments
+% regarding what change has been made. The second of these arguments
% is otherwise ignored, but the others are written out and may be used
% to generate a history of changes, to be printed at the end of the
% document. However, note that older versions of Chen's standard