texlive[67145] trunk: bibcop (18may23)
commits+karl at tug.org
commits+karl at tug.org
Thu May 18 22:06:03 CEST 2023
Revision: 67145
http://tug.org/svn/texlive?view=revision&revision=67145
Author: karl
Date: 2023-05-18 22:06:03 +0200 (Thu, 18 May 2023)
Log Message:
-----------
bibcop (18may23)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/bibcop/bibcop.pl
trunk/Master/texmf-dist/doc/bibtex/bibcop/README.md
trunk/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf
trunk/Master/texmf-dist/doc/man/man1/bibcop.1
trunk/Master/texmf-dist/doc/man/man1/bibcop.man1.pdf
trunk/Master/texmf-dist/scripts/bibcop/bibcop.pl
trunk/Master/texmf-dist/source/bibtex/bibcop/bibcop.dtx
trunk/Master/texmf-dist/tex/latex/bibcop/bibcop.sty
trunk/Master/tlpkg/bin/tlpkg-ctan-check
trunk/Master/tlpkg/libexec/ctan2tds
Modified: trunk/Build/source/texk/texlive/linked_scripts/bibcop/bibcop.pl
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/bibcop/bibcop.pl 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Build/source/texk/texlive/linked_scripts/bibcop/bibcop.pl 2023-05-18 20:06:03 UTC (rev 67145)
@@ -44,6 +44,9 @@
# Check the presence of mandatory tags.
sub check_mandatory_tags {
+ if (exists $args{'--no:tags'}) {
+ return;
+ }
my (%entry) = @_;
my $type = $entry{':type'};
my $mandatory = $blessed{$type};
@@ -71,6 +74,9 @@
# Check that all major words are capitalized.
sub check_capitalization {
+ if (exists $args{'--no:caps'}) {
+ return;
+ }
my (%entry) = @_;
my %tags = map { $_ => 1 } qw/title booktitle journal publisher organization/;
foreach my $tag (keys %entry) {
@@ -101,15 +107,22 @@
# Check that the 'author' is formatted correctly.
sub check_author {
my (%entry) = @_;
- if (exists $entry{'author'} and not $entry{'author'} =~ /^\{.+\}$/) {
- my $author = clean_tex($entry{'author'});
- if (not $author =~ /^[A-Z][^ ]+(,( [A-Z][^ ]+)+)?( and [A-Z][^ ]+(,( [A-Z][^ ]+)+)?)*( and others)?$/) {
- return "The format of the 'author' is wrong, use something like 'Knuth, Donald E. and Duane, Bibby'"
- }
- if ($author =~ /.*[A-Z]([ ,]|$).*/) {
- return "A shortened name must have a tailing dot, as in 'Knuth, Donald E.'"
- }
+ if (not exists $entry{'author'}) {
+ return;
}
+ if ($entry{'author'} =~ /^\{.+\}$/) {
+ return;
+ }
+ my $author = clean_tex($entry{'author'});
+ if (index($author, '{') != -1) {
+ return;
+ }
+ if (not $author =~ /^[A-Z][^ ]+(,( [A-Z][^ ]+)+)?( and [A-Z][^ ]+(,( [A-Z][^ ]+)+)?)*( and others)?$/) {
+ return "The format of the 'author' is wrong, use something like 'Knuth, Donald E. and Duane, Bibby'"
+ }
+ if ($author =~ /.*[A-Z]([ ,]|$).*/) {
+ return "A shortened name must have a tailing dot, as in 'Knuth, Donald E.'"
+ }
}
# Check that titles don't have shortened words with a tailing dot.
@@ -134,7 +147,10 @@
}
# Check the right format of the 'title' and 'booktitle.'
-sub check_titles {
+sub check_wrapping {
+ if (exists $args{'--no:wraps'}) {
+ return;
+ }
my (%entry) = @_;
my @tags = qw/title booktitle/;
foreach my $tag (@tags) {
@@ -177,6 +193,9 @@
# Check that organization is not mentioned in the booktitle.
sub check_org_in_booktitle {
+ if (exists $args{'--no:org'}) {
+ return;
+ }
my (%entry) = @_;
my @orgs = ( 'ACM', 'IEEE' );
if (exists($entry{'booktitle'})) {
@@ -311,6 +330,9 @@
# Check the right format of the 'booktitle' in the 'inproceedings' entry.
sub check_booktile_of_inproceedings {
+ if (exists $args{'--no:inproc'}) {
+ return;
+ }
my (%entry) = @_;
my $tag = 'inproceedings';
if ($entry{':type'} eq $tag) {
@@ -325,6 +347,9 @@
# Check the right format of the 'doi.'
sub check_doi {
+ if (exists $args{'--no:doi'}) {
+ return;
+ }
my (%entry) = @_;
if (exists $entry{'doi'}) {
my $doi = $entry{'doi'};
@@ -339,9 +364,15 @@
my (%entry) = @_;
if (exists $entry{'year'}) {
my $year = $entry{'year'};
- if (not $year =~ /^[0-9]{3,4}$/) {
- return "The format of the 'year' is wrong"
+ if ($year =~ /^\{.+\}$/) {
+ return;
}
+ if (not $year =~ /^[0-9]+$/) {
+ return "The format of the 'year' is wrong, may only contain numbers or must be wrapped in curly braces"
+ }
+ if (not $year =~ /^[0-9]{4}$/) {
+ return "Exactly four digits must be present in the 'year', or it must be wrapped in curly braces"
+ }
}
}
@@ -391,8 +422,8 @@
if ($parts[0] eq $parts[1]) {
return "The 'pages' mentions the same page twice, just use it once"
}
- if ($parts[0] gt $parts[1]) {
- return "The 'pages' are in the wrong order"
+ if ($parts[0] > $parts[1]) {
+ return "The 'pages' are in the wrong order, since $parts[0] is greater than $parts[1]"
}
}
}
@@ -429,7 +460,7 @@
foreach my $check (@sorted) {
no strict 'refs';
my $err = $check->(%entry);
- if ($err ne '') {
+ if (defined $err and $err ne '') {
push(@errors, $err);
}
}
@@ -724,10 +755,17 @@
" -?, --help Print this help screen\n" .
" --fix Fix the errors and print a new version of the .bib file to the console\n" .
" --verbose Print supplementary debugging information\n" .
+ " --no:XXX Disable one of the following checks (e.g. --no:wraps):\n" .
+ " tags Only some tags are allowed, while some of them are mandatory\n" .
+ " caps All major words in titles and booktitles must be capitalized\n" .
+ " wraps Double curly braces are required around titles and booktitles\n" .
+ " doi The presence of the 'doi' tag is mandatory in all entries\n" .
+ " inproc The booktitle of \@inproceedings must start with 'Proceedings of the'\n" .
+ " org The booktitle may not mention ACM or IEEE\n" .
" --latex Report errors in LaTeX format using \\PackageWarningNoLine command\n\n" .
"If any issues, report to GitHub: https://github.com/yegor256/bibcop");
} elsif (exists $args{'--version'} or exists $args{'-v'}) {
- info('0.0.10');
+ info('0.0.11');
} else {
my ($file) = grep { not($_ =~ /^--.*$/) } @ARGV;
if (not $file) {
Modified: trunk/Master/texmf-dist/doc/bibtex/bibcop/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/bibtex/bibcop/README.md 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/texmf-dist/doc/bibtex/bibcop/README.md 2023-05-18 20:06:03 UTC (rev 67145)
@@ -12,7 +12,7 @@
First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
from [CTAN](https://ctan.org/pkg/bibcop)
-and then use in the preamble (if you use BibTeX, for example):
+and then use in the preamble (if you use [BibTeX](http://www.bibtex.org/), for example):
```tex
\documentclass{article}
Modified: trunk/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/man/man1/bibcop.1
===================================================================
--- trunk/Master/texmf-dist/doc/man/man1/bibcop.1 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/texmf-dist/doc/man/man1/bibcop.1 2023-05-18 20:06:03 UTC (rev 67145)
@@ -1,4 +1,4 @@
-.TH bibcop 1 "2023-05-16"
+.TH bibcop 1 "2023-05-18"
.SH NAME
bibcop \- Style Checker and Fixer of BibTeX Files (.bib)
.SH SYNOPSIS
Modified: trunk/Master/texmf-dist/doc/man/man1/bibcop.man1.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/scripts/bibcop/bibcop.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/bibcop/bibcop.pl 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/texmf-dist/scripts/bibcop/bibcop.pl 2023-05-18 20:06:03 UTC (rev 67145)
@@ -44,6 +44,9 @@
# Check the presence of mandatory tags.
sub check_mandatory_tags {
+ if (exists $args{'--no:tags'}) {
+ return;
+ }
my (%entry) = @_;
my $type = $entry{':type'};
my $mandatory = $blessed{$type};
@@ -71,6 +74,9 @@
# Check that all major words are capitalized.
sub check_capitalization {
+ if (exists $args{'--no:caps'}) {
+ return;
+ }
my (%entry) = @_;
my %tags = map { $_ => 1 } qw/title booktitle journal publisher organization/;
foreach my $tag (keys %entry) {
@@ -101,15 +107,22 @@
# Check that the 'author' is formatted correctly.
sub check_author {
my (%entry) = @_;
- if (exists $entry{'author'} and not $entry{'author'} =~ /^\{.+\}$/) {
- my $author = clean_tex($entry{'author'});
- if (not $author =~ /^[A-Z][^ ]+(,( [A-Z][^ ]+)+)?( and [A-Z][^ ]+(,( [A-Z][^ ]+)+)?)*( and others)?$/) {
- return "The format of the 'author' is wrong, use something like 'Knuth, Donald E. and Duane, Bibby'"
- }
- if ($author =~ /.*[A-Z]([ ,]|$).*/) {
- return "A shortened name must have a tailing dot, as in 'Knuth, Donald E.'"
- }
+ if (not exists $entry{'author'}) {
+ return;
}
+ if ($entry{'author'} =~ /^\{.+\}$/) {
+ return;
+ }
+ my $author = clean_tex($entry{'author'});
+ if (index($author, '{') != -1) {
+ return;
+ }
+ if (not $author =~ /^[A-Z][^ ]+(,( [A-Z][^ ]+)+)?( and [A-Z][^ ]+(,( [A-Z][^ ]+)+)?)*( and others)?$/) {
+ return "The format of the 'author' is wrong, use something like 'Knuth, Donald E. and Duane, Bibby'"
+ }
+ if ($author =~ /.*[A-Z]([ ,]|$).*/) {
+ return "A shortened name must have a tailing dot, as in 'Knuth, Donald E.'"
+ }
}
# Check that titles don't have shortened words with a tailing dot.
@@ -134,7 +147,10 @@
}
# Check the right format of the 'title' and 'booktitle.'
-sub check_titles {
+sub check_wrapping {
+ if (exists $args{'--no:wraps'}) {
+ return;
+ }
my (%entry) = @_;
my @tags = qw/title booktitle/;
foreach my $tag (@tags) {
@@ -177,6 +193,9 @@
# Check that organization is not mentioned in the booktitle.
sub check_org_in_booktitle {
+ if (exists $args{'--no:org'}) {
+ return;
+ }
my (%entry) = @_;
my @orgs = ( 'ACM', 'IEEE' );
if (exists($entry{'booktitle'})) {
@@ -311,6 +330,9 @@
# Check the right format of the 'booktitle' in the 'inproceedings' entry.
sub check_booktile_of_inproceedings {
+ if (exists $args{'--no:inproc'}) {
+ return;
+ }
my (%entry) = @_;
my $tag = 'inproceedings';
if ($entry{':type'} eq $tag) {
@@ -325,6 +347,9 @@
# Check the right format of the 'doi.'
sub check_doi {
+ if (exists $args{'--no:doi'}) {
+ return;
+ }
my (%entry) = @_;
if (exists $entry{'doi'}) {
my $doi = $entry{'doi'};
@@ -339,9 +364,15 @@
my (%entry) = @_;
if (exists $entry{'year'}) {
my $year = $entry{'year'};
- if (not $year =~ /^[0-9]{3,4}$/) {
- return "The format of the 'year' is wrong"
+ if ($year =~ /^\{.+\}$/) {
+ return;
}
+ if (not $year =~ /^[0-9]+$/) {
+ return "The format of the 'year' is wrong, may only contain numbers or must be wrapped in curly braces"
+ }
+ if (not $year =~ /^[0-9]{4}$/) {
+ return "Exactly four digits must be present in the 'year', or it must be wrapped in curly braces"
+ }
}
}
@@ -391,8 +422,8 @@
if ($parts[0] eq $parts[1]) {
return "The 'pages' mentions the same page twice, just use it once"
}
- if ($parts[0] gt $parts[1]) {
- return "The 'pages' are in the wrong order"
+ if ($parts[0] > $parts[1]) {
+ return "The 'pages' are in the wrong order, since $parts[0] is greater than $parts[1]"
}
}
}
@@ -429,7 +460,7 @@
foreach my $check (@sorted) {
no strict 'refs';
my $err = $check->(%entry);
- if ($err ne '') {
+ if (defined $err and $err ne '') {
push(@errors, $err);
}
}
@@ -724,10 +755,17 @@
" -?, --help Print this help screen\n" .
" --fix Fix the errors and print a new version of the .bib file to the console\n" .
" --verbose Print supplementary debugging information\n" .
+ " --no:XXX Disable one of the following checks (e.g. --no:wraps):\n" .
+ " tags Only some tags are allowed, while some of them are mandatory\n" .
+ " caps All major words in titles and booktitles must be capitalized\n" .
+ " wraps Double curly braces are required around titles and booktitles\n" .
+ " doi The presence of the 'doi' tag is mandatory in all entries\n" .
+ " inproc The booktitle of \@inproceedings must start with 'Proceedings of the'\n" .
+ " org The booktitle may not mention ACM or IEEE\n" .
" --latex Report errors in LaTeX format using \\PackageWarningNoLine command\n\n" .
"If any issues, report to GitHub: https://github.com/yegor256/bibcop");
} elsif (exists $args{'--version'} or exists $args{'-v'}) {
- info('0.0.10');
+ info('0.0.11');
} else {
my ($file) = grep { not($_ =~ /^--.*$/) } @ARGV;
if (not $file) {
Modified: trunk/Master/texmf-dist/source/bibtex/bibcop/bibcop.dtx
===================================================================
--- trunk/Master/texmf-dist/source/bibtex/bibcop/bibcop.dtx 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/texmf-dist/source/bibtex/bibcop/bibcop.dtx 2023-05-18 20:06:03 UTC (rev 67145)
@@ -50,7 +50,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{bibcop}
%<*package>
-[2023-05-16 0.0.10 Style Checker of Bibliography Files]
+[2023-05-18 0.0.11 Style Checker of Bibliography Files]
%</package>
%<*driver>
\documentclass{ltxdoc}
@@ -149,6 +149,27 @@
%</verb>
%\fi
+% \DescribeMacro{no*}
+% It's possible to suppress certain rules, by using one of the |no*| package options:
+%\iffalse
+%<*verb>
+%\fi
+\begin{verbatim}
+\usepackage[nodoi,nowraps]{bibcop}
+\end{verbatim}
+%\iffalse
+%</verb>
+%\fi
+% The following options are available:
+% \begin{itemize}\setlength\itemsep{0pt}
+% \item |nocaps| allows arbitrary capitalization in titles;
+% \item |nowraps| allows titles to have no double curly braces;
+% \item |nodoi| allows the absence of the |doi| tag in all entries;
+% \item |noinproc| allows the |booktitle| tag in |@inproceedings| entries to not start with ``Proceedings of the'';
+% \item |noorg| allows mentioning of ACM/IEEE in the |booktitle| tag;
+% \item |notags| allows any tags and allow to miss important tags.
+% \end{itemize}
+
% \section{The Rules}
% This is a more or less complete list of rules enforced on a |.bib| file:
@@ -197,6 +218,7 @@
%\iffalse
%</verb>
%\fi
+% This rule may be disabled by the |nocaps| package option.
% \DescribeMacro{author}
% The |author| must contain a list of authors separated by ``|and|''. Each author
@@ -354,6 +376,7 @@
%\iffalse
%</verb>
%\fi
+% This rule may be disabled by the |noinproc| package option.
% \DescribeMacro{arXiv}
% If the |archivePrefix| is present, the |eprint| and the |primaryClass| must also be present and must adhere to the formatting principles of \href{https://arxiv.org/help/arxiv_identifier}{arXiv identifiers}:
@@ -403,6 +426,12 @@
\RequirePackage{pgfopts}
\pgfkeys{
/bibcop/.cd,
+ notags/.store in=\bibcop at notags,
+ noorg/.store in=\bibcop at noorg,
+ noinproc/.store in=\bibcop at noinproc,
+ nocaps/.store in=\bibcop at nocaps,
+ nodoi/.store in=\bibcop at nodoi,
+ nowraps/.store in=\bibcop at nowraps,
verbose/.store in=\bibcop at verbose,
script/.store in = \bibcop at script,
}
@@ -423,6 +452,25 @@
% \end{macrocode}
% \end{macro}
+% \begin{macro}{\bibcop at exec}
+% Then, we define a supplementary command to execute the Perl script:
+% \begin{macrocode}
+\makeatletter
+\newcommand\bibcop at exec[1]{
+ \iexec{\bibcop at script\space
+ \ifdefined\bibcop at verbose--verbose\fi\space
+ \ifdefined\bibcop at notags--no:tags\fi\space
+ \ifdefined\bibcop at noinproc--no:org\fi\space
+ \ifdefined\bibcop at noinproc--no:inproc\fi\space
+ \ifdefined\bibcop at nodoi--no:doi\fi\space
+ \ifdefined\bibcop at nocaps--no:caps\fi\space
+ \ifdefined\bibcop at nowraps--no:wraps\fi\space
+ --latex '#1'}%
+ \message{bibcop: style checking finished for #1^^J}%
+}
+\makeatother
+
+
% \begin{macro}{\bibliography}
% Then, we re-define the |\bibliography| command:
% \begin{macrocode}
@@ -430,10 +478,7 @@
\ifdefined\bibliography
\let\bibcop at oldbibliography\bibliography
\renewcommand\bibliography[1]{%
- \iexec{\bibcop at script\space
- \ifdefined\bibcop at verbose--verbose\fi\space
- --latex '#1.bib'}%
- \message{bibcop: style checking finished^^J}%
+ \bibcop at exec{#1.bib}%
\bibcop at oldbibliography{#1}%
}
\fi
@@ -448,10 +493,7 @@
\ifdefined\addbibresource
\let\bibcop at oldaddbibresource\addbibresource
\renewcommand\addbibresource[1]{%
- \iexec{\bibcop at script\space
- \ifdefined\bibcop at verbose--verbose\fi\space
- --latex '#1'}%
- \message{bibcop: style checking finished^^J}%
+ \bibcop at exec{#1}%
\bibcop at oldaddbibresource{#1}%
}
\fi
Modified: trunk/Master/texmf-dist/tex/latex/bibcop/bibcop.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/bibcop/bibcop.sty 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/texmf-dist/tex/latex/bibcop/bibcop.sty 2023-05-18 20:06:03 UTC (rev 67145)
@@ -31,7 +31,7 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{bibcop}
-[2023-05-16 0.0.10 Style Checker of Bibliography Files]
+[2023-05-18 0.0.11 Style Checker of Bibliography Files]
@@ -62,11 +62,18 @@
+
\RequirePackage{iexec}
\RequirePackage{pgfopts}
\pgfkeys{
/bibcop/.cd,
+ notags/.store in=\bibcop at notags,
+ noorg/.store in=\bibcop at noorg,
+ noinproc/.store in=\bibcop at noinproc,
+ nocaps/.store in=\bibcop at nocaps,
+ nodoi/.store in=\bibcop at nodoi,
+ nowraps/.store in=\bibcop at nowraps,
verbose/.store in=\bibcop at verbose,
script/.store in = \bibcop at script,
}
@@ -82,13 +89,25 @@
\makeatother
\makeatletter
+\newcommand\bibcop at exec[1]{
+ \iexec{\bibcop at script\space
+ \ifdefined\bibcop at verbose--verbose\fi\space
+ \ifdefined\bibcop at notags--no:tags\fi\space
+ \ifdefined\bibcop at noinproc--no:org\fi\space
+ \ifdefined\bibcop at noinproc--no:inproc\fi\space
+ \ifdefined\bibcop at nodoi--no:doi\fi\space
+ \ifdefined\bibcop at nocaps--no:caps\fi\space
+ \ifdefined\bibcop at nowraps--no:wraps\fi\space
+ --latex '#1'}%
+ \message{bibcop: style checking finished for #1^^J}%
+}
+\makeatother
+
+\makeatletter
\ifdefined\bibliography
\let\bibcop at oldbibliography\bibliography
\renewcommand\bibliography[1]{%
- \iexec{\bibcop at script\space
- \ifdefined\bibcop at verbose--verbose\fi\space
- --latex '#1.bib'}%
- \message{bibcop: style checking finished^^J}%
+ \bibcop at exec{#1.bib}%
\bibcop at oldbibliography{#1}%
}
\fi
@@ -98,10 +117,7 @@
\ifdefined\addbibresource
\let\bibcop at oldaddbibresource\addbibresource
\renewcommand\addbibresource[1]{%
- \iexec{\bibcop at script\space
- \ifdefined\bibcop at verbose--verbose\fi\space
- --latex '#1'}%
- \message{bibcop: style checking finished^^J}%
+ \bibcop at exec{#1}%
\bibcop at oldaddbibresource{#1}%
}
\fi
Modified: trunk/Master/tlpkg/bin/tlpkg-ctan-check
===================================================================
--- trunk/Master/tlpkg/bin/tlpkg-ctan-check 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/tlpkg/bin/tlpkg-ctan-check 2023-05-18 20:06:03 UTC (rev 67145)
@@ -216,7 +216,7 @@
context-gantt context-gnuplot context-handlecsv
context-layout context-letter context-lettrine context-mathsets
context-notes-zh-cn context-pocketdiary context-rst context-ruby
- context-simplefonts context-simpleslides context-title
+ context-simplefonts context-simpleslides context-sudoku context-title
context-transliterator context-typearea context-typescripts context-vim
context-visualcounter
continue contour contracard conv-xkv convbkmk
Modified: trunk/Master/tlpkg/libexec/ctan2tds
===================================================================
--- trunk/Master/tlpkg/libexec/ctan2tds 2023-05-17 23:43:44 UTC (rev 67144)
+++ trunk/Master/tlpkg/libexec/ctan2tds 2023-05-18 20:06:03 UTC (rev 67145)
@@ -373,6 +373,7 @@
'context-sgf', "die 'skipping, obsolete per author'",
'context-simplefonts', "&MAKEcopy",
'context-simpleslides',"&MAKEcopy",
+ 'context-sudoku', "&MAKEcopy",
'context-taspresent', "&MAKEcopy",
'context-texlive', "die 'skipping, maintained in TL, see .tlpsrc'",
'context-title', "&MAKEcopy",
More information about the tex-live-commits
mailing list.