summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/citeall/citeall.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/citeall/citeall.tex')
-rw-r--r--Master/texmf-dist/doc/latex/citeall/citeall.tex33
1 files changed, 24 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/citeall/citeall.tex b/Master/texmf-dist/doc/latex/citeall/citeall.tex
index 40ad48b7c07..d550b1516a1 100644
--- a/Master/texmf-dist/doc/latex/citeall/citeall.tex
+++ b/Master/texmf-dist/doc/latex/citeall/citeall.tex
@@ -1,14 +1,25 @@
% !Mode:: "TeX:DE:UTF-8:Main"
-\documentclass[]{scrartcl}
+\documentclass[DIV=12]{scrartcl}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
+\usepackage[english]{babel}
+\usepackage[autostyle]{csquotes}
+\usepackage{microtype}
\usepackage[style=authoryear-ibid,hyperref=false]{biblatex}
\usepackage{citeall}
\usepackage{fourier}
\usepackage{ydoc-desc,tabularx}
+\usepackage{enumitem,needspace}
+\makeatletter
+\enitkv@key{enumitem}{compactsep}[true]{%
+ \divide\partopsep by 2\relax
+ \divide\topsep by 2\relax
+ \divide\itemsep by 2\relax
+ \divide\parsep by 2\relax}
+\makeatother
\addbibresource{examples-citeall.bib}
-\title{The \pkg{citeall} package, v1.0}
-\author{Ulrike Fischer}
+\title{The \pkg{citeall} package, v1.1}
+\author{Ulrike Fischer\thanks{fischer@troubleshooting-tex.de}}
\begin{document}
\maketitle
@@ -33,11 +44,11 @@ The main command of the package is called like the package and has two optional
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.
+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.
+\begin{itemize}[compactsep]
+\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}
@@ -51,7 +62,7 @@ For each entrykey in the .bbl \cs{citeall} will loop through this list and pass
\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}}
@@ -78,13 +89,17 @@ For each entrykey in the .bbl \cs{citeall} will loop through this list and pass
\citeall[{\cite[15]},\endgraf \cite]
\end{tabular}
+\section{Printing the bibliography}
+\cs{citeall} internally issues a \verb+\nocite{*}+, so \cs{printbibliography} will print all entries of the bib-file. Since version 1.1 \cs{citeall} adds all entries it cites to a category \enquote{citeall}. So if you restrict the number of citation with the second optional argument, you can also restrict the length of the bibliography with \verb+\printbibliography[category=citeall]+
+
\section{Configuration}
\DescribeMacro\citeallgroupseparator
\DescribeMacro\citeallseparator
-\DescribeMacro\citeallfinentry
+\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}.
+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}.
+The default cite command used by \cs{citeall} is (\cs{cite}). This can be changed by redefining \cs{citealldefaultcite}.
\end{document}