diff options
author | Karl Berry <karl@freefriends.org> | 2018-05-09 22:21:20 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-05-09 22:21:20 +0000 |
commit | 867aa333d857d958dd28292c7ed61b827376b880 (patch) | |
tree | 572d2d7bedf515c807f3c337a0c64063916adc55 /Master/texmf-dist/doc/support | |
parent | b5c5ee528e09f238529376b45ac7d1adf8e7f0d6 (diff) |
bib2gls (8may18)
git-svn-id: svn://tug.org/texlive/trunk@47658 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
25 files changed, 190 insertions, 28 deletions
diff --git a/Master/texmf-dist/doc/support/bib2gls/CHANGES b/Master/texmf-dist/doc/support/bib2gls/CHANGES index 48af0c3703d..c15c185c129 100644 --- a/Master/texmf-dist/doc/support/bib2gls/CHANGES +++ b/Master/texmf-dist/doc/support/bib2gls/CHANGES @@ -1,3 +1,36 @@ +v1.5 (2018-05-09): + + * added introductory guide (bib2gls-begin.pdf) + + * rearranged some of the resource option sections in + the main user manual (bib2gls.pdf) + + * new .glstex helper command: + + \bibglssetlastgrouptitle + + * added @indexplural and associated .glstex helper command + \bibglsnewindexplural + + * added resource options: + + - sort-replace + - dual-sort-replace + - secondary-sort-replace + + * save-child-count now also creates the childlist internal field. + + * bug fixes: + + - corrected encoding setting (bib2gls and convertgls2bib) + - corrected \ (backslash space) eol causing unwanted extra eol + - corrected sort fallback + - labelify-replace now recognises \$ in the replacement part as a + reference to a captured group + - improved error handling for invalid entry IDs + - save-child-count was partially switching on flatten-lonely + - corrected name-case-change for @index + v1.4 (2018-04-09): * added switches: diff --git a/Master/texmf-dist/doc/support/bib2gls/README.md b/Master/texmf-dist/doc/support/bib2gls/README.md index 93b3e94103a..8dc48d0ef11 100644 --- a/Master/texmf-dist/doc/support/bib2gls/README.md +++ b/Master/texmf-dist/doc/support/bib2gls/README.md @@ -174,6 +174,8 @@ xelatex bib2gls xelatex bib2gls ``` +Similarly for the bib2gls-begin.pdf document. + ## JAR Files Create the following directories: diff --git a/Master/texmf-dist/doc/support/bib2gls/bib2gls-begin.pdf b/Master/texmf-dist/doc/support/bib2gls/bib2gls-begin.pdf Binary files differnew file mode 100644 index 00000000000..e5599050f5d --- /dev/null +++ b/Master/texmf-dist/doc/support/bib2gls/bib2gls-begin.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 b/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 index 0db7814c41f..7cb3ab10c3f 100644 --- a/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 +++ b/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -46,7 +46,7 @@ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" -.\" If the F register is turned on, we'll generate index entries on stderr for +.\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. @@ -54,20 +54,16 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.if !\nF .nr F 0 +.if \nF>0 \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 . \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "BIB2GLS 1" -.TH BIB2GLS 1 "2018-04-07" "perl v5.18.4" "bib2gls" +.TH BIB2GLS 1 "2018-04-07" "perl v5.26.1" "bib2gls" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf b/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf Binary files differindex 5d17bbd70cd..42d6355149a 100644 --- a/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 b/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 index f577e3b5b4a..cc315d6401d 100644 --- a/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 +++ b/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) +.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -46,7 +46,7 @@ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" -.\" If the F register is turned on, we'll generate index entries on stderr for +.\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. @@ -54,20 +54,16 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{ -. if \nF \{ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.if !\nF .nr F 0 +.if \nF>0 \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{ -. nr % 0 -. nr F 2 -. \} +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 . \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "CONVERTGLS2BIB 1" -.TH CONVERTGLS2BIB 1 "2018-03-04" "perl v5.18.4" "convertgls2bib" +.TH CONVERTGLS2BIB 1 "2018-03-04" "perl v5.26.1" "convertgls2bib" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/citations.bib b/Master/texmf-dist/doc/support/bib2gls/examples/citations.bib new file mode 100644 index 00000000000..389cb7bdea0 --- /dev/null +++ b/Master/texmf-dist/doc/support/bib2gls/examples/citations.bib @@ -0,0 +1,65 @@ +% This file is public domain. See the "Examples" chapter +% in the bib2gls user manual for a more detailed description +% of this file. + +% Encoding: UTF-8 + +@preamble{"\providecommand{\titlefmt}[1]{`#1'}"} + +@article{duck2018, + author = {Dickie Duck and Jos\'{e} Arara and Polly Parrot}, + title = {Avian friendship}, + journal = {Fowl Times}, + year = 2018, + volume = 7, + number = 5, + pages = "1032--5" +} + +@book{duck2016, + author = {Dickie Duck}, + title = {Feathered stunt doubles: \titlefmt{The Birds} and +other films}, + publisher = {Duck Duck Goose}, + year = 2016 +} + +@book{macaw, + author = {Prof Macaw}, + title = {Annotated notes on the \titlefmt{Duck and Goose} +chronicles}, + publisher = {Duck Duck Goose}, + year = 2012 +} + +@book{ing, + author = {Bor Ing}, + title = {\titlefmt{Duck and Goose}: an allegory for modern +times?}, + publisher = {Duck Duck Goose}, + year = 2010 +} + +@article{parrot, + author = {Polly Parrot and Dickie Duck}, + title = {\titlefmt{Duck and Goose} Cheat Sheet for Students}, + journal = {Fowl Times}, + year = 2013, + volume = 2, + number = 10, + pages = "15--23" +} + +@book{parrot2012, + author = {A Parrot}, + title = {My Friend is a Duck}, + publisher = {Duck Duck Goose}, + year = 2012 +} + +@book{quackalot, + author = {Sir Quackalot}, + title = {The Adventures of Duck and Goose}, + publisher = {Duck Duck Goose}, + year = 2011 +} diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-authors.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-authors.pdf Binary files differindex fe10f53a947..53dd2b2c9fd 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-authors.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-authors.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-bacteria.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-bacteria.pdf Binary files differindex 49455ff3640..e99f947d3b2 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-bacteria.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-bacteria.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-chemical.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-chemical.pdf Binary files differindex 856549f2d2a..005b6fc393d 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-chemical.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-chemical.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.pdf Binary files differnew file mode 100644 index 00000000000..50df92de206 --- /dev/null +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.tex b/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.tex new file mode 100644 index 00000000000..3cf9fd14a0f --- /dev/null +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-citations.tex @@ -0,0 +1,70 @@ +% This file is public domain. See the "Examples" chapter +% in the bib2gls user manual for a more detailed description +% of this file. + +% bib2gls must be run with the --cite-as-record switch + +\documentclass[12pt,a4paper]{article} + +\usepackage[record,% using bib2gls +nomain,% don't define main glossary +postdot,% full stop after descriptions +nostyles,% don't load default styles +% load glossary-tree and glossary-list and patch styles: +stylemods={tree,list} +]{glossaries-extra} + +\newglossary*{contributors}{Authors} +\newglossary*{titles}{Titles} + +\newcommand{\bibglsnewbibtexentry}[4]{% + \longnewglossaryentry*{#1}{name={#3},#2,type={titles}}{#4}% +} + +\GlsXtrLoadResources[ + src={citations},% data in citations.bib + entry-type-aliases={\GlsXtrBibTeXEntryAliases}, + field-aliases={ + title=name + }, + type={contributors}, + category={same as original entry}, + sort-field={category}, + sort-suffix={name} +] + +\glsxtrsetgrouptitle{article}{Articles} +\glsxtrsetgrouptitle{book}{Books} + +\newcommand{\contributorhandler}[1]{\par\glsentryname{#1} \cite{#1}} + +\newcommand{\glsxtrpostdesccontributor}{% + \glsxtrifhasfield{bibtexentry}{\glscurrententrylabel}% + {% + \glsxtrfieldforlistloop + {\glscurrententrylabel}{bibtexentry}% + {\contributorhandler}% + }% + {\par No titles.}% +} + +\newcommand{\glsxtrpostdescarticle}{\cite{\glscurrententrylabel}} +\newcommand{\glsxtrpostdescbook}{\cite{\glscurrententrylabel}} + +\begin{document} +This is a sample document with some citations~\cite{macaw,parrot} +and some more citations~\cite{duck2018,duck2016} and don't +forget~\cite{ing,parrot2012} and lastly~\cite{quackalot}. + +\printunsrtglossary[type=contributors,style=altlist] +\printunsrtglossary*[type=titles,style=indexgroup] +{% + \renewcommand{\glsxtrgroupfield}{category}% + \renewcommand{\glstreenamefmt}[1]{\emph{#1}}% + \renewcommand{\glstreegroupheaderfmt}[1]{\textbf{#1}}% +} + +\bibliographystyle{unsrt} +\bibliography{citations} + +\end{document} diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-constants.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-constants.pdf Binary files differindex 5efc443c095..cd84465a2d3 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-constants.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-constants.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-languages.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-languages.pdf Binary files differindex 074f4e34945..b5ce4f84b9d 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-languages.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-languages.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-maths.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-maths.pdf Binary files differindex 6867cf63943..0d4d2170158 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-maths.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-maths.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-media.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-media.pdf Binary files differindex 8ef2e531023..379a82017fc 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-media.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-media.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-msymbols.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-msymbols.pdf Binary files differindex 7eee95e4a49..92069a140f1 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-msymbols.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-msymbols.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.pdf Binary files differindex 5c1c8bcb307..3312683b24e 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.pdf Binary files differindex 17bb6275e3d..0cfcc7bd7f9 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-people.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-people.pdf Binary files differindex 0e636887cad..f1bc9a256f3 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-people.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-people.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-textsymbols.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-textsymbols.pdf Binary files differindex 58a326a7c1f..4818e914595 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-textsymbols.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-textsymbols.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units1.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units1.pdf Binary files differindex 493f33c021d..b782107493d 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units1.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units1.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units2.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units2.pdf Binary files differindex af7bc696205..cb280350d6c 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units2.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units2.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units3.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units3.pdf Binary files differindex da9f1ae4715..e10a744bdd9 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-units3.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-units3.pdf diff --git a/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf Binary files differindex 0a1bbbac069..deeb28cbbe7 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf |