summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/macros2e/macros2e.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-12-10 00:36:39 +0000
committerKarl Berry <karl@freefriends.org>2017-12-10 00:36:39 +0000
commit6c56b5f5fd8c901300518179a31ee34fcccd9e35 (patch)
tree23d00453fc6699b1b45752aec0d1ced5959fc5d4 /Master/texmf-dist/doc/latex/macros2e/macros2e.tex
parent9a03dd60f3227afcfd242b9633edbc0d83ffd02e (diff)
macros2e (9dec17)
git-svn-id: svn://tug.org/texlive/trunk@46026 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/macros2e/macros2e.tex')
-rw-r--r--Master/texmf-dist/doc/latex/macros2e/macros2e.tex28
1 files changed, 14 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/latex/macros2e/macros2e.tex b/Master/texmf-dist/doc/latex/macros2e/macros2e.tex
index 964a7f4086e..d1f6a38f02a 100644
--- a/Master/texmf-dist/doc/latex/macros2e/macros2e.tex
+++ b/Master/texmf-dist/doc/latex/macros2e/macros2e.tex
@@ -10,6 +10,7 @@
\MakeSpecialShortVerb\qverb\"
\AtBeginDocument{\MakeShortMacroArgs*\`}
\AtEndDocument{\DeleteShortMacroArgs\`}
+\newcommand\Q[1]{``\texttt{#1}''}
\usepackage{hyperref}
\usepackage{xcolor}
@@ -265,7 +266,7 @@
\title{List of internal \LaTeX2e Macros useful to Package Authors}
\author{Compiled by Martin Scharrer\\\url{martin@scharrer-online.de}}
-\date{Version 0.4 -- July 23rd 2011}
+\date{Version 0.4a -- 2017/12/09}
\setlength{\descindent}{0pt}
\setlength{\parindent}{0pt}
@@ -479,9 +480,9 @@ code. Care must also be taken if they are used together with external macros, wh
Macro & Description \\
\midrule
\Macro\@wholewidth &
- This |dimen| register holds the half line width (thickness) in \env{picture} environments. \\
- \Macro\@halfwidth &
This |dimen| register hold the full line width (thickness) in \env{picture} environments. \\
+ \Macro\@halfwidth &
+ This |dimen| register holds the half line width (thickness) in \env{picture} environments. \\
\bottomrule
\end{tabularx}
@@ -657,7 +658,6 @@ This auxiliary macros were originally defined to handle font changes but can be
\toprule
Name & Description \\
\midrule
- \Macro\strip@prefix & Removes everything up to and including to the next \texttt{>}. \\
\Macro\@makeother{<letter>} & Changes the catcode of the letter to \q{other} (12). Special letters must be escaped with a backslash. \\
\Macro\@sanitize & Changes catcodes of everything except braces to \q{other} (12).\\
\Macro\@onelevel@sanitize<macro> & Sanitizes \meta{macro}, turns it definition into verbatim code. Resulting characters except spaces are in catcode \q{other} (12)! Uses \Macro\meaning and \Macro\strip@prefix. (With $\epsilon$-\TeX\ many applications can be replaced by \Macro\detokenize{<content>}.) \\
@@ -694,8 +694,8 @@ Write on log file only.
Name & Description \\
\midrule
\Macro\@settopoint<register> & Rounds register to whole number of points. \\
- \Macro\rem@pt<dimension value> & Awaits a value dimension value (\MacroArgs<int>'.'<frac>'pt') as string where the "pt" is removed. If \meta{frac} is numerical equal to 0, then it and the decimal dot are removed as well. \\
- \Macro\strip@pt<dimension> & Expands dimension using \cs{the} and strips the "pt" using \Macro\rem@pt. \\
+ \Macro\rem@pt<dimension value> & Awaits a value dimension value (\MacroArgs<int>'.'<frac>'pt') as string where the \Q{pt} is removed. If \meta{frac} is numerical equal to 0, then it and the decimal dot are removed as well. \\
+ \Macro\strip@pt<dimension> & Expands dimension using \cs{the} and strips the \Q{pt} using \Macro\rem@pt. \\
\Macro\@killglue &
Removes (|\unskip|s) the last and then all further skips (|\lastskip|) till one with a size of zero is reached. \\
\bottomrule
@@ -728,17 +728,17 @@ Other units can be used instead of "pt".
\midrule
\Macro\if@filesw & If false the package should not be produce or write to output files. Set to false by \cs{nofiles}.\\
\Macro\if@partsw & \\
- \Macro\@currdir & Holds the current directory, e.g. "./" in an Unix OS. \\
+ \Macro\@currdir & Holds the current directory, e.g. \Q{./} in an Unix OS. \\
\Macro\input@path & List of input paths. Each path should be enclosed in braces with no delimiters between paths. \\
\Macro\@filelist & The comma separated list of all files read so far. Only active if \cs{listfiles} is used in the preamble. \\
\Macro\@inputcheck& Input file handle to check for the existence of the file.\\
\Macro\@unused & Output file handle used to reserve the standard output. Used in \Macro\typeout to write to the terminal.\\
- \Macro\@mainaux & Output file handle for the main |aux| file.\\
- \Macro\@partaux & Output file handle for include file |aux| files.\\
+ \Macro\@mainaux & Output file handle for the main \texttt{aux} file.\\
+ \Macro\@partaux & Output file handle for include file \texttt{aux} files.\\
\Macro\@auxout & Let to \Macro\@partaux inside include files, but to \Macro\@mainaux otherwise.\\
\Macro\@partlist & Holds the comma-separated list defined by \Macro\includeonly. \\
- \Macro\@pushfilename & pushes file name, extension and current catcode of "@" onto the file stack. \\
- \Macro\@popfilename & pushes file name, extension and current catcode of "@" onto the file stack. \\
+ \Macro\@pushfilename & pushes file name, extension and current catcode of \Q{@} onto the file stack. \\
+ \Macro\@popfilename & pushes file name, extension and current catcode of \Q{@} onto the file stack. \\
\Macro\@currnamestack & file name stack.\\
\bottomrule
\end{tabularx}
@@ -856,7 +856,7 @@ The following plain\TeX{} macros are redefined by \LaTeX{} and therefore saved a
\Macro\@bsphack & \\
\Macro\@esphack & Both of these macro ensure that the code between them does not insert any spaces into the document.
The code itself should not produce any text and not change the mode (e.g.\ start or stop math mode).\\
- \Macro\@Esphack & Variant of \cs{@esphack} which sets the |@ignore| switch to true which causes an \cs{ignorespaces}
+ \Macro\@Esphack & Variant of \cs{@esphack} which sets the \texttt{@ignore} switch to true which causes an \cs{ignorespaces}
after the \cs{end} of the environment.\\
\Macro\@vbsphack & Variant of \cs{@bsphack} which ensure the invisible material is \emph{not} set in vmode. Not used by \LaTeX{} itself at the moment. \\
\bottomrule
@@ -895,7 +895,7 @@ will set \Macro\@tempdima to the width of \qq{Hello World}.
\Macro\@alph{<number>} & Expands to lower case letter corresponding to the given number (1=a, 2=b, \ldots). Expands to \Macro\@ctrerr if number is larger then~26.\\
\Macro\@Alph{<number>} & Expands to upper case letter corresponding to the given number (1=A, 2=B, \ldots). Expands to \Macro\@ctrerr if number is larger then~26.\\
\Macro\two@digits{<number>} &
- Returns \meta{number} (e.g.\ a |count| register) as string and ensures that it has at least two digits
+ Returns \meta{number} (e.g.\ a \texttt{count} register) as string and ensures that it has at least two digits
by appending a "0" if required. \\
\bottomrule
\end{tabularx}
@@ -908,7 +908,7 @@ will set \Macro\@tempdima to the width of \qq{Hello World}.
\midrule
\Macro{if@compatibility} & Switch to indicate if the LaTeX2.09 compatibility mode is active. \\
\Macro{if@ignore} & Whether or not to ignore spaces after an environment. Set to true by \Macro\ignorespacesafterend.\\
-\Macro{if@minipage} & True for a |minipage|, false for a |parbox|. Responsible for adding space, skips and paragraph indents for a |parbox|.\\
+ \Macro{if@minipage} & True for a \texttt{minipage}, false for a \texttt{parbox}. Responsible for adding space, skips and paragraph indents for a \texttt{parbox}.\\
\Macro{if@twoside} & True for two-sided documents \\
\Macro{if@twocolumn} & Indicates if two-column mode is active \\
\Macro{if@firstcolumn}& Indicates if the first column is processed \\