examples

doc/alphabetical_index.html

@@ -258,7 +258,7 @@
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/IwcConnector.html

@@ -302,7 +302,7 @@ data from the received intent.</p>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/JsonFramework.html

@@ -335,7 +335,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/JsonType.html

@@ -466,7 +466,7 @@ if (x.type === "JsonType") {
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/JsonTypeWrapper.html

@@ -139,7 +139,7 @@ console.log(w.newProperty == &quot;Awesome&quot;) # true!</code></pre>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/PeerJsConnector.html

@@ -242,7 +242,7 @@ on how to do that with urls.</p>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/TextFramework.html

@@ -356,7 +356,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/WordType.html

@@ -455,7 +455,7 @@ yatta.bind(textbox);</code></pre>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/class/XmlFramework.html

@@ -303,7 +303,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/extra/LICENSE.txt.html

@@ -38,7 +38,7 @@
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/extra/README.md.html

@@ -76,7 +76,7 @@ But I would become really motivated if you gave me some feedback :) (<a href="ht
 </ul>
 <h2 id="support">Support</h2><p>Please report <em>any</em> issues to the <a href="https://github.com/DadaMonad/Yatta/issues">Github issue page</a>!
 I would appreciate if developers gave me feedback on how <em>convenient</em> the framework is, and if it is easy to use. Particularly the XML-support may not support every DOM-methods - if you encounter a method that does not cause any change on other peers,
-please state function name, and sample parameters. However, there are browser-specific features, that Yatta won&#39;t support.</p><h2 id="license">License</h2><p>Yatta! is licensed under the <a href="./LICENSE.txt">MIT License</a>.</p><a href="&#x6d;&#97;&#105;&#108;&#116;&#111;&#58;&#x6b;&#x65;&#x76;&#105;&#x6e;&#46;&#106;&#97;&#104;&#x6e;&#115;&#64;&#114;&#119;&#116;&#x68;&#45;&#x61;&#97;&#x63;&#104;&#101;&#x6e;&#x2e;&#100;&#101;">&#x6b;&#x65;&#x76;&#105;&#x6e;&#46;&#106;&#97;&#104;&#x6e;&#115;&#64;&#114;&#119;&#116;&#x68;&#45;&#x61;&#97;&#x63;&#104;&#101;&#x6e;&#x2e;&#100;&#101;</a>
+please state function name, and sample parameters. However, there are browser-specific features, that Yatta won&#39;t support.</p><h2 id="license">License</h2><p>Yatta! is licensed under the <a href="./LICENSE.txt">MIT License</a>.</p><a href="&#x6d;&#x61;&#105;&#x6c;&#x74;&#x6f;&#x3a;&#x6b;&#x65;&#118;&#x69;&#110;&#46;&#106;&#x61;&#104;&#x6e;&#115;&#x40;&#114;&#119;&#x74;&#104;&#x2d;&#x61;&#97;&#x63;&#x68;&#101;&#x6e;&#x2e;&#x64;&#x65;">&#x6b;&#x65;&#118;&#x69;&#110;&#46;&#106;&#x61;&#104;&#x6e;&#115;&#x40;&#114;&#119;&#x74;&#104;&#x2d;&#x61;&#97;&#x63;&#x68;&#101;&#x6e;&#x2e;&#x64;&#x65;</a>
 
 
 
@@ -85,7 +85,7 @@ please state function name, and sample parameters. However, there are browser-sp
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Connectors/IwcConnector.coffee.html

@@ -100,7 +100,7 @@
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Connectors/PeerJsConnector.coffee.html

@@ -158,7 +158,7 @@
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Connectors/TestConnector.coffee.html

@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Engine.coffee.html

@@ -48,7 +48,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Frameworks/JsonFramework.coffee.html

@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Frameworks/TextFramework.coffee.html

@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Frameworks/XmlFramework.coffee.html

@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/HistoryBuffer.coffee.html

@@ -48,7 +48,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Types/BasicTypes.coffee.html

@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Types/JsonTypes.coffee.html

@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Types/StructuredTypes.coffee.html

@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/Types/TextTypes.coffee.html

@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

doc/file/lib/index.coffee.html

@@ -37,7 +37,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>

examples/PeerJs-Json/README.md

@@ -24,7 +24,31 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true,
+};
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```
 
 

examples/TextEditing/README.md

@@ -28,14 +28,27 @@ First create the connector - the underlaying communication protocol.
 Here, we use the PeerJs connector. Its first parameter is the API key that you need to specify (see [website](http://peerjs.com/))
 
 
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+     // var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
 ```js
-    /*
-     var conn = {key: 'h7nlefbgavh1tt9'}; // this will connect to the server owned by the peerjs team.
-     */
     var conn = {
-      host: "127.0.0.1/", //"terrific-peerjs.herokuapp.com/",
+      host: "terrific-peerjs.herokuapp.com",
-      port: 5000
+      port: "", // this works because heroku can forward to the right port.
+      // debug: true,
     };
+
     Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```
 

examples/XmlExample/README.md

@@ -24,7 +24,31 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true,
+};
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 
   yatta = new Y.XmlFramework(user_id, Connector);
 ```

examples/temp_ex/README.md

@@ -24,7 +24,32 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true
+};
+
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```