Minor fixes (XML)

FileEX · FileEX · commit e4d352204953 · 2025-12-06T16:59:57.000+01:00
- Code formatting
- Typos
diff --git a/functions/XML/examples/xmlLoadFile-1.lua b/functions/XML/examples/xmlLoadFile-1.lua
@@ -1 +1 @@
-local node = xmlLoadFile ( ":ctv/settings.xml" )
+local node = xmlLoadFile(":ctv/settings.xml")
diff --git a/functions/XML/examples/xmlLoadFile_OOP-1.lua b/functions/XML/examples/xmlLoadFile_OOP-1.lua
@@ -1 +1 @@
-local node = XML.load ( ":ctv/settings.xml" )
+local node = XML.load(":ctv/settings.xml")
diff --git a/functions/XML/examples/xmlNodeGetAttributes-1.lua b/functions/XML/examples/xmlNodeGetAttributes-1.lua
@@ -3,7 +3,7 @@ local info = xmlFindChild(meta, "info", 0)
 
 if (info) then
     local attrs = xmlNodeGetAttributes(info)
-    for name,value in pairs (attrs) do
+    for name,value in pairs(attrs) do
         outputConsole(name.." = "..value)
     end
 end
diff --git a/functions/XML/examples/xmlNodeGetChildren-1.lua b/functions/XML/examples/xmlNodeGetChildren-1.lua
@@ -1,19 +1,15 @@
-addEventHandler("onResourceStart", getResourceRootElement(),
-    function()
-        local xml = xmlLoadFile("welcome.xml")             -- open the XML file
-        local messageNodes = xmlNodeGetChildren(xml)       -- get all child nodes of the root node (<messages>)
-        g_WelcomeMessages = {}                             -- create a new global variable to store the welcome messages
-        for i,node in ipairs(messageNodes) do              -- loop over all the message nodes
-            g_WelcomeMessages[i] = xmlNodeGetValue(node)   -- retrieve the text in each node
-        end
-        xmlUnloadFile(xml)                                 -- close the XML file
+addEventHandler("onResourceStart", getResourceRootElement(), function()
+    local xml = xmlLoadFile("welcome.xml") -- open the XML file
+    local messageNodes = xmlNodeGetChildren(xml) -- get all child nodes of the root node (<messages>)
+    g_WelcomeMessages = {} -- create a new global variable to store the welcome messages
+    for i, node in ipairs(messageNodes) do -- loop over all the message nodes
+        g_WelcomeMessages[i] = xmlNodeGetValue(node) -- retrieve the text in each node
     end
-)
+    xmlUnloadFile(xml) -- close the XML file
+end)
 
-addEventHandler("onPlayerJoin", getRootElement(),
-    function()
-        local numMessages = #g_WelcomeMessages                        -- get the number of messages
-        local message = g_WelcomeMessages[math.random(numMessages)]   -- pick a random message
-        outputChatBox(message, source, 0, 255, 0)                     -- display it to the joining player
-    end
-)
+addEventHandler("onPlayerJoin", getRootElement(), function()
+    local numMessages = #g_WelcomeMessages -- get the number of messages
+    local message = g_WelcomeMessages[math.random(numMessages)] -- pick a random message
+    outputChatBox(message, source, 0, 255, 0) -- display it to the joining player
+end)
diff --git a/functions/XML/examples/xmlNodeGetChildren_OOP-1.lua b/functions/XML/examples/xmlNodeGetChildren_OOP-1.lua
@@ -1,19 +1,15 @@
-addEventHandler("onResourceStart", getResourceRootElement(),
-    function()
-        local xml = XML.load("welcome.xml")             -- open the XML file
-        local messageNodes = xml.children       -- get all child nodes of the root node (<messages>)
-        g_WelcomeMessages = {}                             -- create a new global variable to store the welcome messages
-        for i,node in ipairs(messageNodes) do              -- loop over all the message nodes
-            g_WelcomeMessages[i] = node.value   -- retrieve the text in each node
-        end
-        xml:unload()                                 -- close the XML file
+addEventHandler("onResourceStart", getResourceRootElement(), function()
+    local xml = XML.load("welcome.xml") -- open the XML file
+    local messageNodes = xml.children -- get all child nodes of the root node (<messages>)
+    g_WelcomeMessages = {} -- create a new global variable to store the welcome messages
+    for i, node in ipairs(messageNodes) do -- loop over all the message nodes
+        g_WelcomeMessages[i] = node.value -- retrieve the text in each node
     end
-)
+    xml:unload() -- close the XML file
+end)
 
