
[lua scripts api] created manual from embedded library documentation [lua api] created stub to contain lua api manual
742 B
742 B
title | id | weight | draft | author |
---|---|---|---|---|
escape_xml_characters | escape_xml_characters | 20 | false | people |
NAME
escape_xml_characters
SYNOPSIS
escape characters for xml documents
USAGE
local ds = require "lib/dtutils.string"
local result = ds.escape_xml_characters(str)
str - string - the string that needs escaped
DESCRIPTION
escape_xml_characters provides the escape sequences for
"&", '"', "'", "<", and ">"
with the corresponding
"&",""", "'", "<", and ">"
.
RETURN VALUE
result - string - the string containing escapes for the xml characters
REFERENCE
https://stackoverflow.com/questions/1091945/what-characters-do-i-need-to-escape-in-xml-documents