1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
% Kale Ewasiuk (kalekje@gmail.com)
% 2021-12-15
% 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}''}
\usepackage{url}
\usepackage{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})}
\usepackage[yyyymmdd]{datetime}\renewcommand{\dateseparator}{--}
\date{\today}
\RequirePackage{penlight}
\title{penlight}
\subtitle{Lua libraries for use in LuaLaTeX}
\begin{document}
\maketitle
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*{Required Package Option}
The first option sent to this package MUST be one of: \\
\texttt{[penlight]} \ \ \ or \ \ \ \texttt{[pl]}.\\
All Penlight sub-modules are then available under this global variable by either\\
\texttt{penlight.XYZ} or \texttt{pl.XYZ}
\subsection*{Additional Package Options}
\noindent
\begin{tabular}{lp{4.5in}}
\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}\\\\
\texttt{extras} & adds some additional functions. Adds functions to some Penlight sub-modules. The following Lua globals will be defined:
\texttt{close\_bkt\_cnt,
add\_bkt\_cnt,
reset\_bkt\_cnt,
\_NumBkts,
\_xTrue,
\_xFalse,
\_xNoValue,
\_\_SKIP\_TEX\_\_,
hasval,
mod, mod2,
}\\
\end{tabular}
\\\\
If you want to use Penlight (and extras) with the \texttt{texlua} intrepreter (no document made, only for Lua files, useful for testing),
you can access it by the following:
\begin{verbatim}
package.path = package.path .. ';'..'path/to/texmf/tex/latex/penlight/?.lua'
penlight = require('penlight')
__SKIP_TEX__ = true --only required if you want to use
--penlightextras without a LaTeX run
require('penlightextras')
\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}\\
The author of this library has merged all Lua sub-modules into one file for this package.
\end{document}
|