summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex-phys/biblatex-phys.tex
blob: 8beef63dc693150e43c088924e1bf0be271358b3 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
%% ---------------------------------------------------------------
%% biblatex-phys --- A biblatex implementation of the AIP and APS 
%%   bibliography style
%% Maintained by Joseph Wright
%% E-mail: joseph.wright@morningstar2.co.uk
%% Released under the LaTeX Project Public License v1.3c or later
%% See http://www.latex-project.org/lppl.txt
%% ---------------------------------------------------------------
%%  

\documentclass[a4paper]{ltxdoc}
\usepackage[T1]{fontenc}
\usepackage[backend=bibtex,style=phys]{biblatex}
\usepackage[final]{microtype}
\usepackage{csquotes,lmodern}
\usepackage{hyperref}

\hypersetup{hidelinks}

\addbibresource{biblatex-phys.bib}

\author{Joseph Wright\thanks{E-mail: 
  \href{mailto:joseph.wright@morningstar2.co.uk}
  {\texttt{joseph.wright@morningstar2.co.uk}}}}
\title{\pkg{biblatex-phys} -- A \pkg{biblatex} implementation of the
  \textsc{aip} and \textsc{aps} bibliography style%
  \footnote{This file describes v0.9, last revised 2012/07/12.}}
\date{Released 2012/07/12}

\providecommand*{\opt}[1]{\texttt{#1}}
\providecommand*{\pkg}[1]{\textsf{#1}}

\let\DescribeOption\DescribeEnv

\RecordChanges

\begin{document}

\maketitle

This package provides a style for \pkg{biblatex} which follows the
guidelines of the \textsc{aip} and \textsc{aps}. The citation style is numeric
and unsorted. The bibliography style follows the pattern of the official
REV\TeX{} class (\url{http://ctan.org/pkg/revtex}). The style should be loaded
in the usual way
\begin{verbatim}
  \usepackage[style=phys]{biblatex}
\end{verbatim}
Load-time options are provided to deal with the small number of variations
between the \textsc{aip} and \textsc{aps} styles.
The References section of this document demonstrates the format 
generated by the package using the \texttt{biblatex-phys.bib} database
of example citations.

The styles use the standard \pkg{biblatex} database requirements. This means
that a database designed for traditional \pkg{biblatex} use may need some
editing for optimal output. The accompanying example database
\texttt{biblatex-phys.bib} shows examples of all of the supported entry types
with common fields filled in.

\section{Style options}

All of the styles here add a small number of package options to the standard
set provided by \pkg{biblatex}. This allows the styles to cover the variations
seen between the \textsc{aip} and \textsc{aps} styles.

\DescribeOption{doi}
\DescribeOption{eprint}
\DescribeOption{isbn}
\DescribeOption{url}
The standard style options \opt{doi}, \opt{eprint} \opt{isbn} and
\opt{eprint}, as described in the \pkg{biblatex} manual. However, these
options are turned off as standard by the \pkg{phys} style. This reflects the
fact that these entries may be present in reference databases but are not
generally included in published bibliographies. Note that \textsc{doi} values
are printed for journal articles with no pages given, even if the \opt{doi}
option is \opt{false}.

\DescribeOption{subentry}
In common with the standard \pkg{biblatex} numeric styles, all of the styles
in the bundle support the boolean \texttt{subentry} option. With this set
\opt{true}, entries of type \texttt{set} are given individual labels within
the bibliography.

\DescribeOption{articletitle}
The use of article titles varies between the \textsc{aip} and \textsc{aps}
styles. The boolean option \opt{articletitle} is available is control this
behaviour. The standard settings is \opt{true}, which follows the guidelines of
the \textsc{aip}: it should be set to \opt{false} to follow the \textsc{aps}
style. (This option also applies to the titles of proceedings entries and
patents, which are treated in the same way.)

\DescribeOption{biblabel}
The format of the numbers used in the bibliography (the \enquote{bibliography
label}) varies. he \opt{biblabel} option allows the user to easily set the
format used. This option takes a values \opt{superscript} (the standard
setting) and \opt{brackets}.

\DescribeOption{chaptertitle}
Printing chapter titles for \texttt{incollection} entries is part of the
\textsc{aip} style but is not part of the \textsc{aps} style. The
\opt{chaptertitle} option can be used to control this.

\DescribeOption{pageranges}
The inclusion of the full page range of journal articles varies between the
\textsc{aip} and \textsc{aps} styles. The boolean option \opt{pageranges} is
available is control this behaviour. The standard settings is \opt{true},
which follows the guidelines of the \textsc{aip} and prints the full range:
it should be set to \opt{false} to follow the \textsc{aps} style, which will
result in only the first page being printed.

\subsection{\textsc{aip} and \textsc{aps} styles}

As detailed above, the standard settings follow the \textsc{aip} style.
To obtain the \textsc{aps} style, use
\begin{verbatim}
  \usepackage[%
      style=phys,%
      articletitle=false,biblabel=brackets,%
      chaptertitle=false,pageranges=false%
    ]
    {biblatex}
\end{verbatim}

\section{\textsc{url} formatting}

The style uses the \pkg{url} package to format hyperlinks. As such, the
format of these is left to the document author to alter. The \cs{urlstyle}
command may be used to alter this, either for the whole document or only
for the bibliography, for example by using
\begin{verbatim}
\AtBeginBibliography{%
  \urlstyle{rm}%
}
\end{verbatim}

\section{Interaction with \pkg{babel}}

In common with other \pkg{biblatex} styles, \pkg{biblatex-phys} uses the
\pkg{csquotes} package mechanism to place article titles in quotation marks.
This means that the formatting of these will depend on the \pkg{babel}
language in use. Full details are covered in the manuals for \pkg{biblatex}
and \pkg{csquotes}.

\section{Errors and omissions}

Suggestions for improvement and bug reports can be logged in the package issue
database, found at
\url{https://bitbucket.org/josephwright/biblatex-phys/issues}, or can
be sent by e-mail to 
\href{mailto:joseph.wright@morningstar2.co.uk}
  {\texttt{joseph.wright@morningstar2.co.uk}}.
  
\nocite{*}

\printbibliography

\PrintChanges

\end{document}

%% 
%% Copyright (C) 2012 by
%%   Joseph Wright <joseph.wright@morningstar2.co.uk>
%% 
%% It may be distributed and/or modified under the conditions of
%% the LaTeX Project Public License (LPPL), either version 1.3c of
%% this license or (at your option) any later version.  The latest
%% version of this license is in the file:
%% 
%%    http://www.latex-project.org/lppl.txt
%% 
%% This work is "maintained" (as per LPPL maintenance status) by
%%   Joseph Wright.
%% 
%% This work consists of the files biblatex-phys.bib,
%%                                 biblatex-phys.tex,
%%                                 biblatex-phys.tex,
%%                                 phys.bbx and
%%                                 phys.cbx,
%%           and the derived file  biblatex-phys.pdf.
%%
%% End of file `biblatex-phys.tex'.