From 2f691ed2772dbe7b980a9c23cfd722eb469d7857 Mon Sep 17 00:00:00 2001
From: Tarjei Huse <tarjei@scanmine.com>
Date: Fri, 17 Feb 2012 10:45:55 +0100
Subject: [PATCH] Start of documentation for config options

---
 ConfigParameters.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 ConfigParameters.md

diff --git a/ConfigParameters.md b/ConfigParameters.md
new file mode 100644
index 00000000..612eb6b8
--- /dev/null
+++ b/ConfigParameters.md
@@ -0,0 +1,34 @@
+# Configuration parameters for embedded minmaps
+
+The mindmap designer object takse a set of configuration options.
+
+An example config may look like this::
+
+    {
+        "readOnly":false,
+        "zoom":1.3,
+        "size":{
+            "width":800,
+            "height":400
+        },
+        "viewPort":
+        {
+            "width":800,
+            "height":400
+        },
+        "persistenceManager": "mindplot.LocalStorageManager",
+        "mapId": "welcome",
+        "container":"mindplot"
+
+    }
+
+The options are:
+
+* readOnly: Set to true if the viewer should not be able to edit the map.
+* zoom: how much the map should be zoomed.
+* size: size of the map area.
+* viewport
+* persistenceManager: Classname of a class that extends mindplot.PersistenceManager (see ImplementingPersistence for more info.)
+* mapId: The id of the map
+* container: The id of the containing div.
+