diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/bib2gls/README.md')
-rw-r--r-- | Master/texmf-dist/doc/support/bib2gls/README.md | 51 |
1 files changed, 39 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/support/bib2gls/README.md b/Master/texmf-dist/doc/support/bib2gls/README.md index 2627a963a16..c1e0ad4ffcf 100644 --- a/Master/texmf-dist/doc/support/bib2gls/README.md +++ b/Master/texmf-dist/doc/support/bib2gls/README.md @@ -7,23 +7,32 @@ Author: Nicola Talbot (https://www.dickimaw-books.com/contact) Application Home Page: https://www.dickimaw-books.com/software/bib2gls -# Licence +Version details of the current installation can be obtained with +`--version` or `-v`: -Copyright (C) 2017-2024 Nicola L. C. Talbot (dickimaw-books.com) +```bash +bib2gls --version +convertgls2bib --version +datatool2bib --version +``` + +## Licence + +Copyright (C) 2017-2025 Nicola L. C. Talbot (dickimaw-books.com) License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. -# Requirements +## Requirements - Java Runtime Environment (at least Java 8). - TeX distribution that includes `glossaries-extra.sty` and dependent packages (such as `glossaries.sty`). -# Summary +## Summary This application may be used to extract glossary information stored in a `.bib` file and convert it into glossary entry @@ -42,6 +51,10 @@ in a system such as JabRef, and only the entries that are actually required will be defined, reducing the resources required by TeX. +##Supplementary applications + +### `convertgls2bib` + The supplementary application `convertgls2bib` can be used to convert existing `.tex` files containing definitions (`\newglossaryentry` etc) to the `.bib` format @@ -64,7 +77,7 @@ convertgls2tex entries.tex entries.bib ``` to create `entries.bib`. -# Example +## Example File `entries.bib`: @@ -124,7 +137,12 @@ pdflatex myDoc (Replace `pdflatex` with `latex`, `xelatex` or `lualatex` as appropriate.) -# Related Resources +### `datatool2bib`. + +The supplementary application `datatool2bib` can be used to convert +`datatool` databases to `.bib` files suitable for use with `bib2gls`. + +## Related Resources - [bib2gls FAQ](https://www.dickimaw-books.com/faq.php?category=bib2gls). - [bib2gls gallery](https://www.dickimaw-books.com/gallery/#bib2gls). @@ -140,25 +158,34 @@ TUGboat articles: poisons), issue [43:1, 2022](https://tug.org/TUGboat/Contents/contents43-1.html). [(PDF)](https://tug.org/TUGboat/tb43-1/tb133talbot-bib2gls-reorder.pdf) -# Installation +## Installation The files should be installed as follows where *TEXMF* indicates your local or home TEXMF path (for example, `~/texmf/`): - *TEXMF*`/scripts/bib2gls/bib2gls.jar` (Java application.) - *TEXMF*`/scripts/bib2gls/convertgls2bib.jar` (Java application.) + - *TEXMF*`/scripts/bib2gls/datatool2bib.jar` (Java application.) + - *TEXMF*`/scripts/bib2gls/bibglscommon.jar` (Java library + providing code shared by `bib2gls` and the conversion tools.) - *TEXMF*`/scripts/bib2gls/texparserlib.jar` (Java library.) - - *TEXMF*`/scripts/bib2gls/resources/bib2gls-en.xml` (English + - *TEXMF*`/scripts/bib2gls/resources/bib2gls-en.xml` (main English resource file.) + - *TEXMF*`/scripts/bib2gls/resources/bib2gls-extra-en.xml` + (supplementary English resource file.) + - *TEXMF*`/scripts/bib2gls/resources/bib2gls-extra-nl.xml` + (supplementary Dutch resource file.) - *TEXMF*`/scripts/bib2gls/bib2gls.sh` (Unix-like systems only.) - *TEXMF*`/scripts/bib2gls/convertgls2bib.sh` (Unix-like systems only.) + - *TEXMF*`/scripts/bib2gls/datatool2bib.sh` (Unix-like systems + only.) - *TEXMF*`/doc/support/bib2gls/bib2gls.pdf` (User manual.) - *TEXMF*`/doc/support/bib2gls/bib2gls-begin.pdf` (Introductory Guide.) - *TEXMF*`/doc/support/bib2gls/examples/` (example files) Note that `texparserlib.jar` isn't an application. It's -a library used by `bib2gls.jar` and `convertgls2bib.jar` +a library used by `bib2gls.jar` and the `*2bib` conversion tools and so needs to be on the same class path as them. The bash `.sh` scripts are provided for Unix-like users. @@ -173,7 +200,7 @@ convertgls2bib --version ``` These should display the version details. -# Source Code +## Source Code Instructions for compiling the manual and jar files are listed below. The source is also available on GitHub, but that may be for @@ -183,7 +210,7 @@ a newer experimental version. - https://github.com/nlct/texparser -## User Manual (bib2gls.pdf) +### User Manual (bib2gls.pdf) The examples directory needs to be ../examples relative to directory containing bib2gls.tex as the .bib, .tex and .pdf files are included @@ -201,7 +228,7 @@ xelatex bib2gls Similarly for the bib2gls-begin.pdf document. -## JAR Files +### JAR Files Create the following directories: |