diff options
author | Karl Berry <karl@freefriends.org> | 2022-12-16 21:05:20 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-12-16 21:05:20 +0000 |
commit | 2811b370a9db2922ccdd8b3a3619299ea3b759d1 (patch) | |
tree | 750b4f4ed4a7dc373d52ec7df1a4d65d1c9f2266 /Master/texmf-dist/doc/luatex/luakeys | |
parent | be7f325aa40bdbe6f972a5b99206422d9c215c13 (diff) |
luakeys (16dec22)
git-svn-id: svn://tug.org/texlive/trunk@65294 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex/luakeys')
-rw-r--r-- | Master/texmf-dist/doc/luatex/luakeys/README.md | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.pdf | bin | 286697 -> 395011 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.tex | 98 |
3 files changed, 103 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/luatex/luakeys/README.md b/Master/texmf-dist/doc/luatex/luakeys/README.md index bd30edb0667..2779de92e83 100644 --- a/Master/texmf-dist/doc/luatex/luakeys/README.md +++ b/Master/texmf-dist/doc/luatex/luakeys/README.md @@ -97,6 +97,9 @@ local opts = { -- Key-value pair definitions. defs = { key = { default = 'value' } }, + -- Specify the strings that are recognized as boolean false values. + false_aliases = { 'false', 'FALSE', 'False' }, + -- lower, snake, upper format_keys = { 'snake' }, @@ -140,6 +143,8 @@ local opts = { end, }, + invert_flag = '!', + -- Configure the delimiter that separates list items from each other. list_separator = ',', @@ -156,6 +161,9 @@ local opts = { -- Configure the delimiter that marks the end of a string. quotation_end = '"', + -- Specify the strings that are recognized as boolean true values. + true_aliases = { 'true', 'TRUE', 'True' }, + -- { key = { 'value' } } -> { key = 'value' } unpack = false, } @@ -166,8 +174,8 @@ local result = luakeys.parse('one,two,three', opts) `luakeys` is developed using the [Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) -extension in Visual Studio Code. This extension understands the [EmmyLua -annotations](https://github.com/sumneko/lua-language-server/wiki/EmmyLua-Annotations). +extension in Visual Studio Code. This extension understands the modified +[EmmyLua annotations](https://github.com/sumneko/lua-language-server/wiki/Annotations). The Lua source code documentation is generated with [LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html). diff --git a/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.pdf b/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.pdf Binary files differindex e80b60f7620..a44a16094eb 100644 --- a/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.pdf +++ b/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.pdf diff --git a/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.tex b/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.tex index ea427a3c5e4..83c708da941 100644 --- a/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.tex +++ b/Master/texmf-dist/doc/luatex/luakeys/luakeys-doc.tex @@ -11,6 +11,8 @@ \usepackage{multicol} \usepackage{luacode} \usepackage{syntax} +\usepackage{graphicx} + \usemintedstyle{friendly} \BeforeBeginEnvironment{minted}{\begin{mdframed}} \AfterEndEnvironment{minted}{\end{mdframed}} @@ -58,7 +60,7 @@ The default value of the option “\texttt{#1}” is: \href{https://github.com/Josef-Friedrich/luakeys} {github.com/Josef-Friedrich/luakeys}% } -\date{0.9.0 from 2022/11/21} +\date{0.10.0 from 2022/12/16} \maketitle @@ -357,7 +359,7 @@ The \lua{parse} function can be called with an options table. This options are supported: \catcode`_=12 \directlua{luakeys.print_names('opts')} -\InputLua[firstline=5,lastline=86]{opts/all-opts.lua} +\InputLua[firstline=5,lastline=94]{opts/all-opts.lua} \noindent The options can also be set globally using the exported table @@ -539,6 +541,32 @@ we can write ... % %% +\subsubsection{Option “\texttt{false_aliases}”} +\label{option:false-aliases} + +% Mit den den Optionen \lua{true_aliases} and \lua{false_aliases} können +% die Zeichenketten festgelegt werden, die vom Parser als Wahrheitswerte +% erkannt werden. +The \lua{true_aliases} and \lua{false_aliases} options can be used to +specify the strings that will be recognized as boolean values by the +parser. +% Standardmäßig sind folgende Zeichenketten konfiguriert +The following strings are configured by default. + +\InputLua[firstline=4,lastline=8]{opts/boolean-aliases.lua} + +\InputLua[firstline=14,lastline=18]{opts/boolean-aliases.lua} + +\InputLua[firstline=24,lastline=28]{opts/boolean-aliases.lua} + +% Siehe Abschnitt \label{option:true-aliases} für die entsprechende +% Option. +See section \ref{option:true-aliases} for the corresponding option. + +%% +% +%% + \subsubsection{Option “\texttt{format_keys}”} % Mit Hilfe der Option \lua{format_keys} können die Schlüssel formatiert @@ -570,8 +598,8 @@ table. \item[upper] -% Um alle Schlüssel in \emph{Grossbuchstaben} umzuwandeln, geben sie in der -% Optionentabelle \lua{upper} an. +% Um alle Schlüssel in \emph{Grossbuchstaben} umzuwandeln, geben sie in +% der Optionentabelle \lua{upper} an. To convert all keys to \emph{uppercase}, specify \lua{upper} in the options table. @@ -611,6 +639,45 @@ example can be found in section \ref{options-delimiter}. % %% +\subsubsection{Option “\texttt{invert_flag}”} + +% Wird ein nackter Schlüssel mit einem vorangestellten Ausrufezeichen versehen, so wird sein Standardwert invertiert. +If a naked key is prefixed with an exclamation mark, its default value +is inverted. +% Statt \lua{true} nimmt der Schlüssel jetzt den Wert \lua{falsch} an. +Instead of \lua{true} the key now takes the value \lua{false}. + +\InputLua[firstline=4,lastline=5]{opts/invert-flat.lua} + +\noindent +% Mit der Option \lua{invert_flag} kann dieses Invertierungszeichen +% geändert werden. +The \lua{invert_flag} option can be used to change this inversion +character. + +\InputLua[firstline=11,lastline=12]{opts/invert-flat.lua} + +\noindent +% Ist der Standardwert für nackte Schlüssel beispielweise auf \lua{false} +% gesetzt, so nehmen die mit dem Umkehrungszeichen versehenen nackten +% Schlüssel den Wert \lua{true} an. +For example, if the default value for naked keys is set to \lua{false}, +the naked keys prefixed with the invert flat take the value \lua{true}. + +\InputLua[firstline=18,lastline=19]{opts/invert-flat.lua} + +\noindent +% Setzen sie die Option \lua{invert_flag} auf \lua{false}, um diese +% automatische Wertumkehrung zu deaktivieren. +Set the \lua{invert_flag} option to \lua{false} to disable this +automatic boolean value inversion. + +\InputLua[firstline=25,lastline=26]{opts/invert-flat.lua} + +%% +% +%% + \subsubsection{Option “\texttt{hooks}”} % Die folgenden Hooks bzw. Callback-Funktionen ermöglichen es in den @@ -777,6 +844,15 @@ end of a string. The default value of this option is \texttt{'"'} % %% +\subsubsection{Option “\texttt{true_aliases}”} +\label{option:true-aliases} + +See section \ref{option:false-aliases}. + +%% +% +%% + \subsubsection{Option “\texttt{unpack}”} % Mit Hilfe der Option \lua{unpack} werden alle Tabellen, die nur aus @@ -1841,6 +1917,12 @@ An example of how to use the command in \LaTeX: \end{document} \end{minted} +\section{Activity diagramm of the parsing process} + +\begin{center} +\includegraphics[width=0.8\linewidth]{Activity-Diagramm.eps} +\end{center} + %----------------------------------------------------------------------- % %----------------------------------------------------------------------- @@ -1947,7 +2029,7 @@ An example of how to use the command in \LaTeX: “quotation_end”. * Extend the documentation about the option “format_keys”. } -\changes{0.9.0}{2022/11/21}{ +\changes{0.10.0}{2022/12/16}{ * The definition attibute “pick” accepts a new data type: “any”. * The attribute value “true” for the attribute “pick” is deprecated. * The attribute “pick” accepts now multiple data types specified in @@ -1955,6 +2037,12 @@ An example of how to use the command in \LaTeX: * Add a new function called “any(value)” in the “is” table that accepts any data type. } +\changes{0.10.0}{2022/12/16}{ +* Add support for an invert flat that flips the value of naked keys. +* Add new options to specify which strings are recognized as Boolean + values. +} + \pagebreak \PrintChanges \pagebreak |