summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-contrib/biblatex-subseries/documentation/biblatex-subseries.tex
blob: adcb76e3503c5b5fd14a1f15cee000fbfdd789ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
\documentclass{ltxdockit}[2011/03/25]
\usepackage{btxdockit}
\usepackage{fontspec}
\usepackage[mono=false]{libertine}
\usepackage{microtype}
\usepackage[american]{babel}
\usepackage[strict]{csquotes}
\setmonofont[Scale=MatchLowercase]{DejaVu Sans Mono}
\usepackage{shortvrb}
\usepackage{pifont}
\usepackage{minted}
% Usefull commands
\newcommand{\biblatex}{biblatex\xspace}
\pretocmd{\bibfield}{\sloppy}{}{}
\pretocmd{\bibtype}{\sloppy}{}{}
\newcommand{\namebibstyle}[1]{\texttt{#1}}
\newrobustcmd*{\LF}{%
  \textcolor{spot}{\margnotefont Label field}}
\newrobustcmd*{\LFMark}{%
  \leavevmode\marginpar{\LF}}
% Meta-datas
\titlepage{%
	title={Description of subseries with biblatex},
	subtitle={New data fields},
	email={maieul <at> maieul <dot> net},
	author={Maïeul Rouquette},
	revision={1.2.0},
	date={24/02/2017},
	url={https://git.framasoft.org/maieul/biblatex-subseries}}

% biblatex
\usepackage[bibstyle=subseries,citestyle=verbose]{biblatex}
\addbibresource{biblatex-subseries-example.bib}

\begin{document}

\printtitlepage
\tableofcontents
\section{Introduction}

Some publishers organize book series with subseries. In this case, two numbers are associated with one volume: the number inside the series and the number inside the subseries. That is the case, for example, of the series \emph{\foreignlanguage{latin}{Corpus Scriptorium Christianorum Orientalium}} published by Peeters.\footnote{\url{http://www.peeters-leuven.be/search_serie_book.asp?nr=94}.}
Sometime, there is also subsubseries, and number for subsubseries.

This package provides new fields to manage such system.
\section{Basic use}

\subsection{The .bib file}
You can use six additional fields:
\begin{fieldlist}

\fielditem{shortsubseries}{literal\LFMark} The shorthand form of the subseries. Not used by default styles.
\fielditem{subnumber}{literal} The number of the book inside the subseries.
\fielditem{subseries}{literal} The subseries.

\fielditem{shortsubsubseries}{literal\LFMark} The shorthand form of the subsubseries. Not used by default styles.
\fielditem{subsubnumber}{literal} The number of the book inside the subsubseries.
\fielditem{subsubseries}{literal} The subsubseries.

\end{fieldlist}


\inputminted{tex}{biblatex-subseries-example.bib}


\subsection{Loading of the \biblatex package}

When loading the \biblatex package, use the \namebibstyle{subseries}  bibstyle, which is based on the \namebibstyle{verbose} bibstyle:

\begin{minted}{latex}
\usepackage[citestyle=verbose,bibstyle=subseries]{biblatex}
\end{minted}

\subsection{Example of result}

Here, an example of result with the default setting:
\begin{quotation}
\cite{CSCO545}
\end{quotation}

\section{Customization}
You can redefine \cmd{subseriesseparator} to change the separator between series and subseries. You can also redefine \cmd{subsubseriesseparator} to change the separator between subseries and subsubseries. By default, it is the same as \cmd{subseriesseparator}.

If you want to customize the \verb+series+number+ bibmacro, do not forget to call the \verb|subseries+subnumber| bibmacro inside. 

You can also redefine this macro, and redefine the \verb+subsubseries+subsubnumber+ bibmacro which is called by the \verb|subseries+subnumber| bibmacro.


\section{Use with other packages which provide new fields}

To use this package with the features of others which provide new fields, like \verb+biblatex-manuscripts-philology+, you must use the package \verb+biblatex-multiple-dm+.

\section{Credits}

This package was created for Maïeul Rouquette's phd dissertation\footnote{\url{http://apocryphes.hypothese.org}.} in 2015. It is licensed on the \emph{\LaTeX\ Project Public License}\footnote{\url{http://latex-project.org/lppl/lppl-1-3c.html}.}.


All issues can be submitted, in French or English, in the Framagit issues page.\footnote{\url{https://git.framasoft.org/maieul/biblatex-subseries/issues}.}

\section{Change history}

\begin{changelog}

\begin{release}{1.2.0}{2017-02-24}
  \item Add \bibfield{subsubseries}, \bibfield{subsubnumber} and \bibfield{shortsubsubseries} fields.
\end{release}

\begin{release}{1.1.0}{2016-06-07}
  \item Add error message to know more quickly break compatibility with new releases of biblatex.
\end{release}

\begin{release}{1.0.0a}{2015-05-14}
\item Fix typo in handbook.
\end{release}

\begin{release}{1.0.0}{2015-05-12}
\item First public release.
\end{release}
\end{changelog}
\end{document}