diff options
Diffstat (limited to 'macros/luatex/generic/luakeys/documentation.tex')
-rw-r--r-- | macros/luatex/generic/luakeys/documentation.tex | 123 |
1 files changed, 32 insertions, 91 deletions
diff --git a/macros/luatex/generic/luakeys/documentation.tex b/macros/luatex/generic/luakeys/documentation.tex index 42da7c1acc..2e57cbae19 100644 --- a/macros/luatex/generic/luakeys/documentation.tex +++ b/macros/luatex/generic/luakeys/documentation.tex @@ -64,7 +64,7 @@ The default value of the option “\texttt{#1}” is: \href{https://github.com/Josef-Friedrich/luakeys} {github.com/Josef-Friedrich/luakeys}% } -\date{v0.12.0 from 2023/01/05} +\date{v0.13.0 from 2023/01/13} \maketitle @@ -273,11 +273,14 @@ and loads the Lua module \texttt{luakeys.lua} into the global variable Luakeys exports only one function that must be called to access the public API. % -% Das Lua-Modul exportiert diese Funktionen und Tabellen: -The Lua module exports this functions and tables: +% Diese Exportfunktion gibt eine Tabelle zurück, die die öffentlichen +% Funktionen und weiteren Tabellen enthält: +This export function returns a table containing the public functions and +additional tables: \InputLua[firstline=3,lastline=16]{export.lua} +\noindent % Das Projekt verwendet einige wenige Abkürzungen für Variablennamen, % die hoffentlich für externe Leser eindeutig und bekannt sind. The project uses a few abbreviations for variable names that are @@ -316,6 +319,19 @@ The raw result of the Lpeg grammar parser. \\ \end{tabular} \end{center} +\noindent +% Es wird empfohlen, beim Entwickeln im Texteditor luakeys zusammen mit +% dem Lua-Language-Server zu verwenden. +It is recommended to use luakeys together with the +\href{https://github.com/sumneko/lua-language-server}{github.com/sumneko/lua-language-server} +when developing in a text editor. +% +% Luakeys unterstützt nämlich das vom Server angeboten Annotationsformat +luakeys supports the annotation format offered by the server. +% Sie sollten dann Warnungen erhalten, wenn Sie die mittlerweile +% ziemlich große API von luakeys falsch verwenden. +You should then get warnings if you misuse luakeys’ now rather large API. + %% % %% @@ -1524,7 +1540,7 @@ therefore accepts any data type. % In der Tabelle \lua{utils} sind einige Hilfsfunktionen gebündelt. The \lua{utils} table bundles some auxiliary functions. -\InputLua[firstline=3,lastline=34]{utils/all.lua} +\InputLua[firstline=3,lastline=37]{utils/all.lua} %% % @@ -1621,6 +1637,18 @@ installed. \InputLua[firstline=4,lastline=10]{version.lua} +%% +% +%% + +\subsection{Table “error_messages”} + +\InputLua[firstline=4,lastline=17]{error-messages.lua} + +\begin{description} +\directlua{luakeys.print_error_messages()} +\end{description} + %----------------------------------------------------------------------- % %----------------------------------------------------------------------- @@ -2069,93 +2097,6 @@ An example of how to use the command in \LaTeX: \inputminted[linenos=true]{latex}{luakeys-debug.sty} -\changes{v0.1.0}{2021/01/18}{Inital release} -\changes{v0.2.0}{2021/09/19}{ -* Allow all recognized data types as keys. -* Allow TeX macros in the values. -* New public Lua functions: save(identifier, result), get(identifier). -} -\changes{v0.3.0}{2021/11/05}{ -* Add a LuaLaTeX wrapper “luakeys.sty”. -* Add a plain LuaTeX wrapper “luakeys.tex”. -* Rename the previous documentation file “luakeys.tex” to luakeys-doc.tex”. -} -\changes{v0.4.0}{2021/12/31}{ -* Parser: Add support for nested tables (for example {{'a', 'b'}}). -* Parser: Allow only strings and numbers as keys. -* Parser: Remove support from Lua numbers with exponents (for example '5e+20'). -* Switch the Lua testing framework to busted. -} -\changes{v0.5.0}{2022/04/04}{ -* Add possibility to change options globally. -* New option: standalone_as_true. -* Add a recursive converter callback / hook to process the parse tree. -* New option: case_insensitive_keys. -} -\changes{v0.6.0}{2022/06/09}{ -* New feature: keys now can be defined using the function - “define(defs, opts)” or “define(kv_string, { defs = { key = { ... } } })” -* Rename the global options table from “default_options” to “opts”. -* New option “format_keys”. -* Remove option “case_insensitive_keys”. Use - “format_keys = \{ lower \}” to achieve the same effect. -* The default value of the option “convert_dimension” is now false. -* The option “standalone_as_true” is renamed to “naked_as_value”. - The boolean value of the option must be changed to the opposite to. - produce the previous effect. -* The function “print()” is now called “debug()”. -} -\changes{v0.7.0}{2022/07/06}{ -* The project now uses semantic versioning. -* New definition attribute “pick” to pick standalone values and assign - them to a key. -* New function “utils.scan_oarg()” to search for an optional argument, - that means scan for tokens that are enclosed in square brackets. -* Extend and improve the documentation. -} -\changes{v0.8.0}{2022/11/17}{ -* Add 6 new options to change the delimiters: “assignment_operator”, - “group_begin”, “group_end”, “list_separator”, “quotation_begin”, - “quotation_end”. -* Extend the documentation about the option “format_keys”. -} -\changes{v0.9.0}{2022/11/21}{ -* 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 - a table. -* Add a new function called “any(value)” in the “is” table that accepts - any data type. -} -\changes{v0.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. -} -\changes{v0.11.0}{2022/12/23}{ -* Add a new function called “get_private_instance()” to load a private - version of the luakeys module. -} -\changes{v0.12.0}{2023/01/05}{ -Added -* Macros \cmd{\LuakeysGetPackageOptions}, \cmd{\LuakeysGetClassOptions}. -* Option “accumulated_result”. -* Data type “list” to the attribute “data_type”. -* Attribute “description”. -* Tables “utils.log” and “utils.ansi_color”. -* Table “errors_message” to set custom messages. -* Short form syntax for the definition attribute “opposite_keys”. -Changed -* Breaking change! luakeys exports now a function instead of a table. - Use “require('luakeys')()” or “luakeys.new()” instead of - “require('luakeys')”. -* Breaking change! “luakeys.parse()”, “luakeys.define()”, “luakeys.save()” - and “luakeys.get()” can’t be used anymore from the global variable luakeys. -* New name for the function “new()” instead of “get_private_instance()". -} - -\pagebreak -\PrintChanges \pagebreak \PrintIndex \end{document} |