Received: by nummer-3.proteosys id <01C19443.AA5E0124@nummer-3.proteosys>; Thu, 3 Jan 2002 11:44:48 +0100 Return-Path: MIME-Version: 1.0 Content-Type: multipart/alternative; boundary="----_=_NextPart_001_01C19443.AA5E0124" x-vm-v5-data: ([nil nil nil nil nil nil nil nil nil][nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil]) X-MimeOLE: Produced By Microsoft Exchange V6.5 Content-class: urn:content-classes:message Subject: Short form stuff: illustrative documentation, part 1 Date: Wed, 6 May 1992 16:02:41 +0100 Message-ID: X-MS-Has-Attach: X-MS-TNEF-Correlator: From: Sender: "Mailing list for the LaTeX3 project" To: "Rainer M. Schoepf" Reply-To: "Mailing list for the LaTeX3 project" Status: R X-Status: X-Keywords: X-UID: 705 This is a multi-part message in MIME format. ------_=_NextPart_001_01C19443.AA5E0124 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable \documentstyle[11pt,references]{report} \sloppy \begin{document} \title{Short form citations:\\ how a manual might describe \\ the suggested user interface} \author{David Rhead} \date{May 1992} \maketitle \pagenumbering{roman} \tableofcontents \clearpage \pagenumbering{arabic} \dots\ improvements \dots\ major differences from \LaTeX\ 2.09 \dots\ = (see Appendix \ref{old-friends}) \dots\ unless otherwise stated, references = to ``\LaTeX'' mean \LaTeX\ 3 \dots\ \\[20mm] \dots\ ``maps'' a structure to a design \dots\ \\[20mm] \dots\ local ``supplementary documentation'' directory \dots\ \\[20mm] \dots\ local ``examples'' directory \dots\ \\[20mm] \dots\ \verb+\footnote+ \dots\ . Similarly, \dots\ \verb+\endnote+ = \dots \setcounter{chapter}{6} \chapter{\dots} \section{Cross-references} \label{cross-refs} \chapter{Bibliographic references} \label{bib-refs} \section{Background and terminology} You may need to prepare a document that cites other documents. Most disciplines use citation systems in which the running text gives = brief references to the sources consulted, and the document's ``end matter'' contains a detailed list of those sources. \LaTeX\ supports three of these standard citation systems: \begin{itemize} \item reference by number, in which text references take the form of superscript or bracketed numbers which correspond to numbers shown in the reference-list. \item author-date, in which a text reference generally uses the author's surname and the year of publication, and the reference-list is = arranged in alphabetical order of surnames. \item short form, in which the first text reference to a particular = source (or the first reference from a particular chapter) gives fairly full bibliographical details, but subsequent text references use a short = form (e.g., the author's surname and an abbreviated title). This system = is often used in the humanities, where references usually appear in = footnotes (or endnotes). The corresponding reference-list may be organized = according to the type of reference (for example, with all ``unpublished = manuscripts'' grouped together). \end{itemize} Although most documents just use one citation system, there are circumstances (see section \ref{multiple-systems}) under which two or = three citation systems may be used in parallel. \section{Reference-lists} Most citation systems involve a reference-list, which provides the = details needed to identify and locate the cited documents. You may also wish to provide a list of documents (for example, as ``further reading'') to = which you have {\em not\/} referred in your running text. The {\tt reflist} environment is provided for such purposes. To use = {\tt reflist}, you must supply your reference-list entries as ``paragraphs'' within \verb+\begin{reflist}+ and \verb+\end{reflist}+. As with other aspects of your document, the layout of a {\tt reflist} will depend on = the \dots\ % mapping file? you have chosen. (Most \dots\ % mapping files? lay reference-list entries out as ``hanging paragraphs''.) If you wish to use {\tt reflist} for documents that you have {\em not} cited in your running text, you can simply supply reference-list entries separated by blank lines, thus: \begin{verbatim} \section{Further reading} \begin{reflist} {\sc Crane, D.} {\it Invisible colleges.} Chicago: University of Chicago Press, 1972. {\sc Stieg, M. F.} {\it The information needs of historians.} {\it College and Research Libraries}, Nov.\ 1981, {\bf 42}(6), p.\ 549--560. \end{reflist} \end{verbatim} However, if your reference-list is intended as a consolidated list of = all the works cited from your running text, you will probably find it more convenient to put appropriate \verb+\...entry+ commands in a {\tt = reflist} (see below). \section{References from running text: general approach} \LaTeX's general approach to text references is the same whichever of = the three standard citation systems you use: \begin{itemize} \item A \verb+\...entry+ command is available with which you can: \begin{itemize} \item provide the text that is to appear in your reference-list \item if necessary, specify the details needed for text references. (No such details are needed for the reference by number system.) \item declare a ``key'' that will be used to determine which reference-list entry corresponds to a particular text reference. A key can consist of any sequence of letters, digits and punctuation characters, with the = exception of comma (,). \end{itemize} \item One or more \verb+\...cite+ commands are provided with which you = can make text references. For author-date and short form systems, the citation produced will be based on the information you supply in = the corresponding \verb+\...entry+. \end{itemize} (Here \verb+\...entry+ and \verb+\...cite+ are used to indicate various commands whose full names are given in sections \ref{ref-by-number}, \ref{author-date} and \ref{short-form} below.) Thus, whatever your citation scheme, your \LaTeX\ input will have the following structure: \begin{raggedright}\begin{tt} \dots \\[\baselineskip] \dots\ \verb+\...cite{+{\it key\/}\verb+}+ \dots \\[\baselineskip] \dots \\[\baselineskip] \verb+\begin{reflist}+ \\[\baselineskip] \dots \\[\baselineskip] \verb+\...entry{+{\it key\/}\verb+}{+ \dots\ \verb+}+ \\[\baselineskip] \dots \\[\baselineskip] \verb+\end{reflist}+ \\[\baselineskip] \end{tt}\end{raggedright} Given such a structure, \LaTeX\ can: \begin{itemize} \item for the reference by number system, ensure that each text = reference has the same number as the corresponding reference-list entry \item for the other systems, use details taken from a \verb+\...entry+ when a text reference is required. The details only need supplying once, in the \verb+\...entry+. All text references to a particular source will be consistent, since the details will be taken from the same \verb+\...entry+. \end{itemize} \LaTeX\ will also warn you if you make a text reference to a source = without having supplied a reference-list entry for that source. The procedure used for passing details between a \verb+\...cite+ command and the corresponding \verb+\...entry+ command is a two-pass one, like = that for resolving cross-references (see section \ref{cross-refs}). Hence, \dots \section{Reference by number} \label{ref-by-number} \dots\ order of first citation \dots\ \verb+\numcite+ \dots\ \verb+\numentry+ \dots % knows width, so can set hanging indent? \section{Author-date} \label{author-date} \dots\ \verb+\aycite+ \dots\ \verb+\ycite+ \dots\ \verb+\ayentry+ \dots \section{Short form} \label{short-form} \subsection{Basic facilities} The standard \dots\ % mapping files? provide the following commands to support the short form scheme: \begin{itemize} \item \verb+\sfentry+, with specification\\ \verb+\sfentry{+{\it key\/}\verb+}{+{\it = first-text-ref\/}\verb+}{+{\it later-text-ref\/}\verb+}{+{\it ref-list-entry\/}\verb+}+\\ where: \begin{description} \item[{\it key}] is the key that, when used by text reference = commands, identifies the particular \verb+\sfentry+ command which provides = the information needed \item[{\it first-text-ref}] is the form of text reference to be used when you first cite the document identified by {\it key} (or for = your first citation from a particular chapter) \item[{\it later-text-ref}] is the short form to be used for = subsequent citations of the document identified by {\it key} \item[{\it ref-list-entry}] is to be used as the document's = reference-list entry. (Thus, locally, the effect of a sequence of = \verb+\sfentry+ commands within a {\tt reflist} environment is as if each = \verb+\sfentry+ command had been replaced by its {\it ref-list-entry\/}.) \end{description} \item \verb+\firstcite+, for use when you make your first text reference to a particular source (or your first reference from a particular chapter). You will refer to the source by means of the = {\it key} you chose for its \verb+\sfentry+ command. In your typeset document, = the \verb+\firstcite+ will be replaced by the {\it first-text-ref\/} that = you supplied in the corresponding \verb+\sfentry+. \item \verb+\latercite+, for use when you make your second or subsequent text reference to a particular source. In your typeset document, the command will be replaced by the {\it later-text-ref\/} supplied in the corresponding \verb+\sfentry+. \end{itemize} ------_=_NextPart_001_01C19443.AA5E0124 Content-Type: text/html; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Short form stuff: illustrative documentation, part 1

\documentstyle[11pt,references]{report}

\sloppy

\begin{document}

\title{Short form citations:\\
how a manual might describe \\
the suggested user interface}
\author{David Rhead}
\date{May 1992}
\maketitle

\pagenumbering{roman}
\tableofcontents
\clearpage
\pagenumbering{arabic}


\dots\ improvements \dots\ major differences from = \LaTeX\ 2.09 \dots\ (see
Appendix \ref{old-friends})  \dots\ unless = otherwise stated, references to
``\LaTeX'' mean \LaTeX\ 3 \dots\ \\[20mm]

\dots\ ``maps'' a structure to a design \dots\ = \\[20mm]

\dots\ local ``supplementary documentation'' directory = \dots\ \\[20mm]

\dots\ local ``examples'' directory \dots\ = \\[20mm]

\dots\ \verb+\footnote+ \dots\ .  Similarly, = \dots\ \verb+\endnote+ \dots

\setcounter{chapter}{6}
\chapter{\dots}

\section{Cross-references}
\label{cross-refs}

\chapter{Bibliographic references}
\label{bib-refs}

\section{Background and terminology}

You may need to prepare a document that cites other = documents.

Most disciplines use citation systems in which the = running text gives brief
references to the sources consulted, and the = document's ``end matter''
contains a detailed list of those sources.  = \LaTeX\ supports three of
these standard citation systems:
\begin{itemize}
\item reference by number, in which text references = take the form of
   superscript or bracketed numbers which = correspond to numbers
   shown in the reference-list.
\item author-date, in which a text reference = generally uses the author's
   surname and the year of publication, and = the reference-list is arranged
   in alphabetical order of = surnames.
\item short form, in which the first text reference = to a particular source
   (or the first reference from a = particular chapter) gives fairly full
   bibliographical details, but subsequent = text references use a short form
   (e.g., the author's surname and an = abbreviated title).  This system is
   often used in the humanities, where = references usually appear in footnotes
   (or endnotes).  The corresponding = reference-list may be organized according
   to the type of reference (for example, = with all ``unpublished manuscripts''
   grouped together).
\end{itemize}

Although most documents just use one citation system, = there are
circumstances (see section \ref{multiple-systems}) = under which two or three
citation systems may be used in parallel.

\section{Reference-lists}

Most citation systems involve a reference-list, which = provides the details
needed to identify and locate the cited = documents.  You may also wish to
provide a list of documents (for example, as = ``further reading'') to which
you have {\em not\/} referred in your running = text.

The {\tt reflist} environment is provided for such = purposes.  To use {\tt
reflist}, you must supply your reference-list entries = as ``paragraphs''
within \verb+\begin{reflist}+ and = \verb+\end{reflist}+.  As with other
aspects of your document, the layout of a {\tt = reflist} will depend on the
\dots\
%  mapping file?
you have chosen.  (Most \dots\
%  mapping files?
lay reference-list entries out as ``hanging = paragraphs''.)

If you wish to use {\tt reflist} for documents that = you have {\em not}
cited in your running text, you can simply supply = reference-list entries
separated by blank lines, thus:
\begin{verbatim}
\section{Further reading}

\begin{reflist}

{\sc Crane, D.} {\it Invisible colleges.}
Chicago: University of Chicago Press, 1972.

{\sc Stieg, M. F.} {\it The information needs of = historians.}
{\it College and Research Libraries}, Nov.\ 1981, = {\bf 42}(6),
p.\ 549--560.

\end{reflist}
\end{verbatim}

However, if your reference-list is intended as a = consolidated list of all
the works cited from your running text, you will = probably find it more
convenient to put appropriate \verb+\...entry+ = commands in a {\tt reflist}
(see below).

\section{References from running text:  general = approach}

\LaTeX's general approach to text references is the = same whichever of the
three standard citation systems you use:
\begin{itemize}
\item A \verb+\...entry+ command is available with = which you can:
      \begin{itemize}
      \item provide the text = that is to appear in your reference-list
      \item if necessary, = specify the details needed for
          &nbs= p; text references.  (No such details are needed for the
          &nbs= p; reference by number system.)
      \item declare a = ``key'' that will be used to determine
          &nbs= p; which reference-list entry corresponds to a particular
          &nbs= p; text reference.  A key can consist of any sequence of
          &nbs= p; letters, digits and punctuation characters, with the exception
          &nbs= p; of comma (,).
      \end{itemize}
\item One or more \verb+\...cite+ commands are = provided with which you can
      make text = references.  For author-date and short form systems, the
      citation produced will = be based on the information you supply in the
      corresponding = \verb+\...entry+.
\end{itemize}
(Here \verb+\...entry+ and \verb+\...cite+ are used = to indicate various
commands whose full names are given in sections = \ref{ref-by-number},
\ref{author-date} and \ref{short-form} below.)

Thus, whatever your citation scheme, your \LaTeX\ = input will have the
following structure:

\begin{raggedright}\begin{tt}

\dots \\[\baselineskip]

\dots\ \verb+\...cite{+{\it key\/}\verb+}+ \dots = \\[\baselineskip]

\dots \\[\baselineskip]

\verb+\begin{reflist}+ \\[\baselineskip]

\dots \\[\baselineskip]

\verb+\...entry{+{\it key\/}\verb+}{+ \dots\ \verb+}+ = \\[\baselineskip]

\dots \\[\baselineskip]

\verb+\end{reflist}+ \\[\baselineskip]

\end{tt}\end{raggedright}

Given such a structure, \LaTeX\ can:
\begin{itemize}
\item for the reference by number system, ensure that = each text reference
     has the same number as the = corresponding reference-list entry
\item for the other systems, use details taken from a = \verb+\...entry+
     when a text reference is = required.  The details only need
     supplying once, in the = \verb+\...entry+.  All text references to a
     particular source will be = consistent, since the details will be
     taken from the same = \verb+\...entry+.
\end{itemize}
\LaTeX\ will also warn you if you make a text = reference to a source without
having supplied a reference-list entry for that = source.

The procedure used for passing details between a = \verb+\...cite+ command
and the corresponding \verb+\...entry+ command is a = two-pass one, like that
for resolving cross-references (see section = \ref{cross-refs}).  Hence,
\dots

\section{Reference by number}
\label{ref-by-number}

\dots\ order of first citation \dots\ \verb+\numcite+ = \dots\
\verb+\numentry+ \dots
%  knows width, so can set hanging = indent?

\section{Author-date}
\label{author-date}

\dots\ \verb+\aycite+ \dots\ \verb+\ycite+ \dots\ = \verb+\ayentry+ \dots

\section{Short form}
\label{short-form}

\subsection{Basic facilities}

The standard \dots\
%  mapping files?
provide the following commands to support the short = form scheme:
\begin{itemize}
\item  \verb+\sfentry+, with = specification\\
   \verb+\sfentry{+{\it key\/}\verb+}{+{\it = first-text-ref\/}\verb+}{+{\it
   later-text-ref\/}\verb+}{+{\it = ref-list-entry\/}\verb+}+\\
   where:
   \begin{description}
   \item[{\it key}] is the key that, when = used by text reference commands,
      identifies the = particular \verb+\sfentry+ command which provides the
      information = needed
   \item[{\it first-text-ref}] is the form = of text reference to be used
      when you first cite = the document identified by {\it key} (or for your
      first citation from a = particular chapter)
   \item[{\it later-text-ref}] is the short = form to be used for subsequent
      citations of the = document identified by {\it key}
   \item[{\it ref-list-entry}] is to be = used as the document's reference-list
      entry.  (Thus, = locally, the effect of a sequence of \verb+\sfentry+
      commands within a {\tt = reflist} environment is as if each \verb+\sfentry+
      command had been = replaced by its {\it ref-list-entry\/}.)
   \end{description}
\item \verb+\firstcite+, for use when you make your = first text
   reference to a particular source (or = your first reference from a
   particular chapter).  You will = refer to the source by means of the {\it key}
   you chose for its \verb+\sfentry+ = command.  In your typeset document, the
   \verb+\firstcite+ will be replaced by = the {\it first-text-ref\/} that you
   supplied in the corresponding = \verb+\sfentry+.
\item \verb+\latercite+, for use when you make your = second or
   subsequent text reference to a = particular source.  In your typeset
   document, the command will be replaced = by the {\it later-text-ref\/}
   supplied in the corresponding = \verb+\sfentry+.
\end{itemize}

------_=_NextPart_001_01C19443.AA5E0124--