diff options
author | Karl Berry <karl@freefriends.org> | 2022-02-27 21:34:10 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-02-27 21:34:10 +0000 |
commit | a453427485fabe1e4584b52fc7357c575f579688 (patch) | |
tree | 43cf91377e9cdf741b6b35a2257dd6870185a5fa /Master/texmf-dist/doc/luatex/penlight | |
parent | bd2784af386a8d478c89b98790f9d026e7aa5997 (diff) |
penlight (27feb22)
git-svn-id: svn://tug.org/texlive/trunk@62254 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex/penlight')
-rw-r--r-- | Master/texmf-dist/doc/luatex/penlight/penlight.pdf | bin | 29642 -> 38237 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/luatex/penlight/penlight.tex | 109 |
2 files changed, 76 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/luatex/penlight/penlight.pdf b/Master/texmf-dist/doc/luatex/penlight/penlight.pdf Binary files differindex 1edb8bf2b54..a8e166a1ae4 100644 --- a/Master/texmf-dist/doc/luatex/penlight/penlight.pdf +++ b/Master/texmf-dist/doc/luatex/penlight/penlight.pdf diff --git a/Master/texmf-dist/doc/luatex/penlight/penlight.tex b/Master/texmf-dist/doc/luatex/penlight/penlight.tex index 79a5d085891..176dc4e5572 100644 --- a/Master/texmf-dist/doc/luatex/penlight/penlight.tex +++ b/Master/texmf-dist/doc/luatex/penlight/penlight.tex @@ -1,5 +1,5 @@ % Kale Ewasiuk (kalekje@gmail.com) -% 2021-12-15 +% 2022-02-27 % Copyright (C) 2021 Kale Ewasiuk % % Permission is hereby granted, free of charge, to any person obtaining a copy @@ -25,7 +25,7 @@ \documentclass[11pt,parskip=half]{scrartcl} \setlength{\parindent}{0ex} -\newcommand{\llcmd}[1]{\leavevmode\llap{\texttt{\detokenize{#1}\ }}} +\newcommand{\llcmd}[1]{\leavevmode\llap{\texttt{\detokenize{#1}}}} \newcommand{\cmd}[1]{\texttt{\detokenize{#1}}} \newcommand{\qcmd}[1]{``\cmd{#1}''} \usepackage{url} @@ -52,7 +52,7 @@ \date{\today} -\RequirePackage{penlight} +\RequirePackage[pl,extras]{penlight} \title{penlight} \subtitle{Lua libraries for use in LuaLaTeX} @@ -60,7 +60,7 @@ \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#}} + \mbox{\url{https://lunarmodules.github.io/Penlight}} \\ \subsection*{Required Package Option} @@ -70,48 +70,91 @@ \texttt{penlight.XYZ} or \texttt{pl.XYZ} + + \subsection*{texlua usage} +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 setting \cmd{__SKIP_TEX__ = true} and adding the package to path. For example: + \begin{verbatim} +package.path = package.path .. ';'..'path/to/texmf/tex/latex/penlight/?.lua' +penlight = require('penlight') +-- below is optional +__SKIP_TEX__ = true --only required if you want to use + --penlightextras without a LaTeX run +-- __PL_NO_GLOBALS__ = true -- optional, skip global definitions +require('penlightextras') +\end{verbatim} - \subsection*{Additional Package Options} +\pagebreak + + +\subsection*{Additional Package Options} \noindent - \begin{tabular}{lp{4.5in}} + \hspace*{-6ex}\begin{tabular}{lp{4.8in}} \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}\\\\ + & this will be ran in pre-amble: \texttt{require('pl.stringx').format\_operator()}\\ + & \mbox{\url{https://lunarmodules.github.io/Penlight/libraries/pl.stringx.html#format_operator}} + \\ \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, - }\\ + & \url{https://lunarmodules.github.io/Penlight/libraries/pl.func}\\ + \texttt{\llap{extras}noglobals} & does the above three (\cmd{func,stringx,format}); adds some additional functions to \cmd{penlight} module; and adds the \cmd{pl.tex} sub-module.\\ + \texttt{extras} & does the above \texttt{extrasnoglobals} but makes many of the functions global variables. \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} +\subsection*{Extras} + +If \cmd{extras} is used, the following Lua globals will be defined:\\ + +\subsubsection*{Misc stuff} +\llcmd{__SKIP_TEX__} If using package with \cmd{texlua}, set this global before loading \cmd{penlight}\\ +\llcmd{__PL_NO_}\cmd{GLOBALS__} If using package with \cmd{texlua} and you don't want to set some globals (described in next sections), set this global before to \cmd{true} loading \cmd{penlight}\\ +\llcmd{hasval(x)} Python-like boolean testing\\ +\llcmd{COMP'xyz'()} Python-like comprehensions:\\\url{https://lunarmodules.github.io/Penlight/libraries/pl.comprehension.html}\\ +\llcmd{math.mod(n,d)}, \cmd{math.mod2(n)} math modulous\\ +\llcmd{string.}\cmd{totable(s)} string a table of characters\\ +\llcmd{kpairs(t), }\cmd{npairs(t)} iterate over keys only, or include nil value from table ipairs\\ + +\llcmd{pl.utils.}\cmd{filterfiles}\cmd{(dir,filt,rec)} Get files from dir and apply glob-like filters. Set rec to \cmd{true} to include sub directories\\ + +\pagebreak + +\subsubsection*{\cmd{pl.tex.} module is added} +\llcmd{add_bkt}\cmd{_cnt(n), }\cmd{close_bkt_cnt(n), reset_bkt_cnt} functions to keep track of adding curly brackets as strings. \cmd{add} will return \cmd{n} (default 1) \{'s and increment a counter. \cmd{close} will return \cmd{n} \}'s (default will close all brackets) and decrement.\\ +\llcmd{_NumBkts} internal integer for tracking the number of brackets\\ +\llcmd{opencmd(cs)} prints \cmd{\cs}\{ and adds to the bracket counters.\\ +\\ +\llcmd{_xNoValue,}\cmd{_xTrue,_xFalse}: \cmd{xparse} equivalents for commands\\ +\\ +\llcmd{prt(x),prtn(x)} print without or with a newline at end. Tries to help with special characters or numbers printing.\\ +\llcmd{prtl(l),prtt(t)} print a literal string, or table\\ +\llcmd{wrt(x), wrtn(x)} write to log\\ +\llcmd{help_wrt}\cmd{(s1, s2)} pretty-print something to console. S2 is a flag to help you find.\\ +\llcmd{prt_array2d(tt)} pretty print a 2d array\\ +\\ +\llcmd{pkgwarn}\cmd{(pkg, msg1, msg2)} throw a package warning\\ +\llcmd{pkgerror}\cmd{(pkg, msg1, msg2, stop)} throw a package error. If stop is true, immediately ceases compile.\\ +\\ +\llcmd{defcmd}\cmd{(cs, val)} like \cmd{\gdef}\\ +\llcmd{newcmd}\cmd{(cs, val)} like \cmd{\newcommand}\\ +\llcmd{renewcmd}\cmd{(cs, val)} like \cmd{\renewcommand}\\ +\llcmd{prvcmd}\cmd{(cs, val)} like \cmd{\providecommand}\\ +\llcmd{deccmd}\cmd{(cs, dft, overwrite)} declare a command. If \cmd{dft} (default) is \cmd{nil}, \cmd{cs} is set +to a package warning saying \cmd{'cs' was declared and used in document, but never set}. If \cmd{overwrite} +is true, it will overwrite an existing command (using \cmd{defcmd}), otherwise, it will throw error like \cmd{newcmd}.\\ + + + +\subsubsection*{global extras} +If \cmd{extras} is used and NOT \cmd{extrasnoglobals}, then some globals are set.\\ +All \cmd{pl.tex} modules are added.\\ +\cmd{hasval}, \cmd{COMP}, \cmd{kpairs}, \cmd{npairs} are globals.\\ +\cmd{pl.tablex} functions are added to the \cmd{table} table.\\ \section*{} Disclaimer: I am not the author of the Lua Penlight library. |