diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/abstract/abstract.dtx')
| -rw-r--r-- | Master/texmf-dist/source/latex/abstract/abstract.dtx | 141 |
1 files changed, 61 insertions, 80 deletions
diff --git a/Master/texmf-dist/source/latex/abstract/abstract.dtx b/Master/texmf-dist/source/latex/abstract/abstract.dtx index 49299d3de9f..32c1f136a23 100644 --- a/Master/texmf-dist/source/latex/abstract/abstract.dtx +++ b/Master/texmf-dist/source/latex/abstract/abstract.dtx @@ -1,23 +1,20 @@ % \iffalse meta-comment % abstract.dtx % Author: Peter Wilson, Herries Press -% herries dot press at earthlink dot net -% Copyright 2000 --- 2009 Peter R. Wilson +% Maintainer: Will Robertson (will dot robertson at latex-project dot org) +% Copyright 2000--2009 Peter R. Wilson % % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either -% version 1.3 of this license or (at your option) any -% later version. -% The latest version of the 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/06/01 or later. +% version 1.3c of this license or (at your option) any +% later version: <http://www.latex-project.org/lppl.txt> % -% This work has the LPPL maintenance status "author-maintained". +% This work has the LPPL maintenance status "maintained". +% The Current Maintainer of this work is Will Robertson. % % This work consists of the files listed in the README file. % -% +% %<*driver> \documentclass{ltxdoc} \EnableCrossrefs @@ -79,6 +76,7 @@ % \changes{v1.1a}{2004/04/16}{Changed license and contact details} % \changes{v1.2}{2009/05/22}{Changed contact details, and minor improvements} % \changes{v1.2}{2009/05/23}{Added style option} +% \changes{v1.2a}{2009/06/08}{New maintainer} % % \def\dtxfile{abstract.dtx} % ^^A \def\fileversion{v0.3} @@ -88,6 +86,7 @@ % \def\fileversion{v1.1} \def\filedate{2001/02/11} % \def\fileversion{v1.1a} \def\filedate{2004/04/16} % \def\fileversion{v1.2} \def\filedate{2009/05/23} +% \def\fileversion{v1.2a} \def\filedate{2009/06/08} % % \newcommand*{\Lpack}[1]{\textsf {#1}} ^^A typeset a package % \newcommand*{\Lopt}[1]{\textsf {#1}} ^^A typeset an option @@ -100,22 +99,21 @@ % file (\texttt{\dtxfile}) has version number \fileversion, last revised % \filedate.}} % -% \author{% -% Peter Wilson \\ -% Herries Press\\ -% \texttt{herries dot press at earthlink dot net} +% \author{ +% Author: Peter Wilson, Herries Press \\ +% Maintainer: Will Robertson \\ +% \texttt{will dot robertson at latex-project dot org} % } % \date{\filedate} % \maketitle % \begin{abstract} -% The \Lpack{abstract} package provides control over the typesetting +% The \Lpack{abstract} package provides control over the typesetting % of the |abstract| environment, and especially provides for a one-column % abstract in a two-column paper. -% % \end{abstract} % \tableofcontents % -% +% % % \section{Introduction} % @@ -132,28 +130,28 @@ % \LaTeX{} \textsc{docstrip} utility which enables the automatic % extraction of the \LaTeX{} macro source files~\cite{GOOSSENS94}. % -% Section~\ref{sec:usc} describes the usage of the \Lpack{abstract} -% package and +% Section~\ref{sec:usc} describes the usage of the \Lpack{abstract} +% package and % commented source code is in Section~\ref{sec:code}. % % \section{The \Lpack{abstract} package} \label{sec:usc} % -% The typeset format of the |abstract| in a \Lpack{report} or -% \Lpack{article} class\footnote{The \texttt{abstract} environment is not +% The typeset format of the |abstract| in a \Lpack{report} or +% \Lpack{article} class\footnote{The \texttt{abstract} environment is not % available for the \Lpack{book} class.} document depends on the class % options. The formats are: % \begin{itemize} -% \item \Lopt{titlepage} class option: The abstract heading (i.e., value of +% \item \Lopt{titlepage} class option: The abstract heading (i.e., value of % |\abstractname|) is typeset centered in a bold font; the text is set in % the normal font and to the normal width. % \item \Lopt{twocolumn} class option: The abstract heading is typeset like % an unnumbered section; the text is set in the normal font and to the -% normal width (of a single column). +% normal width (of a single column). % \item Default (neither of the above class options): The abstract heading % is typeset centered in a small bold font; the text is set in a small % font and indented like the |quotation| environment. % \end{itemize} -% Note that the \Lopt{titlepage} option takes precedence over the +% Note that the \Lopt{titlepage} option takes precedence over the % \Lopt{twocolumn} option. % % The \Lpack{abstract} package provides handles to modify the typesetting @@ -170,7 +168,7 @@ % two column document (i.e., section heading and normal sized text). % \item \Lopt{addtotoc}. The abstract title (the value of |\abstractname|) % is added to the Table of Contents. -% \item \Lopt{number}. The abstract title will be typeset as a +% \item \Lopt{number}. The abstract title will be typeset as a % numbered |\chapter| % or as a |\section|, depending on whether the document class supports % chapters or not. @@ -179,14 +177,14 @@ % does not apply if you use the \Lopt{style} option. % \item \Lopt{runin}. The abstract title is typeset as a run-in\footnote{This % option was suggested by R.~Chandrasekhar (\texttt{chandra@ee.uwa.edu.au}).} heading. -% Note that the \Lopt{number} and \Lopt{style} options are ignored if the -% \Lopt{runin} option is used, and the \Lopt{number} and \Lopt{addtotoc} +% Note that the \Lopt{number} and \Lopt{style} options are ignored if the +% \Lopt{runin} option is used, and the \Lopt{number} and \Lopt{addtotoc} % options are ignored if the \Lopt{style} option is given. % \end{itemize} % % When the \Lopt{number} option is used with a class that provides chapters, % the usual |\chapter| command is used for typesetting the title. If you -% do not want the word `Chapter' (or its equivalent) to appear, +% do not want the word `Chapter' (or its equivalent) to appear, % you can use the \Lpack{anonchap} % package to suppress this. % @@ -234,13 +232,13 @@ % % \DescribeMacro{\abstractnamefont} % \DescribeMacro{\abstracttextfont} -% These two commands can be redefined to change the fonts used for -% typesetting the heading (defined via |\abstractname|) of the |abstract| +% These two commands can be redefined to change the fonts used for +% typesetting the heading (defined via |\abstractname|) of the |abstract| % environment and the font for typesetting the text of the abstract, % respectively. The default definitions for these are designed to mimic % the traditional |abstract| typesetting. Different values are used % depending on whether the document uses the \Lopt{titlepage} and/or -% \Lopt{twocolumn} options. For example, in a non-titlepage +% \Lopt{twocolumn} options. For example, in a non-titlepage % one-column paper, their definitions are: % \par\begin{small}\begin{verbatim} % \newcommand{\abstractnamefont}{\normalfont\small\bfseries} @@ -265,7 +263,7 @@ % The amended version of |abstract| uses a list environment for typesetting % the text. These four lengths can be changed (via |\setlength|) to adjust % the left and right margins, the paragraph indentation, and the vertical skip -% between paragraphs in this environment. +% between paragraphs in this environment. % The default values depend on the document class options in % effect. % @@ -279,7 +277,7 @@ % % \DescribeMacro{\absnamepos} % If the \Lopt{runin} option is not used then the heading is typeset -% in its own environment. |\absnamepos| specifies the name of the environment +% in its own environment. |\absnamepos| specifies the name of the environment % in which the abstract % name is typeset. It can be redefined to be one of |flushleft|, |center|, % or |flushright| to give a left, centered or right aligned heading; or to any @@ -292,13 +290,13 @@ % |\setlength{\abstitleskip}{-\absparindent}| \\ % will typeset the heading flush left. % -% Without the \Lopt{runin} option |\abstitleskip| is aditional vertical +% Without the \Lopt{runin} option |\abstitleskip| is aditional vertical % space (either positive % or negative) that is inserted between the abstract name and the text of % the abstract. % % \DescribeMacro{\appendiargdef} -% The (internal) command |\appendiargdef{|\meta{macro}|}{|\meta{stuff}|}| +% The (internal) command |\appendiargdef{|\meta{macro}|}{|\meta{stuff}|}| % will append % \meta{stuff} at the end of the current definition of \meta{macro}, where % \meta{macro} is the name of a macro (including the backslash) which takes @@ -327,7 +325,7 @@ % } % % -% +% % \section{The package code} \label{sec:code} % % To try and avoid name clashes, all the internal commands include @@ -340,8 +338,7 @@ % \begin{macrocode} %<*usc> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{abstract}[2009/05/23 v1.2 configurable abstracts] - +\ProvidesPackage{abstract}[2009/06/08 v1.2a configurable abstracts] % \end{macrocode} % % @@ -364,7 +361,6 @@ \@bsruninfalse \newif\if@bsstyle \@bsstylefalse - % \end{macrocode} % \end{macro} % \end{macro} @@ -382,20 +378,19 @@ \DeclareOption{style}{\@bsstyletrue} \ProcessOptions\relax % \end{macrocode} -% Disable the \Lopt{number} and \Lopt{addtotoc} option if \Lopt{style} is +% Disable the \Lopt{number} and \Lopt{addtotoc} option if \Lopt{style} is % specified. -% Make sure that the \Lopt{number} option is disabled +% Make sure that the \Lopt{number} option is disabled % if \Lopt{runin} is used (otherwise the \Lopt{addtotoc} option % may not work as expected) and also disable the \Lopt{style} option. % \begin{macrocode} \if@bsstyle\number@bsfalse\add@bstotocfalse\fi \if@bsrunin\number@bsfalse\@bsstylefalse\fi - % \end{macrocode} -% +% % \subsection{Abstracts} % -% The original definition of the |abstract| environment given in +% The original definition of the |abstract| environment given in % \file{ltclasses.dtx} is: % \par\begin{small}\begin{verbatim} % \if@titlepage @@ -408,7 +403,7 @@ % \@endparpenalty\@M % \end{center}}% % {\par\vfil\null\endtitlepage} -% \else +% \else % \renewenvironment{abstract}{% % \if@twocolumn % \section*{\abstractname}% @@ -423,7 +418,7 @@ % \fi % \end{verbatim} % \end{small}\par -% The next set of macros comprise the \Lpack{abstract} package +% The next set of macros comprise the \Lpack{abstract} package % reimplementation of the |abstract| environment. % % \begin{macro}{\abstractnamefont} @@ -434,7 +429,6 @@ % \begin{macrocode} \newcommand{\abstractnamefont}{\normalfont\small\bfseries} \newcommand{\abstracttextfont}{\normalfont\small} - % \end{macrocode} % \end{macro} % \end{macro} @@ -456,16 +450,15 @@ % \begin{macro}{\absrightindent} % \begin{macro}{\absparindent} % \begin{macro}{\absparsep} -% The abstract's text is typeset as a single item list, called +% The abstract's text is typeset as a single item list, called % |@bstr@ctlist|. These lengths set the left and right margin indents, the % paragraph indentation, and the inter-paragraph vertical space. Their % initial values are all class option-dependent. % \begin{macrocode} -\newlength{\absleftindent} +\newlength{\absleftindent} \newlength{\absrightindent} \newlength{\absparindent} \newlength{\absparsep} - % \end{macrocode} % \end{macro} % \end{macro} @@ -489,7 +482,6 @@ % \begin{macrocode} \newcommand{\@bsrunintitle}{% \hspace*{\abstitleskip}{\abstractnamefont\abstractname\@bslabeldelim}} - % \end{macrocode} % \end{macro} % @@ -509,7 +501,7 @@ % \end{macrocode} % Values for the \Lopt{twocolumn} class option. % \begin{macrocode} - \if@bsonecol + \if@bsonecol \setlength{\absleftindent}{\leftmargin} \else \setlength{\absleftindent}{\z@} @@ -531,7 +523,6 @@ \setlength{\absrightindent}{\absleftindent} \AtBeginDocument{\setlength{\absparindent}{\parindent} \setlength{\absparsep}{\parskip}} - % \end{macrocode} % % \begin{environment}{@bstr@ctlist} @@ -548,7 +539,6 @@ \parsep \absparsep}% \item\relax} {\endlist} - % \end{macrocode} % \end{environment} % @@ -563,7 +553,6 @@ \addcontentsline{toc}{chapter}{\abstractname}} \fi \fi} - % \end{macrocode} % \end{macro} % @@ -574,17 +563,15 @@ \@ifundefined{chapter}{\section{\abstractname}}{% \chapter{\abstractname}} } - % \end{macrocode} % \end{macro} % % \begin{macro}{\abstitlestyle} -% When the \Lopt{style} option is called this macro is called to typeset -% the abstract +% When the \Lopt{style} option is called this macro is called to typeset +% the abstract % heading; it should be redefined by the user to suit. % \begin{macrocode} \newcommand*{\abstitlestyle}[1]{#1} - % \end{macrocode} % \end{macro} % @@ -604,22 +591,22 @@ \if@bsrunin \else % \end{macrocode} -% If the \Lopt{runin} option is not used: +% If the \Lopt{runin} option is not used: % number the title, if called for, otherwise typeset the title in the % specified (via |\absnamepos|) environment and adjust the following vertical % spacing. % \changes{v1.2}{2009/05/22}{Made \cs{abstitleskip} behave to match the manual} % \begin{macrocode} - \if@bsstyle - \abstitlestyle{\abstractname} + \if@bsstyle + \abstitlestyle{\abstractname} \else - \ifnumber@bs - \num@bs + \ifnumber@bs + \num@bs \else - \begin{\absnamepos}% + \begin{\absnamepos}% \abstractnamefont \abstractname \@endparpenalty\@M - \end\absnamepos% + \end\absnamepos% %% \vspace{\abstitleskip}% \fi \fi @@ -644,11 +631,11 @@ \renewenvironment{abstract}{% \if@bsrunin \else - \if@bsstyle + \if@bsstyle \abstitlestyle{\abstractname} \else - \ifnumber@bs - \num@bs + \ifnumber@bs + \num@bs \else \begin{\absnamepos}\abstractnamefont\abstractname\end\absnamepos% %% \vspace{\abstitleskip}% @@ -660,19 +647,17 @@ \begin{@bstr@ctlist}\if@bsrunin\@bsrunintitle\fi\abstracttextfont}% {\par\end{@bstr@ctlist}} \fi - % \end{macrocode} % \end{environment} % % \begin{environment}{onecolabstract} -% An environment for typesetting a single column abstract, +% An environment for typesetting a single column abstract, % particularly as the optional % argument to the |\twocolumn| command. % \begin{macrocode} \newenvironment{onecolabstract}{% \begin{@twocolumnfalse}\begin{abstract}}{% \end{abstract}\end{@twocolumnfalse}} - % \end{macrocode} % \end{environment} % @@ -680,14 +665,13 @@ % |\appendiargdef{\macro}{Additional stuff}| will add |Additional stuff| at % the end of the definition of |\macro|, where |\macro| is a macro that has % one argument.\footnote{Code suggestions for this were made by Michael Downes -% (\texttt{epsmjd@ams.org}) and Heiko Oberdiek +% (\texttt{epsmjd@ams.org}) and Heiko Oberdiek % (\texttt{oberdiek@ruf.uni-freiburg.de}) on \texttt{ctt}.} % \begin{macrocode} \providecommand{\appendiargdef}[2]{\begingroup \toks@\expandafter{#1{##1}#2}% \edef\@bsx{\endgroup \def\noexpand#1####1{\the\toks@}}% \@bsx} - % \end{macrocode} % \end{macro} % @@ -695,7 +679,7 @@ % \begin{macro}{\@bs@thanks} % We have to keep the contents of the |\thanks| commands as normally these % are emptied by the |\maketitle| command. I do this by extending the definition -% of the |\thanks| (from \file{ltsect.dtx}) command, +% of the |\thanks| (from \file{ltsect.dtx}) command, % so that |\@bs@thanks| has a copy of the contents % of |\@thanks|. % \begin{macrocode} @@ -704,19 +688,17 @@ \protect\footnotetext[\the\c@footnote]{#1}}% } \let\@bs@thanks\@empty - % \end{macrocode} % \end{macro} % \end{macro} % % \begin{macro}{\saythanks} -% This macro typesets any |\thanks| commands \emph{after} using -% |onecolabstract|. +% This macro typesets any |\thanks| commands \emph{after} using +% |onecolabstract|. % \begin{macrocode} \newcommand{\saythanks}{\begingroup \renewcommand{\thefootnote}{\fnsymbol{footnote}}\@bs@thanks \endgroup\global\let\@bs@thanks\@empty} - % \end{macrocode} % \end{macro} % @@ -733,7 +715,6 @@ % \PrintIndex % \endinput - %% \CharacterTable %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z %% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z |