Update xml session

TobiasNx · TobiasNx · commit d587391412d1 · 2025-04-10T15:41:00.000+02:00
diff --git a/10_Working_with_XML.md b/10_Working_with_XML.md
@@ -11,7 +11,7 @@ the decoder follows straight after the opening of a file, a website or an OAI-PM
 
 Lets start with this simple record
 
-```XML
+```xml
 <?xml version="1.0" encoding="utf-8"?>
 <record>
   <title>GRM</title>
@@ -21,10 +21,17 @@ Lets start with this simple record
 ```
 
 
-Lets open it:
+Lets open it with the following Flux:
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+as-records%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E
+```text
+inputFile
+| open-file
+| as-records
+| print
+;
+```
 
+[See it here in the Playground.](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+as-records%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E)
 
 Next lets decode the file and encode it as Yaml.
 
@@ -33,7 +40,17 @@ Handlers a specific helpers that decode xml in a certain way, based on the metad
 
 For now we need the `handle-generic-xml` function.
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+encode-yaml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E
+```text
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml
+| encode-yaml
+| print
+;
+```
+
+[See it here in the Playground.](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+encode-yaml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E)
 
 
 You see this as result:
@@ -59,41 +76,142 @@ See:
 <title attribute="test">Test value</title>
 ```
 
-=>
+With the Flux:
+
+```text
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml
+| encode-yaml
+| print
+;
+```
 
 ```yaml
 title:
   attribute: "test"
   value: "Test value"
 ```
 
-For our example above to get rid of the value subfields in the yaml we need to change the hirachy:
+[For our example above to get rid of the value subfields in the yaml we need to change the hirachy:](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+fix%28transformationFile%29%0A%7C+encode-yaml%0A%7C+print%0A%3B&transformation=move_field%28%22title.value%22%2C%22@title%22%29%0Amove_field%28%22@title%22%2C%22title%22%29%0Amove_field%28%22author.value%22%2C%22@author%22%29%0Amove_field%28%22@author%22%2C%22author%22%29%0Amove_field%28%22datePublished.value%22%2C%22@datePublished%22%29%0Amove_field%28%22@datePublished%22%2C%22datePublished%22%29&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E)
+
+
+```
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml
+| fix(transformationFile)
+| encode-yaml
+| print
+;
+```
+
+With Fix:
+```perl
+move_field("title.value","@title")
+move_field("@title","title")
+move_field("author.value","@author")
+move_field("@author","author")
+move_field("datePublished.value","@datePublished")
+move_field("@datePublished","datePublished")
+```
+
+But when you encode it to XML the value subfields are also kept. Like this:
+
+```text
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml
+| encode-xml
+| print
+;
+```
+Results in:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<records>
+
+  <record>
+    <title>
+      <value>GRM</value>
+    </title>
+    <author>
+      <value>Sibille Berg</value>
+    </author>
+    <datePublished>
+      <value>2019</value>
+    </datePublished>
+  </record>
+
+</records>
+```
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+fix%28transformationFile%29%0A%7C+encode-yaml%0A%7C+print%0A%3B&transformation=move_field%28%22title.value%22%2C%22@title%22%29%0Amove_field%28%22@title%22%2C%22title%22%29%0Amove_field%28%22author.value%22%2C%22@author%22%29%0Amove_field%28%22@author%22%2C%22author%22%29%0Amove_field%28%22datePublished.value%22%2C%22@datePublished%22%29%0Amove_field%28%22@datePublished%22%2C%22datePublished%22%29&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E
+[Playground Link](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+encode-xml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E)
 
+Keep in mind that xml elements can have attributes and a value. But also the encoder enable simple flat xml records too.
 
-But when you encode it to XML
+You have to add a specific option when encoding xml: `| encode-xml(valueTag="value")` . Then it results in:
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%0A%7C+encode-xml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle%3EGRM%3C/title%3E%0A++%3Cauthor%3ESibille+Berg%3C/author%3E%0A++%3CdatePublished%3E2019%3C/datePublished%3E%0A%3C/record%3E
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<records>
 
-The value subfields are also kept. Keep in mind that xml elements can have attributes and a value. But also the encoder enable simple flat xml records too.
+  <record>
+    <title>GRM</title>
+    <author>Sibille Berg</author>
+    <datePublished>2019</datePublished>
+  </record>
 
-You have to add a specific option when encoding xml: `(valueTag="value")`
+</records>
+
+```
 
 If you want to create the other elements as attributes. You have to tell MF which elements are attributes by adding a attributeMarker with the option `attributemarker` in handle generic xml.
 Here I use `@` as attribute marker:
 
