summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-09-21 19:48:22 +0000
committerKarl Berry <karl@freefriends.org>2021-09-21 19:48:22 +0000
commit7ae12e79acacd03b0dc8508a6f64762c1d0b3ce0 (patch)
treeaefaa6856303bd1ff794c62b19f87b042c059bb7 /Master/texmf-dist/doc/luatex
parentf8978870d707711cf4790fe169054f49679bd3bf (diff)
penlight (21sep21)
git-svn-id: svn://tug.org/texlive/trunk@60574 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex')
-rw-r--r--Master/texmf-dist/doc/luatex/penlight/README.md29
-rw-r--r--Master/texmf-dist/doc/luatex/penlight/penlight.pdfbin0 -> 22977 bytes
-rw-r--r--Master/texmf-dist/doc/luatex/penlight/penlight.tex95
3 files changed, 124 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/luatex/penlight/README.md b/Master/texmf-dist/doc/luatex/penlight/README.md
new file mode 100644
index 00000000000..55544e7d9fe
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/penlight/README.md
@@ -0,0 +1,29 @@
+# penlight -- Lua libraries for use in LuaLaTeX
+
+This LuaLaTeX package provides a thin-wrapper to use the [penlight](https://github.com/lunarmodules/Penlight) Lua libraries with LuaLaTeX. It uses the `luapackageloader` package.
+
+
+
+# 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/luatex/penlight/penlight.pdf b/Master/texmf-dist/doc/luatex/penlight/penlight.pdf
new file mode 100644
index 00000000000..688706ad51d
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/penlight/penlight.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/luatex/penlight/penlight.tex b/Master/texmf-dist/doc/luatex/penlight/penlight.tex
new file mode 100644
index 00000000000..9d3330bc9bb
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/penlight/penlight.tex
@@ -0,0 +1,95 @@
+% Kale Ewasiuk (kalekje@gmail.com)
+% 2021-09-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{article}
+\usepackage{url}
+\begin{document}
+
+ \section*{Penlight -- Lua libraries for use in LuaLaTeX}
+ v. 2021-09-20, Kale Ewasiuk, \url{kalekje@gmail.com}\\\\
+
+ 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} \ No newline at end of file