texlive[51809] Master/texmf-dist: glosmathtools (3aug19)
commits+karl at tug.org
commits+karl at tug.org
Sat Aug 3 23:57:18 CEST 2019
Revision: 51809
http://tug.org/svn/texlive?view=revision&revision=51809
Author: karl
Date: 2019-08-03 23:57:18 +0200 (Sat, 03 Aug 2019)
Log Message:
-----------
glosmathtools (3aug19)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/glosmathtools/README.md
trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.pdf
trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.tex
trunk/Master/texmf-dist/tex/latex/glosmathtools/glosmathtools.sty
Modified: trunk/Master/texmf-dist/doc/latex/glosmathtools/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glosmathtools/README.md 2019-08-03 08:32:20 UTC (rev 51808)
+++ trunk/Master/texmf-dist/doc/latex/glosmathtools/README.md 2019-08-03 21:57:18 UTC (rev 51809)
@@ -23,7 +23,7 @@
## Version
-0.5 (2019-08-01)
+0.5.1 (2019-08-02)
## Author
Modified: trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.tex 2019-08-03 08:32:20 UTC (rev 51808)
+++ trunk/Master/texmf-dist/doc/latex/glosmathtools/sample_glosmathtools.tex 2019-08-03 21:57:18 UTC (rev 51809)
@@ -22,6 +22,7 @@
\renewcommand*{\glscatnamefmt}[1]{\textbf{#1}} % format des catégories
%% ------------- ulthese ----------------------------------------------------
\titre{Documentation et exemple de \texttt{glosmathtools} dans \texttt{ulthese}}
+\soustitre{v0.5.1}
\auteur{Francis Gagnon}
%% ============================================================================
@@ -49,10 +50,21 @@
\end{itemize}
Sous Windows avec MiKTeX, il est possible que le script \texttt{makeglossaries} nécessite une installation de Perl (voir \url{https://tinyurl.com/ybnoyqjp}). Une fois Perl installé, il faut exécuter le script \texttt{perltex.exe} disponible dans le répertoire d'installation de MiKTeX.
-\section{Symboles, indices et accentuations}
+\section{Options du package}
+Les options du package \texttt{glosmathtools} se résument par :
+\begin{description}
+ \item[qtmarkupright] caractère \texttt{<">} raccourci pour indice sans italique
+ \item[singlelineskip] force interligne simple pour la nomenclature
+ \item[nodefop] utilisation des opérateurs et accents sans définition
+ \item[{[autres options]}] passés au package \texttt{glossaries}
+\end{description}
+De plus amples informations sont fournies ci-dessous.
-L'insertion d'un symbole mathématique simple avec hyperlien se fait avec la macro \texttt{\textbackslash gls} de glossaries : \gls{k}, \gls{mat.A} et \gls{mat.b}. C'est la même chose pour les abréviations : le \Glspl{LOOP}. Les abréviations sont uniquement définies à leur première utilisation : le \gls{LOOP}.
+\section{Utilisation du package}
+\subsection{Symboles, indices et accentuations}
+L'insertion d'un symbole mathématique simple avec hyperlien se fait avec la macro \texttt{\textbackslash gls} de \texttt{glossaries} : \gls{k}, \gls{mat.A} et \gls{mat.b}. C'est la même chose pour les abréviations : le \gls{LOOP}. Les abréviations sont uniquement définies à leur première utilisation : le \gls{LOOP}.
+
Les indices doivent être définis avec un label du format \texttt{sub.resteDuLabel}: l'indice \gls{sub.a} désigne l'air. La macro \texttt{\textbackslash glsub} permet d'ajouter un indice à une variable : \glsub{d}{v}, \glsub{z}{v}, \glsub{T}{v}, \glsub{D}{a}, \glsub{rho}{w} et \glsub{mu}{v}. En définissant les symboles mathématiques avec \texttt{\textbackslash newglosentrymath}, toutes les macros peuvent s'utiliser autant en mode \texttt{text} qu'en mode \texttt{math} (avec \texttt{\$\$}). Par contre, il est mieux d'écrire explicitement les symboles dans une équation afin d'alléger le code (pas d'hyperlien):
\begin{equation}
d"v + \glsub{d}{v} = \SI{10.0}{\centi\meter} = 3.937\qtmark
@@ -72,7 +84,7 @@
\end{description}
De plus, un argument optionnel permet d'ajouter des accents à toutes les macros précédentes : \glsub[bar]{T}{v} et \glsubs[dot]{m}{v}{a}. Il y a deux arguments optionnels dans le cas de \texttt{\textbackslash glsvi} : \glsvi[dot]{m}{k}, \glsvi[][dot]{k}{m} et \glsvi[bar][dot]{T}{m}. Finalement, il est possible d'utiliser les accents sans définition dans la nomenclature avec l'option \texttt{nodefop}.
-\section{Langue, abréviations et nomenclature}
+\subsection{Langue, abréviations et nomenclature}
S'il y a des changements de langues à travers le document, il faut changer de langue pour les acronymes. La clé \texttt{descseclang} doit être préalablement définie dans le glossaire. Par la suite, la macro \texttt{\textbackslash setacronymlang} permet de choisir 4 options de langue:
\begin{description}
@@ -92,7 +104,7 @@
\item[nomencl-L1L2] descriptions bilingues, langue principale (\textit{langue seconde})
\item[nomencl-L2L1] descriptions bilingues, langue seconde (\textit{langue principale})
\end{description}
-L'option \texttt{singlespaceglos} du package permet de forcer un interligne simple pour la nomenclature (nécessite \texttt{ulthese}/\texttt{memoir} ou le package \texttt{linespace}). La macro \texttt{\textbackslash glscatnamefmt} peut être redéfinie au préambule afin de modifier le style de l'en-tête des catégories. L'exemple de la page ii est une nomenclature bilingue \textbf{nomencl-L2L1} en interligne simple.
+L'option \texttt{singlespaceglos} du package permet de forcer un interligne simple pour la nomenclature (nécessite \texttt{ulthese}/\texttt{memoir} ou le package \texttt{setspace}). La macro \texttt{\textbackslash glscatnamefmt} peut être redéfinie au préambule afin de modifier le style de l'en-tête des catégories. L'exemple de la page ii est une nomenclature bilingue \textbf{nomencl-L2L1} en interligne simple.
Si défini, le contenu de la clé \texttt{symbol} est ajouté a la fin de la description (pour les unités ou dimensions). À noter que les symboles mathématiques ne sont pas enregistrés dans cette clé, mais bien dans la clé \texttt{name}.
Modified: trunk/Master/texmf-dist/tex/latex/glosmathtools/glosmathtools.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/glosmathtools/glosmathtools.sty 2019-08-03 08:32:20 UTC (rev 51808)
+++ trunk/Master/texmf-dist/tex/latex/glosmathtools/glosmathtools.sty 2019-08-03 21:57:18 UTC (rev 51809)
@@ -3,18 +3,16 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{glosmathtools}%
[%
-2019/08/01 v0.5 %
+2019/08/02 v0.5.1 %
Mathematical nomenclature tools based on glossaries package %
Francis Gagnon %
]%
\RequirePackage{amsmath,amsfonts,etoolbox}%
-% noredefwarn to supress warnings with memoir class redifintion :
-\RequirePackage[noredefwarn]{glossaries}%
% ===========================================================================
% =================== PACKAGE OPTIONS =======================================
% ===========================================================================
-% define char '"' as shortcut for "sbu" macro in math mode
+% define char <"> as shortcut for "sbu" macro in math mode
% and define qtmark macro to show the quotation mark character
\DeclareOption{qtmarkupright}{%
\begingroup\lccode`~=`"\lowercase{\endgroup\def~}#1{\sbu{#1}}%
@@ -21,7 +19,7 @@
\mathchardef\qtmark=\mathcode`"\AtBeginDocument{\mathcode`"=\string"8000}%
}%
-% single lineskip nomenclature (memoir/linespace package required)
+% single lineskip nomenclature (memoir/setspace package required)
\newtoggle{glosmath at singlelineskip}%
\DeclareOption{singlelineskip}{\toggletrue{glosmath at singlelineskip}}%
@@ -29,13 +27,24 @@
\newtoggle{glosmath at nodefop}%
\DeclareOption{nodefop}{\toggletrue{glosmath at nodefop}}%
-%% unknown options
-\DeclareOption*{%
- \PackageWarning{glosmathtools}{Unknown option '\CurrentOption'}%
-}%
+%% other options are passed to glossaires package
+\DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}}%
\ProcessOptions\relax%
+% noredefwarn to supress warnings with memoir class redifintion
+\RequirePackage[noredefwarn]{glossaries}%
+% checkup if memoir or setspace is loaded with singlelineskip option
+\iftoggle{glosmath at singlelineskip}{%
+ \@ifclassloaded{memoir}{\relax}{%
+ \@ifpackageloaded{setspace}{\relax}{%
+ \PackageError{glosmathtools}%
+ {memoir class ot setspace package must be %
+ loaded for singlelineskip option}{}%
+ }%
+ }%
+}%
+
% ===========================================================================
% =================== PUBLIC MACROS =========================================
% ===========================================================================
@@ -223,8 +232,8 @@
\renewcommand*{\glossaryheader}%
{%
\iftoggle{glosmath at singlelineskip}{%
- \ifdefined\SingleSpacing \SingleSpacing \fi% memoir class
- \ifdefined\singlespacing \singlespacing \fi% setspace package
+ \ifdefined\SingleSpacing\SingleSpacing\fi% memoir class
+ \ifdefined\singlespacing\singlespacing\fi% setspace package
}{}%
}%
\setcounter{glosmath at mainEntryCtr}{0}%
@@ -335,13 +344,13 @@
\renewcommand*{\glosmath at acrmainpl}[1]{\glsentrylongpl{##1}}%
\renewcommand*{\glosmath at Acrmainpl}[1]{\Glsentrylongpl{##1}}%
\renewcommand*{\glosmath at acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}}%
\renewcommand*{\glosmath at Acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}}%
\renewcommand*{\glosmath at acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}}%
\renewcommand*{\glosmath at Acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}}%
\renewcommand*{\glosmath at acrlang}{L1}%
}%
@@ -361,16 +370,16 @@
{%
\glosmath at setLone % base defintions
\renewcommand*{\glosmath at acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}%
,\space\textit{\glsentrydescsec{##1}}}%
\renewcommand*{\glosmath at Acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}%
,\space\textit{\Glsentrydescsec{##1}}}%
\renewcommand*{\glosmath at acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}%
,\space\textit{\glsentrydescsec{##1}}}%
\renewcommand*{\glosmath at Acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}%
,\space\textit{\Glsentrydescsec{##1}}}%
\renewcommand*{\glosmath at acrlang}{L1L2}%
}%
@@ -380,16 +389,16 @@
{%
\glosmath at setLtwo % base defintions
\renewcommand*{\glosmath at acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}%
,\space\textit{\glsentrydesc{##1}}}%
\renewcommand*{\glosmath at Acrpar}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}%
,\space\textit{\Glsentrydesc{##1}}}%
\renewcommand*{\glosmath at acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshort{##1}}%
+ {\protect\firstacronymfont{\glsentryshort{##1}}%
,\space\textit{\glsentrydescpl{##1}}}%
\renewcommand*{\glosmath at Acrparpl}[1]%
- {\protect\firstacronymfont{\glsentryshortpl{##1}}%
+ {\protect\firstacronymfont{\glsentryshortpl{##1}}%
,\space\textit{\Glsentrydescpl{##1}}}%
\renewcommand*{\glosmath at acrlang}{L2L1}%
}%
More information about the tex-live-commits
mailing list