+```text
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml(attributeMarker="@")
+| encode-xml(attributeMarker="@",valueTag="value")
+| print
+;
+```
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%28attributeMarker%3D%22@%22%29%0A%7C+encode-xml%28attributeMarker%3D%22@%22%2CvalueTag%3D%22value%22%29%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle+attribute%3D%22test%22%3ETest+value%3C/title%3E%0A%3C/record%3E
+[Playground Link](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%28attributeMarker%3D%22@%22%29%0A%7C+encode-xml%28attributeMarker%3D%22@%22%2CvalueTag%3D%22value%22%29%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle+attribute%3D%22test%22%3ETest+value%3C/title%3E%0A%3C/record%3E)
 
 When you encode it as yaml you see the magic behind it:
 
-https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%28attributeMarker%3D%22@%22%29%0A%7C+encode-yaml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle+attribute%3D%22test%22%3ETest+value%3C/title%3E%0A%3C/record%3E
+```text
+inputFile
+| open-file
+| decode-xml
+| handle-generic-xml(attributeMarker="@")
+| encode-yaml
+| print
+;
+```
 
+[Playground Link](https://metafacture.org/playground/?flux=inputFile%0A%7C+open-file%0A%7C+decode-xml%0A%7C+handle-generic-xml%28attributeMarker%3D%22@%22%29%0A%7C+encode-yaml%0A%7C+print%0A%3B&data=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22utf-8%22%3F%3E%0A%3Crecord%3E%0A++%3Ctitle+attribute%3D%22test%22%3ETest+value%3C/title%3E%0A%3C/record%3E)
 
 Another important thing, when working with xml data sets is to specify the record tag. Default is the tag record. But other data sets have different tags that separate records:
 
-https://metafacture.org/playground/?flux=%22http%3A//www.lido-schema.org/documents/examples/LIDO-v1.1-Example_FMobj00154983-LaPrimavera.xml%22%0A%7C+open-http%0A%7C+decode-xml%0A%7C+handle-generic-xml%28recordtagname%3D%22lido%22%29%0A%7C+encode-yaml%0A%7C+print%0A%3B
+```text
+"http://www.lido-schema.org/documents/examples/LIDO-v1.1-Example_FMobj00154983-LaPrimavera.xml"
+| open-http
+| decode-xml
+| handle-generic-xml(recordtagname="lido")
+| encode-yaml
+| print
+;
+```
+
+[Playground Link](https://metafacture.org/playground/?flux=%22http%3A//www.lido-schema.org/documents/examples/LIDO-v1.1-Example_FMobj00154983-LaPrimavera.xml%22%0A%7C+open-http%0A%7C+decode-xml%0A%7C+handle-generic-xml%28recordtagname%3D%22lido%22%29%0A%7C+encode-yaml%0A%7C+print%0A%3B)
 
 
 ## Bonus: Working with namespaces
@@ -104,14 +222,24 @@ the option `emitnamespace="true"` for the `handle-generic-xml` command.
 
 Add this option to the previous example and see that there are elements belonging to lido as well as skos.
 
+```text
+"http://www.lido-schema.org/documents/examples/LIDO-v1.1-Example_FMobj00154983-LaPrimavera.xml"
+| open-http
+| decode-xml
+| handle-generic-xml(recordtagname="lido", emitnamespace="true")
+| encode-yaml
+| print
+;
+```
+
 See this in the Playground [here](https://metafacture.org/playground/?flux=%22http%3A//www.lido-schema.org/documents/examples/LIDO-v1.1-Example_FMobj00154983-LaPrimavera.xml%22%0A%7C+open-http%0A%7C+decode-xml%0A%7C+handle-generic-xml%28recordtagname%3D%22lido%22%2C+emitnamespace%3D%22true%22%29%0A%7C+encode-yaml%0A%7C+print%0A%3B).
 
 When you want to add the namespace definition to the output metafacture does not know that by itself but you have to tell metafacture
 the new namespace when `encoding-xml` either by a file with the option `namespacefile` or in the flux with the option `namespaces`.
 
 See here an example for adding namespaces in the flux:
 
-```
+```text
 inputFile
 | open-file
 | as-lines