-addEventHandler("onPlayerJoin", getRootElement(),
-    function()
-        local numMessages = #g_WelcomeMessages                        -- get the number of messages
-        local message = g_WelcomeMessages[math.random(numMessages)]   -- pick a random message
-        source:outputChat(message, 0, 255, 0)                     -- display it to the joining player
-    end
-)
+addEventHandler("onPlayerJoin", getRootElement(), function()
+    local numMessages = #g_WelcomeMessages -- get the number of messages
+    local message = g_WelcomeMessages[math.random(numMessages)] -- pick a random message
+    source:outputChat(message, 0, 255, 0) -- display it to the joining player
+end)
diff --git a/functions/XML/examples/xmlNodeGetValue-1.lua b/functions/XML/examples/xmlNodeGetValue-1.lua
@@ -5,6 +5,6 @@ if (xmlFile) then -- If it's indeed opened
     xmlUnloadFile(xmlFile)
 
     if (success) then -- Check if it was successful
-        outputChatBox (tostring(success)) -- Output "somevalue" to the chatbox
+        outputChatBox(tostring(success)) -- Output "somevalue" to the chatbox
     end
-end
+end
diff --git a/functions/XML/xmlCreateChild.yaml b/functions/XML/xmlCreateChild.yaml
@@ -14,7 +14,7 @@ shared: &shared
       description: 'The type of the child node that will be created.'
   returns:
     description: |
-      Returns the created [xmlnode](/xmlnode) if successful, false otherwise.
+      Returns the created [xmlnode](/xmlnode) if successful, **false** otherwise.
     values:
       - type: 'xmlnode|false'
         name: 'xmlnode'
diff --git a/functions/XML/xmlCreateFile.yaml b/functions/XML/xmlCreateFile.yaml
@@ -22,7 +22,7 @@ shared: &shared
       description: 'The name of the root node in the XML document.'
   returns:
     description: |
-      Returns the root [xmlnode](/xmlnode) object of the new XML file if successful, or false otherwise.
+      Returns the root [xmlnode](/xmlnode) object of the new XML file if successful, or **false** otherwise.
     values:
       - type: 'xmlnode|false'
         name: 'xmlnode'
diff --git a/functions/XML/xmlDestroyNode.yaml b/functions/XML/xmlDestroyNode.yaml
@@ -11,7 +11,7 @@ shared: &shared
       description: "The [xmlnode](/xmlnode) you want to destroy."
   returns:
     description: |
-      Returns true if the xml node was successfully destroyed, false otherwise.
+      Returns **true** if the xml node was successfully destroyed, **false** otherwise.
     values:
       - type: 'bool'
         name: 'bool'
diff --git a/functions/XML/xmlFindChild.yaml b/functions/XML/xmlFindChild.yaml
@@ -18,7 +18,7 @@ shared: &shared
         This is the 0-based index of the node you wish to find. For example, to find the 5th subnode with a particular name, you would use 4 as the index value. To find the first occurence, use 0.
   returns:
     description: |
-      Returns an [xmlnode](/xmlnode) if the node was found, false otherwise.
+      Returns an [xmlnode](/xmlnode) if the node was found, **false** otherwise.
     values:
       - type: 'xmlnode|false'
         name: 'xmlnode'
diff --git a/functions/XML/xmlLoadFile.yaml b/functions/XML/xmlLoadFile.yaml
@@ -17,7 +17,7 @@ shared: &shared
       description: By default, the XML file is opened with reading and writing access. You can specify true for this parameter if you only need reading access.
   returns:
     description: |
-      Returns the root [xmlnode](/xmlnode) object of an xml file if successful, or false otherwise.
+      Returns the root [xmlnode](/xmlnode) object of an xml file if successful, or **false** otherwise.
     values:
       - type: 'xmlnode|false'
         name: 'xmlnode'
diff --git a/functions/XML/xmlLoadString.yaml b/functions/XML/xmlLoadString.yaml
@@ -13,7 +13,7 @@ shared: &shared
         A string containing XML data.
   returns:
     description: |
-      Returns the root [xmlnode](/xmlnode) object of an xml string if successful, or false otherwise (invalid XML string).
+      Returns the root [xmlnode](/xmlnode) object of an xml string if successful, or **false** otherwise (invalid XML string).
     values:
       - type: 'xmlnode|false'
         name: 'xmlnode'
diff --git a/functions/XML/xmlNodeGetAttribute.yaml b/functions/XML/xmlNodeGetAttribute.yaml
@@ -15,7 +15,7 @@ shared: &shared
       description: The name of the attribute.
   returns:
     description: |
-      Returns the attribute in string form or false, if the attribute is not defined.
+      Returns the attribute in string form or **false**, if the attribute is not defined.
     values:
       - type: 'string|false'
         name: 'attribute'
diff --git a/functions/XML/xmlNodeGetAttributes.yaml b/functions/XML/xmlNodeGetAttributes.yaml
@@ -12,7 +12,7 @@ shared: &shared
       description: The [xmlnode](/xmlnode) to get the attributes of.
   returns:
     description: |
-      If successful, returns a table with as keys the names of the attributes and as values the corresponding attribute values. If the node has no attributes, returns an empty table. In case of failure, returns false.
+      If successful, returns a [[table]] with as keys the names of the attributes and as values the corresponding attribute values. If the node has no attributes, returns an empty table. In case of failure, returns **false**.
     values:
       - type: 'table|false'
         name: 'attributes'
