From 86049c20cbd45434a3766d2e584b800912a78b82 Mon Sep 17 00:00:00 2001
From: Dave Conway-Jones <conway@dhcp-9-20-202-211.hursley.ibm.com>
Date: Wed, 2 Mar 2016 13:27:22 +0000
Subject: [PATCH] update storage nodes info style

---
 storage/leveldb/67-leveldb.html               |  8 ++--
 storage/leveldb/README.md                     |  8 ++--
 storage/leveldb/package.json                  |  2 +-
 storage/mongodb/66-mongodb.html               | 34 +++++++++------
 storage/mongodb/README.md                     | 43 +++++++++----------
 storage/mongodb/locales/en-US/66-mongodb.json |  4 +-
 storage/mongodb/package.json                  |  2 +-
 storage/mysql/68-mysql.html                   |  6 +--
 storage/mysql/README.md                       |  4 +-
 storage/mysql/package.json                    |  2 +-
 storage/redis/README.md                       | 12 ++----
 storage/redis/package.json                    |  2 +-
 storage/sqlite/README.md                      |  7 +--
 storage/sqlite/package.json                   |  2 +-
 storage/sqlite/sqlite.html                    |  6 +--
 15 files changed, 75 insertions(+), 67 deletions(-)

diff --git a/storage/leveldb/67-leveldb.html b/storage/leveldb/67-leveldb.html
index 1e49327f..5de44bf0 100644
--- a/storage/leveldb/67-leveldb.html
+++ b/storage/leveldb/67-leveldb.html
@@ -47,8 +47,8 @@
 <script type="text/x-red" data-help-name="leveldb in">
     <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
     <p>Use this node to <b>get</b>, or retrieve the data already saved in the database.</p>
-    <p><b>msg.topic</b> must hold the <i>key</i> for the database, and the result is returned in <b>msg.payload</b>.</p>
-    <p>If nothing is found for the key then <b>msg.payload</b> is set to the <i>null</i> object.</p>
+    <p><code>msg.topic</code> must hold the <i>key</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
+    <p>If nothing is found for the key then <code>msg.payload</code> is set to the <i>null</i> object.</p>
 </script>
 
 <script type="text/javascript">
@@ -94,8 +94,8 @@
 
 <script type="text/x-red" data-help-name="leveldb out">
     <p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
-    <p>Use this node to either <b>put</b> (store) the <b>msg.payload</b> to the named database file, using <b>msg.topic</b> as the key.</p>
-    <p>To <b>delete</b> information select delete in the properties dialogue and again use <b>msg.topic</b> as the key.</b>.</p>
+    <p>Use this node to either <b>put</b> (store) the <code>msg.payload</code> to the named database file, using <code>msg.topic</code> as the key.</p>
+    <p>To <b>delete</b> information select delete in the properties dialogue and again use <code>msg.topic</code> as the key.</b>.</p>
 </script>
 
 <script type="text/javascript">
diff --git a/storage/leveldb/README.md b/storage/leveldb/README.md
index 7dbc770d..8a359df9 100644
--- a/storage/leveldb/README.md
+++ b/storage/leveldb/README.md
@@ -5,7 +5,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to read and write
 Install
 -------
 
-Run the following command in the root directory of your Node-RED install
+Run the following command in your Node-RED user directory - typically `~/.node-red`
 
     npm install node-red-node-leveldb
 
@@ -19,8 +19,10 @@ Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></
 
 There are two node to choose from...
 
-Use one node to either <b>put</b> (store) the <b>msg.payload</b> to the named database file, using <b>msg.topic</b> as the key, or to <b>delete</b> information select delete in the properties dialogue and again use <b>msg.topic</b> as the key.</b>.
+Use one node to either <b>put</b> (store) the `msg.payload` to the named database file, using `msg.topic`
+as the key, or to <b>delete</b> information select delete in the properties dialogue and again use `msg.topic` as the key.
 
 Use the other node to <b>get</b>, or retrieve the data already saved in the database.
 
