First test on Simantics documentation using gitbook

[simantics/platform.git] / docs / Developer / Ontology / BinaryContainerFormat.md

diff --git a/docs/Developer/Ontology/BinaryContainerFormat.md b/docs/Developer/Ontology/BinaryContainerFormat.md
new file mode 100644 (file)
index 0000000..f7bcfc3
--- /dev/null
+++ b/docs/Developer/Ontology/BinaryContainerFormat.md
@@ -0,0 +1,14 @@
+Simantics binary container format is a format for storing binary encoded data to file system.\r
+\r
+~~~\r
+type DataContainer = {\r
+    format : String,\r
+    version : Integer,\r
+    metadata : Map(String, Variant),\r
+    content : Variant\r
+}\r
+~~~\r
+\r
+In addition to the actual content data that is stored as a Variant, a file contains a format name that tells how the data is used: for example "aprosModel", "aprosSymbol" and a version number. Applications use format name to decide if the file can be used for the operation the user has requested and version number to choose how to handle the data.\r
+\r
+Version number is increased by one every time the data type of the content or the semantics of the data (how it should be handled in the application) is changed.\r