diff --git a/functions/XML/xmlNodeGetChildren.yaml b/functions/XML/xmlNodeGetChildren.yaml
@@ -17,7 +17,7 @@ shared: &shared
         If you only want to retrieve one particular child node, specify its (0-based) index here. For example if you only want the first node, specify 0; the fifth node has index 4, etc.
   returns:
     description: |
-      If index isn't specified, returns a table containing all child nodes. If index is specified, returns the corresponding child node if it exists. If no nodes are found, it returns an empty table. Returns false in case of failure.
+      If index isn't specified, returns a [[table]] containing all child nodes. If index is specified, returns the corresponding child node if it exists. If no nodes are found, it returns an empty table. Returns **false** in case of failure.
     values:
       - type: 'table|xmlnode|false'
         name: 'children'
diff --git a/functions/XML/xmlNodeGetName.yaml b/functions/XML/xmlNodeGetName.yaml
@@ -12,7 +12,7 @@ shared: &shared
       type: 'xmlnode'
       description: The [xmlnode](/xmlnode) to get the tag name of.
   returns:
-    description: Returns the tag name of the node if successful, false otherwise.
+    description: Returns the tag name of the node if successful, **false** otherwise.
     values:
       - type: 'string|false'
         name: 'name'
diff --git a/functions/XML/xmlNodeGetParent.yaml b/functions/XML/xmlNodeGetParent.yaml
@@ -11,7 +11,7 @@ shared: &shared
       type: 'xmlnode'
       description: The node of which you want to know the parent.
   returns:
-    description: Returns the parent node of the specified node if successful. Returns false if the specified node is the root node or an invalid node was passed.
+    description: Returns the parent node of the specified node if successful. Returns **false** if the specified node is the root node or an invalid node was passed.
     values:
       - type: 'xmlnode|false'
         name: 'parent'
diff --git a/functions/XML/xmlNodeGetValue.yaml b/functions/XML/xmlNodeGetValue.yaml
@@ -12,7 +12,7 @@ shared: &shared
       type: 'xmlnode'
       description: The [xmlnode](/xmlnode) of which you need to know the value.
   returns:
-    description: Returns the value of the node as a string if it was received successfully, false otherwise.
+    description: Returns the value of the node as a [[string]] if it was received successfully, **false** otherwise.
     values:
       - type: 'string|false'
         name: 'name'
diff --git a/functions/XML/xmlNodeSetAttribute.yaml b/functions/XML/xmlNodeSetAttribute.yaml
@@ -17,7 +17,7 @@ shared: &shared
       type: 'string|number|nil'
       description: The value which you wish to change the attribute to. (Note - **nil** will delete the attribute).
   returns:
-    description: Returns true if the attribute was set successfully, false if the node and/or attribute do not exist, or if they're faulty.
+    description: Returns **true** if the attribute was set successfully, **false** if the node and/or attribute do not exist, or if they're faulty.
     values:
       - type: 'bool'
         name: 'result'
diff --git a/functions/XML/xmlNodeSetName.yaml b/functions/XML/xmlNodeSetName.yaml
@@ -15,7 +15,7 @@ shared: &shared
       type: 'string'
       description: The name of the attribute.
   returns:
-    description: Returns true if successful, false otherwise.
+    description: Returns **true** if successful, **false** otherwise.
     values:
       - type: 'bool'
         name: 'result'
diff --git a/functions/XML/xmlNodeSetValue.yaml b/functions/XML/xmlNodeSetValue.yaml
@@ -19,7 +19,7 @@ shared: &shared
       description: A boolean indicating if you want the value to be enclosed inside CDATA tags.
       default: 'false'
   returns:
-    description: Returns true if value was successfully set, false otherwise.
+    description: Returns **true** if value was successfully set, **false** otherwise.
     values:
       - type: 'bool'
         name: 'result'
diff --git a/functions/XML/xmlSaveFile.yaml b/functions/XML/xmlSaveFile.yaml
@@ -11,7 +11,7 @@ shared: &shared
       description: The root [xmlnode](/xmlnode) of the loaded XML file.
   returns:
     description: |
-      Returns true if save was successful, false if the XML file does not exist.
+      Returns **true** if save was successful, **false** if the XML file does not exist.
     values:
       - type: 'boolean'
         name: 'result'
diff --git a/functions/XML/xmlUnloadFile.yaml b/functions/XML/xmlUnloadFile.yaml
@@ -11,7 +11,7 @@ shared: &shared
       description: The root of the XML document to unload.
   returns:
     description: |
-      Returns true if the document was unloaded successfully, false otherwise.
+      Returns **true** if the document was unloaded successfully, **false** otherwise.
     values:
       - type: 'boolean'
         name: 'result'

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-local node = xmlLoadFile ( ":ctv/settings.xml" )`
	`1`	`+local node = xmlLoadFile(":ctv/settings.xml")`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-local node = XML.load ( ":ctv/settings.xml" )`
	`1`	`+local node = XML.load(":ctv/settings.xml")`