diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua-filters.md | 148 |
1 files changed, 94 insertions, 54 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md index 37bc89d81..d3bea4cb4 100644 --- a/doc/lua-filters.md +++ b/doc/lua-filters.md @@ -3718,17 +3718,19 @@ Usage: [WriterOptions]: #type-writeroptions +<!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.cli --> + # Module pandoc.cli Command line options and argument parsing. ## Fields {#pandoc.cli-fields} -### default\_options {#pandoc.cli.default_options} +### default_options {#pandoc.cli.default_options} -Default CLI options, using a JSON-like representation (table). +Default CLI options, using a JSON-like representation. (table) -## Functions +## Functions {#pandoc.cli-functions} ### parse_options {#pandoc.cli.parse_options} @@ -3741,7 +3743,7 @@ the list of arguments from the global `arg`. Parameters: `args` -: list of command line arguments ({string,...}) +: list of command line arguments ({string,\...}) Returns: @@ -3781,6 +3783,7 @@ Returns: The result(s) of the last evaluated input, or nothing if the last input resulted in an error. +<!-- END: AUTOGENERATED CONTENT --> # Module pandoc.utils @@ -4604,25 +4607,28 @@ Returns: - JSON encoding of the given object (string) +<!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.path --> # Module pandoc.path Module for file path manipulations. -## Static Fields {#pandoc.path-fields} +## Fields {#pandoc.path-fields} ### separator {#pandoc.path.separator} -The character that separates directories. +The character that separates directories. (string) ### search_path_separator {#pandoc.path.search_path_separator} The character that is used to separate the entries in the `PATH` -environment variable. +environment variable. (string) ## Functions {#pandoc.path-functions} -### directory (filepath) {#pandoc.path.directory} +### directory {#pandoc.path.directory} + +`directory (filepath)` Gets the directory name, i.e., removes the last directory separator and everything after from the given path. @@ -4636,7 +4642,9 @@ Returns: - The filepath up to the last directory separator. (string) -### filename (filepath) {#pandoc.path.filename} +### filename {#pandoc.path.filename} + +`filename (filepath)` Get the file name. @@ -4649,9 +4657,11 @@ Returns: - File name part of the input path. (string) -### is_absolute (filepath) {#pandoc.path.is_absolute} +### is_absolute {#pandoc.path.is_absolute} + +`is_absolute (filepath)` -Checks whether a path is absolute, i.e. not fixed to a root. +Checks whether a path is absolute, i.e. not fixed to a root. Parameters: @@ -4660,10 +4670,12 @@ Parameters: Returns: -- `true` if `filepath` is an absolute path, `false` otherwise. +- `true` iff `filepath` is an absolute path, `false` otherwise. (boolean) -### is_relative (filepath) {#pandoc.path.is_relative} +### is_relative {#pandoc.path.is_relative} + +`is_relative (filepath)` Checks whether a path is relative or fixed to a root. @@ -4674,31 +4686,32 @@ Parameters: Returns: -- `true` if `filepath` is a relative path, `false` otherwise. +- `true` iff `filepath` is a relative path, `false` otherwise. (boolean) -### join (filepaths) {#pandoc.path.join} +### join {#pandoc.path.join} + +`join (filepaths)` Join path elements back together by the directory separator. Parameters: `filepaths` -: path components (list of strings) +: path components ({string,\...}) Returns: - The joined path. (string) -### make_relative (path, root[, unsafe]) {#pandoc.path.make_relative} +### make_relative {#pandoc.path.make_relative} -Contract a filename, based on a relative path. Note that the -resulting path will usually not introduce `..` paths, as the -presence of symlinks means `../b` may not reach `a/b` if it starts -from `a/c`. For a worked example see [this blog -post](https://neilmitchell.blogspot.co.uk/2015/10/filepaths-are-subtle-symlinks-are-hard.html). +`make_relative (path, root[, unsafe])` -Set `unsafe` to a truthy value to allow `..` in paths. +Contract a filename, based on a relative path. Note that the +resulting path will never introduce `..` paths, as the presence of +symlinks means `../b` may not reach `a/b` if it starts from `a/c`. +For a worked example see [this blog post]. Parameters: @@ -4715,15 +4728,17 @@ Returns: - contracted filename (string) -### normalize (filepath) {#pandoc.path.normalize} +### normalize {#pandoc.path.normalize} + +`normalize (filepath)` Normalizes a path. - `//` makes sense only as part of a (Windows) network drive; elsewhere, multiple slashes are reduced to a single `path.separator` (platform dependent). -- `/` becomes `path.separator` (platform dependent) -- `./` -\> '' +- `/` becomes `path.separator` (platform dependent). +- `./` is removed. - an empty path becomes `.` Parameters: @@ -4735,7 +4750,9 @@ Returns: - The normalized path. (string) -### split (filepath) {#pandoc.path.split} +### split {#pandoc.path.split} + +`split (filepath)` Splits a path by the directory separator. @@ -4746,13 +4763,16 @@ Parameters: Returns: -- List of all path components. (list of strings) +- List of all path components. ({string,\...}) -### split_extension (filepath) {#pandoc.path.split_extension} +### split_extension {#pandoc.path.split_extension} -Splits the last extension from a file path and returns the parts. The -extension, if present, includes the leading separator; if the path has -no extension, then the empty string is returned as the extension. +`split_extension (filepath)` + +Splits the last extension from a file path and returns the parts. +The extension, if present, includes the leading separator; if the +path has no extension, then the empty string is returned as the +extension. Parameters: @@ -4762,14 +4782,15 @@ Parameters: Returns: - filepath without extension (string) - - extension or empty string (string) -### split_search_path (search_path) {#pandoc.path.split_search_path} +### split_search_path {#pandoc.path.split_search_path} + +`split_search_path (search_path)` -Takes a string and splits it on the `search_path_separator` character. -Blank items are ignored on Windows, and converted to `.` on Posix. On -Windows path elements are stripped of quotes. +Takes a string and splits it on the `search_path_separator` +character. Blank items are ignored on Windows, and converted to +`.` on Posix. On Windows path elements are stripped of quotes. Parameters: @@ -4778,7 +4799,16 @@ Parameters: Returns: -- list of directories in search path (list of strings) +- list of directories in search path ({string,\...}) + +### treat_strings_as_paths {#pandoc.path.treat_strings_as_paths} + +`treat_strings_as_paths ()` + +Augment the string module such that strings can be used as path +objects. + +<!-- END: AUTOGENERATED CONTENT --> # Module pandoc.structure @@ -5639,18 +5669,21 @@ Returns [Doc]: #type-doc +<!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.scaffolding --> + # Module pandoc.scaffolding Scaffolding for custom writers. -## Writer {#pandoc.scaffolding.writer} +## Fields {#pandoc.scaffolding-fields} -A structure to be used as a `Writer` function; the construct -handles most of the boilerplate, expecting only render functions -for all AST elements. See the documentation for custom writers for -details. +### Writer {#pandoc.scaffolding.Writer} +An object to be used as a `Writer` function; the construct handles +most of the boilerplate, expecting only render functions for all +AST elements (table) +<!-- END: AUTOGENERATED CONTENT --> # Module pandoc.template @@ -5767,6 +5800,8 @@ Returns: - A new [Version] object. +<!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.zip --> + # Module pandoc.zip Functions to create, modify, and extract files from zip archives. @@ -5801,7 +5836,7 @@ Parameters: `bytestring_or_entries` : binary archive data or list of entries; defaults to an empty - list ([string]{.builtin-lua-type}\|{[zip.Entry],\...}) + list (string\|{[zip.Entry],\...}) Returns: @@ -5817,10 +5852,10 @@ the file's modification time. Parameters: `path` -: file path in archive ([string]{.builtin-lua-type}) +: file path in archive (string) `contents` -: uncompressed contents ([string]{.builtin-lua-type}) +: uncompressed contents (string) `modtime` : modification time ([integer]{unknown-type="integer"}) @@ -5838,10 +5873,10 @@ Generates a ZipEntry from a file or directory. Parameters: `filepath` -: ([string]{.builtin-lua-type}) +: (string) `opts` -: zip options ([table]{.builtin-lua-type}) +: zip options (table) Returns: @@ -5857,10 +5892,10 @@ Parameters: `filepaths` : list of files from which the archive is created. - ({[string]{.builtin-lua-type},\...}) + ({string,\...}) `opts` -: zip options ([table]{.builtin-lua-type}) +: zip options (table) Returns: @@ -5891,7 +5926,7 @@ Parameters: Returns: -- bytes of the archive ([string]{.builtin-lua-type}) +- bytes of the archive (string) ##### extract {#pandoc.zip.Archive.extract} @@ -5908,7 +5943,7 @@ Parameters: : ([zip.Archive]) `opts` -: zip options ([table]{.builtin-lua-type}) +: zip options (table) ### zip.Entry {#type-pandoc.zip.Entry} @@ -5939,11 +5974,16 @@ Parameters: : ([zip.Entry]) `password` -: password for entry ([string]{.builtin-lua-type}) +: password for entry (string) Returns: -- binary contents ([string]{.builtin-lua-type}) +- binary contents (string) + +<!-- END: AUTOGENERATED CONTENT --> + +<!-- BEGIN: GENERATED REFERENCE LINKS --> + [this blog post]: http://neilmitchell.blogspot.co.uk/2015/10/filepaths-are-subtle-symlinks-are-hard.html [zip.Entry]: #type-pandoc.zip.Entry [zip.Archive]: #type-pandoc.zip.Archive |