summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-contrib/biblatex-ieee/biblatex-ieee.tex
blob: 9aefc79c824269b67492046d5c09f75c0af41ad9 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
%% ---------------------------------------------------------------
%% biblatex-ieee --- A biblatex implementation of the IEEE 
%%   bibliography style
%% Maintained by Joseph Wright
%% E-mail: joseph@texdev.net
%% Released under the LaTeX Project Public License v1.3c or later
%% See http://www.latex-project.org/lppl.txt
%% ---------------------------------------------------------------
%% 

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

\hypersetup{hidelinks}

\addbibresource{biblatex-ieee.bib}

\author{Joseph Wright\thanks{E-mail: 
  \href{mailto:joseph@texdev.net}
  {\texttt{joseph@texdev.net}}}}
\title{The \pkg{ieee} bibliography style for \pkg{biblatex}%
  \footnote{This file describes v1.4a, last revised 2024-11-17.}}
\date{Released 2024-11-17}

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

\RecordChanges

\begin{document}

\maketitle

This package provides a style for \pkg{biblatex} which follows the
guidelines of the \textsc{ieee}. The citation style is numeric and unsorted.
The bibliography style follows the pattern of the official \pkg{IEEEtran}
package (\url{https://ieeeauthorcenter.ieee.org/wp-content/uploads/IEEE-Editorial-Style-Manual.pdf}). The style
should be loaded in the usual way
\begin{verbatim}
  \usepackage[style=ieee]{biblatex}
\end{verbatim}
The References section of this document demonstrates the format 
generated by the package using the \texttt{biblatex-ieee.bib} database
of example citations.

The style introduces new bibliography strings:
\begin{description}
  \item[\texttt{patentjp}] the text \enquote{Japanese Patent};
  \item[\texttt{presentedat}] the text \enquote{presented at the} when 
    printing conference papers using the name of the conference rather 
    than a reference to a book of abstracts.
\end{description}
These may be localized in the usual way.

The style adds the \opt{dashed} option to those recognised: as-standard,
this is activated. The option works in the same way as that from the
core \pkg{biblatex} style \pkg{author-year}.

As-standard, citation numbers are all printed. If you do no wish to have compressed
citations, use
\begin{verbatim}
\usepackage[style = ieee, citestyle = ieee-comp]{biblatex}
\end{verbatim}

The appearance of URLs in the bibliography is set by the mechanism of the
\textsf{url} package. Thus to print URLs in the current roman font,
place the instruction
\begin{verbatim}
  \renewcommand*{\UrlFont}{\rmfamily}
\end{verbatim}
immediately before
\begin{verbatim}
  \printbibliography
\end{verbatim}

Control of the exact information in dates is best achieved by using the
\cs{AtEveryCite} command with appropriate data manipulation. In particular,
if your database includes full dates, you will likely want to drop these
for most periodicals using \cs{clearfield} 

Also include in the bundle is a style using alphabetic labels, but otherwise
following the guidelines of the \textsc{ieee}. This style should be loaded
using
\begin{verbatim}
  \usepackage[style=ieee-alphabetic]{biblatex}
\end{verbatim}
It is demonstrated in the accompany \textsc{pdf} file
\texttt{biblatex-ieee-alphabetic}.

Suggestions for improvement and bug reports can be logged in the package
issue database, found at
\url{https://github.com/josephwright/biblatex-ieee/issues/}, or can
be sent by e-mail to 
\href{mailto:joseph@texdev.net}
  {\texttt{joseph@texdev.net}}.
\nocite{*}

\printbibliography

\changes{v1.0}{2011-02-27}{First stable release}
\changes{v1.0a}{2011-04-07}{Print \enquote{presented at} for
  \texttt{inproceedings} entries only if an \texttt{eventtitle} is
  available}
\changes{v1.0b}{2011-05-07}{Add instructions for printing URL in roman font}
\changes{v1.0b}{2011-05-07}{Use dash for repeated author names}
\changes{v1.0c}{2012-03-21}{Turn off citation sorting}
\changes{v1.0c}{2012-03-21}{Set \emph{et al.}~in italics}
\changes{v1.0c}{2012-03-21}{Use two em-dashes for repeated names}
\changes{v1.0d}{2012-03-23}{Place \texttt{series} before \texttt{editor}
  for \texttt{incollection} entries}
\changes{v1.1}{2012-05-03}{New alphabetic style \texttt{ieee-alphabetic}}
\changes{v1.1}{2012-05-03}{Update citation-related options set by the style}
\changes{v1.1a}{2012-06-16}{Bracket citation numbers singly, not as a group}
\changes{v1.1a}{2012-06-16}{Omit comma after \texttt{!} and \texttt{?}
  if this occurs at the end of a title}
\changes{v1.1b}{2012-07-18}{Fix spacing between bibliography label and entry}
\changes{v1.1c}{2012-10-04}{Improve handling of names in \cs{textcite}}
\changes{v1.1d}{2012-10-12}{Improve handling of names in \cs{textcite} again}
\changes{v1.1e}{2012-12-04}{Address brackets around citations again, hopefully
 correctly this time}
\changes{v1.1e}{2012-12-04}{Use US-style punctuation suppression}
\changes{v1.1f}{2012-12-17}{Fix brackets in \cs{textcite}}
\changes{v1.1g}{2013-01-27}{Include data for related entries}
\changes{v1.1h}{2013-02-08}{Print post-notes within brackets surrounding
  citation number}
\changes{v1.1i}{2013-06-13}{Remove extraneous bracket when \cs{cites} is used}
\changes{v1.1j}{2013-10-25}{Update \cs{textcite} code for \pkg{biblatex}~v2.7}
\changes{v1.1j}{2013-10-25}{Correctly format multi-part page ranges}
\changes{v1.1k}{2015-03-12}{Capitalise after colon in titles}
\changes{v1.1l}{2015-03-25}{Respect braces for capitalisation in titles}
\changes{v1.1m}{2016-04-06}{Track \pkg{biblatex} changes}
\changes{v1.1m}{2016-04-16}{Much simplified citation style approach}
\changes{v1.1n}{2016-05-08}{Fix printing of titles when braced in
  database}
\changes{v1.1o}{2016-06-27}{Fix capitalisation of journal titles}
\changes{v1.1p}{2016-07-20}{Revert changes in internal code for citation
  handling}
\changes{v1.1q}{2016-08-31}{Fix stray space after \enquote{\emph{et al.}}}
\changes{v1.2}{2016-12-26}{New \opt{dashed} option}
\changes{v1.2}{2016-12-29}{Refine handling of case changing in titles}
\changes{v1.2}{2016-12-30}{Use title case for book tiles}
\changes{v1.2a}{2017-02-02}{Minor internal updates}
\changes{v1.2a}{2017-03-01}{Move some formatting directives}
\changes{v1.2a}{2017-03-01}{More work on formatting of titles}
\changes{v1.2b}{2017-03-22}{Fix accidental printing of string \texttt{no.}}
\changes{v1.2c}{2017-03-25}{Fix formatting for volume in some entry types}
\changes{v1.2d}{2017-03-26}{Subtle adjustment for volume string}
\changes{v1.3}{2018-08-20}{Hungarian localisation}
\changes{v1.3b}{2020-02-26}{Add quotes to website titles}
\changes{v1.3d}{2020-12-17}{Adjust \texttt{online} type}
\changes{v1.3e}{2021-03-25}{Adjust truncation of names list}
\changes{v1.3f}{2021-03-30}{Use \texttt{false} as the default for \texttt{dashed} setting}
\changes{v1.3f}{2021-04-12}{Fix brackets in \cs{supercite}}
\changes{v1.3f}{2021-12-01}{Adjust printing of series for books}
\changes{v1.3g}{2024-08-14}{Print separator between journal title and subtitle}
\changes{v1.3g}{2024-08-14}{Correct formatting of URL for online entries}
\changes{v1.4}{2024-11-13}{Swtich from compressed to non-compressed citations}
\changes{v1.4a}{2024-11-17}{Correct use of \cs{newbibmacro}}
\changes{v1.4a}{2024-11-17}{Correct \cs{textcite}}

\PrintChanges

\end{document}

%% 
%% Copyright (C) 2011-2013,2015-2021,2024 by
%%   Joseph Wright <joseph@texdev.net>
%% 
%% 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-ieee.bib,
%%                                 biblatex-ieee.tex,
%%                                 ieee.bbx,
%%                                 ieee.cbx,
%%                                 ieee-alphabetic.bbx,
%%                                 ieee-alphabetic.cbx,
%%                                 ieee-comp.cbx and
%%                                 magyar-ieee.lbx,
%%           and the derived files biblatex-ieee.pdf and
%%                                 biblatex-ieee-alphabetic.pdf.
%% 
%%
%% End of file `biblatex-ieee.tex'.