summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-12-12 21:07:17 +0000
committerKarl Berry <karl@freefriends.org>2022-12-12 21:07:17 +0000
commitb1511fb94a322b9edc7c1ca91676cf5275d6bcae (patch)
tree646aaa75ba5e3739e5b3ecbbc42914d5631b0d97 /Master/texmf-dist/doc
parenta2a6f21e711bb27829653d592df98c8d9060a22a (diff)
bibcop (12dec22)
git-svn-id: svn://tug.org/texlive/trunk@65257 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/bibcop/DEPENDS.txt3
-rw-r--r--Master/texmf-dist/doc/latex/bibcop/LICENSE.txt21
-rw-r--r--Master/texmf-dist/doc/latex/bibcop/README.md54
-rw-r--r--Master/texmf-dist/doc/latex/bibcop/bibcop-logo.pdfbin0 -> 5100 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bibcop/bibcop.pdfbin0 -> 330862 bytes
5 files changed, 78 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bibcop/DEPENDS.txt b/Master/texmf-dist/doc/latex/bibcop/DEPENDS.txt
new file mode 100644
index 00000000000..08a680f05bf
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibcop/DEPENDS.txt
@@ -0,0 +1,3 @@
+hard iexec
+hard fancyvrb
+hard verbatimcopy \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/bibcop/LICENSE.txt b/Master/texmf-dist/doc/latex/bibcop/LICENSE.txt
new file mode 100644
index 00000000000..463e7d252d4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibcop/LICENSE.txt
@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2022 Yegor Bugayenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Master/texmf-dist/doc/latex/bibcop/README.md b/Master/texmf-dist/doc/latex/bibcop/README.md
new file mode 100644
index 00000000000..b3cbd2ef8a3
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibcop/README.md
@@ -0,0 +1,54 @@
+<img src="https://raw.githubusercontent.com/yegor256/bibcop/master/logo.svg" height="92px"/>
+
+[![l3build](https://github.com/yegor256/bibcop/actions/workflows/l3build.yml/badge.svg)](https://github.com/yegor256/bibcop/actions/workflows/l3build.yml)
+[![CTAN](https://img.shields.io/ctan/v/bibcop)](https://ctan.org/pkg/bibcop)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/bibcop/blob/master/LICENSE.txt)
+
+This LaTeX package checks the quality of your `.bib` file and
+emits warning message if any issues found. You may also like
+[biblint](https://github.com/Kingsford-Group/biblint) tool —
+it does almost the same but from the command line.
+
+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):
+
+```tex
+\documentclass{article}
+\usepackage{bibcop}
+\begin{document}
+\bibliographystyle{plain}
+\bibliography{main}
+\end{document}
+```
+
+Otherwise, you can download [`bibcop.sty`](https://raw.githubusercontent.com/yegor256/bibcop/gh-pages/bibcop/bibcop.sty) and add to your project.
+
+You can also download [bibcop.pl](https://raw.githubusercontent.com/yegor256/bibcop/master/bibcop.pl)
+and use it as a command line tool
+to check your `.bib` files and to auto-fix them:
+
+```
+$ ./bibcop.pl --fix main.bib > fixed.bib
+```
+
+This command will read the `main.bib` file and create `fixed.bib`, which
+will have the fixed and properly formatted content (well, to some extent).
+
+## How to Contribute
+
+If you want to contribute yourself, make a fork, then create a branch,
+then run `l3build ctan` in the root directory.
+It should compile everything without errors. If not, submit an issue and wait.
+Otherwise, make your changes and then run `l3build ctan` again. If the build is
+still clean, submit a pull request.
+
+If you want to add a new check, add it as a Perl subroutine to the `bibcop.pl` file.
+Don't forget to add a test to one of the test files that stay in the `perl-tests/` directory.
+When ready, run this, in order to check that all tests pass:
+
+```bash
+$ ./tests.pl
+```
+
+You should see the `GREAT!` message. \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/bibcop/bibcop-logo.pdf b/Master/texmf-dist/doc/latex/bibcop/bibcop-logo.pdf
new file mode 100644
index 00000000000..497d52dc0b0
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibcop/bibcop-logo.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bibcop/bibcop.pdf b/Master/texmf-dist/doc/latex/bibcop/bibcop.pdf
new file mode 100644
index 00000000000..a8320c97a13
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibcop/bibcop.pdf
Binary files differ