DATAMONGO-1412 - Fix backticks and code element highlighting.

Fixed broken highlighting using backticks followed by chars/single quotes. Convert single quote emphasis of id to backtick code fences. Add missing spaces between words and backticks.

Original Pull Request: #359

src/main/asciidoc/reference/mapping.adoc

@@ -12,25 +12,25 @@ NOTE: `SimpleMongoConverter` has been deprecated in Spring Data MongoDB M3 as al
 
 `MongoMappingConverter` has a few conventions for mapping objects to documents when no additional mapping metadata is provided. The conventions are:
 
-* The short Java class name is mapped to the collection name in the following manner. The class '`com.bigbank.SavingsAccount`' maps to '`savingsAccount`' collection name.
+* The short Java class name is mapped to the collection name in the following manner. The class `com.bigbank.SavingsAccount` maps to `savingsAccount` collection name.
 * All nested objects are stored as nested objects in the document and *not* as DBRefs
 * The converter will use any Spring Converters registered with it to override the default mapping of object properties to document field/values.
 * The fields of an object are used to convert to and from fields in the document. Public JavaBean properties are not used.
 * You can have a single non-zero argument constructor whose constructor argument names match top level field names of document, that constructor will be used. Otherwise the zero arg constructor will be used. if there is more than one non-zero argument constructor an exception will be thrown.
 
 [[mapping.conventions.id-field]]
-=== How the '_id' field is handled in the mapping layer
+=== How the `_id` field is handled in the mapping layer
 
-MongoDB requires that you have an '_id' field for all documents. If you don't provide one the driver will assign a ObjectId with a generated value. The "_id" field can be of any type the, other than arrays, so long as it is unique. The driver naturally supports all primitive types and Dates. When using the `MongoMappingConverter` there are certain rules that govern how properties from the Java class is mapped to this '_id' field.
+MongoDB requires that you have an `_id` field for all documents. If you don't provide one the driver will assign a ObjectId with a generated value. The "_id" field can be of any type the, other than arrays, so long as it is unique. The driver naturally supports all primitive types and Dates. When using the `MongoMappingConverter` there are certain rules that govern how properties from the Java class is mapped to this `_id` field.
 
-The following outlines what field will be mapped to the '_id' document field:
+The following outlines what field will be mapped to the `_id` document field:
 
-* A field annotated with `@Id` (`org.springframework.data.annotation.Id`) will be mapped to the '_id' field.
-* A field without an annotation but named 'id' will be mapped to the '_id' field.
-* The default field name for identifiers is '_id' and can be customized via the `@Field` annotation.
+* A field annotated with `@Id` (`org.springframework.data.annotation.Id`) will be mapped to the `_id` field.
+* A field without an annotation but named `id` will be mapped to the `_id` field.
+* The default field name for identifiers is `_id` and can be customized via the `@Field` annotation.
 
 [cols="1,2", options="header"]
-.Examples for the translation of '_id'-field definitions
+.Examples for the translation of `_id` field definitions
 |===
 | Field definition
 | Resulting Id-Fieldname in MongoDB
@@ -41,21 +41,21 @@ The following outlines what field will be mapped to the '_id' document field:
 | `@Field` `String` id
 | `_id`
 
-| `@Field('x')` `String` id
+| `@Field("x")` `String` id
 | `x`
 
 | `@Id` `String` x
 | `_id`
 
-| `@Field('x')` `@Id` `String` x
+| `@Field("x")` `@Id` `String` x
 | `_id`
 |===
 
 The following outlines what type conversion, if any, will be done on the property mapped to the _id document field.
 
-* If a field named 'id' is declared as a String or BigInteger in the Java class it will be converted to and stored as an ObjectId if possible. ObjectId as a field type is also valid. If you specify a value for 'id' in your application, the conversion to an ObjectId is detected to the MongoDBdriver. If the specified 'id' value cannot be converted to an ObjectId, then the value will be stored as is in the document's _id field.
-* If a field named ' id' id field is not declared as a String, BigInteger, or ObjectID in the Java class then you should assign it a value in your application so it can be stored 'as-is' in the document's _id field.
-* If no field named 'id' is present in the Java class then an implicit '_id' file will be generated by the driver but not mapped to a property or field of the Java class.
+* If a field named `id` is declared as a String or BigInteger in the Java class it will be converted to and stored as an ObjectId if possible. ObjectId as a field type is also valid. If you specify a value for `id` in your application, the conversion to an ObjectId is detected to the MongoDBdriver. If the specified `id` value cannot be converted to an ObjectId, then the value will be stored as is in the document's _id field.
+* If a field named `id` id field is not declared as a String, BigInteger, or ObjectID in the Java class then you should assign it a value in your application so it can be stored 'as-is' in the document's _id field.
+* If no field named `id` is present in the Java class then an implicit `_id` file will be generated by the driver but not mapped to a property or field of the Java class.
 
 When querying and updating `MongoTemplate` will use the converter to handle conversions of the `Query` and `Update` objects that correspond to the above rules for saving documents so field names and types used in your queries will be able to match what is in your domain classes.
 
