Aligning what we can with 5.x

Author: andrus

agrest-docs-framework/src/docs/asciidoc/_chapters/_writing-resource-endpoints/create-entity.adoc

@@ -1,4 +1,4 @@
-=== Create Entity with `POST`
+=== Create Entity with "POST"
 
 Now let's implement a `POST` method in DomainResource class:
 
@@ -27,7 +27,7 @@ curl -i -X POST 'http://example.org/myapp/domain' \
 >          -d '{"vhost":"mysite1.example.org","name":"My Site #1"}'
 ```
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 201 Created
 Content-Type: application/json

agrest-docs-framework/src/docs/asciidoc/_chapters/_writing-resource-endpoints/read-collection-of-entities.adoc

@@ -1,4 +1,4 @@
-=== Read Collection of Entities with `GET`
+=== Read Collection of Entities with "GET"
 
 You may create more Domain objects, executing `POST` request above. Now
 let's write a `GET` method to search for domains:
@@ -22,7 +22,7 @@ client like this:
 
 `curl -i -X GET 'http://example.org/myapp/domain'`
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json
@@ -37,12 +37,12 @@ Content-Type: application/json
 ----
 
 Since select chain above incorporates UriInfo, it will recognize Agrest control
-parameters passed from the client (see link:/protocol#control-parameters[Control Parameters]). Let's try using "cayenneExp" filter and "include":
+parameters passed from the client (see link:/protocol#control-parameters[Control Parameters]). Let's try using "exp" filter and "include":
 
 
 `curl -i -X GET 'http://example.org/myapp/domain?exp=vhost="mysite1.example.org"&include=id'`
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json

agrest-docs-framework/src/docs/asciidoc/_chapters/_writing-resource-endpoints/read-single-entity.adoc

@@ -1,4 +1,4 @@
-=== Read a Single Entity with `GET`
+=== Read a Single Entity with "GET"
 
 A common request is to locate a single instance of an entity by ID. Here is how
 this can be done with Agrest:
@@ -23,7 +23,7 @@ Calling this endpoint, we'll get an expected result:
 
 `curl -i -X GET 'http://example.org/myapp/domain/1'`
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json

agrest-docs-framework/src/docs/asciidoc/_chapters/_writing-resource-endpoints/update-entity.adoc

@@ -1,6 +1,6 @@
-=== Update Entity with `PUT`
+=== Update Entity with "PUT"
 
-To update the entity we created before <<Create Entity with `POST`>> we have to implement a `PUT` method in DomainResource class:
+To update the entity we created before <<Create Entity with "POST">> we have to implement a `PUT` method in DomainResource class:
 
 [source, Java]
 ----
@@ -16,15 +16,15 @@ public SimpleResponse update(@PathParam("id") int id, String data) {
 }
 ----
 
-This simple "update chain" is very similar to the <<Create Entity with `POST`>> and the <<Read a Single Entity with `GET`>> chains.
+This simple "update chain" is very similar to the <<Create Entity with "POST">> and the <<Read a Single Entity with "GET">> chains.
 Try to sent a request to this endpoint and get a result as expected
 
 ```
 curl -i -X PUT 'http://example.org/myapp/domain/1' \
 >          -d '{"vhost":"mysite2.example.org","name":"My Site #2"}'
 ```
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json

agrest-docs-framework/src/docs/asciidoc/_chapters/header.html

@@ -2,6 +2,6 @@
 title: "Framework"
 layout: docs-index
 weight: 30
-docsMenuTitle: "Framework"
+docsMenuTitle: "Table of Contents"
 description: "Agrest server framework documentation"
 ---

agrest-docs-overview/src/docs/asciidoc/_chapters/header.html

@@ -2,6 +2,6 @@
 title: "Overview"
 layout: docs-index
 weight: 10
-docsMenuTitle: "Overview"
+docsMenuTitle: "Table of Contents"
 description: "Overview of the framework and it's basic concepts"
 ---

agrest-docs-protocol/src/docs/asciidoc/_chapters/_control-parameters/filtering-collection.adoc

@@ -1,4 +1,4 @@
-=== Filtering Collection with `exp`
+=== Filtering Collection with "exp"
 
 NOTE: "exp" key was first introduced in Agrest 4.1. Previously it was called "cayenneExp".
 Both are synonymous. "cayenneExp" is still supported, though should be considered deprecated.

agrest-docs-protocol/src/docs/asciidoc/_chapters/_control-parameters/ordering-collection.adoc

@@ -1,4 +1,4 @@
-=== Ordering Collection with `sort / dir`
+=== Ordering Collection with "sort" / "dir"
 
 Example 1: Sort on a single property.
 

agrest-docs-protocol/src/docs/asciidoc/_chapters/_control-parameters/pagination.adoc

@@ -1,14 +1,14 @@
 [#Pagination]
-=== Pagination with `start / limit`
+=== Pagination with "start" / "limit"
 
 These two parameters are used together to request from the server a range of objects
 for a potentially huge collection. They allow to implement efficient data pagination on the client.
 
-`"start"` is an offset within the "data" array. All the objects below this
+`start` is an offset within the "data" array. All the objects below this
 offset are discarded from the collection. Default "start" is 0.
 
 
-`"limit"` is a maximum number of objects in the collection "data". Default is infinity (no limit).
+`limit` is a maximum number of objects in the collection "data". Default is infinity (no limit).
 
 "limit" is applied after "start". So for a collection with a total of 10 objects,
 `?start=2&limit=5` would result in objects 2..6 returned from the server. Returned Collection "total" would still be 10.

agrest-docs-protocol/src/docs/asciidoc/_chapters/_control-parameters/shaping-collection.adoc

@@ -1,4 +1,4 @@
-=== Shaping Collection with `include / exclude`
+=== Shaping Collection with "include" / "exclude"
 
 Model entities may have "simple" properties (attributes) and properties that point to
 related entities (relationships). By default Collection Document contains entity
@@ -11,7 +11,7 @@ Example 1: Include default properties (all entity attributes) minus "vhost" attr
 
 `exclude=vhost`
 
-[source, JSON]
+[source,json]
 ----
 { "id" : 45, "name" : "Agrest Site" }
 ----
@@ -20,7 +20,7 @@ Example 2: Exclude all properties, but "id".
 
 `include=id`
 
-[source, JSON]
+[source,json]
 ----
 { "id" : 45 }
 ----
@@ -29,7 +29,7 @@ Example 3: Multiple includes, one of them points to attributes of related entity
 
 `include=id&include=articles.title`
 
-[source, JSON]
+[source,json]
 ----
 {
    "id" : 45,
@@ -47,7 +47,7 @@ of related objects for each root object.
 
 `include={"path":"articles","exp":"title like '%Agrest%'","sort":"title"}&include=articles.title`
 
-[source, JSON]
+[source,json]
 ----
 {
    "id" : 45,
@@ -65,7 +65,7 @@ Example 5: Related objects as a map. Here we'll map article bodies by title.
 
 `include={"path":"articles","mapBy":"title"}&include=articles.body`
 
-[source, JSON]
+[source,json]
 ----
 {
    "articles" : {
@@ -79,7 +79,7 @@ Example 6: Include and Exclude parameters have ability to take an array of value
 
 `include=["id","name"]`
 
-[source, JSON]
+[source,json]
 ----
 { "id" : 45, "name" : "Agrest Site" }
 ----
@@ -88,7 +88,7 @@ Example 7: The array can contain both the simple include and the advanced includ
 
 `include=["id","articles.title",{"path":"articles","exp":"title like '%Agrest%'"}]`
 
-[source, JSON]
+[source,json]
 ----
 {
    "id" : 45,
@@ -103,7 +103,7 @@ Example 8: Attributes of a related entity can be presented as an inner array in
 
 `include=["id","name",{"articles":["title","body"]}]`
 
-[source, JSON]
+[source,json]
 ----
 {
    "id" : 45,

agrest-docs-protocol/src/docs/asciidoc/_chapters/_control-parameters/structuring-collection.adoc

@@ -1,9 +1,9 @@
-=== Structuring Collection with `mapBy`
+=== Structuring Collection with "mapBy"
 
 Agrest presents the response as an array of entities <<Response: Collection Document>>.
 E.g. Request of articles returns the following array:
 
-[source, JSON]
+[source,json]
 ----
 {
 "data" : [
@@ -19,7 +19,7 @@ Using `mapBy` this array can be transformed to a map. One of entity fields is us
 
 `mapBy=publishedOn`
 
-[source, JSON]
+[source,json]
 ----
 {
 "data" : {

agrest-docs-protocol/src/docs/asciidoc/_chapters/_json-documents/request-update-document.adoc

@@ -1,16 +1,16 @@
-=== Request: Update Document
+=== Update Document
 
-Update Document is sent from the client to the server to modify an entity collection.
+Update Document is sent in a _request_ body from the client to the server to modify an entity collection.
 It is a Collection document stripped down to its "data" section. There are two flavors -
 a single object and an array of objects:
 
-[source, JSON]
+[source,json]
 ----
 { "id" : 5, "name": "X" }
 ----
 
 
-[source, JSON]
+[source,json]
 ----
 [
    { "id" : 5, "name": "X" },

agrest-docs-protocol/src/docs/asciidoc/_chapters/_json-documents/response-collection-document.adoc

@@ -1,9 +1,9 @@
-=== Response: Collection Document
+=== Collection Document
 
-A document that passes the data from the server to the client. This is the main
+A document is used in _responses_ that return the data from the server. This is the main
 representation of data in Agrest.
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json

agrest-docs-protocol/src/docs/asciidoc/_chapters/_json-documents/response-simple-document.adoc

@@ -1,9 +1,9 @@
-=== Response: Simple Document
+=== Simple Document
 
-This document is used in responses that contain no data, just a boolean status and a
-message. On success it might look like this:
+This document is used in _responses_ that contain no data, just a boolean status and a
+message. On success, it might look like this:
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Content-Type: application/json
@@ -15,9 +15,9 @@ Content-Type: application/json
 ----
 
 
-On failure it might look like this:
+On failure, it might look like this:
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 500 Server error
 Content-Type: application/json

agrest-docs-protocol/src/docs/asciidoc/_chapters/dates-and-times.adoc

@@ -4,7 +4,7 @@ JSON doesn't have datatypes for either date or time. Both are represented as str
 Server and client must ensure that date/time strings are in
 http://en.wikipedia.org/wiki/ISO_8601[ISO 8601 format] E.g.:
 
-[source, JSON]
+[source,json]
 ----
 2015-04-19T11:08:53Z
 2015-04-10T11:08

agrest-docs-protocol/src/docs/asciidoc/_chapters/header.html

@@ -2,6 +2,6 @@
 title: "Protocol"
 layout: docs-index
 weight: 20
-docsMenuTitle: "Protocol"
+docsMenuTitle: "Table of Contents"
 description: "HTTP/JSON protocol that unifies interaction between a client and an Agrest server"
 ---

agrest-docs-workflow/src/docs/asciidoc/_chapters/header.html

@@ -2,6 +2,6 @@
 title: "Workflow"
 layout: docs-index
 weight: 40
-docsMenuTitle: "Workflow"
+docsMenuTitle: "Table of Contents"
 description: "A full tutorial covering simple Agrest application"
 ---

agrest-docs-workflow/src/docs/asciidoc/_chapters/running_app.adoc

@@ -26,7 +26,7 @@ curl -i -X GET 'http://localhost:8080/api/category'
 
 And get the following response:
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Date: Wed, 03 Oct 2018 10:14:51 GMT
@@ -51,7 +51,7 @@ curl -i -X POST 'http://localhost:8080/api/category' -d '{"id":"2","name":"Horro
 
 The response will be:
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 201 Created
 Date: Wed, 03 Oct 2018 10:42:17 GMT
@@ -64,7 +64,7 @@ Server: Jetty(9.3.14.v20161028)
 
 Now make the 'GET' request again and you will receive the following:
 
-[source, JSON]
+[source,json]
 ----
 HTTP/1.1 200 OK
 Date: Wed, 03 Oct 2018 10:44:44 GMT