docs/gql: highlight syntax

docs/gql.md

@@ -33,25 +33,31 @@ Note that only identifiers and string literals are case-sensitive.
 
 ## Perform a Query
 
-    db.gql(query, [options], [callback])
+```js
+db.gql(query, [options], [callback])
+```
 
 Although only the query is mandatory, the callback is required to access the query result.
 Currently no query options are implemented.
 
-    var pouchdb;
-    PouchDB('idb://test', function(err, db) {
-       pouchdb = db;
-      // Use pouchdb to call further functions
-        db.gql({select: "*", where: "type='Fire' and name is not null"}, function(err, result){
-            if(!err){
-            // Use the results of the query here
-            }
-          }
-    })
+```js
+var pouchdb;
+PouchDB('idb://test', function(err, db) {
+  pouchdb = db;
+  // Use pouchdb to call further functions
+  db.gql({select: "*", where: "type='Fire' and name is not null"}, function(err, result) {
+    if(!err){
+     // Use the results of the query here
+    }
+  }
+})
+```
 
 ## Select
 
-    db.gql({select: "`name!`, price-discount, upper(vendor)"}, callback)
+```js
+db.gql({select: "`name!`, price-discount, upper(vendor)"}, callback)
+```
 
 Select returns an object for each document in the database (unless limited by another clause).
 Each of these objects will be populated with the properties specified in the select clause.
@@ -60,18 +66,24 @@ Properties that are missing from an object in the database are assigned null.
 
 With these documents in the database
 
-    {name!: "pencil", price: 2, discount: 0.7, vendor: "store1"},
-    {name!: "pen", price:3, discount: 2, vendor: "store2"}
+```js
+{name!: "pencil", price: 2, discount: 0.7, vendor: "store1"},
+{name!: "pen", price:3, discount: 2, vendor: "store2"}
+```
 
 The above query will return
 
-    {name!: "pen", price - discount: 1, upper(vendor): "STORE2"},
-    {name!: "pencil", price - discount: 1.3, upper(vendor): "STORE1"}
+```js
+{name!: "pen", price - discount: 1, upper(vendor): "STORE2"},
+{name!: "pencil", price - discount: 1.3, upper(vendor): "STORE1"}
+```
 
 
 ## Where
 
-    db.gql({select: "*", where: "type='Fire' and name is not null"}, callback)
+```js
+db.gql({select: "*", where: "type='Fire' and name is not null"}, callback)
+```
 
 Where allows filtering of the objects that are passed to the select clause.  In this way, unwanted documents
 can be excluded from the query result.  The where clause is composed of conditions which are joined by the
@@ -83,23 +95,29 @@ something is null IS NULL is used.  To check if something is not null, IS NOT NU
 
 With these documents in the database
 
-    {name: "charmander", type: "Fire"},
-    {type: "Fire", attack:"tail whip"},
-    {name: "charizard", type: "Fire", attack:"slash"}
+```js
+{name: "charmander", type: "Fire"},
+{type: "Fire", attack:"tail whip"},
+{name: "charizard", type: "Fire", attack:"slash"}
+```
 
 The above query will return
 
-    {_id: "0D715E2C-CEDD-46B4-A060-9C9C290BEBE8", _rev: "1-71d1e0f8ab00cf432306890a4116602b",
+```js
+{_id: "0D715E2C-CEDD-46B4-A060-9C9C290BEBE8", _rev: "1-71d1e0f8ab00cf432306890a4116602b",
     attack: "slash", name: "charizard", type: "Fire"},
-    {_id: "3153F94B-0568-4D4C-BFA1-83EDF6185915" _rev: "1-d24f7405c5a63943391eaff9a260139c",
+{_id: "3153F94B-0568-4D4C-BFA1-83EDF6185915" _rev: "1-d24f7405c5a63943391eaff9a260139c",
     name: "charmander", type: "Fire"}
+```
 
 Note the inclusion of the \_rev and \_id fields.  This is the result of using 'select \*' instead of naming the
 desired fields explicitly.
 
 ## Group By
 
-    db.gql({select: "max(charizard), charmeleon", groupBy: "charmeleon"}, callback)
+```js
+db.gql({select: "max(charizard), charmeleon", groupBy: "charmeleon"}, callback)
+```
 
 Group by creates one object for each unique combination of values in the group by clause. For the query above,
 if every document in the database had the value "Level 22" for the property "charmeleon", only a single
@@ -111,18 +129,24 @@ clause could have multiple values for some identifiers.
 
 With these documents in the database
 
-    {charizard: 50, charmander: 24, charmeleon: 2, haunter:true},
-    {charizard: 40, charmeleon: 2, charmander: 50},
-    {charizard: 7, charmeleon: 20, charmander: 15}
+```js
+{charizard: 50, charmander: 24, charmeleon: 2, haunter:true},
+{charizard: 40, charmeleon: 2, charmander: 50},
+{charizard: 7, charmeleon: 20, charmander: 15}
+```
 
 The above query will return
 
-    {charmeleon: 2, max(charizard): 50}
-    {charmeleon: 20, max(charizard): 7}
+```js
+{charmeleon: 2, max(charizard): 50}
+{charmeleon: 20, max(charizard): 7}
+```
 
 ## Pivot
 
-     db.gql({select: "max(charizard)", pivot: "charmeleon"}, callback)
+```js
+db.gql({select: "max(charizard)", pivot: "charmeleon"}, callback)
+```
 
 Pivot is essentially group by for properties.  Each distinct value in the pivot clause gets its own property.
 Unless used with group by, the result will have only a single document.
@@ -135,18 +159,24 @@ Note that using pivot will generate novel property names.  See below for an exam
 
 With these documents in the database
 
-    {charizard: 50, charmeleon: "hello"},
-    {charizard: 40, charmeleon: "hello"},
-    {charizard: 7, charmeleon: "world", charmander: 15}
+```js
+{charizard: 50, charmeleon: "hello"},
+{charizard: 40, charmeleon: "hello"},
+{charizard: 7, charmeleon: "world", charmander: 15}
+```
 
 The above query will return
 
-    {'hello max(charizard)': 50, 'world max(charizard)': 7}
+```js
+{'hello max(charizard)': 50, 'world max(charizard)': 7}
+```
 
 ## Label
 
-     db.gql({select: 'upper(dept), charizard',
-     label: "upper(dept) 'Department', charizard 'Maximum Charizard!'"}, callback)
+```js
+db.gql({select: 'upper(dept), charizard',
+    label: "upper(dept) 'Department', charizard 'Maximum Charizard!'"}, callback)
+```
 
 Label is used to transform cryptic identifiers into something that can be displayed directly to the end user.
 Items in the label clause can be identifiers, aggregation functions, scalar functions, or operators.  The label
@@ -155,26 +185,32 @@ the select clause and the label is a string literal.
 
 With these documents in the database
 
-    {charizard: 50, dept: "eng", lunch:"2"},
-    {charizard: 40, lunch: "1", dept: "market"},·
-    {charizard: 99, dept: "eng", lunch: 1},
-    {charizard: 7, dept: "eng", lunch: 2}
+```js
+{charizard: 50, dept: "eng", lunch:"2"},
+{charizard: 40, lunch: "1", dept: "market"},·
+{charizard: 99, dept: "eng", lunch: 1},
+{charizard: 7, dept: "eng", lunch: 2}
+```
 
 The above query will return
 
-    {Department: "ENG", Maximum Charizard!: 7},
-    {Department: "ENG", Maximum Charizard!: 99},
-    {Department: "MARKET", Maximum Charizard!: 40},
-    {Department: "ENG", Maximum Charizard!: 50}
+```js
+{Department: "ENG", Maximum Charizard!: 7},
+{Department: "ENG", Maximum Charizard!: 99},
+{Department: "MARKET", Maximum Charizard!: 40},
+{Department: "ENG", Maximum Charizard!: 50}
+```
 
 ## Functions
 
 GQL contains a number of operators and functions that can operate on retrieved documents.
 
 ### Aggregation Functions
 
-    db.gql({select: "max(charizard), min(charizard), average(charizard), count(charizard), sum(charizard)"},
+```js
+db.gql({select: "max(charizard), min(charizard), average(charizard), count(charizard), sum(charizard)"},
     callback)
+```
 
 The currently supported aggregation functions are avg, count, max, min, and sum.  Each of these takes a single
 statement as an argument.  A statement can be composed of one or more identifiers joined by operators.
@@ -184,38 +220,50 @@ may only appear in the select and label clauses.
 
 With these documents in the database
 
-    {charizard: 50},
-    {charizard: 40},
-    {charizard: 7}
+```js
+{charizard: 50},
+{charizard: 40},
+{charizard: 7}
+```
 
 The above query will return
 
-    {average(charizard): 32.333333333333336, count(charizard): 3, max(charizard): 50,
+```js
+{average(charizard): 32.333333333333336, count(charizard): 3, max(charizard): 50,
     min(charizard): 7, sum(charizard): 97}
+```
 
 ### Scalar Functions
 
-    db.gql({select: "`name!`, price-discount, upper(vendor)"}, callback)
+```js
+db.gql({select: "`name!`, price-discount, upper(vendor)"}, callback)
+```
 
 Currently only two scalar functions are supported, upper and lower.  These change the characters in their inputs
 to uppercase and lowercase respectively.  Unlike aggregator functions, scalar functions take only a single
 identifier as their input.  Scalar functions may only appear in the select and label clauses.
 
 With these documents in the database
 
-    {name!: "pencil", price: 2, discount: 0.7, vendor: "store1"},
-    {name!: "pen", price:3, discount: 2, vendor: "store2"}
+```js
+{name!: "pencil", price: 2, discount: 0.7, vendor: "store1"},
+{name!: "pen", price:3, discount: 2, vendor: "store2"}
+```
 
 The above query will return
 
-    {name!: "pen", price - discount: 1, upper(vendor): "STORE2"},
-    {name!: "pencil", price - discount: 1.3, upper(vendor): "STORE1"}
+```js
+{name!: "pen", price - discount: 1, upper(vendor): "STORE2"},
+{name!: "pencil", price - discount: 1.3, upper(vendor): "STORE1"}
+```
 
 
 ### Arithmetic Operators
 
-    db.gql({select: "*", where: "charizard <=charmander * charmeleon + 2 and (charmander - 7 !=  24/3)"},
+```js
+db.gql({select: "*", where: "charizard <=charmander * charmeleon + 2 and (charmander - 7 !=  24/3)"},
     callback)
+```
 
 Arithmetic operators are used to perform basic math on the values from documents.  Their arguments must be
 numbers.  Arithmetic operators may only appear in the select, label, and where clauses.  The arguments are
@@ -229,13 +277,17 @@ implicitly upcast to floats if necessary. The supported arithmetic operators are
 
 With these documents in the database
 
-    {charizard: 50, charmander: 24, charmeleon: 2, haunter:true},
-    {charizard: 40, charmeleon: .5, charmander: 50},
-    {charizard: 7, charmeleon: 20, charmander: 15}
+```js
+{charizard: 50, charmander: 24, charmeleon: 2, haunter:true},
+{charizard: 40, charmeleon: .5, charmander: 50},
+{charizard: 7, charmeleon: 20, charmander: 15}
+```
 
 The above query will return
 
-    {charizard: 50, charmander: 24, charmeleon: 2, haunter: true}
+```js
+{charizard: 50, charmander: 24, charmeleon: 2, haunter: true}
+```
 
 ## Miscellaneous