{"route":"/en-US-v0.13.1/reference/data-loading/xml/","title":"XML","description":"Documentation for the `xml` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-source","name":"source","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-decode","name":"Decode XML","children":[{"id":"definitions-decode-data","name":"data","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"xml","title":"XML","keywords":[],"oneliner":"Reads structured data from an XML file.","element":false,"contextual":false,"deprecation":null,"details":"Reads structured data from an XML file.
\nThe XML file is parsed into an array of dictionaries and strings. XML nodes\ncan be elements or strings. Elements are represented as dictionaries with\nthe following keys:
\n\ntag: The name of the element as a string.attrs: A dictionary of the element's attributes as strings.children: An array of the element's child nodes.
\nThe XML file in the example contains a root news tag with multiple\narticle tags. Each article has a title, author, and content tag. The\ncontent tag contains one or more paragraphs, which are represented as p\ntags.
\nExample
\n#let find-child(elem, tag) = {\n elem.children\n .find(e => "tag" in e and e.tag == tag)\n}\n\n#let article(elem) = {\n let title = find-child(elem, "title")\n let author = find-child(elem, "author")\n let pars = find-child(elem, "content")\n\n [= #title.children.first()]\n text(10pt, weight: "medium")[\n Published by\n #author.children.first()\n ]\n\n for p in pars.children {\n if type(p) == dictionary {\n parbreak()\n p.children.first()\n }\n }\n}\n\n#let data = xml("example.xml")\n#for elem in data.first().children {\n if type(elem) == dictionary {\n article(elem)\n }\n}\n
A path to an XML file or raw XML bytes.
","example":null,"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[{"path":["xml"],"name":"decode","title":"Decode XML","keywords":[],"oneliner":"Reads structured data from an XML string/bytes.","element":false,"contextual":false,"deprecation":"`xml.decode` is deprecated, directly pass bytes to `xml` instead","details":"Reads structured data from an XML string/bytes.
","example":null,"self":false,"params":[{"name":"data","details":"XML data.
","example":null,"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]}]}}} ![\"Preview\"](\"/en-US-v0.13.1/assets/3cb7f4941d7061f93cb7357d15706f74.png\")