parse_document_xml
Parses an XML file, or a string of XML data, and returns a LuaDocument.
TIP: You can use this function if the file or string contains a single document. If you have a file or string that contains multiple documents, use one of the following functions instead:
Syntax
parse_document_xml( input [, file [, params ]] )
Arguments
Argument | Description |
---|---|
input
|
(string) The path to the XML file, or a string of XML data. |
file
|
(boolean, default false ) Specifies whether the input is a file path. |
params
|
(table) A table of named parameters to configure parsing. The table maps parameter names (String) to parameter values. For information about the parameters that you can set, see the following table. |
Named Parameters
Named Parameter | Description |
---|---|
content_paths
|
(string list, default DRECONTENT ) The paths in the XML to the elements that contain document content. You can specify a list of paths. |
document_root_paths
|
(string list, default DOCUMENT ) The paths in the XML to the elements that represent the root of a document. You can specify a list of paths. |
include_root_path
|
(boolean, default false ) Specifies whether to include the document_root_paths node in the document metadata. The default value includes only children of the root node. |
reference_paths
|
(string list, default DREREFERENCE ) The paths in the XML to elements that contain document references. Though you can specify a list of paths, there must be exactly one reference per document. |
Example
If you have a string named myXmlString
that contains a document in XML format, you can obtain a LuaDocument object as follows:
local xmlParams = { document_root_paths={"DOC"}, reference_paths={"REF"}, content_paths={"CONTENT","MORE_CONTENT"} } local myDocument = parse_document_xml(myXmlString, false, xmlParams)
Returns
(LuaDocument). A LuaDocument object that represents the document.