From 73050198c50b2b60bc0242c8310e9e5504ab451e Mon Sep 17 00:00:00 2001 From: Christoph Strobl Date: Thu, 31 Aug 2023 18:22:11 +0200 Subject: [PATCH] Enable Section Summary TOC for small pages --- src/main/antora/modules/ROOT/pages/reference/introduction.adoc | 1 + src/main/antora/modules/ROOT/pages/reference/mongodb.adoc | 1 + .../ROOT/pages/reference/mongodb/mongo-examples-repo.adoc | 1 + .../modules/ROOT/pages/reference/mongodb/mongo-exception.adoc | 1 + .../antora/modules/ROOT/pages/reference/mongodb/mongo-query.adoc | 1 + .../pages/reference/mongodb/mongo-query/template-querying.adoc | 1 + .../ROOT/pages/reference/mongodb/mongo-template-commands.adoc | 1 + src/main/antora/modules/ROOT/pages/upgrading.adoc | 1 + 8 files changed, 8 insertions(+) diff --git a/src/main/antora/modules/ROOT/pages/reference/introduction.adoc b/src/main/antora/modules/ROOT/pages/reference/introduction.adoc index 235bd682b..a107bd0e5 100644 --- a/src/main/antora/modules/ROOT/pages/reference/introduction.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/introduction.adoc @@ -1,5 +1,6 @@ [[introduction]] = Introduction +:page-section-summary-toc: 1 [[document-structure]] == Document Structure diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb.adoc index 8ae421726..755680f62 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb.adoc @@ -1,5 +1,6 @@ [[mongo.core]] = MongoDB support +:page-section-summary-toc: 1 The MongoDB support contains a wide range of features: diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-examples-repo.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-examples-repo.adoc index 35eebf783..c6e6e8471 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-examples-repo.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-examples-repo.adoc @@ -1,5 +1,6 @@ [[mongo.examples-repo]] = Examples Repository +:page-section-summary-toc: 1 There is a https://github.com/spring-projects/spring-data-examples[GitHub repository with several examples] that you can download and play around with to get a feel for how the library works. diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-exception.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-exception.adoc index 9044945bf..c7c05355a 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-exception.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-exception.adoc @@ -1,5 +1,6 @@ [[mongo.exception]] = Exception Translation +:page-section-summary-toc: 1 The Spring framework provides exception translation for a wide variety of database and mapping technologies. This has traditionally been for JDBC and JPA. The Spring support for MongoDB extends this feature to the MongoDB Database by providing an implementation of the `org.springframework.dao.support.PersistenceExceptionTranslator` interface. diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query.adoc index 20f131685..72e639d47 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query.adoc @@ -1,5 +1,6 @@ [[mongo.query]] = Querying Documents +:page-section-summary-toc: 1 You can use the `Query` and `Criteria` classes to express your queries.They have method names that mirror the native MongoDB operator names, such as `lt`, `lte`, `is`, and others.The `Query` and `Criteria` classes follow a fluent API style so that you can chain together multiple method criteria and queries while having easy-to-understand code.To improve readability, static imports let you avoid using the 'new' keyword for creating `Query` and `Criteria` instances.You can also use `BasicQuery` to create `Query` instances from plain JSON Strings, as shown in the following example: diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query/template-querying.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query/template-querying.adoc index 3f4710364..3d8bf6e36 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query/template-querying.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-query/template-querying.adoc @@ -1,5 +1,6 @@ [[mongo-template.querying]] = Methods for Querying for Documents +:page-section-summary-toc: 1 The query methods need to specify the target type `T` that is returned, and they are overloaded with an explicit collection name for queries that should operate on a collection other than the one indicated by the return type. The following query methods let you find one or more documents: diff --git a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-template-commands.adoc b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-template-commands.adoc index 114fd9ddc..a1b6440c2 100644 --- a/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-template-commands.adoc +++ b/src/main/antora/modules/ROOT/pages/reference/mongodb/mongo-template-commands.adoc @@ -1,5 +1,6 @@ [[mongo-template.commands]] = Running Commands +:page-section-summary-toc: 1 You can get at the MongoDB driver's `MongoDatabase.runCommand( )` method by using the `executeCommand(…)` methods on `MongoTemplate`. These methods also perform exception translation into Spring's `DataAccessException` hierarchy. diff --git a/src/main/antora/modules/ROOT/pages/upgrading.adoc b/src/main/antora/modules/ROOT/pages/upgrading.adoc index b710c5bfb..a32be6aa2 100644 --- a/src/main/antora/modules/ROOT/pages/upgrading.adoc +++ b/src/main/antora/modules/ROOT/pages/upgrading.adoc @@ -1,5 +1,6 @@ [[upgrading.data-mongo]] = Upgrading +:page-section-summary-toc: 1 include::{spring-data-commons-docs}/upgrade.adoc[leveloffset=+1]