Documentation + improving examples

ericabouaf · Jul 21, 2009 · e8d5046 · e8d5046
1 parent c85669d
commit e8d5046
Show file tree

Hide file tree

Showing 9 changed files with 314 additions and 90 deletions.
diff --git a/VERSION.txt b/VERSION.txt
@@ -7,22 +7,18 @@ not released yet
 
 Current:
 
-	* Layer.onChangeEvt (+implementation in WiringEditor for saved state, + implementation in Layouts to reinit the layout)
-	* Default language propertiesForm (guide + examples)
-	* document Layout
-
+	* Layer.onChangeEvt (+implementation in WiringEditor for saved state)
 	* Adapters:
-		* Ajax (3 different actions)
-		* REST
-		* XML REST Adapter
+		* Ajax (3 different actions) / REST adapter
+		* XML Conversion Adapter
 
 	* BUG: WiringEditor: Containers are mispositionned when the layer is scrolled
-
 	* BUG: jsBox: form values in input fields are overriden !!
 	* BUG: jsBox should be broken (because of autoload)
 
 Before release:
 
+	* Rebuild homepage from guide
 	* API Doc
 	* Rollup files for wireit-base and wiringEditor	
 	* Presentation 
@@ -38,6 +34,7 @@ Changeset:
 		* Adapters: (removed the complicated SMD & YUI-RPC stuff)
 			* JSON-RPC (the old adapter)
 			* Gears (if no backend usable)
+		* propertiesFields default value (becomes optional)
 
 	* WireIt Guide
 	* Show only one scissor at a time

