%% file: TXSrefs.doc - References and Citations - TeXsis version 2.18 %% @(#) $Id: TXSrefs.doc,v 18.5 2000/05/17 00:19:46 myers Exp $ %======================================================================* % (C) Copyright 1989, 1992, 1999 by Eric Myers and Frank E. Paige. % This file is a part of TeXsis. Distribution and/or modifications % are allowed under the terms of the LaTeX Project Public License (LPPL). % See the file COPYING or ftp://ftp.texsis.org/texsis/LPPL %======================================================================* \ifx\undefined\meta\texsis\input TXSdocM.doc\input Manual.aux\draft\fi \section{References and Citations \label{sect.refs}} \TeXsis\ includes instructions for making citations to the literature in the text of a document. References are processed in the standard format used by many American physics journals: they are automatically assigned consecutive numbers as they appear in the text and are listed in numerical order at the end of the document. In the text a citation appears as a superscript number corresponding to the reference cited, though other methods of citation are possible (see Section~\use{sect.cite}). When each reference is defined it is given a \idx{label}, which is associated with the number assigned to the reference. Subsequent citations to the same reference are made using this label, so there is no need to know the particular number assigned to the reference. Indeed, the number may change as the document goes through editing and revision, \index{references}\index{citations|see{references}} but the references will still automatically be in the correct order. \subsection{Entering References} \TeXsis\ is flexible enough that the text of the references may be entered in two different ways, either all references at once at the beginning of the document or each one individually at the point in the text where the work is first cited. In either case, \TeXsis\ stores the text of all of the references in numerical order until it is asked to print the list at the end of the document, by saying \cs{ListReferences}. To make a citation to a new reference and to enter the text of the reference, use the command \CS{reference}\arg{label}, where \meta{label} is the label to be used to refer to this reference. This is followed by the text of the reference, which is terminated by \cs{endreference}. An example is: \TeXexample To this end we will follow Feynman\reference{Feynman, 1949} R.P.~Feynman, Phys.\ Rev.\ \vol{76}, 749 (1949) \endreference in developing the propagator approach. |endTeXexample \noindent This would appear in the text of the document as, \example To this end we will follow Feynman\reference{Feynman, 1949} R.P.~Feynman, Phys.\ Rev.\ \vol{76}, 749 (1949) \endreference in developing the propagator approach. \endexample and the text of the reference would be saved until the list of references is printed at the end of the document. If you look at the end of this manual you will see it. There are several things to take note of in the example above. Most importantly, there is no space between the word in the text where the citation is made ("Feynman")\index{Feynman, Richard P.} and the \CS{reference}. This is so the superscript reference number will appear in the text right after the word to which the citation is attached, with no intervening space. Note also in the reference text the tie (|~|) between the initials and the name, the control spaces (\hbox{\tt\bs\ }) after the abbreviations, and the use of the \CS{vol} macro for the volume number; \CS{vol}\arg{number} prints the volume \meta{number} with an underscore below it. (This is easier to read than boldfaced volume numbers on small laser printers, but if you prefer something else you can simply redefine the \CS{vol} macro). Similarly, \CS{booktitle}\arg{title} will print the title of a book, in slanted type. Finally, note that there is no punctuation at the end of the reference text. This is because \TeXsis\ automatically supplies the appropriate punctuation when it prints the list of references. Normally this will simply be a period (.), but it is possible to have multiple references assigned to the same reference number, in which case the references are separated by semi-colons, with the last reference terminated by a period. How to do this is described below. Since typing the text of a journal citation is somewhat complicated, the \CS{journal} macro was created to make things a little easier. The format is \example |\journal| \meta{journal name}|;|\meta{volume}|,|\meta{page number}% |(|\meta{year}|)| \endexample This constructs the journal citation for you, with periods automatically replaced by ``\hbox{\tt .\bs\char`\ }'' in abbreviations and the volume number underlined for you by |\vol|. It is important that the field separators (the semi-colon, the comma and the parentheses), all be present and in the right order or \TeX\ will look as far forward as it takes to find the next one it wants. There should be no extra spaces between the arguments. Besides making it a little easier to type a citation to a journal article, using \CS{journal} lets you switch from the American form of citation to the European form very easily. In the American form the page number follows the volume, followed by the year in parentheses. In the European form the year follows the volume number and the the page number comes after that. Normally \TeXsis\ uses the American form, but you can change to the European form simply by saying \example \CS{Eurostyletrue} \endexample The arguments to \CS{journal} are always in the American order, no matter how they are eventually printed. A number of abreviations which are commonly used in references and which are usually set in italics are defined as simple control words. Thus saying \CS{cf} produces ``\cf'', saying \CS{etal} produces ``\etal'', saying \CS{ie} produces ``\ie'', and saying \CS{ibid} produces ``\ibid'' Sometimes you want to print the title of a journal article, and sometimes you don't. An easy way to control this is to enter the title using \CS{ArticleTitle}, as in\index{Schwinger, Julian} \TeXexample \reference{Schwinger, 1951} J.~Schwinger, \ArticleTitle{On Gauge Invariance and Vacuum Polarization} \journal Phys. Rev.;82,664(1951) \endreference |endTeXexample Then if you say \CS{ShowArticleTitletrue}, the title will be printed (in slanted type, with a trailing comma), but with \CS{ShowArticleTitlefalse} (the default) it will not. \bigskip To enter several references with the same reference number simply begin the next \CS{reference} immediately after the previous \cs{endreference}, and begin the labels of all but the first reference with an asterisk "|*|", as in the following example: \TeXexample The vacuum polarization term can be regularized by introducing a cut-off at high frequencies.\reference{Pauli and Villars, 1949} W.~Pauli and F.~Villars, \journal Rev. Mod. Phys.;21,434(1949) \endreference \reference{*Schwinger, 1948} J.~Schwinger, \journal Phys. Rev.;74,1439(1948) \endreference |endTeXexample This produces the single citation \index{Schwinger, Julian}\index{Villars, F.}\index{Pauli, W.}% \example The vacuum polarization term can be regularized by introducing a cut-off at high frequencies.\reference{Pauli and Villars, 1949} W.~Pauli and F.~Villars, \journal Rev. Mod. Phys.;21,434(1949) \endreference \reference{*Schwinger, 1948} J.~Schwinger, \journal Phys. Rev.;74,1439(1948) \endreference \endexample The "|*|"\index{*@{\tt *}'d citations} at the beginning of the second label tells \TeXsis\ not to assign a new reference number to this reference, but instead just to add it to the text of the previous one. Of course you could type the text of both references between one \cs{reference} and \cs{endreference}. An advantage to following the example above is that the second reference can be given a reference number of its own simply by deleting the "|*|" at the beginning of the label. Similarly, two references with different reference numbers can be lumped together into one citation by inserting a "|*|" in front of the label of the second reference. Another advantage to keeping the references separate is that it is easy to move references around, either within a document that is being revised or between documents. It is therefore recommended that each reference be entered separately, although this is obviously not required. Instead of putting the \cs{reference} \dots \cs{endreference} in the text it may be more convenient to type them all together, especially if they already appear that way in the manuscript. This can be done without producing any unwanted printed numbers by using \index{references!entering a list} \example\obeylines \CS{referencelist} |\reference{1}| {\it text 1...} |\endreference | |\reference{2}| {\it text 2...} |\endreference | |...| |\reference{last}| {\it last text...} |\endreference| \cs{endreferencelist} \endexample The \CS{referencelist} must appear at the beginning of the document, so that the reference labels are defined before they are used. This is best put into a separate file which is \cs{input} by the master file. Of course the list of references is not printed until the end of the document, when \cs{ListReferences} is called. \subsection{Citations to Defined References} All subsequent citations to a previously defined reference are made using its label. If a \CS{referencelist} is used, then \undertext{all} citations appearing in the text will be made in this way, since then the initial reference definitions print nothing. The construction \CS{cite}\arg{label} prints the reference number corresponding to the label as a superscript. For example, \TeXexample A good discussion of this is given by Doob\cite{Doob} in section~7. |endTeXexample produces \example A good discussion of this is given by Doob\cite{Doob} in section 7. \endexample since Michael Doob's\index{Doob, Michael} book \booktitle{A Gentle Introduction to \TeX} is in fact \Ref{Doob} of this document and has the label "|Doob|." If several \CS{cite}'s are given in succession then the corresponding numbers are printed separated by commas. Unlike \cs{reference}, which defines the reference numbers, \CS{cite} does not know if references are sequential, so it cannot replace a sequence of numbers by a range. To avoid a long sequence of reference numbers use instead \CS{citerange}\arg{first label}\arg{last label} to print the numbers corresponding to the first and last labels as a range. The construction \CS{Ref}\arg{label} produces ``Ref.~$nn$'' in the text, with $nn$ the number of the reference corresponding to the label. For example, the ``\Ref{Doob}'' in the previous paragraph was typed into the manuscript file as |\Ref{Doob}|. \CS{Ref} is simply shorthand for |Ref.~\use{Ref.|\