diff options
author | Karl Berry <karl@freefriends.org> | 2024-05-06 16:47:16 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-05-06 16:47:16 +0000 |
commit | fcf1e0fa22fa90e8da88239b678a366591dabe23 (patch) | |
tree | 42cc0353219fdf54ed8e5be54d53a2a0d37e2ca4 /Master/texmf-dist/doc/bibtex/bibcop | |
parent | e1169a7511b55fc522976ea334eadddadd7d3093 (diff) |
bibcop
git-svn-id: svn://tug.org/texlive/trunk@71186 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/bibtex/bibcop')
-rw-r--r-- | Master/texmf-dist/doc/bibtex/bibcop/README.md | 73 | ||||
-rw-r--r-- | Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf | bin | 347801 -> 347804 bytes |
2 files changed, 48 insertions, 25 deletions
diff --git a/Master/texmf-dist/doc/bibtex/bibcop/README.md b/Master/texmf-dist/doc/bibtex/bibcop/README.md index e1263b09f34..04e5f0810f6 100644 --- a/Master/texmf-dist/doc/bibtex/bibcop/README.md +++ b/Master/texmf-dist/doc/bibtex/bibcop/README.md @@ -1,4 +1,6 @@ -<img src="https://raw.githubusercontent.com/yegor256/bibcop/master/bibcop-logo.svg" height="92px"/> +# Bibcop: Style Checker of BibTeX .bib files + +![bibcop logo](bibcop-logo.png) [![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) @@ -10,12 +12,12 @@ emits warning message if any issues are found. You may also like [biblatex-check](https://github.com/pezmc/biblatex-check) tools — they do _almost_ the same but from the command line. -Read [this blog post](https://www.yegor256.com/2023/09/05/style-checker-for-bibtex-files.html), -in order to understand the motivation behind this package. +Read [this blog post][BLOG],in order to understand +the motivation behind this package. -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](http://www.bibtex.org/), for example): +First, [install it][INSTALL] from [CTAN](https://ctan.org/pkg/bibcop) +and then use in the preamble +(if you use [BibTeX](http://www.bibtex.org/), for example): ```tex \documentclass{article} @@ -26,45 +28,66 @@ and then use in the preamble (if you use [BibTeX](http://www.bibtex.org/), for e \end{document} ``` -Otherwise, you can download [`bibcop.sty`](https://raw.githubusercontent.com/yegor256/bibcop/gh-pages/bibcop.sty) and add to your project (together with [`bibcop.pl`](https://raw.githubusercontent.com/yegor256/bibcop/gh-pages/bibcop.pl)!). +You can also add it as a GitHub Action to your +GitHub repository, with the help of +[bibcop-action](https://github.com/yegor256/bibcop-action). + +Otherwise, you can download +[`bibcop.sty`](https://yegor256.github.io/bibcop/bibcop.sty) +and add to your project (together with +[`bibcop.pl`](https://yegor256.github.io/bibcop/bibcop.pl)!). -You can also download [`bibcop.pl`](https://raw.githubusercontent.com/yegor256/bibcop/gh-pages/bibcop.pl) +You can also download +[`bibcop.pl`](https://yegor256.github.io/bibcop/bibcop.pl) and use it as a command line tool to check your `.bib` files and to auto-fix them (you should have [Perl](https://www.perl.org) installed): -``` -$ perl bibcop.pl --fix main.bib > fixed.bib +```bash +perl 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). +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). Be careful, all comments will be removed. -If you install the package using [`tlmgr`](https://www.tug.org/texlive/tlmgr.html), -you should be able to use `bibcop` directly, without the necessity to mention Perl: +You can also make changes inline, not creating a new file: +```bash +perl bibcop.pl --fix --in-place main.bib ``` -$ tlgmr install bibcop -$ bibcop --help + +If you install the package using +[`tlmgr`](https://www.tug.org/texlive/tlmgr.html), +you should be able to use `bibcop` directly, without the +necessity to mention Perl: + +```bash +tlgmr install bibcop +bibcop --help ``` ## 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 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. +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 -$ perl tests.pl +perl tests.pl ``` You should see the `GREAT!` message. -Copyright (c) 2022-2024 Yegor Bugayenko, MIT License
\ No newline at end of file +Copyright (c) 2022-2024 Yegor Bugayenko, MIT License + +[BLOG]: https://www.yegor256.com/2023/09/05/style-checker-for-bibtex-files.html +[INSTALL]: https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages diff --git a/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf b/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf Binary files differindex 57e80dcc822..74b981beb0a 100644 --- a/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf +++ b/Master/texmf-dist/doc/bibtex/bibcop/bibcop.pdf |