-Again use <b>msg.topic</b> to hold the <i>key</i> for the database, and the result is returned in <b>msg.payload</b>. If nothing is found for the key then <i>null</i> is returned.
+Again use `msg.topic` to hold the <i>key</i> for the database, and the result is returned in `msg.payload`.
+If nothing is found for the key then <i>null</i> is returned.
diff --git a/storage/leveldb/package.json b/storage/leveldb/package.json
index d90f90b5..9d3bf64b 100644
--- a/storage/leveldb/package.json
+++ b/storage/leveldb/package.json
@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-node-leveldb",
-    "version"       : "0.0.5",
+    "version"       : "0.0.6",
     "description"   : "A Node-RED node to read and write to a LevelDB database",
     "dependencies"  : {
         "level"   : "1.0.0"
diff --git a/storage/mongodb/66-mongodb.html b/storage/mongodb/66-mongodb.html
index 4701942b..ad44cb23 100644
--- a/storage/mongodb/66-mongodb.html
+++ b/storage/mongodb/66-mongodb.html
@@ -104,13 +104,18 @@
     <p>A simple MongoDB output node. Can save, insert, update and remove objects from a chosen collection.</p>
     <p>Save will update an existing object or insert a new object if one does not already exist.</p>
     <p>Insert will insert a new object.</p>
-    <p>Save and insert either store <b>msg</b> or <b>msg.payload</b>.</p>
-    <p>Update will modify an existing object or objects. The query to select objects to update uses <b>msg.query</b> and the update to the element uses <b>msg.payload</b>.</p>
+    <p>Save and insert either store <code>msg</code> or <code>msg.payload</code>.</p>
+    <p>Update will modify an existing object or objects. The query to select objects to update uses <code>msg.query</code>
+    and the update to the element uses <code>msg.payload</code>.</p>
     <p>Update can add a object if it does not exist or update multiple objects.</p>
-    <p>Remove will remove objects that match the query passed in on <b>msg.payload</b>. A blank query will delete <i>all of the objects</i> in the collection.</p>
-    <p>You can either set the collection method in the node config or on <b>msg.collection</b>. Setting it in the node will override <b>msg.collection</b>.</p>
-    <p>By default MongoDB creates an <i>_id</i> property as the primary key - so repeated injections of the same <b>msg</b> will result in many database entries.</p>
-    <p>If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, then you must set the <b>msg._id</b> property to be a constant by the use of a previous function node.</p>
+    <p>Remove will remove objects that match the query passed in on <code>msg.payload</code>. A blank query will delete
+    <i>all of the objects</i> in the collection.</p>
+    <p>You can either set the collection method in the node config or on <code>msg.collection</code>. Setting it in the
+    node will override <code>msg.collection</code>.</p>
+    <p>By default MongoDB creates an <i>_id</i> property as the primary key - so repeated injections of the
+    same <code>msg</code> will result in many database entries.</p>
+    <p>If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, then you must set
+    the <code>msg._id</code> property to be a constant by the use of a previous function node.</p>
     <p>This could be a unique constant or you could create one based on some other msg property.</p>
     <p>Currently we do not limit or cap the collection size at all... this may well change.</p>
 </script>
@@ -195,12 +200,17 @@
 
 <script type="text/x-red" data-help-name="mongodb in">
     <p>Calls a MongoDB collection method based on the selected operator.</p>
-        <p>Find queries a collection using the <b>msg.payload</b> as the query statement as per the .find() function. Optionally, you may also (via a function) set a <b>msg.projection</b> object to constrain the returned fields, a <b>msg.sort</b> object, a <b>msg.limit</b> number and a <b>msg.skip</b> number.</p>
-    <p>Count returns a count of the number of documents in a collection or matching a query using the <b>msg.payload</b> as the query statement.</p>
-    <p>Aggregate provides access to the aggregation pipeline using the <b>msg.payload</b> as the pipeline array.</p>
-    <p>You can either set the collection method in the node config or on <b>msg.collection</b>. Setting it in the node will override <b>msg.collection</b>.</p>
-    <p>See the <a href="http://docs.mongodb.org/manual/reference/method/db.collection.find/" target="new"><i>MongoDB collection methods docs</i></a> for examples.</p>
-    <p>The result is returned in <b>msg.payload</b>.</p>
+    <p>Find queries a collection using the <code>msg.payload</code> as the query statement as per the .find() function.
+    Optionally, you may also (via a function) set a <code>msg.projection</code> object to constrain the returned
+    fields, a <code>msg.sort</code> object, a <code>msg.limit</code> number and a <code>msg.skip</code> number.</p>
+    <p>Count returns a count of the number of documents in a collection or matching a query using the
+    <code>msg.payload</code> as the query statement.</p>
+    <p>Aggregate provides access to the aggregation pipeline using the <code>msg.payload</code> as the pipeline array.</p>
+    <p>You can either set the collection method in the node config or on <code>msg.collection</code>. Setting it in
+    the node will override <code>msg.collection</code>.</p>
+    <p>See the <a href="http://docs.mongodb.org/manual/reference/method/db.collection.find/" target="new"><i>MongoDB
+    collection methods docs</i></a> for examples.</p>
+    <p>The result is returned in <code>msg.payload</code>.</p>
 </script>
 
 <script type="text/javascript">
diff --git a/storage/mongodb/README.md b/storage/mongodb/README.md
index 18cb7779..955f21e8 100644
--- a/storage/mongodb/README.md
+++ b/storage/mongodb/README.md
@@ -15,8 +15,7 @@ To run this you need a local MongoDB server running. For details see
 Install
 -------
 
-Run the following command in the root directory of your Node-RED install.
-Usually this is `~/.node-red` .
+Run the following command in your Node-RED user directory - typically `~/.node-red`
 
         npm install node-red-node-mongodb
 
@@ -25,39 +24,39 @@ Usage
 
 Nodes to save and retrieve data in a local MongoDB instance.
 
-###Input
+### Input
 
 Calls a MongoDB collection method based on the selected operator.
 
-*Find* queries a collection using the **msg.payload** as the query statement as
+*Find* queries a collection using the `msg.payload` as the query statement as
 per the *.find()* function.
 
 Optionally, you may also (via a function) set
 
-- a **msg.projection** object to constrain the returned fields,
-- a **msg.sort** object,
-- a **msg.limit** number,
-- a **msg.skip** number.
+- a `msg.projection` object to constrain the returned fields,
+- a `msg.sort` object,
+- a `msg.limit` number,
+- a `msg.skip` number.
 
 *Count* returns a count of the number of documents in a collection or matching a
-query using the **msg.payload** as the query statement.
+query using the `msg.payload` as the query statement.
 
-*Aggregate* provides access to the aggregation pipeline using the **msg.payload** as the pipeline array.
+*Aggregate* provides access to the aggregation pipeline using the `msg.payload` as the pipeline array.
 
-You can either set the collection method in the node config or on **msg.collection**.
-Setting it in the node will override **msg.collection**.
+You can either set the collection method in the node config or on `msg.collection`.
+Setting it in the node will override `msg.collection`.
 
 See the <a href="http://docs.mongodb.org/manual/reference/method/db.collection.find/" target="new">*MongoDB collection methods docs*</a> for examples.
 
-The result is returned in **msg.payload**.
+The result is returned in `msg.payload`.
 
-###Output
+### Output
 
 A simple MongoDB output node. Can save, insert, update and remove objects from a chosen collection.
 
 MongoDB only accepts objects.
 
-Save and insert can either store **msg** or **msg.payload**. If msg.payload is
+Save and insert can either store `msg` or `msg.payload`. If msg.payload is
 selected it should contain an object. If not it will be wrapped in an object with a name of payload.
 
 *Save* will update an existing object or insert a new object if one does not already exist.
@@ -65,19 +64,19 @@ selected it should contain an object. If not it will be wrapped in an object wit
 *Insert* will insert a new object.
 
 *Update* will modify an existing object or objects. The query to select objects
-to update uses **msg.query** and the update to the element uses **msg.payload**.
+to update uses `msg.query` and the update to the element uses `msg.payload`.
 Update can add an object if it does not exist or update multiple objects.
 
-*Remove* will remove objects that match the query passed in on **msg.payload**.
+*Remove* will remove objects that match the query passed in on `msg.payload`.
 A blank query will delete *all of the objects* in the collection.
 
-You can either set the collection method in the node config or on **msg.collection**.
-Setting it in the node will override **msg.collection**.
+You can either set the collection method in the node config or on `msg.collection`.
+Setting it in the node will override `msg.collection`.
 
-By default MongoDB creates an **msg._id** property as the primary key - so
-repeated injections of the same **msg** will result in many database entries.
+By default MongoDB creates an `msg._id` property as the primary key - so
+repeated injections of the same `msg` will result in many database entries.
 If this is NOT the desired behaviour - ie. you want repeated entries to overwrite,
-then you must set the **msg._id** property to be a constant by the use of a previous function node.
+then you must set the `msg._id` property to be a constant by the use of a previous function node.
 This must be done at the correct level. If only writing msg.payload then payload must contain the \_id property.
 If writing the whole msg object then it must contain an \_id property.
 
diff --git a/storage/mongodb/locales/en-US/66-mongodb.json b/storage/mongodb/locales/en-US/66-mongodb.json
index 5211a4f3..0846820a 100644
--- a/storage/mongodb/locales/en-US/66-mongodb.json
+++ b/storage/mongodb/locales/en-US/66-mongodb.json
@@ -22,10 +22,10 @@
             "count": "count",
             "aggregate": "aggregate"
         },