diff --git a/examples/WiringEditor/demo.js b/examples/WiringEditor/demo.js
@@ -4,10 +4,15 @@ var demoLanguage = {
 	languageName: "meltingpotDemo",
 
 	// inputEx fields for pipes properties
-	/*propertiesFields: [
+	propertiesFields: [
+		// default fields (the "name" field is required by the WiringEditor):
 		{"type": "string", inputParams: {"name": "name", label: "Title", typeInvite: "Enter a title" } },
-		{"type": "text", inputParams: {"name": "description", label: "Description", cols: 30} }
-	],*/
+		{"type": "text", inputParams: {"name": "description", label: "Description", cols: 30} },
+
+		// Additional fields
+		{"type": "boolean", inputParams: {"name": "isTest", value: true, label: "Test"}},
+		{"type": "select", inputParams: {"name": "category", label: "Category", selectValues: ["Demo", "Test", "Other"]} }
+	],
 
 	// List of node types definition
 	modules: [
@@ -17,7 +22,7 @@ var demoLanguage = {
 	      "container": {
 	   		"xtype": "WireIt.FormContainer",
 	   		"title": "WireIt.FormContainer demo",    
-	   		"icon": "http://dev.tarpipe.com/img/flickr.png",
+	   		"icon": "../../res/icons/application_edit.png",
 
 	   		"collapsible": true,
 	   		"fields": [ 
@@ -31,13 +36,31 @@ var demoLanguage = {
 	   		"legend": "Tell us about yourself..."
 	   	}
 	   },
+
+		{
+	      "name": "comment",
+
+	      "container": {
+	         "xtype": "WireIt.FormContainer",
+				"icon": "../../res/icons/comment.png",
+	   		"title": "Comment",
+	   		"fields": [
+	            {"type": "text", "inputParams": {"label": "", "name": "comment", "wirable": false }}
+	         ]
+	      },
+	      "value": {
+	         "input": {
+	            "type":"url","inputParams":{}
+	         }
+	      }
+	   },
 
 	      {
 	         "name": "AND gate",
 	         "container": {
 	      		"xtype":"WireIt.ImageContainer", 
 	      		"image": "../logicGates/images/gate_and.png",
-	      		"icon": "http://dev.tarpipe.com/img/tumblr.png",
+	      		"icon": "../../res/icons/arrow_join.png",
 	      		"terminals": [
 	      			{"name": "_INPUT1", "direction": [-1,0], "offsetPosition": {"left": -3, "top": 2 }},
 	      			{"name": "_INPUT2", "direction": [-1,0], "offsetPosition": {"left": -3, "top": 37 }},
@@ -52,7 +75,7 @@ var demoLanguage = {
 					"container": {
 	         		"xtype":"WireIt.ImageContainer", 
 	         		"className": "WireIt-Container WireIt-ImageContainer Bubble",
-	            	"icon": "http://dev.tarpipe.com/img/photobucket.png",
+	            	"icon": "../../res/icons/color_wheel.png",
 	         		"image": "../images/bubble.png",
 	         		"terminals": [
 	         				{"direction": [-1,-1], "offsetPosition": {"left": -10, "top": -10 }, "name": "tl"},
@@ -64,9 +87,9 @@ var demoLanguage = {
 		      },
 
 				{
-					"name": "Plurk",
+					"name": "Other form module",
 					"container": {
-	   				"icon": "http://dev.tarpipe.com/img/plurk.png",
+	   				"icon": "../../res/icons/application_edit.png",
 	   				"xtype": "WireIt.FormContainer",
 	   				"outputTerminals": [],
 	   				"propertiesForm": [],
@@ -86,7 +109,7 @@ var demoLanguage = {
 	            "container": {
 	         		"xtype": "WireIt.FormContainer",
 	         		"title": "Post",    
-	         		"icon": "http://dev.tarpipe.com/img/flickr.png",
+	         		"icon": "../../res/icons/comments.png",
 
 	         		"fields": [ 
 
@@ -116,7 +139,7 @@ var demoLanguage = {
 		         "name": "InOut test",
 		         "container": {
 		      		"xtype":"WireIt.InOutContainer", 
-		      		"icon": "http://dev.tarpipe.com/img/tumblr.png",
+		      		"icon": "../../res/icons/arrow_right.png",
 						"inputs": ["text1", "text2", "option1"],
 						"outputs": ["result", "error"]
 		      	}

diff --git a/examples/WiringEditor/index.html b/examples/WiringEditor/index.html
@@ -109,6 +109,15 @@
 
 <script type="text/javascript" src="demo.js"></script>
 
+
+<style>
+/* Comment Module */
+div.WireIt-Container.WiringEditor-module-comment { width: 200px; }
+div.WireIt-Container.WiringEditor-module-comment div.body { background-color: #EEEE66; }
+div.WireIt-Container.WiringEditor-module-comment div.body textarea { background-color: transparent; font-weight: bold; border: 0; }
+</style>
+
+
 <script>
 
 // InputEx needs a correct path to this image

diff --git a/examples/gearsAdapter/index.html b/examples/gearsAdapter/index.html
@@ -112,6 +112,14 @@
 
 <script type="text/javascript" src="../WiringEditor/demo.js"></script>
 
+
+<style>
+/* Comment Module */
+div.WireIt-Container.WiringEditor-module-comment { width: 200px; }
+div.WireIt-Container.WiringEditor-module-comment div.body { background-color: #EEEE66; }
+div.WireIt-Container.WiringEditor-module-comment div.body textarea { background-color: transparent; font-weight: bold; border: 0; }
+</style>
+
 <script>
 
 if (!window.google || !google.gears) {

diff --git a/examples/jsBox/jsBox.html b/examples/jsBox/jsBox.html
@@ -46,21 +46,14 @@
 
 
 
-div.WireIt-Container.WiringEditor-module-comment div.body {
-	background-color: #EEEE66;
-}
-
-
-div.WireIt-Container.WiringEditor-module-comment div.body textarea {
-	background-color: transparent;
-	font-weight: bold;
-	border: 0;
-}
+/* Comment Module */
+div.WireIt-Container.WiringEditor-module-comment { width: 200px; }
+div.WireIt-Container.WiringEditor-module-comment div.body { background-color: #EEEE66; }
+div.WireIt-Container.WiringEditor-module-comment div.body textarea { background-color: transparent; font-weight: bold; border: 0; }
 
 
-div.ComposedModule {
-	background-color: #DDDDAA;
-}
+/* Composed Module */
+div.ComposedModule { background-color: #DDDDAA; }
 
 </style>
 

diff --git a/examples/jsBox/jsBox.js b/examples/jsBox/jsBox.js
@@ -4,11 +4,9 @@
 var jsBox = {
 
    language: {
+
 	   languageName: "jsBox",
-		propertiesFields: [
-			{"type": "string", inputParams: {"name": "name", label: "Title", typeInvite: "Enter a title" } },
-			{"type": "text", inputParams: {"name": "description", label: "Description", cols: 30} }
-		],
+
 		modules: [
 		   {
 		      "name": "jsBox",

diff --git a/examples/logicGates/logicGates.js b/examples/logicGates/logicGates.js
@@ -4,12 +4,6 @@ var logicGatesLang = {
 	// Set a unique name for the language
 	languageName: "logicGates",
 
-	// inputEx fields for pipes properties
-	propertiesFields: [
-		{"type": "string", inputParams: {"name": "name", label: "Name", typeInvite: "Enter a title"} },
-		{"type": "text", inputParams: {"name": "description", label: "Description", cols: 30} }
-	],
-
 	// List of node types definition
 	modules: [
 		{