diff options
author | Karl Berry <karl@freefriends.org> | 2006-01-09 00:49:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-01-09 00:49:07 +0000 |
commit | 007f67a693e4d031fd3d792df8e4d5f43e2cb2e7 (patch) | |
tree | 90d17e00e572ecb1e24764b6f29c80e098b08d29 /Master/texmf-dist/doc/latex/natbib | |
parent | 950209b26f70aa87ed07c54f82a95b6f03b7c3a0 (diff) |
doc/latex
git-svn-id: svn://tug.org/texlive/trunk@84 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/natbib')
-rw-r--r-- | Master/texmf-dist/doc/latex/natbib/README.1st | 36 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/natbib/README.v71 | 401 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/natbib/natnotes.tex | 332 |
3 files changed, 769 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/natbib/README.1st b/Master/texmf-dist/doc/latex/natbib/README.1st new file mode 100644 index 00000000000..1d44a64310e --- /dev/null +++ b/Master/texmf-dist/doc/latex/natbib/README.1st @@ -0,0 +1,36 @@ + What is NATBIB? + +It is a LaTeX (2e, with some support for 2.09) package to act as generalized +interface for standard and non-standard bibliographic style files (BibTeX). + +It is intended primarily to produce author-year style citations from a variety +of non-standard .bst outputs; it therefore replaces the special and individual +packages that go along with such .bst files: + apalike.sty for apalike.bst et al. + newapa.sty newapa.bst, + chicago.sty chicago.bst, named.bst et al. + harvard.sty agsm.bst, dcu.bst, kluwer.bst et al. + astron.sty astron.bst, apa.bst, humanbio.bst, et al. + authordate<n>.sty authordate<n>.bst, aaai-named.bst + +The above .bst files may also be used with natbib to produce author-year or +numerical citations, so that switching from author-year to numerical is only +a matter of selecting an option. + +The standard .bst files (plain et al) and other numerical citation .bst files +are also understood, but they can produce only numerical citations. +Replacement .bst files + plainnat.bst + abbrvnat.bst + unsrtnat.bst +are provided to produce the same formatting of the reference list as the +standard equivalent, but allowing both author-year and numerical citations. + +See my parallel custom-bib system for generating customized bst files. + +For installation instructions and more details, see README.vxx. + +Patrick W. Daly +Max-Planck-Institut f\"ur Aeronomie +D-37191 Katlenburg-Lindau, Germany +E-mail: daly@linmpi.mpg.de diff --git a/Master/texmf-dist/doc/latex/natbib/README.v71 b/Master/texmf-dist/doc/latex/natbib/README.v71 new file mode 100644 index 00000000000..96012c66efd --- /dev/null +++ b/Master/texmf-dist/doc/latex/natbib/README.v71 @@ -0,0 +1,401 @@ + NATBIB Package + +Version 7.1 (See list of changes below) + The bst files have been upgraded to contain + doi and eid fields for electronic journals + +This is the natbib package for handling both author-year and numerical +BibTeX styles. It contains the following files: + natbib.dtx -- Documented source file that may be LaTeXed to get the + detailed description and/or coding documentation; needs + ltxdoc class distributed with LaTeX2e. + + May be docstripped with option `package,all' to get the + natbib.sty package file, or with `package,all,209' to obtain + a LaTeX 2.09 style file. + + natbib.ins -- A docstrip batch job to extract natbib.sty and natnotes.tex + from the source file natbib.dtx. + Simply TeX or LaTeX this file. + + This file can be extracted from natbib.dtx when it is + LaTeXed and natbib.ins does not already exist. + + plainnat.bst -- Replacements for plain.bst, abbrv.bst, unsrt.bst, the + abbrvnat.bst standard BibTeX bib style files. These replacements + unsrtnat.bst permit both numerical and author-year citations + + bibentry.dtx -- Documented source file for the bibentry package, defines + \bibentry{key} command that place the bibliography entry + in the text. Useful for descriptive bibliographies. + + bibentry.ins -- The installation file for bibentry. Just TeX or LaTeX it. + +Installation:- Simply run TeX or LaTeX on natbib.ins, which extracts +~~~~~~~~~~~~~~ natbib.sty from the documented source natbib.dtx. You + may first edit natbib.ins if you want natbib209.sty and/or + natbib.drv, the configurable documentation driver. If + natbib.ins has been lost, it may be regenerated by running + LaTeX on natbib.dtx. + + Natbib.ins also extracts the reference sheet source + file, natnotes.tex. + + For the bibentry package, TeX or LaTeX bibentry.ins, + which extracts bibentry.sty. + +Documentation:- Run LaTeX on natbib.dtx or natbib.drv. The latter may be +~~~~~~~~~~~~~~~ edited as needed to conform to local requirements (paper + size, duplex or not, with or without entire coding). + Alternatively, a ltxdoc.cfg file can contain local + configurations. + + Similarly for bibentry: LaTeX the bibentry.dtx file. + +Reference Sheet:- Run LaTeX on natnotes.tex (extracted from natbib.dtx when +~~~~~~~~~~~~~~~~~ natbib.dtx was processed). This is a 5 page summary of + the main natbib features. + +The package will accept BibTeX output in the forms: + \bibitem{key} (standard numerical format) + +or the following author-year formats: + \bibitem[Jones et al.(1990)]{key}... (native natbib style) + \bibitem[Jones et al.(1990)Jones, Baker, and Williams]{key}... + (extended natbib 5.3 style) + + \bibitem[Jones et al., 1990]{key}... (apalike style) + \bibitem[\protect\citeauthoryear{Jones, Baker, and Williams}{Jones + et al.}{1990}]{key}... (newapa or chicago styles) + \bibitem[\protect\citeauthoryear{Jones et al.}{1990}]{key}... (named style) + \bibitem[\protect\astroncite{Jones et al.}{1990}]{key}... (astron style) + \bibitem[\protect\citename{Jones et al., }1990]{key}... (authordate style) + \harvarditem[Jones et al.]{Jones, Baker, and Williams}{1990}{key}... + (harvard style) + +These are all the existing interfaces for author-year format that I could +find. Natbib.sty accepts them all, and converts them into its own system. + +Use \citet for in-text form and \citep for parenthetical citations: + \citet{key} ==>> Jones et al. (1990) (in-text form) + \citep{key} ==>> (Jones et al., 1990) (parenthetical form) + + \citep{key1,key2} ==>> (Jones et al., 1990, 1992) + (multiple citations; common authors suppressed) + \citep[chap. 2]{key} ==>> (Jones et al., 1990, chap. 2) + \citep[see][]{key} ==>> (see Jones et al., 1990) + \citep[see][chap. 2]{key} ==>> (see Jones et al., 1990, chap. 2) + +All \cite's may also take a starred version to print the full +author list, if that is supported by the bib style file. + \citet*{key} ==>> Jones, Baker, and Williams (1990) + +Other citing commands + \citeauthor{key} ==>> Jones et al. + \citeauthor*{key} ==>> Jones, Baker, and Williams + \citeyear{key} ==>> 1990 + \citeyearpar{key} ==>> (1990) + +With numerical citations, + \citep{key} ==>> [23] like standard \cite command + \citet{key} ==>> Jones et al. [23] + +For a name like von Braun or della Robbia, coming at the start of a sentence, +use \Citet for Von Braun and Della Robbia. Also \Citep, \Citeauthor exist. + +Citation aliasing, + \defcitealias{key}{text} + \citetalias{key} ==>> text + \citepalias{key} ==>> (text) +(With the hyperref package, these will be proper links to the reference list) + +Punctuation may be altered with \bibpunct command (see comments and + examples in natbib.sty and natbib.dtx) + +Or may be specified with options to the \usepackage{natbib} command. + +Punctuation styles may be set for given .bst file and then invoked by the +\bibliographystyle command. This requires making a simple (and legitimate) +addition to natbib.sty, or creating a local configuration file natbib.cfg to +contain the additions. + +For full details, print out the documentation in natbib.dtx by LaTeXing it. + +------------------------------------------------------------------------- +List of changes + v7.1 Add warning when multiple citations with common authors and year + are missing distinguishing extra letter. + + Modify plainnat.bst et al to include new fields: + doi (Digital Object Identifier) + eid (Electronic Identifier) + The eid is the article sequence number used in place of page numbers + for the print version of electronic journals, such as Phys. Rev. + + v7.0b Fix superscript bug + + v7.0a Fix bug in \citenumfont so it works with \textit as well as \it + Fix bug with the index.sty package which caused vertical shifts + under certain circumstances. + + v7.0 Fix bug with \bibpunct and all the predefined citation styles + that use it; blank was missing after post-note punctuation. + + Add \citenumfont and \bibnumfmt to format the citation numbers and + numbers in the reference list, respectively. + + Support for authorless works: replace the author in \bibitem with and + code and leave the date blank, as + \bibitem[ABC98()]{wxyz98} + Then \citet{wxyz98} ==>> ABC98 + \citep{wxyz98) ==>> (ABC98) + ie, not only is the date left off, but the punctuation and (for + \citet) the braces as well. + + Most author-year bst files insert the text of the KEY field in place + of the author if there is no author or editor. The (revised) natbib + bst's do this too, but also leave off the date. Thus the KEY text + becomes the replacement for author-year. + + \Citet, \Citep, \Citealp, \Citealt, \Citeauthor capitalize first + letter of first author's name in case it begins with von or de and + comes at the start of a sentence. + + With amsbook, now uses \chapter* instead of erroneous \section*. + + v6.9a Fix bugs with babel 3.6t (earlier versions of babel will not work + well with this natbib version). Order of loading is unimportant. + + Add \bibpreamble to allow user to define a preamble to the list of + references. + + Fix bug that occurred when optional notes to \cite's began with a + command like \S. + + v6.9 The \makeindex can be issued before \usepackage{natbib} + + Add \defcitealias, \citetalias, \citepalias to define and print + some identifying code text for the citation: + \defcitealias{key}{TEXT} then \citepalias{key} => (TEXT) + + The character coming between the citation and following note is + specified by the optional argument to \bibpunct; this must now + include a space if that is wanted. The default is now {, } where it + was previously {,}. + + Copyright notices in all files (even .bst's) conform to LaTeX Project + Public Licence. + + v6.8c Exclude notes, punctuation, both braces from the hyperref link text. + + Add nonamebreak option to prevent line breaks within author names. + + v6.8b Add chapterbib compatibility for hyperref and backref packages + (in arrangement with Sebastian Rahtz) + + With hyperref, links are broken between author name and date, to + prevent some possible pdftex problems. + + v6.8a Fix some problems with redefinition of \@biblabel + + v6.8 Allow user to be able to redefine \@biblabel for numerical mode + + Fix bug with hyperref package; previously failed with \citep and + multiple citations with repeated authors + + Allow cites within cites, as \citep[cited in \citealp{xx}]{yy} + (previously these clashed and final brace was missing) + + \citealp and \citealt suppress parenthese in numerical mode too + + Add \citetext{..} to produce citations manually, with help + of \citealp, such as + \citetext{see \citealp{AA}, or better \citealp{BB}} + + v6.7 Option `longnamesfirst' causes first citation of any reference to use + the full author list. + + In numerical mode, \citet with multiple citations suppresses + repeated authors, Jones et al. [21, 22]. + + A bug is fixed that caused problems with the showkeys package and + its `final' option. + + A clash with babel's active characters is fixed up. + + A reference sheet is available, consisting (mainly) of selected text + from the main documentation. Source file is natnotes.tex, extracted + from natbib.dtx with option `notes'. + + v6.6 Options `sort' and `sort&compress' order multiple citations in one + \citep or \citet command to be in the sequence in which they appear + in the list of references; this is normally ordered alphabetically + and then by year. + + Fix functionality with showkeys and hyperref packages + + Fix \nocite so that warning messages are not always printed with + chapterbib package + + All \cite... commands coded from a basic one so that they all have the + same syntax: notes and multiple citations always possible, but may not + always be meaningful. + + Add \citeyearpar to print year in parentheses; add \citeauthor* to + be equivalent to \citefullauthor. + + Package showkeys must be loaded after natbib (this is not an improvement, + but seems unavoidable). + + v6.5 Made compatible with KOMA scripts by adding \bib@heading to the + definition of thebibliography environment + + change documentation to stress \citet and \citep instead of old + syntax with \cite and \cite[]; now both these commands can also + take optional arguments for notes, before and after ref. + + v6.4 Made compatible with the chapterbib package of Donald Arseneau + which allows multiple bibliographies in one document + + Contains modified coding from Arseneau's cite package to allow + numerical citations to be sorted and compressed + + Made compatible with the hyperref package of Sebastian Rahtz and + Yannis Haralambous, for use with HyperTeX + + Multiple superscript citations have no space between them + + v6.3 The package `showkeys' used to have some problems when loaded + before natbib; this is now repaired + + The supplied .bst files have a bug fixed so that the extra letters + added to the dates function properly; they are now added when the + abbreviated author list and date are the same for more than one + reference (previously the full author list and date determined this, + which is incorrect) + + With numerical citations, the extra letters are superfluous; these can + now be suppressed with the supplied .bst files + + v6.2 Adds \citet for textual citations in both author-year and numerical + modes. + + Adds \bibsep as a length that goes between lines of the reference list + Can be changed with \setlength + + Fixes the superscript style of numerical references so that the + numbers are the proper (smaller) size + + Fixes a clash with the classes amsart and amsbook + + v6.1 The LaTeX update of December 1995 contains some changes to internal + command which natbib has used. Natbib needs to be altered accordingly. + In fact, it has been made far more robust against any such future + interal changes, although not 100%. + + There are no changes to the user interface. + + V6.0 New method for parsing the author and year parts, which is now done + before writing the information to the auxiliary file. This allows + numerical citations to be used even with author-year bst files. + (Numerical bst files can NEVER generate author-year citations!) + Now provide replacements for standard BibTeX bst files so that + they may be used for both numerical and author-year. + + Note: the bib style file provided in previous releases (natbib.bst) + is no longer provided, since it only meant to be an example. It is now + replaced by plainnat.bst and others. + + Citation styles (punctuation, brackets, etc) can be selected in + various ways: an improved priority system has now been introduced. + For example, any punctuation selection through an option to + \usepackage has priority over any prestored citation style. + + \bibpunct can now take a 7th optional argument (at the start of + the list) for the punctuation that comes before a post-note. + + It is possible to have all citations and entries in the list of + references automatically entered in an index, either with the standard + makeidx package or the contributed index package of David M. Jones. + + V5.5: some fixed bugs + + Many internal names have been changed to recommended style, ie with + the prefix \NAT@... For example, \@citebegin and \@citeend are + now \NAT@open and \NAT@close (these contain the opening and closing + brackets). + + Where possible, \def has been replaced by \(re)newcommand. + + Selection of citation format (numerical, superscript, author-year) is + coded better; previously, if numerical were ever selected, it was + impossible to switch back to author-year. + +** As a result: ALL CITATION CUSTOMIZATIONS (\bibpunct, \citestyle) MUST +** BE ISSUED BEFORE \begin{document}!!!!! This differs from the +** situation in earlier versions, but is in fact much more logical. + + Add \citep{key} and \citep*{key} as shorthands for + \cite[]{key} and \cite*[]{key}, ie for parenthetical citations + (this was requested) + + Add \citealt{key} and \citealt*{key} that function like \cite{key} and + \cite*{key}, but without brackets. These are textual citations of + the form Jones et al. 1990. (Also a requested feature.) + + The amount of hanging indentation in the list of references can be + redefined via the length command \bibhang. Change with e.g. + \setlength{\bibhang}{2em} %Default is 1em + + V5.4: a few bugs fixed + + add superscript citation style to \bibpunct, as `s' (in place of + `n' for numerical or `a' for author-year; improve superscript coding + + add \citestyle command to be able to invoke a preprogrammed citation + style that is different from that given in \bibliographystyle + + for (Jones et al, 1994a; Jones et al, 1994b) print instead + (Jones et al, 1994a,b) + [up until now, it would have printed (Jones et al, 1994a, 1994b) ] + + V5.3: support the new release of harvard.sty, so that natbib will work with + those bib styles that are designed for it (agms,dcu,kluwer) This means + adding \harvardand, \harvardurl, and some others + + provide \citefullauthor to list all authors for those bib styles that + support this: harvard, chicago + + extend the native format of \bibitem to support full author citations + too; add starred form of \cite to print full author list, if present. + + fix up a bug that caused accents in citations (not references) to be + ignored. + + + V5.2: \citeauthor and \citeyear make auxiliary file entries so BibTeX + can see them; also, any font changes in the author (like {\it Smith}) + will be localized (in 5.0, the brackets were removed, so all following + text was italicized.) + + Internal definition of \cite made to be like that of LaTeX2e, so that + multiple citations may have spaces after commas, as \cite{a, b, c} + + A local configuration file natbib.cfg will be read in (2e only) that + may contain local \bibstyle@xxx commands. + + V5.1: pure LaTeX2e, not mixed as v5.0 was. Fixes up problems of font + commands in the citation labels (like {\em et al.} that caused + terrible problems and had a poor ad hoc solution. + +Changes from previous (4.x) versions: + \cite now takes two optional arguments for text before and after citation + \citeyear and \citeauthor have been added + Under LaTeX2e, punctuation can be selected with options in \usepackage + +------------------------------------------------------------------------- +2003 June 6 +Patrick W. Daly +Max-Planck-Institut f\"ur Aeronomie +D-37191 Katlenburg-Lindau, Germany +E-mail: daly@linmpi.mpg.de diff --git a/Master/texmf-dist/doc/latex/natbib/natnotes.tex b/Master/texmf-dist/doc/latex/natbib/natnotes.tex new file mode 100644 index 00000000000..556ef7db044 --- /dev/null +++ b/Master/texmf-dist/doc/latex/natbib/natnotes.tex @@ -0,0 +1,332 @@ +%% +%% This is file `natnotes', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% natbib.dtx (with options: `notes') +%% ============================================= +%% IMPORTANT NOTICE: +%% +%% This program can be redistributed and/or modified under the terms +%% of the LaTeX Project Public License Distributed from CTAN +%% archives in directory macros/latex/base/lppl.txt; either +%% version 1 of the License, or any later version. +%% +%% This is a generated file. +%% It may not be distributed without the original source file natbib.dtx. +%% +%% This is a Reference Sheet for natbib. It consists of excerpts from the +%% original source file. +%% +%% For more details, LaTeX the source natbib.dtx. +%% ============================================== +%% Copyright 1993-2003 Patrick W Daly +%% Max-Planck-Institut f\"ur Aeronomie +%% Max-Planck-Str. 2 +%% D-37191 Katlenburg-Lindau +%% Germany +%% E-mail: daly@linmpi.mpg.de +\NeedsTeXFormat{LaTeX2e} +\def\DescribesFile#1 [#2 #3 #4] + {\def\filename{#1}\def\filedate{#2}\def\fileversion{#3}} +\DescribesFile{natbib} + [2003/06/06 7.1 (PWD)] +\documentclass{article} + +\setlength{\parindent}{0pt} +\setlength{\parskip}{1ex} +\setlength{\textwidth}{\paperwidth} +\addtolength{\textwidth}{-2in} +\setlength{\oddsidemargin}{0pt} +\setlength{\textheight}{\paperheight} + +\addtolength{\textheight}{-\headheight} +\addtolength{\textheight}{-\headsep} +\addtolength{\textheight}{-\footskip} +\addtolength{\textheight}{-2in} +\makeatletter +\def\@listI{\leftmargin\leftmargini + \topsep\z@ \parsep\parskip \itemsep\z@} +\let\@listi\@listI +\@listi +\makeatother +\newcommand{\head}[1]{\subsubsection*{#1}} + +\pagestyle{headings} +\markright{Reference sheet: \texttt{natbib}} + +\usepackage{shortvrb} +\MakeShortVerb{\|} + +\begin{document} +\thispagestyle{plain} + +\newcommand{\btx}{\textsc{Bib}\TeX} +\newcommand{\thestyle}{\texttt{\filename}} +\begin{center}{\bfseries\Large + Reference sheet for \thestyle\ usage}\\ + \large(Describing version \fileversion\ from \filedate) +\end{center} + +\begin{quote}\slshape +For a more detailed description of the \thestyle\ package, \LaTeX\ the +source file \thestyle\texttt{.dtx}. +\end{quote} +\head{Overview} +The \thestyle\ package is a reimplementation of the \LaTeX\ |\cite| command, +to work with both author--year and numerical citations. It is compatible with +the standard bibliographic style files, such as \texttt{plain.bst}, as well as +with those for \texttt{harvard}, \texttt{apalike}, \texttt{chicago}, +\texttt{astron}, \texttt{authordate}, and of course \thestyle. + +\head{Loading} +Load with |\usepackage[|\emph{options}|]{|\thestyle|}|. See list of +\emph{options} at the end. + +\head{Replacement bibliography styles} +I provide three new \texttt{.bst} files to replace the standard \LaTeX\ +numerical ones: +\begin{quote}\ttfamily + plainnat.bst \qquad abbrvnat.bst \qquad unsrtnat.bst +\end{quote} +\head{Basic commands} +The \thestyle\ package has two basic citation commands, |\citet| and +|\citep| for \emph{textual} and \emph{parenthetical} citations, respectively. +There also exist the starred versions |\citet*| and |\citep*| that print +the full author list, and not just the abbreviated one. +All of these may take one or two optional arguments to add some text before +and after the citation. +\begin{quote} +\begin{tabular}{l@{\quad$\Rightarrow$\quad}l} + |\citet{jon90}| & Jones et al. (1990)\\ + |\citet[chap.~2]{jon90}| & Jones et al. (1990, chap.~2)\\[0.5ex] + |\citep{jon90}| & (Jones et al., 1990)\\ + |\citep[chap.~2]{jon90}| & (Jones et al., 1990, chap.~2)\\ + |\citep[see][]{jon90}| & (see Jones et al., 1990)\\ + |\citep[see][chap.~2]{jon90}| & (see Jones et al., 1990, chap.~2)\\[0.5ex] + |\citet*{jon90}| & Jones, Baker, and Williams (1990)\\ + |\citep*{jon90}| & (Jones, Baker, and Williams, 1990) +\end{tabular} +\end{quote} +\head{Multiple citations} +Multiple citations may be made by including more than one +citation key in the |\cite| command argument. +\begin{quote} +\begin{tabular}{l@{\quad$\Rightarrow$\quad}l} + |\citet{jon90,jam91}| & Jones et al. (1990); James et al. (1991)\\ + |\citep{jon90,jam91}| & (Jones et al., 1990; James et al. 1991)\\ + |\citep{jon90,jon91}| & (Jones et al., 1990, 1991)\\ + |\citep{jon90a,jon90b}| & (Jones et al., 1990a,b) +\end{tabular} +\end{quote} + +\head{Numerical mode} +These examples are for author--year citation mode. In numerical mode, the +results are different. +\begin{quote} +\begin{tabular}{l@{\quad$\Rightarrow$\quad}l} + |\citet{jon90}| & Jones et al. [21]\\ + |\citet[chap.~2]{jon90}| & Jones et al. [21, chap.~2]\\[0.5ex] + |\citep{jon90}| & [21]\\ + |\citep[chap.~2]{jon90}| & [21, chap.~2]\\ + |\citep[see][]{jon90}| & [see 21]\\ + |\citep[see][chap.~2]{jon90}| & [see 21, chap.~2]\\[0.5ex] + |\citep{jon90a,jon90b}| & [21, 32] +\end{tabular} +\end{quote} +\head{Suppressed parentheses} +As an alternative form of citation, |\citealt| is the same as |\citet| but +\emph{without parentheses}. Similarly, |\citealp| is |\citep| without +parentheses. Multiple references, notes, and the starred variants +also exist. +\begin{quote} +\begin{tabular}{l@{\quad$\Rightarrow$\quad}l} + |\citealt{jon90}| & Jones et al.\ 1990\\ + |\citealt*{jon90}| & Jones, Baker, and Williams 1990\\ + |\citealp{jon90}| & Jones et al., 1990\\ + |\citealp*{jon90}| & Jones, Baker, and Williams, 1990\\ + |\citealp{jon90,jam91}| & Jones et al., 1990; James et al., 1991\\ + |\citealp[pg.~32]{jon90}| & Jones et al., 1990, pg.~32\\ + |\citetext{priv.\ comm.}| & (priv.\ comm.) +\end{tabular} +\end{quote} +The |\citetext| command +allows arbitrary text to be placed in the current citation parentheses. +This may be used in combination with |\citealp|. +\head{Partial citations} +In author--year schemes, it is sometimes desirable to be able to refer to +the authors without the year, or vice versa. This is provided with the +extra commands +\begin{quote} +\begin{tabular}{l@{\quad$\Rightarrow$\quad}l} + |\citeauthor{jon90}| & Jones et al.\\ + |\citeauthor*{jon90}| & Jones, Baker, and Williams\\ + |\citeyear{jon90}| & 1990\\ + |\citeyearpar{jon90}| & (1990) +\end{tabular} +\end{quote} +\head{Forcing upper cased names} +If the first author's name contains a \textsl{von} part, such as ``della +Robbia'', then |\citet{dRob98}| produces ``della Robbia (1998)'', even at the +beginning of a sentence. One can force the first letter to be in upper case +with the command |\Citet| instead. Other upper case commands also exist. +\begin{quote} +\begin{tabular}{rl@{\quad$\Rightarrow$\quad}l} + when & |\citet{dRob98}| & della Robbia (1998) \\ + then & |\Citet{dRob98}| & Della Robbia (1998) \\ + & |\Citep{dRob98}| & (Della Robbia, 1998) \\ + & |\Citealt{dRob98}| & Della Robbia 1998 \\ + & |\Citealp{dRob98}| & Della Robbia, 1998 \\ + & |\Citeauthor{dRob98}| & Della Robbia +\end{tabular} +\end{quote} +These commands also exist in starred versions for full author names. + +\head{Citation aliasing} +Sometimes one wants to refer to a reference with a special designation, +rather than by the authors, i.e. as Paper~I, Paper~II. Such aliases can be +defined and used, textual and/or parenthetical with: +\begin{quote} +\begin{tabular}{lcl} + |\defcitealias{jon90}{Paper~I}|\\ + |\citetalias{jon90}| & $\Rightarrow$ & Paper~I\\ + |\citepalias{jon90}| & $\Rightarrow$ & (Paper~I) +\end{tabular} +\end{quote} +These citation commands function much like |\citet| and |\citep|: they may +take multiple keys in the argument, may contain notes, and are marked as +hyperlinks. +\head{Selecting citation style and punctuation} +Use the command |\bibpunct| with one optional and 6 mandatory arguments: +\begin{enumerate} +\item the opening bracket symbol, default = ( +\item the closing bracket symbol, default = ) +\item the punctuation between multiple citations, default = ; +\item the letter `n' for numerical style, or `s' for numerical superscript + style, any other letter for + author--year, default = author--year; +\item the punctuation that comes between the author names and the year +\item the punctuation that comes between years or numbers when common author + lists are suppressed (default = ,); +\end{enumerate} + +The optional argument is the character preceding a post-note, default is a +comma plus space. In redefining this character, one must include a space if +one is wanted. + +Example~1, |\bibpunct{[}{]}{,}{a}{}{;}| changes the output of +\begin{quote} + |\citep{jon90,jon91,jam92}| +\end{quote} +into [Jones et al. 1990; 1991, James et al. 1992]. + +Example~2, |\bibpunct[; ]{(}{)}{,}{a}{}{;}| changes the output of +\begin{quote} + |\citep[and references therein]{jon90}| +\end{quote} +into (Jones et al. 1990; and references therein). + +\head{Other formatting options} +Redefine |\bibsection| to the desired sectioning command for introducing +the list of references. This is normally |\section*| or |\chapter*|. + +Define |\bibpreamble| to be any text that is to be printed after the heading but +before the actual list of references. + +Define |\bibfont| to be a font declaration, e.g.\ |\small| to apply to +the list of references. + +Define |\citenumfont| to be a font declaration or command like |\itshape| +or |\textit|. + +Redefine |\bibnumfmt| as a command with an argument to format the numbers in +the list of references. The default definition is |[#1]|. + +The indentation after the first line of each reference is given by +|\bibhang|; change this with the |\setlength| command. + +The vertical spacing between references is set by |\bibsep|; change this with +the |\setlength| command. + +\head{Automatic indexing of citations} +If one wishes to have the citations entered in the \texttt{.idx} indexing +file, it is only necessary to issue |\citeindextrue| at any point in the +document. All following |\cite| commands, of all variations, then insert +the corresponding entry to that file. With |\citeindexfalse|, these +entries will no longer be made. + +\head{Use with \texttt{chapterbib} package} + +The \thestyle\ package is compatible with the \texttt{chapterbib} package +which makes it possible to have several bibliographies in one document. + +The package makes use of the |\include| command, and each |\include|d file +has its own bibliography. + +The order in which the \texttt{chapterbib} and \thestyle\ packages are loaded +is unimportant. + +The \texttt{chapterbib} package provides an option \texttt{sectionbib} +that puts the bibliography in a |\section*| instead of |\chapter*|, +something that makes sense if there is a bibliography in each chapter. +This option will not work when \thestyle\ is also loaded; instead, add +the option to \thestyle. + +Every |\include|d file must contain its own +|\bibliography| command where the bibliography is to appear. The database +files listed as arguments to this command can be different in each file, +of course. However, what is not so obvious, is that each file must also +contain a |\bibliographystyle| command, \emph{preferably with the same +style argument}. +\head{Sorting and compressing citations} +Do not use the \texttt{cite} package with \thestyle; rather use one of the +options \texttt{sort} or \texttt{sort\&compress}. + +These also work with author--year citations, making multiple citations appear +in their order in the reference list. + +\head{Long author list on first citation} +Use option \texttt{longnamesfirst} to have first citation automatically give +the full list of authors. + +Suppress this for certain citations with |\shortcites{|\emph{key-list}|}|, +given before the first citation. + +\head{Local configuration} +Any local recoding or definitions can be put in \thestyle\texttt{.cfg} which +is read in after the main package file. + +\head{Options that can be added to \texttt{\char`\\ usepackage}} +\begin{description} +\item[\ttfamily round] (default) for round parentheses; +\item[\ttfamily square] for square brackets; +\item[\ttfamily curly] for curly braces; +\item[\ttfamily angle] for angle brackets; +\item[\ttfamily colon] (default) to separate multiple citations with + colons; +\item[\ttfamily comma] to use commas as separaters; +\item[\ttfamily authoryear] (default) for author--year citations; +\item[\ttfamily numbers] for numerical citations; +\item[\ttfamily super] for superscripted numerical citations, as in + \textsl{Nature}; +\item[\ttfamily sort] orders multiple citations into the sequence in + which they appear in the list of references; +\item[\ttfamily sort\&compress] as \texttt{sort} but in addition multiple + numerical citations are compressed if possible (as 3--6, 15); +\item[\ttfamily longnamesfirst] makes the first citation of any reference + the equivalent of the starred variant (full author list) and subsequent + citations normal (abbreviated list); +\item[\ttfamily sectionbib] redefines |\thebibliography| to issue + |\section*| instead of |\chapter*|; valid only for classes with a + |\chapter| command; to be used with the \texttt{chapterbib} package; +\item[\ttfamily nonamebreak] keeps all the authors' names in a citation on + one line; causes overfull hboxes but helps with some \texttt{hyperref} + problems. +\end{description} +\end{document} +%% +%% End of Reference Sheet file +%% +%% +%% End of file `natnotes'. |