summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/textualicomma
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/textualicomma
Initial commit
Diffstat (limited to 'macros/latex/contrib/textualicomma')
-rw-r--r--macros/latex/contrib/textualicomma/README.md32
-rw-r--r--macros/latex/contrib/textualicomma/textualicomma-doc.dtx260
-rw-r--r--macros/latex/contrib/textualicomma/textualicomma-doc.pdfbin0 -> 118401 bytes
-rw-r--r--macros/latex/contrib/textualicomma/textualicomma.dtx168
-rw-r--r--macros/latex/contrib/textualicomma/textualicomma.ins40
5 files changed, 500 insertions, 0 deletions
diff --git a/macros/latex/contrib/textualicomma/README.md b/macros/latex/contrib/textualicomma/README.md
new file mode 100644
index 0000000000..c68f2f739e
--- /dev/null
+++ b/macros/latex/contrib/textualicomma/README.md
@@ -0,0 +1,32 @@
+# textualicomma
+Use the textual comma character as decimal separator in math mode.
+
+**`textualicomma` is based on the [`icomma`](https://ctan.org/pkg/icomma) package and intended as a solution for situations where the text comma character discerns from the math comma character**, e. g. when fonts whithout math support are involved.
+Escaping to text mode every time a comma is used in math mode might slow down the compilation of huge documents.
+Please check, whether [`icomma`](https://ctan.org/pkg/icomma) already satisfies your needs.
+
+
+
+### Installation
+Extract the *package* file first:
+
+ 1. Run LaTeX over the file `textualicomma.ins`
+ 2. Move the resulting `.sty` file to `TEXMF/tex/latex/textualicomma/`
+
+Then, you can compile the *documentation* yourself by executing
+
+ lualatex textualicomma-doc.dtx
+ makeindex -s gind.ist textualicomma-doc.idx
+ makeindex -s gglo.ist -o textualicomma-doc.gls textualicomma-doc.glo
+ lualatex textualicomma-doc.dtx
+ lualatex textualicomma-doc.dtx
+
+
+or just use the precompiled documentation shipped with the source files.
+In both cases, copy the files `textualicomma-doc.pdf` and `README.md` to `TEXMF/doc/latex/textualicomma/`.
+
+
+
+### License
+This work, consisting of the files `textualicomma.dtx`, `textualicomma.ins`, `textualicomma-doc.dtx` and the derived file `textualicomma.sty`, is licensed under the LPPL, Version 1.3c (or, at your option, any later version)
+Current maintainer of the work is Sebastian Friedl.
diff --git a/macros/latex/contrib/textualicomma/textualicomma-doc.dtx b/macros/latex/contrib/textualicomma/textualicomma-doc.dtx
new file mode 100644
index 0000000000..2e5504b10b
--- /dev/null
+++ b/macros/latex/contrib/textualicomma/textualicomma-doc.dtx
@@ -0,0 +1,260 @@
+%\iffalse
+%% Doc-Source file to use with LaTeX2e
+%% Copyright (C) 2017-18 Sebastian Friedl
+%%
+%% This work is subject to the LaTeX Project Public License, Version 1.3c or -- at
+%% your option -- any later version of this license.
+%% The work consists of the files textualicomma.dtx, textualicomma.ins,
+%% textualicomma-doc.dtx and the derived file textualicomma.sty
+%%
+%% This work has the LPPL maintenance status ‘maintained’.
+%% Current maintainer of the work is Sebastian Friedl.
+%%
+%% -------------------------------------------------------------------------------------------
+%%
+%% Use the textual comma character as decimal separator in math mode
+%%
+%% -------------------------------------------------------------------------------------------
+%%
+%% Please report bugs and other problems as well as suggestions for improvements
+%% to my email address (sfr682k@t-online.de).
+%%
+%% -------------------------------------------------------------------------------------------
+%\fi
+
+% !TeX spellcheck=en_US
+
+\documentclass[11pt]{ltxdoc}
+
+\usepackage{iftex}
+\RequireLuaTeX
+
+\usepackage[no-math]{fontspec}
+\usepackage{polyglossia}
+\setdefaultlanguage{english}
+\usepackage[english]{selnolig}
+
+
+
+\usepackage{csquotes}
+\usepackage{graphicx}
+\usepackage{hologo}
+\usepackage{multicol}
+
+\usepackage{verbatim}
+
+
+\usepackage[a4paper,left=4.50cm,right=2.75cm,top=3.25cm,bottom=2.75cm,nohead]{geometry}
+
+
+\usepackage[unicode, pdfborder={0 0 0}, linktoc=all, hyperindex=false]{hyperref}
+
+
+\usepackage[erewhon,vvarbb]{newtxmath}
+\setmainfont{Source Serif Pro}
+\setsansfont[Scale=MatchLowercase]{Source Sans Pro}
+\setmonofont[Scale=MatchLowercase]{Hack}
+
+
+
+\newcommand*{\cls}[1]{\textsf{#1}}
+\newcommand*{\sty}[1]{\textsf{#1}}
+\newcommand*{\opt}[1]{\texttt{#1}\index{#1=\texttt{#1}~~option|main}}
+
+\def\DescribeOption#1{\marginpar{\raggedleft\PrintDescribeMacro{#1}}}
+
+\renewcommand*{\usage}[1]{\hyperpage{#1}}
+\renewcommand*{\main}[1]{\hyperpage{#1}}
+
+\PageIndex
+\RecordChanges
+
+\parindent0pt
+
+\MakeShortVerb{"}
+\CheckSum{101}
+
+
+\title{The \sty{textualicomma} package \\ {\large\url{https://gitlab.com/SFr682k/textualicomma}}}
+\author{Sebastian Friedl \\ \href{mailto:sfr682k@t-online.de}{\ttfamily sfr682k@t-online.de}}
+\date{2018/08/23 (v1.1)}
+
+\hypersetup{pdftitle={The textualicomma package}, pdfauthor={Sebastian Friedl}}
+
+
+\begin{document}
+ \maketitle
+
+ \begin{abstract}\noindent
+ Use the textual comma character as decimal separator in math mode. \\[\medskipamount]
+ \sty{textualicomma} is based on the \href{https://www.ctan.org/pkg/icomma}{\sty{icomma} package}
+ and intended as a solution for cases where the comma character used in horizontal (i.e.~text) mode
+ discerns from the one used in math mode. \\
+ Note: Escaping to text mode every time a comma is used in math mode might slow down the compilation of huge documents.
+ Please check, whether \href{https://www.ctan.org/pkg/icomma}{\sty{icomma}} already satisfies your needs.
+ \end{abstract}
+
+
+ \tableofcontents
+
+
+
+ \clearpage
+ \subsection*{Dependencies and other requirements}
+ \addcontentsline{toc}{subsection}{Dependencies and other requirements}
+ \sty{textualicomma} requires \LaTeXe\ and depends on the \sty{amstext} package. \\
+ Also, the three NFSS commands "\rmfamily", "\sffamily" and "\ttfamily" have to be defined
+ (which holds true for every common document class).
+
+
+
+ \subsection*{Installation}
+ \addcontentsline{toc}{subsection}{Installation}
+ Extract the \textit{package} file first:
+ \begin{enumerate}
+ \item Run \LaTeX\ over the file "textualicomma.ins"
+ \item Move the resulting ".sty" file to "TEXMF/tex/latex/textualicomma/"
+ \end{enumerate}
+
+ Then, you can compile the \textit{documentation} yourself by executing \\[\smallskipamount]
+ "lualatex textualicomma-doc.dtx" \\
+ "makeindex -s gind.ist textualicomma-doc.idx" \\
+ "makeindex -s gglo.ist -o textualicomma-doc.gls textualicomma-doc.glo" \\
+ "lualatex textualicomma-doc.dtx" \\
+ "lualatex textualicomma-doc.dtx"
+
+ \smallskip
+ or just use the precompiled documentation shipped with the source files. \\
+ In both cases, copy the files "textualicomma-doc.pdf" and "README.md" to \\
+ "TEXMF/doc/latex/textualicomma/"
+
+
+
+ \subsection*{License}
+ \addcontentsline{toc}{subsection}{License}
+ \begin{small}
+ \textcopyright\ 2017-18 Sebastian Friedl
+
+ \smallskip
+ This work may be distributed and/or modified under the conditions of the \LaTeX\ Project Public License, either version 1.3c of this license or (at your option) any later version.
+
+ \smallskip
+ The latest version of this license is available at \url{http://www.latex-project.org/lppl.txt} and version 1.3c or later is part of all distributions of \LaTeX\ version 2008-05-04 or later.
+
+ \smallskip
+ This work has the LPPL maintenace status \enquote*{maintained}. \\
+ Current maintainer of this work is Sebastian Friedl.
+
+ \medskip
+ This work consists of the following files:
+ \begin{itemize} \itemsep 0pt
+ \item "textualicomma.sty",
+ \item "textualicomma.ins",
+ \item "textualicomma-doc.dtx" and
+ \item the derived file "textualicomma.sty"
+ \end{itemize}
+ \end{small}
+
+
+
+
+
+
+
+ \clearpage
+ \part{The documentation}
+ \section{Introduction}
+ Using the comma as decimal separator in ordinary \LaTeX\ has always been proble\-matic: since the comma is treated as punctuation,\TeX\ adds some space after it. \\
+ The solution was defining an \enquote*{intelligent} comma recognizing whether it's used as decimal separator or punctuation character.
+
+ \medskip
+ The common package implementing this solution is \sty{icomma} by Walter Schmidt~\cite{icomma}.
+ However, some fonts, e.g. Source Serif Pro, don't provide any math support. \\
+ Although there are fonts looking very similar to Source Serif and providing math support (like Utopia and its ‘clones’ Fourier and Erewhon), more or less obvious differences are visible (compare \enquote*{$,$} to~\enquote*{,} at high magnifications). The only solution solving this \enquote*{problem} is escaping to text mode.
+
+
+
+ \section{The \sty{textualicomma} package}
+ \subsection{\sty{textualicomma}'s behaviour}
+ \sty{textualicomma} makes some changes and additions to \sty{icomma}'s code in order to provide automated escaping to text mode.
+ The behaviour remains the same:
+ \begin{itemize}
+ \item
+ The comma is treated as decimal separator if it is directly followed by a number.
+ Thus, a number is to be entered as, for instance, \\
+ "3,142"
+ \item
+ whereas mathematical expressions like $(x\text{,}\,y)$ are to be written with a space after the comma: \\
+ \verb*|(x, y)|
+ \end{itemize}
+
+ Also, the period is redefined so that it adapts to the used font.
+ This feature might be useful with \LaTeX\ \cls{beamer}'s sans-serif math.
+
+
+ \subsection{Package options}
+ By default, the font used for typesetting the comma is the current roman text font. This behavior can be modified by using package options:
+
+ \medskip\leavevmode%
+ \DescribeOption{sffamily}%
+ Passing the \opt{sffamily} option to \sty{textualicomma} results in the comma character being taken from the current sans serif text font
+
+ \medskip\leavevmode%
+ \DescribeOption{ttfamily}%
+ Passing the \opt{ttfamily} option to \sty{textualicomma} results in the comma character being taken from the current mono-spaced text font
+
+
+ \bigskip
+ \DescribeMacro{\textualicommafont}
+ Both options change the used font family \textit{for the whole document}.
+ Changes \emph{inside} the document can be made using the "\textualicommafont" command: \\[\smallskipamount]
+ "\textualicommafont{\rmfamily}" \qquad\rightarrow~~ roman comma in math mode \\
+ "\textualicommafont{\sffamily}" \qquad\rightarrow~~ sans-serif comma in math mode \\
+ "\textualicommafont{\ttfamily}" \qquad\rightarrow~~ monospaced comma in math mode
+
+
+
+ \section{Bugs and problems}
+ Generally, since the comma is made ‘active’, problems are not unlikely.
+
+ \medskip
+ For example, when using the ‘intelligent comma’ together with the \sty{dcolumn} package, a comma to be \textit{printed} as the decimal separator in a column of type "D" is to be specified as "{\mathord\mathcomma}", rather than "{,}", since the latter leads to an error. For example:
+ \begin{center}
+ \verb|\begin{tabular}{... D{,}{\mathord\mathcomma}{2} ...}|
+ \end{center}
+
+ Note that specifying the comma as the related input character works as usual.
+
+
+
+ \phantomsection
+ \addcontentsline{toc}{section}{References}
+ \begin{thebibliography}{1}
+ \bibitem{icomma}
+ Walter Schmidt.
+ The \sty{icomma} package for \LaTeXe.
+ Package and Documentation available on CTAN (\url{https://www.ctan.org/pkg/icomma})
+ \end{thebibliography}
+
+
+
+
+
+ % Start determining the checksum from here
+ \StopEventually{%
+ \clearpage
+ \PrintChanges
+ \setcounter{IndexColumns}{2}
+ \phantomsection
+ \addcontentsline{toc}{part}{Index}%
+ \IndexPrologue{\section*{Index}}
+ \PrintIndex}
+
+ \clearpage
+ \part{The package code}
+ \CodelineNumbered
+ \DocInput{textualicomma.dtx}
+
+
+ \Finale
+\end{document} \ No newline at end of file
diff --git a/macros/latex/contrib/textualicomma/textualicomma-doc.pdf b/macros/latex/contrib/textualicomma/textualicomma-doc.pdf
new file mode 100644
index 0000000000..3037d11b41
--- /dev/null
+++ b/macros/latex/contrib/textualicomma/textualicomma-doc.pdf
Binary files differ
diff --git a/macros/latex/contrib/textualicomma/textualicomma.dtx b/macros/latex/contrib/textualicomma/textualicomma.dtx
new file mode 100644
index 0000000000..8eaf3d505d
--- /dev/null
+++ b/macros/latex/contrib/textualicomma/textualicomma.dtx
@@ -0,0 +1,168 @@
+%\iffalse
+%<*package>
+%% \CharacterTable
+%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+%% Digits \0\1\2\3\4\5\6\7\8\9
+%% Exclamation \! Double quote \" Hash (number) \#
+%% Dollar \$ Percent \% Ampersand \&
+%% Acute accent \' Left paren \( Right paren \)
+%% Asterisk \* Plus \" Comma \,
+%% Minus \- Point \. Solidus \/
+%% Colon \: Semicolon \; Less than \<
+%% Equals \= Greater than \> Question mark \?
+%% Commercial at \@ Left bracket \[ Backslash \\
+%% Right bracket \] Circumflex \^ Underscore \_
+%% Grave accent \` Left brace \{ Vertical bar \|
+%% Right brace \} Tilde \~}
+%</package>
+%\fi
+% \iffalse
+% Doc-Source file to use with LaTeX2e
+% Copyright (C) 2017-18 Sebastian Friedl
+%
+% This work is subject to the LaTeX Project Public License, Version 1.3c or -- at
+% your option -- any later version of this license.
+% The work consists of the files textualicomma.dtx, textualicomma.ins,
+% textualicomma-doc.dtx and the derived file textualicomma.sty
+%
+% This work has the LPPL maintenance status 'maintained'.
+% Current maintainer of the work is Sebastian Friedl.
+% \fi
+%
+%
+%
+% \changes{1.0}{2017/12/03}{Initial release}
+% \changes{1.1}{2018/08/23}{Take care of dependencies and requirements}
+%
+%
+% \subsubsection*{Initialization}
+% \begin{macrocode}
+\ProvidesPackage{textualicomma}%
+ [2018/08/23 v1.1 Use textual comma characters as decimal separators]
+\NeedsTeXFormat{LaTeX2e}
+% \end{macrocode}
+%
+%
+%
+% \bigskip
+% \subsubsection*{Load dependencies and check requirements}
+% Load the \sty{amstext} package to enable escaping to horizontal mode:
+% \begin{macrocode}
+\RequirePackage{amstext}
+% \end{macrocode}
+%
+% Check whether "\rmfamily", "\sffamily" and "\ttfamily" are available:
+% \begin{macrocode}
+\AtBeginDocument{%
+ \ifx\rmfamily\@undefined%
+ \PackageError{textualicomma}%
+ {\noexpand\rmfamily is undefined. textualicomma doesn't work}%
+ {textualicomma requires the \noexpand\rmfamily command to be
+ defined; otherwise, this package won't work properly}%
+ \PackageWarning{textualicomma}{Emergency stop}%
+ \stop%
+ \fi%
+ \ifx\sffamily\@undefined%
+ \PackageError{textualicomma}%
+ {\noexpand\sffamily is undefined. textualicomma doesn't work}%
+ {textualicomma requires the \noexpand\sffamily command to be
+ defined; otherwise, this package won't work properly}%
+ \PackageWarning{textualicomma}{Emergency stop}%
+ \stop%
+ \fi%
+ \ifx\ttfamily\@undefined%
+ \PackageError{textualicomma}%
+ {\noexpand\ttfamily is undefined. textualicomma doesn't work}%
+ {textualicomma requires the \noexpand\ttfamily command to be
+ defined; otherwise, this package won't work properly}%
+ \PackageWarning{textualicomma}{Emergency stop}%
+ \stop%
+ \fi%
+}
+% \end{macrocode}
+%
+%
+%
+% \subsubsection*{Package options}
+% Provide a \opt{sffamily} option for using the sans serif font:
+% \begin{macrocode}
+\newif\if@txticmma@sffamily
+\@txticmma@sffamilyfalse
+\DeclareOption{sffamily}{\@txticmma@sffamilytrue}
+% \end{macrocode}
+%
+% Provide a \opt{ttfamily} option for using the typewriter font:
+% \begin{macrocode}
+\newif\if@txticmma@ttfamily
+\@txticmma@ttfamilyfalse
+\DeclareOption{ttfamily}{\@txticmma@ttfamilytrue}
+% \end{macrocode}
+%
+% Process all options passed to \sty{textualicomma}:
+% \begin{macrocode}
+\ProcessOptions
+% \end{macrocode}
+%
+%
+%
+% \subsubsection*{Configuration}
+% Use the roman text font family by default:
+% \begin{macrocode}
+\def\txticmma@ffamily{\rmfamily}
+% \end{macrocode}
+%
+% If one of the \opt{sffamily} or \opt{ttfamily} options has been used, changes are applied:
+% \begin{macrocode}
+\if@txticmma@sffamily\def\txticmma@ffamily{\sffamily}\fi
+\if@txticmma@ttfamily\def\txticmma@ffamily{\ttfamily}\fi
+% \end{macrocode}
+%
+% \begin{macro}{\textualicommafont}
+% Provide a command for switching the font family inside the document:
+% \begin{macrocode}
+\def\textualicommafont#1{\def\txticmma@ffamily{#1}}
+% \end{macrocode}
+% \end{macro}
+%
+%
+%
+% \subsubsection*{Defining the \enquote{textual intelligent comma}}
+% At the very beginning, provide access to the textual comma character.
+% Also, define a math character referring to the comma contained in the math font,
+% to be used in enumerations:
+% \begin{macrocode}
+\AtBeginDocument{%
+ \def\m@thtextcomma{\text{\txticmma@ffamily,}}
+ \mathchardef\mathcomma\mathcode`\,%
+ \mathcode`\,="8000 %
+}
+% \end{macrocode}
+%
+% Make the comma character active and map it to the \enquote*{smart comma}:
+% \begin{macrocode}
+{\catcode`,=\active
+ \gdef,{\futurelet\@let@token\sm@rtcomma}
+}
+% \end{macrocode}
+%
+% Last but not least, define the \enquote*{smart comma} \dots
+% \begin{macrocode}
+\def\sm@rtcomma{%
+ \ifx\@let@token\@sptoken\m@thtextcomma\protect\,\else
+ \ifx\@let@token\space \else
+ \m@thtextcomma\fi\fi}
+% \end{macrocode}
+%
+% \dots\ and allow changing the period's font:
+% \begin{macrocode}
+\DeclareMathSymbol{.}{\mathalpha}{operators}{`.}
+% \end{macrocode}
+%
+%
+%
+% \subsubsection*{Famous last words}
+% That's enough code. "\endinput".
+% \begin{macrocode}
+\endinput
+% \end{macrocode} \ No newline at end of file
diff --git a/macros/latex/contrib/textualicomma/textualicomma.ins b/macros/latex/contrib/textualicomma/textualicomma.ins
new file mode 100644
index 0000000000..b0cdf7a0d8
--- /dev/null
+++ b/macros/latex/contrib/textualicomma/textualicomma.ins
@@ -0,0 +1,40 @@
+% file textualicomma.ins
+\input docstrip
+
+
+\preamble
+
+ textualicomma.dtx
+ Copyright 2017-18 Sebastian Friedl
+
+ This work may be distributed and/or modified under the
+ conditions of the LaTeX Project Public License, either version 1.3c
+ of this license of (at your option) any later version.
+ The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+ and version 1.3c or later is part of all distributions of LaTeX
+ version 2008/05/04 or later.
+
+ This work has the LPPL maintenance status 'maintained'.
+ Current maintainer of the work is Sebastian Friedl
+
+ This work consists of the files textualicomma.dtx,
+ textualicomma.ins and textualicomma-doc.dtx,
+ as well as the derived file textualicomma.sty
+
+\endpreamble
+
+\askforoverwritefalse
+
+
+\generate{%
+ \file{textualicomma.sty}%
+ {%
+ \usepreamble\defaultpreamble
+ \usepostamble\defaultpostamble
+ \from{textualicomma.dtx}{package}%
+ }%
+}
+
+\endbatchfile
+