summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex')
-rw-r--r--macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex75
1 files changed, 75 insertions, 0 deletions
diff --git a/macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex b/macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex
new file mode 100644
index 0000000000..71918e5b53
--- /dev/null
+++ b/macros/latex/contrib/biblatex-ms/doc/examples/20-indexing-single-ms.tex
@@ -0,0 +1,75 @@
+%
+% This file demonstrates indexing with the 'makeidx' package.
+% This file is processed as follows:
+%
+% latex file
+% bibtex/biber file
+% latex file
+% makeindex file
+% latex file
+%
+% Note that the file name suffix may be omitted. It's 'latex file'
+% and not 'latex file.tex'.
+%
+\documentclass[a4paper]{article}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage[american]{babel}
+\usepackage{csquotes}
+%
+% We set the 'indexing' package option ('indexing' is similar to
+% 'indexing=true') to enable indexing in both citations and the
+% bibliography. It is rather unusual to add bibliography entries to
+% the index so you will normally use 'indexing=cite' instead. The
+% only reason we're indexing the bibliography in this example is to
+% get a larger index. For a change, let's also use the 'authortitle'
+% style in this example.
+\usepackage[indexing,style=authortitle,backend=biber]{biblatex-ms}
+\addbibresource{biblatex-examples.bib}
+%
+% The 'makeidx' package provides indexing facilities on a fairly
+% basic level. It is highly advisable to use the 'index' package
+% instead, even if you do not need the additional facilities
+% provided by this package, such as multiple indexes. The reason is
+% that the \index command defined by this package is more robust
+% than the basic command provided by 'makeidx'.
+\usepackage{makeidx}
+% We need to enable indexing globally by way of \makeindex.
+% Otherwise, no index is created at all, regardless of the
+% 'indexing' option of biblatex.
+\makeindex
+%
+% Note that biblatex uses makeindex's 'actual' operator to pass the
+% 'indexsorttitle' field to makeindex. The default character used
+% is '@'. If the makeindex style uses a different character, i.e.,
+% if the .ist file contains a line like this
+%
+% actual '='
+%
+% you need to redefine \actualoperator accordingly:
+%
+% \renewcommand*{\actualoperator}{=}
+%
+\begin{document}
+
+\section*{Indexing with the \texttt{makeidx} package}
+
+% We add the contents of the entire bib file to the bibliography.
+% Note that \nocite does not add anything to the index on its own.
+\nocite{*}
+
+% We cite a few items. These citations will be added to the index.
+\cite{piccato,gaonkar,malinowski,coleridge,gerhardt,cicero}
+
+% We also add an explicit index entry.
+\index{Example entry}
+
+\clearpage
+
+% We print the printbibliography...
+\printbibliography
+% ...and the index
+\raggedright
+\printindex
+
+\end{document}