@@ -292,11 +292,11 @@ public class GeoSpatialAppConfig extends AbstractMongoConfiguration {
 ----
 ====
 
-`AbstractMongoConfiguration` requires you to implement methods that define a `com.mongodb.Mongo` as well as provide a database name. `AbstractMongoConfiguration` also has a method you can override named '`getMappingBasePackage`' which tells the converter where to scan for classes annotated with the `@org.springframework.data.mongodb.core.mapping.Document` annotation.
+`AbstractMongoConfiguration` requires you to implement methods that define a `com.mongodb.Mongo` as well as provide a database name. `AbstractMongoConfiguration` also has a method you can override named  `getMappingBasePackage(…)` which tells the converter where to scan for classes annotated with the `@Document` annotation.
 
 You can add additional converters to the converter by overriding the method afterMappingMongoConverterCreation. Also shown in the above example is a `LoggingEventListener` which logs `MongoMappingEvent` s that are posted onto Spring's `ApplicationContextEvent` infrastructure.
 
-NOTE: AbstractMongoConfiguration will create a MongoTemplate instance and registered with the container under the name 'mongoTemplate'.
+NOTE: AbstractMongoConfiguration will create a MongoTemplate instance and registered with the container under the name `mongoTemplate`.
 
 You can also override the method `UserCredentials getUserCredentials()` to provide the username and password information to connect to the database.
 
@@ -349,7 +349,7 @@ The `base-package` property tells it where to scan for classes annotated with th
 [[mapping-usage]]
 == Metadata based Mapping
 
-To take full advantage of the object mapping functionality inside the Spring Data/MongoDB support, you should annotate your mapped objects with the `@org.springframework.data.mongodb.core.mapping.Document` annotation. Although it is not necessary for the mapping framework to have this annotation (your POJOs will be mapped correctly, even without any annotations), it allows the classpath scanner to find and pre-process your domain objects to extract the necessary metadata. If you don't use this annotation, your application will take a slight performance hit the first time you store a domain object because the mapping framework needs to build up its internal metadata model so it knows about the properties of your domain object and how to persist them.
+To take full advantage of the object mapping functionality inside the Spring Data/MongoDB support, you should annotate your mapped objects with the `@Document` annotation. Although it is not necessary for the mapping framework to have this annotation (your POJOs will be mapped correctly, even without any annotations), it allows the classpath scanner to find and pre-process your domain objects to extract the necessary metadata. If you don't use this annotation, your application will take a slight performance hit the first time you store a domain object because the mapping framework needs to build up its internal metadata model so it knows about the properties of your domain object and how to persist them.
 
 .Example domain object
 ====
@@ -599,7 +599,7 @@ Simply declaring these beans in your Spring ApplicationContext will cause them t
 [[mapping-explicit-converters]]
 === Overriding Mapping with explicit Converters
 
-When storing and querying your objects it is convenient to have a `MongoConverter` instance handle the mapping of all Java types to DBObjects. However, sometimes you may want the `MongoConverter`'s do most of the work but allow you to selectively handle the conversion for a particular type or to optimize performance.
+When storing and querying your objects it is convenient to have a `MongoConverter` instance handle the mapping of all Java types to DBObjects. However, sometimes you may want the `MongoConverter` s do most of the work but allow you to selectively handle the conversion for a particular type or to optimize performance.
 
 To selectively handle the conversion yourself, register one or more one or more `org.springframework.core.convert.converter.Converter` instances with the MongoConverter.
 

src/main/asciidoc/reference/mongodb.adoc

@@ -643,21 +643,21 @@ NOTE: This example is meant to show the use of save, update and remove operation
 The query syntax used in the example is explained in more detail in the section <<mongo.query,Querying Documents>>.
 
 [[mongo-template.id-handling]]
-=== How the '_id' field is handled in the mapping layer
+=== How the `_id` field is handled in the mapping layer
 
-MongoDB requires that you have an '_id' field for all documents. If you don't provide one the driver will assign a `ObjectId` with a generated value. When using the `MongoMappingConverter` there are certain rules that govern how properties from the Java class is mapped to this '_id' field.
+MongoDB requires that you have an `_id` field for all documents. If you don't provide one the driver will assign a `ObjectId` with a generated value. When using the `MongoMappingConverter` there are certain rules that govern how properties from the Java class is mapped to this `_id` field.
 
-The following outlines what property will be mapped to the '_id' document field:
+The following outlines what property will be mapped to the `_id` document field:
 
-* A property or field annotated with `@Id` (`org.springframework.data.annotation.Id`) will be mapped to the '_id' field.
-* A property or field without an annotation but named `id` will be mapped to the '_id' field.
+* A property or field annotated with `@Id` (`org.springframework.data.annotation.Id`) will be mapped to the `_id` field.
+* A property or field without an annotation but named `id` will be mapped to the `_id` field.
 
 The following outlines what type conversion, if any, will be done on the property mapped to the _id document field when using the `MappingMongoConverter`, the default for `MongoTemplate`.
 
 * An id property or field declared as a String in the Java class will be converted to and stored as an `ObjectId` if possible using a Spring `Converter<String, ObjectId>`. Valid conversion rules are delegated to the MongoDB Java driver. If it cannot be converted to an ObjectId, then the value will be stored as a string in the database.
 * An id property or field declared as `BigInteger` in the Java class will be converted to and stored as an `ObjectId` using a Spring `Converter<BigInteger, ObjectId>`.
 
-If no field or property specified above is present in the Java class then an implicit '_id' file will be generated by the driver but not mapped to a property or field of the Java class.
+If no field or property specified above is present in the Java class then an implicit `_id` file will be generated by the driver but not mapped to a property or field of the Java class.
 
 When querying and updating `MongoTemplate` will use the converter to handle conversions of the `Query` and `Update` objects that correspond to the above rules for saving documents so field names and types used in your queries will be able to match what is in your domain classes.
 
@@ -823,7 +823,7 @@ The MongoDB driver supports inserting a collection of documents in one operation
 
 The MongoDB driver supports inserting a collection of documents in one operation. The methods in the MongoOperations interface that support this functionality are listed below
 
-* *insert*` methods that take a `Collection` as the first argument. This inserts a list of objects in a single batch write to the database.
+* *insert* methods that take a `Collection` as the first argument. This inserts a list of objects in a single batch write to the database.
 
 [[mongodb-template-update]]
 === Updating documents in a collection
@@ -1385,7 +1385,7 @@ Executing this will result in a collection as shown below.
 { "_id" : "d", "value" : 1 }
 ----
 
-Assuming that the map and reduce functions are located in map.js and reduce.js and bundled in your jar so they are available on the classpath, you can execute a map-reduce operation and obtain the results as shown below
+Assuming that the map and reduce functions are located in `map.js` and `reduce.js` and bundled in your jar so they are available on the classpath, you can execute a map-reduce operation and obtain the results as shown below
 
 [source,java]
 ----
@@ -1493,7 +1493,7 @@ Spring provides integration with MongoDB's group operation by providing methods
 [[mongo.group.example]]
 === Example Usage
 
-In order to understand how group operations work the following example is used, which is somewhat artificial. For a more realistic example consult the book 'MongoDB - The definitive guide'. A collection named "group_test_collection" created with the following rows.
+In order to understand how group operations work the following example is used, which is somewhat artificial. For a more realistic example consult the book 'MongoDB - The definitive guide'. A collection named `group_test_collection` created with the following rows.
 
 [source]
 ----
@@ -1505,7 +1505,7 @@ In order to understand how group operations work the following example is used,
 { "_id" : ObjectId("4ec1d25d41421e2015da64f6"), "x" : 3 }
 ----
 
-We would like to group by the only field in each row, the 'x' field and aggregate the number of times each specific value of 'x' occurs. To do this we need to create an initial document that contains our count variable and also a reduce function which will increment it each time it is encountered. The Java code to execute the group operation is shown below
+We would like to group by the only field in each row, the `x` field and aggregate the number of times each specific value of `x` occurs. To do this we need to create an initial document that contains our count variable and also a reduce function which will increment it each time it is encountered. The Java code to execute the group operation is shown below
 
 [source,java]
 ----
@@ -1664,7 +1664,7 @@ Note that the aggregation operations not listed here are currently not supported
 [[mongo.aggregation.projection]]
 === Projection Expressions
 
-Projection expressions are used to define the fields that are the outcome of a particular aggregation step. Projection expressions can be defined via the `project` method of the `Aggregate` class either by passing a list of `String`s or an aggregation framework `Fields` object. The projection can be extended with additional fields through a fluent API via the `and(String)` method and aliased via the `as(String)` method.
+Projection expressions are used to define the fields that are the outcome of a particular aggregation step. Projection expressions can be defined via the `project` method of the `Aggregate` class either by passing a list of `String` 's or an aggregation framework `Fields` object. The projection can be extended with additional fields through a fluent API via the `and(String)` method and aliased via the `as(String)` method.
 Note that one can also define fields with aliases via the static factory method `Fields.field` of the aggregation framework that can then be used to construct a new `Fields` instance.
 
 .Projection expression examples