-        "tip": "<b> Tip:</b> If no collection is set, ensure <b>msg.collection</b> will contain the collection name",
+        "tip": "<b> Tip:</b> If no collection is set, ensure <code>msg.collection</code> will contain the collection name",
         "errors": {
             "nocollection": "No collection defined",
             "missingconfig": "missing mongodb configuration"
         }
     }
-}
\ No newline at end of file
+}
diff --git a/storage/mongodb/package.json b/storage/mongodb/package.json
index 3a9e6718..79bdfc19 100644
--- a/storage/mongodb/package.json
+++ b/storage/mongodb/package.json
@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-node-mongodb",
-    "version"       : "0.0.4",
+    "version"       : "0.0.5",
     "description"   : "Node-RED nodes to talk to an Mongo database",
     "dependencies"  : {
         "mongodb"   : "1.4.29"
diff --git a/storage/mysql/68-mysql.html b/storage/mysql/68-mysql.html
index bc501580..87ccfe3e 100644
--- a/storage/mysql/68-mysql.html
+++ b/storage/mysql/68-mysql.html
@@ -77,9 +77,9 @@
 <script type="text/x-red" data-help-name="mysql">
     <p>Allows basic access to a MySQL database.</p>
     <p>This node uses the <b>query</b> operation against the configured database. This does allow both INSERTS and DELETES.
-    By it's very nature it allows SQL injection... so <i>be careful out there...</i></p>
-    <p><b>msg.topic</b> must hold the <i>query</i> for the database, and the result is returned in <b>msg.payload</b>.</p>
-    <p><b>msg.payload</b> can contain an array of values to bind to the topic.</p>
+    By its very nature it allows SQL injection... so <i>be careful out there...</i></p>
+    <p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
+    <p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
     <p>Typically the returned payload will be an array of the result rows.</p>
     <p>If nothing is found for the key then <i>null</i> is returned,</p>
     <p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
diff --git a/storage/mysql/README.md b/storage/mysql/README.md
index a2be5cb0..b3b76930 100644
--- a/storage/mysql/README.md
+++ b/storage/mysql/README.md
@@ -5,7 +5,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to read and write
 Install
 -------
 
-Run the following command in the root directory of your Node-RED install
+Run the following command in your Node-RED user directory - typically `~/.node-red`
 
     npm install node-red-node-mysql
 
@@ -19,7 +19,7 @@ This node uses the <b>query</b> operation against the configured database. This
 
 By it's very nature it allows SQL injection... so <i>be careful out there...</i>
 
-The <b>msg.topic</b> must hold the <i>query</i> for the database, and the result is returned in <b>msg.payload</b>.
+The `msg.topic` must hold the <i>query</i> for the database, and the result is returned in `msg.payload`.
 
 Typically the returned payload will be an array of the result rows.
 
diff --git a/storage/mysql/package.json b/storage/mysql/package.json
index a7bbdd79..3edc7554 100644
--- a/storage/mysql/package.json
+++ b/storage/mysql/package.json
@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-node-mysql",
-    "version"       : "0.0.7",
+    "version"       : "0.0.8",
     "description"   : "A Node-RED node to read and write to a MySQL database",
     "dependencies"  : {
         "mysql"   : "2.9.*"
diff --git a/storage/redis/README.md b/storage/redis/README.md
index ba19b92d..8a6d2d3d 100644
--- a/storage/redis/README.md
+++ b/storage/redis/README.md
@@ -3,9 +3,6 @@ node-red-node-redis
 
 A <a href="http://nodered.org" target="_new">Node-RED</a> node to save data in a Redis database.
 
-**Note** : This is the same node as was in the core of Node-RED.
-As of v0.10.8 you will need to install it from here if still required.
-
 Pre-requisite
 -------------
 
@@ -15,8 +12,7 @@ To run this you need a local Redis server running. For details see <a href="http
 Install
 -------
 
-Run the following command in the root directory of your Node-RED install.
-Usually this is `~/.node-red` .
+Run the following command in your Node-RED user directory - typically `~/.node-red`
 
         npm install node-red-node-redis
 
@@ -25,10 +21,10 @@ Usage
 
 Simple node to save data in a local Redis instance
 
-###Output
+### Output
 
 A Redis output node. Options include **Hash**, **Set**, **List** and **String**.
 
-If **key** is blank, the **msg.topic** will be used as the key.
+If **key** is blank, the `msg.topic` will be used as the key.
 
-If **type** is *hash*, **msg.payload** should be an *object* or *field=value* string.
+If **type** is *hash*, `msg.payload` should be an *object* or *field=value* string.
diff --git a/storage/redis/package.json b/storage/redis/package.json
index 7260101e..60689c2a 100644
--- a/storage/redis/package.json
+++ b/storage/redis/package.json
@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-node-redis",
-    "version"       : "0.0.2",
+    "version"       : "0.0.3",
     "description"   : "A Node-RED node to save data to an Redis database",
     "dependencies"  : {
         "redis"   : "0.12.1"
diff --git a/storage/sqlite/README.md b/storage/sqlite/README.md
index bd0e963d..9d2b8d3c 100644
--- a/storage/sqlite/README.md
+++ b/storage/sqlite/README.md
@@ -6,7 +6,7 @@ A Node-Red node to read and write a local sqlite database.
 Install
 -------
 
-Run the following command in the root directory of your Node-RED install
+Run the following command in your Node-RED user directory - typically `~/.node-red`
 
     npm install node-red-node-sqlite
 
@@ -16,11 +16,12 @@ Usage
 
 Allows basic access to a Sqlite database.
 
-This node uses the <b>db.all</b> operation against the configured database. This does allow INSERTS, UPDATES and DELETES.
+This node uses the <b>db.all</b> operation against the configured database.
+This does allow INSERTS, UPDATES and DELETES.
 
 By it's very nature it is SQL injection... so *be careful* out there...
 
-**msg.topic** must hold the <i>query</i> for the database, and the result is returned in **msg.payload**.
+`msg.topic` must hold the <i>query</i> for the database, and the result is returned in `msg.payload`.
 
 Typically the returned payload will be an array of the result rows, (or an error).
 
diff --git a/storage/sqlite/package.json b/storage/sqlite/package.json
index 241e364f..979964ea 100644
--- a/storage/sqlite/package.json
+++ b/storage/sqlite/package.json
@@ -1,6 +1,6 @@
 {
     "name"          : "node-red-node-sqlite",
-    "version"       : "0.1.0",
+    "version"       : "0.1.1",
     "description"   : "A sqlite node for Node-RED",
     "dependencies"  : {
         "sqlite3"   : "3.1.*"
diff --git a/storage/sqlite/sqlite.html b/storage/sqlite/sqlite.html
index 60f5d363..82f3de3a 100644
--- a/storage/sqlite/sqlite.html
+++ b/storage/sqlite/sqlite.html
@@ -48,9 +48,9 @@
 <script type="text/x-red" data-help-name="sqlite">
     <p>Allows basic access to a Sqlite database.</p>
     <p>This node uses the <b>db.all</b> operation against the configured database. This does allow INSERTS, UPDATES and DELETES.
-    By it's very nature it is SQL injection... so <i>be careful out there...</i></p>
-    <p><b>msg.topic</b> must hold the <i>query</i> for the database, and the result is returned in <b>msg.payload</b>.</p>
-    <p><b>msg.payload</b> can contain an array of values to bind to the topic.</p>
+    By its very nature it is SQL injection... so <i>be careful out there...</i></p>
+    <p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
+    <p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
     <p>Typically the returned payload will be an array of the result rows, (or an error).</p>
     <p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
     <pre>sqliteReconnectTime: 20000,</pre></p>