luadocs/content/lua.scripts.api.manual/dtutils.string/details.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

1.5 KiB

title id weight draft author
details details 10 false people

DTUTILS.STRING

NAME

dtutils.string

SYNOPSIS

a library of string utilities for use in darktable lua scripts

USAGE

local ds = require "lib/dtutils.string"

DESCRIPTION

This library contains string manipulation routines to aid in building darktable lua scripts.

RETURN VALUE

ds - library - the darktable lua string library

FUNCTIONS

escape_xml_characters

escape characters for xml documents

is_not_sanitized

check if a string has been sanitized

sanitize

surround a string in quotes making it safe to pass as an argument

sanitize_lua

escape lua 'magic' characters from a pattern string

strip_accents

strip accents from characters

urlencode

encode a string in a websafe manner

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.