Merge pull request #520 from markleusink/patch-2

AngularMeteorCollection doc page updated, added highlight.js to make code samples more readable

Author: Urigo

.docs/angular-meteor/.meteor/packages

@@ -15,3 +15,4 @@ urigo:angularmeteormarkdown
 urigo:angulartics
 twbs:bootstrap
 fortawesome:fontawesome
+simple:highlight.js

.docs/angular-meteor/.meteor/versions

@@ -48,6 +48,7 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
+simple:[email protected]
 [email protected]
 [email protected]
 [email protected]

.docs/angular-meteor/client/views/api/api.AngularMeteorCollection.html

@@ -45,9 +45,11 @@ <h3><p><code><span class="pln">save( :docs );</span></code></p></h3>
     <a href="" class="label type-hint type-hint-object">object</a>
   </td>
   <td><p>The docs to save to the Meteor Collection.
-         If nothing is passed, the method saves everything in the AngularMeteorCollection as is.
-         If an object is passed, the method pushes that object into the AngularMeteorCollection.
-         If an array is passed, the method pushes that all objects in the array into the AngularMeteorCollection.
+    <ul>
+     <li>If nothing is passed, the method saves everything in the AngularMeteorCollection as is.</li>
+     <li>If an object is passed, the method pushes that object into the AngularMeteorCollection.</li>
+     <li>If an array of objects is passed, the method pushes all objects into the AngularMeteorCollection.</li>
+     </ul>
   </p></td>
   <td><a href="" class="label type-hint type-hint-object">No</a></td>
 </tr>
@@ -87,9 +89,11 @@ <h4>Parameters</h4>
     <a href="" class="label type-hint type-hint-object">object</a>
   </td>
   <td><p>The keys of the object to remove from the Meteor Collection.
-    If nothing is passed, the method removes all the documents from the AngularMeteorCollection.
-    If an object is passed, the method removes the object with that key from the AngularMeteorCollection.
-    If an array is passed, the method removes all objects that matches the keys in the array from the AngularMeteorCollection.
+    <ul>
+     <li>If nothing is passed, the method removes all the documents from the AngularMeteorCollection.</li>
+     <li>If an object is passed, the method removes the object with that key from the AngularMeteorCollection.</li>
+     <li>If an array is passed, the method removes all objects that matches the keys in the array from the AngularMeteorCollection.</li>
+    </li>
   </p></td>
   <td><a href="" class="label type-hint type-hint-object">No</a></td>
 </tr>
@@ -107,9 +111,9 @@ <h4>Parameters</h4>
 <br>
 <h3><p><code><span class="pln">subscribe( :subscriptionName );</span></code></p></h3>
 <br>
-A shorten (Syntactic sugar) function for the <a href="/api/subscribe">$meteor.subscribe function</a>.
+A shorter ('syntactic sugar') function for <a href="/api/subscribe">$meteor.subscribe</a>.
 
-Takes only one parameter and not returns a promise like <a href="/api/subscribe">$meteor.subscribe</a> does.
+Takes only one parameter and doesn't return a promise like <a href="/api/subscribe">$meteor.subscribe</a> does.
 
 When called after $scope.meteorCollection, it acts the same but in addition it automatically closes the subscription when the scope is destroyed.
 
@@ -130,7 +134,7 @@ <h4>Parameters</h4>
     <td>
       <a href="" class="label type-hint type-hint-string">subscriptionName</a>
     </td>
-    <td><p>The subscription name to subscribe to.  exactly like the first parameter in $meteor.subscribe service.
+    <td><p>The subscription name to subscribe to. Exactly like the first parameter in the $meteor.subscribe service.
     </p></td>
     <td><a href="" class="label type-hint type-hint-object">Yes</a></td>
   </tr>
@@ -141,7 +145,7 @@ <h4>Parameters</h4>
 <br>
 <h3><p><code><span class="pln">stop();</span></code></p></h3>
 <br>
-Stops watching the current collection for changes made in the scope variable or the meteor collection. 
+Stops watching the current collection for changes made in the scope variable or meteor collection. 
 
 #### Parameters
 None
@@ -154,32 +158,57 @@ <h3><p><code><span class="pln">stop();</span></code></p></h3>
     // Bind all the todos to $scope.todos without auto-save
     $scope.todos = $meteor.collection(Todos, false);
 
+    // Add a single todo to the collection
     var todoObject = {name:'first todo'};
-    var todoArray = [{name:'second todo'}, {name:'third todo'}];
-    var todoSecondObject = {name:'forth todo'};
-
     $scope.todos.save(todoObject);  // todos equals [{name:'first todo'}]
 
+    // Add multiple todos to the collection
+    var todoArray = [{name:'second todo'}, {name:'third todo'}];
     $scope.todos.save(todosArray);  // todos equals [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}]
 
-    $scope.todos.push(todoSecondObject);  // The scope variable equals to [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}, {name:'forth todo'}]
-                                          // but the collection still equals to [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}]
-
-    $scope.todos.save();  // Now the collection also equals to [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}, {name:'forth todo'}]
-
-    $scope.todos.remove(firstTodoId); // scope and collection equals to [{name:'second todo'}, {name:'third todo'}, {name:'forth todo'}]
+    // Add another todo to the collection
+    var anotherTodoObject = {name:'fourth todo'};
+    $scope.todos.push(anotherTodoObject);  
+
+    /*
+     * The scope variable now holds:
+     * [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}, {name:'fourth todo'}]
+     * 
+     * but the collection holds:
+     * [{name:'first todo'}, {name:'second todo'}, {name:'third todo'}]
+     *
+     * that's because auto-save was set to false (the 2nd parameter in the $meteor.collection call).
+     * 
+     * To save the data we need to explicitly call the save() function:
+     */
+    $scope.todos.save();
+
+    $scope.todos.remove(firstTodoId); // scope and collection equals to [{name:'second todo'}, {name:'third todo'}, {name:'fourth todo'}]
 
     $scope.todos.remove(todoIdsArray); // removes everything matches the array of IDs both in scope and in collection
 
     $scope.todos.pop();  // removes only in scope
 
     $scope.todos.remove(); // syncs also in Meteor collection
 
-
     // Using the subscribe function
     $scope.parties = $meteor.collection(Parties).subscribe('partiesSubscription');
 
+    // With a callback to do something after the todo was saved and to catch errors
+    $scope.todos.save(todoObject)
+      .then( function() {
+
+        // todos were successfully saved
+        console.log('The todo was saved');
+
+      }, function(err) {
+
+        // an error occurred while saving the todos: maybe you're not authorized
+        console.error( 'An error occurred. The error message is: ' + err.message);
+
+      });
         {{/markdown}}
+
     </do-nothing>
 
   </div>