Differences

This shows you the differences between two versions of the page.

--- other:inspect3d:documentation:files:r3d_export_setting_file [2024/07/16 17:02] – removed sgranger
+++ other:inspect3d:documentation:files:r3d_export_setting_file [2024/12/18 14:40] (current) – wikisysop
@@ Line 1: / Line 1: @@
+====== R3D Export Setting File ======
+The .r3d file format is an method of storing Inspect3D export settings as XML, ensuring that they are both human- and machine-readable. Inspect3D allows users to save export settings from the {{:I3DExportPCAResults.png?20}} **[[Other:Inspect3D:Documentation:Dialogs:Export_Results|Export Results]]** dialog. Previously-saved export settings can also be loaded and used from this dialog.
+==== Format ====
+As an XML document, an .r3d file is made up of hierarchical elements that are demarcated by tags, indicated by the < and > characters. An element consists of a start tag, <//elementname//>, and end tag, <///elementname//>, and all of the characters in between. Alternatively, an element can be defined by a single tag, <//elementname ///>.
+Tags can also contain attributes in the //name="value"// format, further describing the associated element.
+. The top-level element in an .q3d file is //settings//. It contains an arbitrary (1-n) number of //setting// elements.
+. The second-, and bottom-, level element in an .r3d file is //setting//. A //setting// element has a //name// attribute (the corresponding setting's name) and a //value// attribute (the corresponding setting's value).
+==== DTD ====
+Formally, an .r3d file respects the Document Type Definition (DTD):
+<code>
+<!DOCTYPE settings [
+  <!ELEMENT settings (setting+)>
+  <!ATTLIST setting name CDATA #REQUIRED
+    setting value CDATA #REQUIRED
+  >
+]>
+</code>