summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-12-13 21:08:43 +0000
committerKarl Berry <karl@freefriends.org>2022-12-13 21:08:43 +0000
commit76fbbeea8ed397248b62a749f2d8a22ea8aad062 (patch)
tree4b76501c0e09ea652abfbe80869e8d2d1f5c5f0c /Master/texmf-dist/source/latex
parent37acdfb25ae9a280366c6ee994127edc42badf9b (diff)
bibcop (13dec22)
git-svn-id: svn://tug.org/texlive/trunk@65265 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex')
-rw-r--r--Master/texmf-dist/source/latex/bibcop/bibcop.dtx62
1 files changed, 46 insertions, 16 deletions
diff --git a/Master/texmf-dist/source/latex/bibcop/bibcop.dtx b/Master/texmf-dist/source/latex/bibcop/bibcop.dtx
index 07d513b49fc..36c8ac747bd 100644
--- a/Master/texmf-dist/source/latex/bibcop/bibcop.dtx
+++ b/Master/texmf-dist/source/latex/bibcop/bibcop.dtx
@@ -50,7 +50,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{bibcop}
%<*package>
-[2022-12-12 0.0.2 Style Checker of Bibliography Files]
+[2022-12-13 0.0.3 Style Checker of Bibliography Files]
%</package>
%<*driver>
\documentclass{ltxdoc}
@@ -105,14 +105,15 @@
%\iffalse
%</verb>
%\fi
-% You may see warnings in the \TeX log. Fix the issues in the |main.bib| file
+% You may see warnings in the \TeX{} log --- fix the issues in the |main.bib| file
% and the warnings will disappear.
% If you use the |.sty| file (without installing it into the \TeX{} tree), don't forget
% to also copy the |bibcop.pl| file --- it is the Perl script that does all the work
% of checking your |.bib| files. The |.sty| is just a simple wrapper around it.
-% Make sure |\usepackage{bibcop}| stays before all other |\usepackage| commands, otherwise
+% Make sure |\usepackage{bibcop}| stays right after |\usepackage{biblatex}|
+% (if you use it), otherwise
% you won't see any warnings from |bibcop|.
% \section{The Rules}
@@ -132,7 +133,8 @@
% Every bib item must have the |doi| key, which is a unique
% \href{https://www.doi.org}{Digital Object Identifier}
% of the material that you reference. It seems to be a good practice, in order to avoid ambiguity,
-% to always mention the DOI.
+% to always mention the DOI. I would also recommend to use \href{https://ctan.org/pkg/iexec}{doi} package,
+% in order to make all ``|doi|'' fields turned into hyper links.
% \DescribeMacro{caps}
% In |title|, |booktitle|, and |journal| keys, all major words must be capitalized,
@@ -149,6 +151,18 @@ title = {A Preliminary Architecture for a Basic Data-Flow Processor}
% Here, the leading ``|A|'' is capital because it opens the title.
% The word ``|for|'' and the article ``|a|'' are minor words, that's why they are in lower case.
% Both parts of the composite word ``|Data-Flow|'' are capitalized.
+% Sometimes you need to violate this rule and use custom capitalization, as it is done
+% by the author of the paper. In order to do this, wrap the words with custom capitalization
+% in curled brackets, for example:
+%\iffalse
+%<*verb>
+%\fi
+\begin{verbatim}
+title = {Structured Programming {with} Go {To} Statements}
+\end{verbatim}
+%\iffalse
+%</verb>
+%\fi
% \DescribeMacro{author}
% The |author| must contain a list of authors separated by ``|and|''. Each author
@@ -259,6 +273,18 @@ volume = {32},
%</verb>
%\fi
+% \DescribeMacro{number}
+% The |number| may contain only a number:
+%\iffalse
+%<*verb>
+%\fi
+\begin{verbatim}
+number = {132},
+\end{verbatim}
+%\iffalse
+%</verb>
+%\fi
+
% \DescribeMacro{pages}
% The |pages| may contain either a number or two numbers separated by a double dash:
%\iffalse
@@ -311,12 +337,14 @@ booktitle = {{Proceedings of the International
% Then, we re-define the |\bibliography| command:
% \begin{macrocode}
\makeatletter
-\ifdefined\bibliography\else\gdef\bibliography#1{}\fi
-\let\bibcop@oldbibliography\bibliography
-\renewcommand\bibliography[1]{%
- \iexec{perl "./bibcop.tmp.pl" --latex '#1.bib'}%
- \bibcop@oldbibliography{#1}%
-}
+\ifdefined\bibliography
+ \let\bibcop@oldbibliography\bibliography
+ \renewcommand\bibliography[1]{%
+ \iexec{perl "./bibcop.tmp.pl" --latex '#1.bib'}%
+ \message{bibcop: style checking finished^^J}%
+ \bibcop@oldbibliography{#1}%
+ }
+\fi
\makeatother
% \end{macrocode}
% \end{macro}
@@ -325,12 +353,14 @@ booktitle = {{Proceedings of the International
% Then, we re-define the |\addbibresource| command:
% \begin{macrocode}
\makeatletter
-\ifdefined\addbibresource\else\gdef\addbibresource#1{}\fi
-\let\bibcop@oldaddbibresource\addbibresource
-\renewcommand\addbibresource[1]{%
- \iexec{perl "./bibcop.tmp.pl" --latex '#1'}%
- \bibcop@oldaddbibresource{#1}%
-}
+\ifdefined\addbibresource
+ \let\bibcop@oldaddbibresource\addbibresource
+ \renewcommand\addbibresource[1]{%
+ \iexec{perl "./bibcop.tmp.pl" --latex '#1'}%
+ \message{bibcop: style checking finished^^J}%
+ \bibcop@oldaddbibresource{#1}%
+ }
+\fi
\makeatother
% \end{macrocode}
% \end{macro}