Changes between Version 7 and Version 8 of S3XRC/S3XML

Timestamp:

05/03/11 19:00:45 (14 years ago)

Author:

Dominic König

Comment:

--

S3XRC/S3XML

@@ -9 +9 @@
 
 These can be converted using [wiki:XsltTemplates XSLT Stylesheets].
+
+=== Document Structure ===
+
+S3XML defines 4 element types:
+
+  - [#s3xml s3xml]
+  - [#resource resource]
+  - [#data data]
+  - [#reference reference]
+
+==== s3xml ====
+||'''Parent elements'''||''none (root element)''||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||''empty''||
+
+==== resource ====
+||'''Parent elements'''||[#s3xml s3xml], [#resource resource], [#reference reference]||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||''empty''||
+
+==== data ====
+||'''Parent elements'''||[#resource resource]||
+||'''Child elements'''||''none (leaf element)''||
+||'''Contents'''||Text||
+
+Represents the value of a single field in the record.
+
+Attributes:
+||'''Name'''||'''Type'''||'''Description'''||'''mandatory?'''||
+||'''field'''||string||the field name in the record||''yes''||
+||'''value'''||JSON value||the native field value||''no''||
+||'''url'''||URL||the URL to download the contents from*||''no''||
+||'''filename'''||filename||the filename of the attached contents*||''no''||
+
+The text node in the {{{data}}} element provides a human-readable representation of the field value. If this representation is different from the original value in the database, then the original value must be provided by the ''value'' attribute.
+
+* If the field is for file upload, a {{{url}}} attribute should be provided to specify the location of the file. The importer will try to download and store the file (file transfer) from that URL (''pull''). It is also possible to send the file with the HTTP request - in this case the {{{filename}}} must be specified instead of {{{url}}} (''push'').
+
+The ''push'' variant for uploads is meant for peers which do not support pulling for some reason (e.g. mobile phones). Normal servers would always provide a URL for download in order to allow the consuming site decide which files to download and when (saves bandwidth).
+
+==== reference ====
+||'''Parent elements'''||[#resource resource]||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||Text||
+
+=== Example ===
 
 {{{