summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/penlight/penlight.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/penlight/penlight.tex')
-rw-r--r--macros/luatex/generic/penlight/penlight.tex84
1 files changed, 84 insertions, 0 deletions
diff --git a/macros/luatex/generic/penlight/penlight.tex b/macros/luatex/generic/penlight/penlight.tex
new file mode 100644
index 0000000000..2259cf27fd
--- /dev/null
+++ b/macros/luatex/generic/penlight/penlight.tex
@@ -0,0 +1,84 @@
+% Kale Ewasiuk (kalekje@gmail.com)
+% 2021-09-19
+%
+% 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{article}
+\usepackage[pl]{penlight}
+\usepackage{url}
+\begin{document}
+
+ \section*{penlight -- Lua libraries for use in LuaLaTeX}
+ v. 2021-09.19, Kale Ewasiuk, \url{kalekje@gmail.com}
+
+ \subsection*{Default}
+
+ \begin{verbatim}
+ \usepackage{penlight}
+ \end{verbatim}
+
+ If no options are used when using this package,
+ then all penlight packages are available under the lua variable \texttt{penlight}.
+ Here is an example:
+
+ \begin{verbatim}
+ \begin{luacode*}
+ texio.write_nl(penlight.pretty.write(penlight.List('hello')))
+ \end{luacode*}
+ \end{verbatim}
+
+ The official documentation for the lua library can be found here:\\
+ \mbox{\url{https://stevedonovan.github.io/Penlight/api/manual/01-introduction.md.html#}}
+
+ \subsection*{Package Options}
+
+ \noindent
+ \begin{tabular}{lp{4.5in}}
+ \texttt{pl} & will make penlight packages are available under the global lua variable \texttt{pl} or \texttt{penlight}.\\\\
+ \texttt{stringx} & will import additional string functions into the string meta table.\\
+ & this will be ran in pre-amble: \texttt{require('pl.stringx').import()}\\
+ & \hspace*{-4em}\url{https://stevedonovan.github.io/Penlight/api/libraries/pl.stringx.html}\\\\
+ \texttt{format} & allows \% operator for Python-style string formating\\
+ & this will be ran in pre-amble: \texttt{require('pl.text').format\_operator()}\\
+ & \hspace*{-4em}\url{https://stevedonovan.github.io/Penlight/api/libraries/pl.text.html}\\\\
+ \texttt{func} & allows placehold expressions eg. \texttt{\_1 + 1} to be used \\
+ & this will be ran in pre-amble: \texttt{penlight.utils.import('pl.func')}\\
+ & \hspace*{-4em}\url{https://stevedonovan.github.io/Penlight/api/libraries/pl.func.html}\\\\
+ \end{tabular}
+
+ \begin{verbatim}
+
+ \end{verbatim}
+
+
+
+
+
+ \section*{}
+ Disclaimer: I am not the author of the Lua penlight library.
+ penlight is Copyright \textcopyright 2009-2016 Steve Donovan, David Manura.
+ The distribution of penlight used for this library is:
+\url{https://github.com/lunarmodules/penlight}
+
+
+\end{document} \ No newline at end of file