diff options
| author | Albert Krewinkel <[email protected]> | 2024-04-18 14:32:15 +0200 |
|---|---|---|
| committer | John MacFarlane <[email protected]> | 2024-05-10 19:03:29 -0700 |
| commit | e5c135e68ecde81296ca045c9c362461b83ef4a4 (patch) | |
| tree | 7ea19c3b41552291d1a65f172da83fcde72968cf /doc | |
| parent | 673edabac0f01124cb412fecdc6f440aa77db6b4 (diff) | |
Lua: add a `pandoc.log` module.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua-filters.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md index 787c64da4..6dc910117 100644 --- a/doc/lua-filters.md +++ b/doc/lua-filters.md @@ -4736,6 +4736,66 @@ Returns: <!-- END: AUTOGENERATED CONTENT --> +<!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.log --> + +# Module pandoc.log + +Access to pandoc's logging system. + +## Functions {#pandoc.log-functions} + +### info {#pandoc.log.info} + +`info (message)` + +Reports a ScriptingInfo message to pandoc's logging system. + +Parameters: + +`message` +: the info message (string) + +*Since: 3.2* + +### silence {#pandoc.log.silence} + +`silence (fn)` + +Applies the function to the given arguments while preventing log +messages from being added to the log. The warnings and info +messages reported during the function call are returned as the +first return value, with the results of the function call +following thereafter. + +Parameters: + +`fn` +: function to be silenced (function) + +Returns: + +List of log messages triggered during the function call, and any +value returned by the function. + +*Since: 3.2* + +### warn {#pandoc.log.warn} + +`warn (message)` + +Reports a ScriptingWarning to pandoc's logging system. The warning +will be printed to stderr unless logging verbosity has been set to +*ERROR*. + +Parameters: + +`message` +: the warning message (string) + +*Since: 3.2* + +<!-- END: AUTOGENERATED CONTENT --> + <!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.path --> # Module pandoc.path |
