diff options
33 files changed, 434 insertions, 49 deletions
diff --git a/Master/texmf-dist/doc/support/bib2gls/CHANGES b/Master/texmf-dist/doc/support/bib2gls/CHANGES index db762113cb2..f7279391084 100644 --- a/Master/texmf-dist/doc/support/bib2gls/CHANGES +++ b/Master/texmf-dist/doc/support/bib2gls/CHANGES @@ -1,3 +1,13 @@ +v1.3 (2018-03-05): + + * bug fix: check for quoted path elements (spaces in file names) + + * bug fix: corrected category={same as base} + + * bug fix: corrected dual selection + + * New switch --ignore-packages (-k) + v1.2 (2018-02-25): * New resource options: diff --git a/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 b/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 index 6579989a335..a5b9fdd713f 100644 --- a/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 +++ b/Master/texmf-dist/doc/support/bib2gls/bib2gls.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "BIB2GLS 1" -.TH BIB2GLS 1 "2018-02-25" "perl v5.18.4" "bib2gls" +.TH BIB2GLS 1 "2018-03-04" "perl v5.18.4" "bib2gls" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -230,6 +230,14 @@ in \fIlist\fR have been used by the document. Note that there's only a limited number of packages supported by the TeX parser library. This option has a cumulative action so \fB\-\-packages wasysym,pifont\fR is the same as \fB\-\-packages wasysym \-\-packages pifont\fR. +.IP "\fB\-\-ignore\-packages\fR \fIlist\fR (or \fB\-k\fR \fIlist\fR)" 4 +.IX Item "--ignore-packages list (or -k list)" +Don't parse the log file for the packages listed in \fIlist\fR. Note +that \fB\-\-packages\fR overrides this option, so if the same package is +listed in both \fB\-\-ignore\-packages\fR and \fB\-\-packages\fR then the +interpreter will check if it's supported. This option has a +cumulative action. (The \fBglossaries-extra\fR package can't be +included in the ignored \fIlist\fR.) .IP "\fB\-\-mfirstuc\-protection\fR \fIfields\fR|\fBall\fR (or \fB\-u\fR \fIfields\fR|\fBall\fR)" 4 .IX Item "--mfirstuc-protection fields|all (or -u fields|all)" Insert an empty group if fields start with certain problematic diff --git a/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf b/Master/texmf-dist/doc/support/bib2gls/bib2gls.pdf Binary files differindex dbe8b39442b..fe8ac4ece60 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 f597e111b39..f577e3b5b4a 100644 --- a/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 +++ b/Master/texmf-dist/doc/support/bib2gls/convertgls2bib.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "CONVERTGLS2BIB 1" -.TH CONVERTGLS2BIB 1 "2017-11-25" "perl v5.18.4" "convertgls2bib" +.TH CONVERTGLS2BIB 1 "2018-03-04" "perl v5.18.4" "convertgls2bib" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -154,6 +154,15 @@ Display help message and exit. .IP "\fB\-\-version\fR or \fB\-v\fR" 4 .IX Item "--version or -v" Display version information and exit. +.IP "\fB\-\-silent\fR" 4 +.IX Item "--silent" +Suppress all messages except for errors. +.IP "\fB\-\-verbose\fR" 4 +.IX Item "--verbose" +Display messages. +.IP "\fB\-\-debug\fR" 4 +.IX Item "--debug" +Display debugging messages. .IP "\fB\-\-texenc\fR \fIname\fR" 4 .IX Item "--texenc name" Set the character encoding to \fIname\fR for the input \fB.tex\fR files. 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 510cd199b8d..76534290322 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 1b7cf09e7c1..5a5584e01aa 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 0a815e12732..0475e6c3a75 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-constants.pdf b/Master/texmf-dist/doc/support/bib2gls/examples/sample-constants.pdf Binary files differindex 1dc2ab903d7..71bb4a1e182 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 2cd64e23f5e..c1201374f86 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 0a5aecc7ee2..65f831f1e1b 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 536c44cd526..c82a4893b2a 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 d86febb2414..8c26e31452c 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 f72f0384782..7c959fd1b34 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-multi1.tex b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.tex index d2611ebdece..e3151ced73f 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.tex +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi1.tex @@ -36,7 +36,7 @@ % style-dependent name format must be set % before \GlsXtrLoadResources: \renewcommand*{\glsxtrlongshortdescname}{% - \protect\protect\glsabbrvfont{\the\glsshorttok}\space + \protect\glsabbrvfont{\the\glsshorttok}\space \glsxtrparen{\glslongfont{\the\glslongtok}}% } @@ -156,6 +156,7 @@ Derived: \gls{area}, \gls{volume}, \gls{velocity}, \gls{specificvolume}, \gls{concentration}, \gls{wavenumber}. \chapter*{Glossaries} +\renewcommand{\glsextrapostnamehook}[1]{\glsadd[format=hyperbf]{#1}} \printunsrtglossary[type=bacteria,style=mcoltree] \printunsrtglossary[type=markuplanguage,style=altlist] \printunsrtglossary[type=vegetable,style=tree,nogroupskip] @@ -172,6 +173,7 @@ Derived: \gls{area}, \gls{volume}, \gls{velocity}, \printunsrtglossary[type=baseunit,style=alttree] \printunsrtglossary[type=derivedunit,style=alttree] +\renewcommand{\glsextrapostnamehook}[1]{} \setupglossaries{section=chapter} \printunsrtglossary[type=index,style=bookindex] \end{document}} 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 66453f7fc6d..5b7694e8585 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-multi2.tex b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.tex index 77c20456e15..433a56cc1ec 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.tex +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-multi2.tex @@ -72,7 +72,7 @@ % And also the style-dependent name format: \renewcommand*{\glsxtrlongshortdescname}{% - \protect\protect\glsabbrvfont{\the\glsshorttok}\space + \protect\glsabbrvfont{\the\glsshorttok}\space \glsxtrparen{\glslongfont{\the\glslongtok}}% } 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 bcb2a5385a7..2b51baa69d8 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 e76039c30ac..f3ed504f878 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 0dba6b4b051..bf2bed2ec30 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 f02c68b5eb1..2175683b701 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 3a181db17a8..53f6af6c97f 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 39d4154313b..e867646d135 100644 --- a/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf +++ b/Master/texmf-dist/doc/support/bib2gls/examples/sample-usergroups.pdf diff --git a/Master/texmf-dist/scripts/bib2gls/bib2gls.jar b/Master/texmf-dist/scripts/bib2gls/bib2gls.jar Binary files differindex ce9f8050835..dc534c7e0fa 100755 --- a/Master/texmf-dist/scripts/bib2gls/bib2gls.jar +++ b/Master/texmf-dist/scripts/bib2gls/bib2gls.jar diff --git a/Master/texmf-dist/scripts/bib2gls/convertgls2bib.jar b/Master/texmf-dist/scripts/bib2gls/convertgls2bib.jar Binary files differindex 0bcfee40d95..92a7cd9c549 100755 --- a/Master/texmf-dist/scripts/bib2gls/convertgls2bib.jar +++ b/Master/texmf-dist/scripts/bib2gls/convertgls2bib.jar diff --git a/Master/texmf-dist/scripts/bib2gls/resources/bib2gls-en.xml b/Master/texmf-dist/scripts/bib2gls/resources/bib2gls-en.xml index 40d63d636de..ed928374730 100644 --- a/Master/texmf-dist/scripts/bib2gls/resources/bib2gls-en.xml +++ b/Master/texmf-dist/scripts/bib2gls/resources/bib2gls-en.xml @@ -128,6 +128,9 @@ See the manual for further details.</entry> <entry key="syntax.packages">{0} <list> or {1} <list> Instruct interpreter to pretend the listed packages have been used in the document.</entry> +<entry key="syntax.ignore.packages">{0} <list> or {1} <list> + Don''t check the log file for the listed + packages.</entry> <entry key="message.reading">Reading {0}</entry> <entry key="message.writing">Writing {0}</entry> @@ -140,6 +143,7 @@ See the manual for further details.</entry> <entry key="message.crossref.found">Entry {0}: found cross-reference ({1}): {2}</entry> <entry key="message.crossref.by">Entry {0} cross-referenced by {1}</entry> <entry key="message.checking.crossrefs">Checking cross-references for: {0}</entry> +<entry key="message.field.not.set">Field {0} not set.</entry> <entry key="message.dual.dep">Dual found: {0} (primary {1})</entry> <entry key="message.added.alias.dep">Adding alias {0} as dependency for {1}</entry> <entry key="message.added.dep">Added dependent: {0}</entry> @@ -489,4 +493,32 @@ converted to @dualabbreviationentry.)</entry> <entry key="bibtex.error.too_many_commas">Too many commas in name ''{0}''</entry> <entry key="bibtex.error.string_name_undefined">String name ''{0}'' undefined</entry> <entry key="bibtex.error.repeated_entry">Repeated entry ''{0}''</entry> + +<!-- Package messages --> + +<!-- probsoln messages --> + +<entry key="probsoln.no_such_db">ProbSoln database ''{0}'' doesn''t exist.</entry> +<entry key="probsoln.no_such_entry_in_db">Entry ''{0}'' doesn''t exist in ProbSoln database '{1}'.</entry> +<entry key="probsoln.db_exists">ProbSoln database ''{0}'' already exists.</entry> +<entry key="probsoln.request_args">Problem ''{0}'' (in database ''{1}'') requires {2} arguments. Please specify</entry> +<entry key="probsoln.request_arg">Problem ''{0}'' (in database ''{1}'') requires 1 argument. Please specify</entry> + +<!-- datatool messages --> + +<entry key="datatool.db_exists">Database ''{0}'' already exists.</entry> +<entry key="datatool.db_doesnt_exist">Database ''{0}'' doesn''t exist.</entry> +<entry key="datatool.mismatched">Unmatched ''{0}'' (ended with ''{1}'').</entry> +<entry key="datatool.invalid.header">Invalid header specs ''{0}''.</entry> +<entry key="datatool.invalid.contents">Invalid contents specs ''{0}''.</entry> +<entry key="datatool.header.exists">Header ''{0}'' already exists.</entry> +<entry key="datatool.header.doesnt_exist">Header ''{0}'' doesn''t exist.</entry> +<entry key="datatool.row.not.found">Row index ''{0}'' doesn''t exist.</entry> +<entry key="datatool.loaddb.message">Database ''{0}'' loaded from ''{1}'' (column count={2}, row count={3}).</entry> + +<!-- ifthen messages --> + +<entry key="ifthen.invalid.condition">Invalid condition ''{0}''.</entry> + + </properties> diff --git a/Master/texmf-dist/scripts/bib2gls/texparserlib.jar b/Master/texmf-dist/scripts/bib2gls/texparserlib.jar Binary files differindex f3ba6dc02ac..2436eac873d 100755 --- a/Master/texmf-dist/scripts/bib2gls/texparserlib.jar +++ b/Master/texmf-dist/scripts/bib2gls/texparserlib.jar diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls-src.zip b/Master/texmf-dist/source/support/bib2gls/src/bib2gls-src.zip Binary files differindex 008daefa215..aa582b37b1b 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls-src.zip +++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls-src.zip diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib index a400cdf49bf..6b2269114f8 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib +++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.bib @@ -749,6 +749,38 @@ name}, category={command} } +@dualindexentry{glsexpandfields, + name={\csfmt{gls\-expand\-fields}}, + user1={}, + description={switches on field expansion}, + note={provided by \styfmt{glossaries}}, + category={command} +} + +@dualindexentry{glsnoexpandfields, + name={\csfmt{gls\-no\-expand\-fields}}, + user1={}, + description={switches off field expansion}, + note={provided by \styfmt{glossaries}}, + category={command} +} + +@dualindexentry{glssetexpandfield, + name={\csfmt{gls\-set\-expand\-field}}, + user1={\margm{field}}, + description={switches on field expansion for the given field}, + note={provided by \styfmt{glossaries}}, + category={command} +} + +@dualindexentry{glssetnoexpandfield, + name={\csfmt{gls\-set\-no\-expand\-field}}, + user1={\margm{field}}, + description={switches off field expansion for the given field}, + note={provided by \styfmt{glossaries}}, + category={command} +} + @dualindexentry{newglossaryentry, name={\csfmt{new\-glossary\-entry}}, user1={\margm{label}\margm{\keyvallist}}, @@ -841,12 +873,13 @@ name}, category={command} } -@dualindexentry{glssetexpandfield, - name={\csfmt{gls\-set\-expand\-field}}, - user1={\margm{field}}, - description={when defining a new entry, the given field should be - expanded}, - note={provided by \styfmt{glossaries}}, +@dualindexentry{glsxtr@resource, + name={\csfmt{glsxtr@resource}}, + user1={\margm{options}\margm{filename}}, + description={this internal command is written to the \ext{aux} +file by \gls{glsxtrresourcefile} + to provide \bibgls\ with the resource information}, + note={internal command provided by \styfmt{glossaries-extra}}, category={command} } @@ -2456,12 +2489,24 @@ cs}\margm{Glspl-like cs}}, parent={applications} } +@index{makeglossaries-lite, + name={\appfmt{make\-glos\-saries\dhyphen lite}}, + category={application}, + parent={applications} +} + @index{kpsewhich, name={\appfmt{kpsewhich}}, category={application}, parent={applications} } +@index{arara, + name={\appfmt{arara}}, + category={application}, + parent={applications} +} + @index{convertgls2bib, name={\appfmt{convert\-gls2bib}}, category={application}, @@ -4332,6 +4377,14 @@ field.}, parent={commandlineoptions} } +@dualindexentry{switch.ignore-packages, + name={\longargfmt{ignore-packages}}, + symbol={\shortargfmt{k}}, + user1={\meta{list}}, + category={switch}, + parent={commandlineoptions} +} + @dualindexentry{switch.mfirstuc-protection, name={\longargfmt{mfirstuc\dhyphen protection}}, symbol={\shortargfmt{u}}, @@ -4855,6 +4908,24 @@ field.}, category={command} } +@index{glsxtrautoindexassignsort, + name={\csfmt{gls\-xtr\-auto\-index\-assign\-sort}}, + user1={\margm{cs}\margm{label}}, + description={assigns the sort value for \cs{index} when + using auto-indexing}, + note={provided by \styfmt{glossaries-extra} v1.16+}, + category={command} +} + +@index{glsxtrautoindexentry, + name={\csfmt{gls\-xtr\-auto\-index\-entry}}, + user1={\margm{label}}, + description={used for the actual value in \cs{index} when + using auto-indexing}, + note={provided by \styfmt{glossaries-extra} v1.16+}, + category={command} +} + @index{glsseeformat, name={\csfmt{gls\-see\-format}}, user1={\margm{tag}\margm{labels}\margm{location (ignored)}}, @@ -5130,14 +5201,6 @@ label of the current entry}, category={command} } -@index{glsnoexpandfields, - name={\csfmt{gls\-noexpand\-fields}}, - user1={}, - description={don't expand fields when an entry is defined}, - note={provided by \styfmt{glossaries}}, - category={command} -} - @index{newentry, name={\csfmt{newentry}}, user1={\margm{label}\margm{\keyvallist}}, @@ -5461,6 +5524,16 @@ label of the current entry}, category={command} } +@index{index, + name={\csfmt{index}}, + user1={\margm{text}}, + description={indexes the given term by writing the relevant +information to an associated file that can then be processed +by \gls{makeindex} or \gls{xindy}}, + note={kernel command}, + category={command} +} + @index{glsignore, name={\csfmt{glsignore}}, user1={\margm{text}}, @@ -5470,6 +5543,16 @@ label of the current entry}, category={command} } +@index{@istfilename, + name={\csfmt{@istfilename}}, + user1={\margm{filename}}, + description={identifies the style file in the \ext{aux} + file for the benefit of external tools like + \idx{makeglossaries} and \idx{makeglossaries-lite}}, + note={provided by \styfmt{glossaries}}, + category={command} +} + @index{glstriggerrecordformat, name={\csfmt{gls\-trigger\-record\-format}}, user1={\margm{text}}, @@ -6588,6 +6671,14 @@ has three or more items}, category={command} } +@index{usepackage, + name={\csfmt{use\-pack\-age}}, + user1={\oargm{options}\margm{name}\oargm{min version}}, + description={loads the package identified by \meta{name}}, + note={kernel command}, + category={command} +} + @index{cjkname, name={\csfmt{cjkname}}, user1={\margm{CJK characters}}, diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.pod b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.pod index c1c986bef27..ae1485f9916 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.pod +++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.pod @@ -114,6 +114,15 @@ limited number of packages supported by the TeX parser library. This option has a cumulative action so B<--packages wasysym,pifont> is the same as B<--packages wasysym --packages pifont>. +=item B<--ignore-packages> I<list> (or B<-k> I<list>) + +Don't parse the log file for the packages listed in I<list>. Note +that B<--packages> overrides this option, so if the same package is +listed in both B<--ignore-packages> and B<--packages> then the +interpreter will check if it's supported. This option has a +cumulative action. (The B<glossaries-extra> package can't be +included in the ignored I<list>.) + =item B<--mfirstuc-protection> I<fields>|B<all> (or B<-u> I<fields>|B<all>) Insert an empty group if fields start with certain problematic diff --git a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.tex b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.tex index 8c6e3fedabb..a66a4125ae1 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/bib2gls.tex +++ b/Master/texmf-dist/source/support/bib2gls/src/bib2gls.tex @@ -1155,6 +1155,71 @@ If the \idx{crossresourceref} mode is enabled then stage~3 and stage~4 are processed in separate loops, otherwise they are processed in the same loop. +\section{Indexing} + +The dual index entries such as \atentry{dualindexentry} (described in +\sectionref{sec:dualentry}) are designed to provide a way of +including an entry in both a glossary (with a description) and also +include the term (without the description) in an index. Additional +terms that should only appear in the index can be defined with +\atentry{index}. (See, for example, the \exfile{sample-multi1.tex} +and \exfile{sample-multi2.tex} sample files.) + +Although \bibgls\ is designed to create indexes as well as glossary +lists using the same interface (\cs{gls} etc), it is +possible to have a mixture of \bibgls\ and \ics{index}. For example: +\begin{verbatim} +\documentclass{report} + +\usepackage{makeidx} +\usepackage[record]{glossaries-extra} + +\makeindex +\GlsXtrLoadResources[src={entries}] + +\glssetcategoryattribute{general}{dualindex}{true} +\glssetcategoryattribute{symbol}{dualindex}{true} +\glssetcategoryattribute{abbreviation}{dualindex}{true} + +\glssetcategoryattribute{general}{indexname}{hyperbf} +\glssetcategoryattribute{symbol}{indexname}{hyperbf} +\glssetcategoryattribute{abbreviation}{indexname}{hyperbf} + +\begin{document} +\chapter{Example} +\gls{bird}, \gls{html}, $\gls{v}$ and \glspl{goose}. + +\printunsrtglossaries +\printindex +\end{document} +\end{verbatim} +If the document is called \filefmt{myDoc.tex} then the document +build is: +\begin{verbatim} +pdflatex myDoc +bib2gls myDoc +pdflatex myDoc +makeindex myDoc.idx +pdflatex myDoc +\end{verbatim} +This requires an additional \LaTeX\ call between \bibgls\ and +\idx{makeindex} since the entries must be defined before they can be +indexed (and they can't be defined until \bibgls\ creates the +associated \ext{glstex} files). + +Note that this method will use the \field{sort} value obtained by \bibgls\ +as the \meta{sort} part within +\code{\cs{index}\marg{\meta{sort}@\meta{actual}}}. +Be careful if you use \idx{makeindex} as this can result in Unicode +characters appearing in the sort value, which \idx{makeindex} +doesn't support. +The \meta{actual} part is given by +\code{\ics{glsentryname}\margm{label}}. +(You can change the \meta{sort} and \meta{actual} parts by +redefining \ics{glsxtrautoindexassignsort} and +\ics{glsxtrautoindexentry}. See the \sty{glossaries-extra} manual +for further details.) + \section{Security} \TeX\ Live come with security settings @@ -1208,6 +1273,59 @@ the correct translation (in English, this would be \csopt[Page\dcomma Pages]{loc-prefix}). The default definition of \csref{bibglspassim} is also obtained from the resource file. +\section{Conditional Document Build} + +If you are using a document build method that tries to determine +whether or not \bibgls\ should be run, you can find the information +by searching the \iext{aux} file for instances of +\nosecdef{glsxtr@resource} +Each instance corresponds to an instance of \gls{glsxtrresourcefile} +where \meta{filename} is the base name of the \iext{glstex} file +that \bibgls\ needs to create for this resource set. If the +\meta{options} part is missing the \csopt{src} option, this also indicates +the base name for the \iext{bib} file. + +So the simplest check to determine if \bibgls\ needs to be run is to test +if the \iext{aux} file contains \gls{glsxtr@resource}. For +example, with \idx{arara} version 4.0: +\begin{codeenv} +\% arara: bib2gls if found("aux", "glsxtr@resource") +\end{codeenv} +A sophisticated method could check if +\meta{filename}\ext{glstex} is missing or is older than the document +\ext{tex} file for each instance of \gls{glsxtr@resource} found in +the \ext{aux} file. + +It might also be possible, although far more complex, to +parse the \meta{options} part in each instance of \gls{glsxtr@resource} +for \csopt{src} and determine if the corresponding \ext{bib} file or +files are newer than the \ext{tex} file. + +It's not possible to determine if the location lists require +updating, just as it's not possible to do this for the table of +contents, list of figures, list of tables etc. (Or, if it could be +implemented, the required code would make the document build far more +complicated.) + +In general, the basic algorithm is: +\begin{enumerate} +\item If \gls{glsxtr@resource} is found in the \ext{aux} file then: + + \begin{enumerate} + \item run \bibgls; + \item run \LaTeX\ (or PDF\LaTeX\ etc). + \end{enumerate} + +\item If \idx{@istfilename} is found in the \ext{aux} file then: + + \begin{enumerate} + \item run \idx{makeglossaries} (or \idx{makeglossaries-lite}); + \item run \LaTeX\ (or PDF\LaTeX\ etc). + \end{enumerate} + +\end{enumerate} +This allows for the \styopt[alsoindex]{record} package option. + \section{Manual Installation} If you are unable to install \bibgls\ through your \TeX\ package @@ -1349,7 +1467,8 @@ following packages: \isty{wasysym}, \isty{lipsum}, \isty{natbib}, \isty{mhchem}, \isty{bpchem}, \isty{stix}, \isty{textcomp}, \isty{MnSymbol}, \isty{fourier}, \isty{upgreek}, \isty{xspace}, \isty{siunitx}, -\isty{fontenc} and \isty{tipa}. If you're wondering about the +\isty{fontenc} and \isty{tipa}. (You can omit checking for specific +packages with \longarg{ignore-packages}.) If you're wondering about the selection, the \file{texparserlib.jar} library was originally written for another application that required support for some of them. There are a few other packages that the library supports (see @@ -1832,7 +1951,8 @@ if available (default). For example, \begin{verbatim} \textsuperscript{(2)} \end{verbatim} -will be converted to \hex{207D} (superscript left parenthesis) +will be converted to \code{\textsuperscript{(2)}}, which consists +of: \hex{207D} (superscript left parenthesis) \hex{00B2} (superscript two) \hex{207E} (superscript right parenthesis). If the entire contents of the argument can't be represented by Unicode characters, the interpreter uses \verb|<sup>| @@ -1882,6 +2002,17 @@ using a command from a package that the interpreter doesn't support but it happens to have the same name and meaning as a command from a package that the interpreter does support. +\argsection{ignore-packages} + +This option is cumulative. When the document \iext{log} file is +parsed for known packages, \bibgls\ will skip the check for any +listed in \meta{list}. Note that this option simply instructs +\bibgls\ to ignore the package information in the log file. Any packages +that are identified with \longarg{packages} will be passed to the +interpreter if support is available, even if the package is also +listed in \longargfmt{ignore-packages}. Note that +\sty{glossaries-extra} can't be included in the ignored \meta{list}. + \argsection{mfirstuc-protection} Commands like \ics{Gls} use \ics{makefirstuc} provided by the @@ -2263,7 +2394,7 @@ The glossary won't have groups even if a group style, such as \bibgls\ tries to determine the character encoding to use for the output files. If the document has loaded the \isty{inputenc} package then \bibgls\ can obtain the value of the encoding from the -\iext{aux} file. This then needs to be converted to a name +\iext{aux} file. This is then converted to a name recognised by Java. For example, \code{utf8} will be mapped to \code{UTF-8}. If the \isty{fontspec} package has been loaded, \styfmt{glossaries-extra} will assume the encoding is \code{utf8} and @@ -2273,7 +2404,27 @@ If neither package has been loaded, \bibgls\ will assume the operating system's default encoding. If this is incorrect or if \bibgls\ can't work out the appropriate mapping then you can specify the correct encoding using \longargfmt{tex-encoding} \meta{name} -where \meta{name} is the encoding name. +where \meta{name} is the encoding name (such as \code{UTF-8}). + +If you have a problem with non-ASCII characters not displaying +correctly in your document: +\begin{itemize} +\item Check that the file encoding of your document \ext{tex} file (or files) +has been correctly set by your text editor. +\item Check that your document supports that encoding (for example, +through the \isty{inputenc} package). +\item Check \bibgls's transcript file (\ext{glg}) for the line that +starts +\begin{verbatim} +TeX character encoding: +\end{verbatim} +This should be followed by the encoding used by \bibgls\ when +creating the \ext{glstex} files. If this is incorrect use +\longargfmt{tex-encoding}. +\item Check that the encoding of the \ext{bib} files (set by your +text editor or bibliographic management system) matches the encoding +line in the \ext{bib} file or the \csopt{charset} resource option. +\end{itemize} \argsection{no-expand-fields} @@ -2284,7 +2435,7 @@ This is useful if constructing field values programmatically commands are included in the field. The switch \longarg{no-expand-fields} makes \bibgls\ write -\ics{glsnoexpandfields} to the \iext{glstex} file, which +\gls{glsnoexpandfields} to the \iext{glstex} file, which switches off the expansion. Since \bibgls\ is simply fetching the data from \iext{bib} files, it's unlikely that this automatic expansion is required and since it can @@ -2293,12 +2444,11 @@ switch it off with \longarg{expand-fields}. \argsection{expand-fields} -Don't write \ics{glsnoexpandfields} to the \iext{glstex} file, +Don't write \gls{glsnoexpandfields} to the \iext{glstex} file, allowing fields to expand when the entries are defined. Remember that this doesn't include the \field{name}, \field{symbol} or \field{description} fields, which need to have their -expansion switched on with -\nosecdef{glssetexpandfield} +expansion switched on with \gls{glssetexpandfield} before the entries are defined (that is, before using \gls!{GlsXtrLoadResources}). @@ -10394,6 +10544,10 @@ This is a boolean setting that determines whether or not primary and dual entries should be considered mutual dependencies. The default value is \csopt[true]{primary-dual-dependency}, which means that if a primary has records then the dual is added as a dependency and vice versa. +The setting \csopt[false]{primary-dual-dependency} can't be used +with \csopt[none]{dual-sort} or \csopt[use]{dual-sort} (but may be +used with \csopt[combine]{dual-sort} and \csopt[none]{sort} or +\csopt[use]{sort}). \optsection[\subsubsection]{combine-dual-locations} @@ -12682,6 +12836,13 @@ sort value than either \idx!{makeindex} or \idx!{xindy}. \item[\longargfmt{no-ignore-sort}] Don't ignore the \field{sort} field. +\item[\longargfmt{silent}] Suppress all messages except for errors. + +\item[\longargfmt{verbose}] Display messages and warnings (default). + +\item[\longargfmt{debug}] Display debugging messages (stack +traces and other information in addition to \longargfmt{verbose}). + \item[\longargfmt{help} or \shortargfmt{h}] Display help message and quit. \item[\longargfmt{version} or \shortargfmt{v}] Display version @@ -12690,7 +12851,10 @@ information and quit. This application recognises the commands listed below. Avoid any overly complicated code within the \ext{tex} file. The \TeX\ parser -library isn't a \TeX\ engine! +library isn't a \TeX\ engine! The \ext{tex} file doesn't need to be +a complete document, but if you want certain commands recognised +from packages that the \TeX\ parser library supports, you'll need to +include \ics{usepackage} in the \ext{tex} file. In all cases below, if \meta{\keyvallist} contains \begin{alltt} see=[\ics{seealsoname}]\margm{label(s)} @@ -12722,6 +12886,38 @@ recommended in \meta{\keyvallist} when loading files with argument to set the \field{type}. With \bibgls\ you can use the \csopt{type} option instead.) +\cssection[\section]{glsexpandfields} +The base \styfmt{glossaries} package provides: +\formatdef{glsexpandfields} +If present, this instructs \idx{convertgls2bib} to expand all fields +except for those explicitly identified by \gls{glssetnoexpandfield}. +Remember that there are many commands that aren't recognised by +\idx{convertgls2bib} so it may not be possible to correctly expand +field values. Conversely, there are some commands that will be +expanded by \idx{convertgls2bib} that aren't expandable in \TeX\ +(such as \ics{MakeUppercase} and \ics{char}). + +\cssection[\section]{glsnoexpandfields} +The base \styfmt{glossaries} package provides: +\formatdef{glsnoexpandfields} +If present, this instructs \idx{convertgls2bib} to not expand fields +unless explicitly identified by \gls{glssetexpandfield}. + +\cssection[\section]{glssetexpandfield} +The base \styfmt{glossaries} package provides: +\formatdef{glssetexpandfield} +If present, this instructs \idx{convertgls2bib} to expand the +given field, even if \gls{glsnoexpandfields} has been used. + +\cssection[\section]{glssetnoexpandfield} +The base \styfmt{glossaries} package provides: +\formatdef{glssetnoexpandfield} +If present, this instructs \idx{convertgls2bib} to not expand the +given field, even if \gls{glsexpandfields} has been used. +Unlike the default behaviour with the \sty{glossaries} package, there are no +fields switched explicitly switched off by default with +\idx{convertgls2bib}. + \cssection[\section]{newglossaryentry} The base \styfmt{glossaries} package provides: \formatdef{newglossaryentry} @@ -15537,7 +15733,7 @@ round so that the short form is shown first, which conveniently matches the default \csopt{abbreviation-sort-fallback}. \begin{verbatim} \renewcommand*{\glsxtrlongshortdescname}{% - \protect\protect\glsabbrvfont{\the\glsshorttok}\space + \protect\glsabbrvfont{\the\glsshorttok}\space \glsxtrparen{\glslongfont{\the\glslongtok}}% } \end{verbatim} @@ -16410,12 +16606,28 @@ The dual entry's label is easily obtained because \csopt{dual-field} has provided the \fieldfmt{dual} internal field and set it to the corresponding label. -The complete document code is listed below. The document build is: +It's sometimes useful for the index to include a reference to the +term's definition. This can be done by making use of +\idx{glsextrapostnamehook}, which can be redefined before the +glossaries to automatically record each entry: +\begin{verbatim} +\renewcommand{\glsextrapostnamehook}[1]{\glsadd[format=hyperbf]{#1}} +\end{verbatim} +This needs to be redefined to ignore its argument before the index, +to avoid the redundant index record: \begin{verbatim} +\renewcommand{\glsextrapostnamehook}[1]{} +\end{verbatim} +Remember that if any records are added within a glossary, an extra +\LaTeX\ and \bibgls\ call are required, so the document build is: +\begin{verbatim} +pdflatex sample-multi1 +bib2gls --group sample-multi1 pdflatex sample-multi1 bib2gls --group sample-multi1 pdflatex sample-multi1 \end{verbatim} +The complete document code is listed below. The resulting document is shown in \figureref{fig:sample-multi1.pdf} and \figureref{fig:sample-multi1.pdf2}. @@ -16464,12 +16676,12 @@ example, so it has extra glossaries, which all need to be defined: \newglossary*{information}{Information Symbols} \newglossary*{weather}{Weather Symbols} \end{verbatim} -Note that this is a total of 15 (including the \code{index}) -glossaries. With the \ics{makeglossaries} method, this would require -16 write registers (including the write register used to create the -indexing style file), and a total of $15\times3 + 1 = 46$ associated -files. (This doesn't include the standard \ext{aux} file and the -\ext{out} file created by \sty{hyperref}.) With \bibgls, no +Note that this is a total of 15~glossaries (including the +\code{index}). With the basic \ics{makeglossaries} method, this would +require 16 write registers (including the write register used to +create the indexing style file), and a total of $15\times3 + 1 = 46$ +associated files. (This doesn't include the standard \ext{aux} file +and the \ext{out} file created by \sty{hyperref}.) With \bibgls, no additional write registers are required and the number of associated \bibgls\ files is equal to the number of resource commands plus the transcript file (in this example, $9+1=10$). @@ -16623,7 +16835,7 @@ Next come the chemical formulae: \csopt[ identifier=category, formula=name, - chemicalname=description, + chemicalname=description ]{field-aliases}, \csopt[chemical]{type}, \csopt{set-widest}, @@ -16636,18 +16848,18 @@ and the \idxpl{SIunit}, which are now combined into a single glossary: \begin{codeenv} \gls{GlsXtrLoadResources}\oarg{ - src={baseunits,derivedunits}, + \csopt[baseunits,derivedunits]{src}, \csopt[measurement=symbol,unit=symbol]{entry-type-aliases}, - field-aliases={ + \csopt[ unitname=description, unitsymbol=symbol, measurement=name - }, - category={measurement}, - type={measurement}, - set-widest, - symbol-sort-fallback={name}, - save-locations=false + ]{field-aliases}, + \csopt[measurement]{category}, + \csopt[measurement]{type}, + \csopt{set-widest}, + \csopt[name]{symbol-sort-fallback}, + \csopt[false]{save-locations} } \end{codeenv} Here the \field{name} field is obtained from the custom @@ -16764,7 +16976,7 @@ style (that is, the abbreviations with the \field{category} set to \meta{long} (\meta{short}): \begin{verbatim} \renewcommand*{\glsxtrlongshortdescname}{% - \protect\protect\glslongfont{\the\glslongtok}\space + \protect\glslongfont{\the\glslongtok}\space \glsxtrparen{\glsabbrvfont{\the\glsshorttok}}% } \end{verbatim} @@ -16934,10 +17146,10 @@ entries without worrying about the prefixes: \cs{glsxtrnewgls}\marg{film.}\marg{\csfmt{film}} \end{codeenv} -It would be useful to include the page where the entries are defined -in their corresponding lists. This can be done by redefining the -general purpose non-category post-name hook -\ics{glsextrapostnamehook}: +As with \exfile{sample-multi1.tex}, it would be useful to include +the page where the entries are defined in their corresponding lists. +Again this can be done by redefining the general purpose +non-category post-name hook \ics{glsextrapostnamehook}: \begin{verbatim} \newcommand*{\glsextrapostnamehook}[1]{% \glsadd[format=hyperbf]{#1}% diff --git a/Master/texmf-dist/source/support/bib2gls/src/convertgls2bib.pod b/Master/texmf-dist/source/support/bib2gls/src/convertgls2bib.pod index 300bb3e264a..d5617dc00e5 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/convertgls2bib.pod +++ b/Master/texmf-dist/source/support/bib2gls/src/convertgls2bib.pod @@ -20,6 +20,18 @@ Display help message and exit. Display version information and exit. +=item B<--silent> + +Suppress all messages except for errors. + +=item B<--verbose> + +Display messages. + +=item B<--debug> + +Display debugging messages. + =item B<--texenc> I<name> Set the character encoding to I<name> for the input B<.tex> files. diff --git a/Master/texmf-dist/source/support/bib2gls/src/gls2bib-src.zip b/Master/texmf-dist/source/support/bib2gls/src/gls2bib-src.zip Binary files differindex 9c0d593a2a1..011dda8b4eb 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/gls2bib-src.zip +++ b/Master/texmf-dist/source/support/bib2gls/src/gls2bib-src.zip diff --git a/Master/texmf-dist/source/support/bib2gls/src/texparser-src.zip b/Master/texmf-dist/source/support/bib2gls/src/texparser-src.zip Binary files differindex 3cbb272504b..5b4b2b996cd 100644 --- a/Master/texmf-dist/source/support/bib2gls/src/texparser-src.zip +++ b/Master/texmf-dist/source/support/bib2gls/src/texparser-src.zip |