diff options
author | Karl Berry <karl@freefriends.org> | 2015-02-19 22:16:31 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-02-19 22:16:31 +0000 |
commit | 773310e58596170d4241a9896088b7b77f2cc312 (patch) | |
tree | 03a761183b4050ae1b3ef46811223d22e9d87642 /Master/texmf-dist/doc/latex/citeall | |
parent | 10eee2660dbd42a48abf08917f3708dc6024832d (diff) |
citeall (19feb15)
git-svn-id: svn://tug.org/texlive/trunk@36325 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/citeall')
-rw-r--r-- | Master/texmf-dist/doc/latex/citeall/README | 18 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/citeall/citeall.pdf | bin | 0 -> 108508 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/citeall/citeall.tex | 90 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/citeall/examples-citeall.bib | 25 |
4 files changed, 133 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/citeall/README b/Master/texmf-dist/doc/latex/citeall/README new file mode 100644 index 00000000000..3c69cb2a7c2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/citeall/README @@ -0,0 +1,18 @@ +citeall --- A package to cite all entries of a bbl created with biblatex +Version 1.0 Ulrike Fischer 2015 + +LICENSE +LaTeX Project Public License + +CONTENTS + +- Readme (this file) +- citeall.sty (the sty) +- citeall.tex, citeall.pdf (the docu) +- examples-citeall.bib (and example bib-file used by the documentation + +INSTALLATION + +Put the sty where it can be found. +If you want to compile the documentation: +put the bib-file where it can be found.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/citeall/citeall.pdf b/Master/texmf-dist/doc/latex/citeall/citeall.pdf Binary files differnew file mode 100644 index 00000000000..5ef6f7c9019 --- /dev/null +++ b/Master/texmf-dist/doc/latex/citeall/citeall.pdf 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} diff --git a/Master/texmf-dist/doc/latex/citeall/examples-citeall.bib b/Master/texmf-dist/doc/latex/citeall/examples-citeall.bib new file mode 100644 index 00000000000..1f4eec3acec --- /dev/null +++ b/Master/texmf-dist/doc/latex/citeall/examples-citeall.bib @@ -0,0 +1,25 @@ +@ARTICLE{article2015, + AUTHOR = {Muster, Max}, + TITLE = {Title of Article}, + YEAR = {2015}, + JOURNAL = {Testjournal}, + volume = {1}, + number = {2}, + pages = {15}, + month = {2}, +} + + +@BOOK{book2015, + AUTHOR = {BookAuthor, Eva}, + EDITOR = {Editor, Ben}, + TITLE = {a book}, + YEAR = {2015}, + PUBLISHER = {Publisher}, +} + +@misc{fischer2015, + AUTHOR = {Fischer, Ulrike}, + TITLE = {The citeall package}, + YEAR = {2015}, +} |