diff options
Diffstat (limited to 'Master/texmf-dist/doc/lualatex')
| -rw-r--r-- | Master/texmf-dist/doc/lualatex/autopuncitems/README.md | 28 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.pdf | bin | 0 -> 35326 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.tex | 201 |
3 files changed, 229 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/lualatex/autopuncitems/README.md b/Master/texmf-dist/doc/lualatex/autopuncitems/README.md new file mode 100644 index 00000000000..3cd4844b108 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/autopuncitems/README.md @@ -0,0 +1,28 @@ +# autopuncitems + +Automatically punctuate lists by passing the autopunc option to enumitem lists. + +# License + +Copyright (C) 2021 Kale Ewasiuk + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR +ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE +OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.pdf b/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.pdf Binary files differnew file mode 100644 index 00000000000..fd743e4d996 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.pdf diff --git a/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.tex b/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.tex new file mode 100644 index 00000000000..fd829b81e62 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/autopuncitems/autopuncitems.tex @@ -0,0 +1,201 @@ +% Kale Ewasiuk (kalekje@gmail.com) +% 2021-12-20 +% Copyright (C) 2021 Kale Ewasiuk +% +% Permission is hereby granted, free of charge, to any person obtaining a copy +% of this software and associated documentation files (the "Software"), to deal +% in the Software without restriction, including without limitation the rights +% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +% copies of the Software, and to permit persons to whom the Software is +% furnished to do so, subject to the following conditions: +% +% The above copyright notice and this permission notice shall be included in +% all copies or substantial portions of the Software. +% +% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +% ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +% TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +% PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +% SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR +% ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +% ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE +% OR OTHER DEALINGS IN THE SOFTWARE. + + +\documentclass[11pt,parskip=half]{scrartcl} +\setlength{\parindent}{0ex} +\newcommand{\llcmd}[1]{\leavevmode\llap{\texttt{\detokenize{#1}\ }}} +\newcommand{\cmd}[1]{\texttt{\detokenize{#1}}} +\newcommand{\qcmd}[1]{``\cmd{#1}''} +\RequirePackage{url} +\RequirePackage{xcolor} +\RequirePackage{showexpl} +\lstset{explpreset={justification=\raggedright,pos=r,wide=true}} +\setlength\ResultBoxRule{0mm} +\lstset{ + language=[LaTeX]TeX, + basicstyle=\ttfamily\small, + commentstyle=\ttfamily\small\color{gray}, + frame=none, + numbers=left, + numberstyle=\ttfamily\small\color{gray}, + prebreak=\raisebox{0ex}[0ex][0ex]{\color{gray}\ensuremath{\hookleftarrow}}, + extendedchars=true, + breaklines=true, + tabsize=4, +} +\addtokomafont{title}{\raggedright} +\addtokomafont{author}{\raggedright} +\addtokomafont{date}{\raggedright} +\author{Kale Ewasiuk (\url{kalekje@gmail.com})} +\RequirePackage[yyyymmdd]{datetime}\renewcommand{\dateseparator}{--} +\date{\today} + + +\usepackage{autopuncitems} +\setlist{nosep} + +\title{autopuncitems} + + +\begin{document} +\maketitle + +\section{Introduction} +This package provides the \cmd{autopunc} option in the +\cmd{enumitem} environemnts \cmd{itemize}, \cmd{enumerate}, and \cmd{description} +to automatically punctuate the items. +It uses lua pattern matching to modify the environment's contents. + +\section{Some commands} +\llcmd{\APomit}Used in an \cmd{\item} to signify that that item should not be automatically punctuated, and not be counted. Expands to nothing.\\ +\llcmd{\APpass}Used in an \cmd{\item} to signify that that item should not be automatically punctuated, and but still counted. Expands to nothing.\\ + +\begin{addmargin}[0.8in]{0in} +\llcmd{\setAPeach{}{}{}}Set the default, second last, and last punctuation point in that order.\\ +\llcmd{\setAPall{}}Set all punctuation points the same.\\ +\llcmd{\setAPdef{}}Set the default punctuation point. \cmd{;} by default.\\ +\llcmd{\setAPseclast{}}Set the second last punctuation point. \cmd{; and} by default.\\ +\llcmd{\setAPlast{}}Set the second last punctuation point. \cmd{.} by default.\\ + +\llcmd{\enableAPautopassnest}Automatically put an \cmd{\APpass} on items that introduce a nested list. Default behaviour.\\ +\llcmd{\disableAPautopassnest}Do not automatically put an \cmd{\APpass} on items that introduce a nested list.\\ + +\end{addmargin} + + +\section{Tutorial} +\subsection{Basic Use} + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three + \item four +\end{itemize} +\end{LTXexample} + + +\subsection{Demonstrating Pass} + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three \APpass + \item four +\end{itemize} +\end{LTXexample} + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three \APpass + \item four \APpass +\end{itemize} +\end{LTXexample} + + +\subsection{Demonstrating Omit} + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three \APomit + \item four +\end{itemize} +\end{LTXexample} + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three \APomit + \item four \APomit +\end{itemize} +\end{LTXexample} + +\subsection{Nested} +You must use \cmd{autopunc} on each nested list if you want that sub-list to be automatically punctuated. +Note that by default, the item introducing (before) a sub-list will not be automatically punctuated. + +\begin{LTXexample} +\begin{itemize}[autopunc] + \item one + \item two + \item three: + \begin{enumerate}[autopunc] + \item alpha: + \begin{description}[autopunc] + \item[hello] world + \end{description} + \item beta + \item delta + \end{enumerate} + \item four +\end{itemize} +\end{LTXexample} + + +\subsubsection{If you forget to use APpass} +If you disable auto-pass nested lists, and don't use \cmd{\APpass}, here is what happens. Notice the extra ``; and'' below hello world and beta. +\begin{LTXexample} +\disableAPautopassnest +\begin{itemize}[autopunc] + \item one + \item two + \item three + \begin{enumerate}[autopunc] + \item alpha + \begin{description}[autopunc] + \item[hello] world + \end{description} + \item beta + \end{enumerate} + \item four +\end{itemize} +\end{LTXexample} + +\begin{LTXexample} +\enableAPautopassnest +\begin{itemize}[autopunc] + \item one + \item two + \item three + \begin{enumerate} + \item alpha + \begin{description}[autopunc] + \item[hello] world + \end{description} + \item beta + \end{enumerate} + \item four +\end{itemize} +\end{LTXexample} + +\end{document} + |