diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/citeall/citeall.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/citeall/citeall.tex | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/citeall/citeall.tex b/Master/texmf-dist/doc/latex/citeall/citeall.tex new file mode 100644 index 00000000000..40ad48b7c07 --- /dev/null +++ b/Master/texmf-dist/doc/latex/citeall/citeall.tex @@ -0,0 +1,90 @@ +% !Mode:: "TeX:DE:UTF-8:Main" +\documentclass[]{scrartcl} +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage[style=authoryear-ibid,hyperref=false]{biblatex} +\usepackage{citeall} +\usepackage{fourier} +\usepackage{ydoc-desc,tabularx} +\addbibresource{examples-citeall.bib} +\title{The \pkg{citeall} package, v1.0} +\author{Ulrike Fischer} + +\begin{document} +\maketitle +\section{Important} +\pkg{citeall} works only together with \pkg{biblatex}. \pkg{biblatex} should be loaded before \pkg{citeall}. + +The package relies on some inner working of \pkg{biblatex}, so it could break with future versions. + +\section{The aim of the package} +The \pkg{citeall} package is a package to help to adapt and debug \pkg{biblatex} +citation styles. When adapting such a style one often needs to inspect the +output of examples. While it is easy with \verb+\nocite{*}+ to output all entries of a bib-file in the bibliography it is more troublesome to show citations. +So I wrote a (very) small package which allows me to show citations of all entries of the bib-files. + + + + +\section{The command} +The main command of the package is called like the package and has two optional arguments: + +\DescribeMacro\citeall[<list of commands>][<number of entries>] + +The second optional argument sets the number of entries of the .bib (more precisely the .bbl-file) printed by \cs{citeall}. By default everything is cited. + +The first optional argument is a comma separated list. +For each entrykey in the .bbl \cs{citeall} will loop through this list and pass to each item the entrykey as last argument. By default this list consist simply of a \cs{cite} command. The items don't need to be cite commands. As the examples show you can add text and other commands. + +\begin{itemize} +\item The last command should be something that can handle the entry key argument. +\item If there are brackets e.g. from optional argument of a \cs{cite} you should protect them with braces. +\item If there are commas you should protect them with braces. +\item If you want to insert a paragraph break, use \cs{endgraf} +\item Don't overdo the system. It is meant for simple debbugging not for complicated citation printouts. +\end{itemize} + +\section{Some examples} +\verb+\citeall+ \begin{tabular}[t]{p{0.3\textwidth}} + \citeall + \end{tabular} +\verb+\citeall[][1]+ \begin{tabular}[t]{p{0.3\textwidth}} + \citeall[][1] + \end{tabular} + + +\noindent +\verb+\citeall[\fullcite]+\begin{tabular}[t]{p{0.7\textwidth}} + \citeall[\fullcite] + \end{tabular} + + +\noindent +\verb+\citeall[\cite[15],\cite]+\begin{tabular}[t]{p{0.7\textwidth}} + \citeall[\cite[15],\cite] + \end{tabular} + +\noindent +\verb+\citeall[Key: \textcolor{red},{\cite[15]},Test ibid: \cite]+ + +\begin{tabular}[t]{p{0.7\textwidth}} + \citeall[Key: \textcolor{red},{\cite[15]},Test ibid: \cite] +\end{tabular} + +\noindent +\verb+\citeall[{\cite[15]},\endgraf \cite]+ + +\begin{tabular}[t]{p{0.7\textwidth}} + \citeall[{\cite[15]},\endgraf \cite] +\end{tabular} + +\section{Configuration} + +\DescribeMacro\citeallgroupseparator +\DescribeMacro\citeallseparator +\DescribeMacro\citeallfinentry +\DescribeMacro\citealldefaultcite + +By default the item of an entry are separated by a comma and a space. This can be changed by redefining \cs{citeallseparator}. The last item is finished by \cs{citeallfinentry} (default nothing). The entries are separated by a \cs{par}, this can be changed by redefining \cs{citeallgroupseparator}. + +\end{document} |