From 540b575e54ad219b1b06349be1d420549d56e124 Mon Sep 17 00:00:00 2001
From: Paulo Gustavo Veiga <pveiga@wisemapping.com>
Date: Sat, 25 Jan 2014 15:39:50 -0300
Subject: [PATCH] Improve readme documentation.
---
Home.textile | 20 --------
README.md | 83 ++++------------------------------
wise-editor/doc/Integration.md | 71 +++++++++++++++++++++++++++++
3 files changed, 80 insertions(+), 94 deletions(-)
delete mode 100644 Home.textile
create mode 100644 wise-editor/doc/Integration.md
diff --git a/Home.textile b/Home.textile
deleted file mode 100644
index 416bff08..00000000
--- a/Home.textile
+++ /dev/null
@@ -1,20 +0,0 @@
-h1. What is WiseMapping Open Source?
-
-WiseMapping is a free web based mindmapping application. The goal of this project is to provide a high quality product that can be deployed by educational and academic institutions, private and public companies and anyone who needs to have a mindmapping application. WiseMapping is based on the same code source supporting WiseMapping.com.
-
-
-h1. Why Open Source ?
-
-In the last years, we have received hundred of mails from different persons asking for:
-Integrating wisemapping.com with their sites
-Deploying a private instance of wisemapping.com
-Participating in the development of the site
-All this make us wonder "Why if we share our product to all this people and invite them to participate with us in this journey ?" .
-
-h1. Who are we ?
-
-We’re a couple of friends working on an idea: “Create the best on-line collaborative mind mapping tool ever created”. This has been our idea since the first day we started.
-
-h1. [[Documentation]]
-
-h1. [[Compiling and Running]]
diff --git a/README.md b/README.md
index 24e4574a..3e9ce963 100644
--- a/README.md
+++ b/README.md
@@ -37,84 +37,19 @@ This will start the application on the URL: [http://localhost:8080/wise-webapp/]
User: test@wisemapping.org
Password: test
+## Members
+Founders
-## Running the JS only version
+ * Pablo Luna <pveiga@wisemapping.com>
+ * Paulo Veiga <pablo@wisemapping.com>
-Start by creating the .zip file:
+Individual Controbutors
+ * Ezequiel Bergamaschi
-`mvn assembly:assembly -Dmaven.test.skip=true`
-
-To test the javascript frontend you then do:
-
- ruby -rwebrick -e 'WEBrick::HTTPServer.new(:Port=>8000,:DocumentRoot=>".").start'
-
-Now open a browser using the URL http://localhost:8000/wise-editor/src/main/webapp/
-
-### Attaching drag and drop events.
-
-1) Support for dragging TextNodes:
-
-The following code is an example of how to add attach to the div dragImageNode the support for node dragging.
-
- $("dragTextNode").addEvent('mousedown', function(event) {
- event.preventDefault();
-
- // Create a image node ...
- var mindmap = designer.getMindmap();
- var node = mindmap.createNode();
- node.setText("Node Text !!!!");
- node.setMetadata("{'media':'test'}");
- node.setShapeType(mindplot.model.TopicShape.RECTANGLE);
-
- // Add link ...
- var link = node.createFeature(mindplot.TopicFeature.Link.id, {url:"http://www.wisemapping.com"});
- node.addFeature(link);
-
- // Add Note ...
- var note = node.createFeature(mindplot.TopicFeature.Note.id, {text:"This is a note"});
- node.addFeature(note);
-
- designer.addDraggedNode(event, node);
- });
-
-In the example, a new node is created with text "Node Text !!!!" and a note and a link associated to it when the user drop the node. Something to pay attention is the node.setMetadata("{}"), this delegated will be persisted during the serialization. Here you can store all the data you need.
-
-2) Support for dragging Images: Similar to the point 1,drag support is registered to the div dragImageNode.
-
- $("dragImageNode").addEvent('mousedown', function(event) {
- event.preventDefault();
-
- // Create a image node ...
- var mindmap = designer.getMindmap();
- var node = mindmap.createNode();
- node.setImageSize(80, 43);
- node.setMetadata("{'media':'video,'url':'http://www.youtube.com/watch?v=P3FrXftyuzw&feature=g-vrec&context=G2b4ab69RVAAAAAAAAAA'}");
- node.setImageUrl("images/logo-small.png");
- node.setShapeType(mindplot.model.TopicShape.IMAGE);
-
- designer.addDraggedNode(event, node);
- });
-
-The node.setShapeType(mindplot.model.TopicShape.IMAGE) defines a image node. This makes mandatory the set of setImageUrl and setImageSize properties in the node.
-
-3) An event registration mechanism for Image nodes edit events: The next snipped show how to register a custom edition handler.
-
- designer.addEvent("editnode", function(event) {
- var node = event.model;
-
- alert("Node Id:" + node.getId());
- alert("Node Metadata:" + node.getMetadata());
- alert("Is Read Only:" + event.readOnly);
- } });
-
-
-## Authors
-
- * Pablo Luna
- * Paulo Veiga
-
-Past Collaborators: Ignacio Manzano, Nicolas Damonte
+Past Individual Contributors
+ * Ignacio Manzano
+ * Nicolas Damonte
## License
diff --git a/wise-editor/doc/Integration.md b/wise-editor/doc/Integration.md
new file mode 100644
index 00000000..dcca093b
--- /dev/null
+++ b/wise-editor/doc/Integration.md
@@ -0,0 +1,71 @@
+JS Editor Integration
+---------------------
+
+## Running the JS only version
+
+Start by creating the .zip file:
+
+`mvn assembly:assembly -Dmaven.test.skip=true`
+
+To test the javascript frontend you then do:
+
+ ruby -rwebrick -e 'WEBrick::HTTPServer.new(:Port=>8000,:DocumentRoot=>".").start'
+
+Now open a browser using the URL http://localhost:8000/wise-editor/src/main/webapp/
+
+### Attaching drag and drop events.
+
+1) Support for dragging TextNodes:
+
+The following code is an example of how to add attach to the div dragImageNode the support for node dragging.
+
+ $("dragTextNode").addEvent('mousedown', function(event) {
+ event.preventDefault();
+
+ // Create a image node ...
+ var mindmap = designer.getMindmap();
+ var node = mindmap.createNode();
+ node.setText("Node Text !!!!");
+ node.setMetadata("{'media':'test'}");
+ node.setShapeType(mindplot.model.TopicShape.RECTANGLE);
+
+ // Add link ...
+ var link = node.createFeature(mindplot.TopicFeature.Link.id, {url:"http://www.wisemapping.com"});
+ node.addFeature(link);
+
+ // Add Note ...
+ var note = node.createFeature(mindplot.TopicFeature.Note.id, {text:"This is a note"});
+ node.addFeature(note);
+
+ designer.addDraggedNode(event, node);
+ });
+
+In the example, a new node is created with text "Node Text !!!!" and a note and a link associated to it when the user drop the node. Something to pay attention is the node.setMetadata("{}"), this delegated will be persisted during the serialization. Here you can store all the data you need.
+
+2) Support for dragging Images: Similar to the point 1,drag support is registered to the div dragImageNode.
+
+ $("dragImageNode").addEvent('mousedown', function(event) {
+ event.preventDefault();
+
+ // Create a image node ...
+ var mindmap = designer.getMindmap();
+ var node = mindmap.createNode();
+ node.setImageSize(80, 43);
+ node.setMetadata("{'media':'video,'url':'http://www.youtube.com/watch?v=P3FrXftyuzw&feature=g-vrec&context=G2b4ab69RVAAAAAAAAAA'}");
+ node.setImageUrl("images/logo-small.png");
+ node.setShapeType(mindplot.model.TopicShape.IMAGE);
+
+ designer.addDraggedNode(event, node);
+ });
+
+The node.setShapeType(mindplot.model.TopicShape.IMAGE) defines a image node. This makes mandatory the set of setImageUrl and setImageSize properties in the node.
+
+3) An event registration mechanism for Image nodes edit events: The next snipped show how to register a custom edition handler.
+
+ designer.addEvent("editnode", function(event) {
+ var node = event.model;
+
+ alert("Node Id:" + node.getId());
+ alert("Node Metadata:" + node.getMetadata());
+ alert("Is Read Only:" + event.readOnly);
+ } });
\ No newline at end of file