From 35229c8bffbd613f57266553c5fcec163b26ae2b Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 19 Apr 2023 10:26:17 -0500 Subject: [PATCH] Enable Section Summary TOC for small pages --- framework-docs/modules/ROOT/pages/core/aop-api.adoc | 1 + framework-docs/modules/ROOT/pages/core/aop-api/advisor.adoc | 1 + .../modules/ROOT/pages/core/aop-api/extensibility.adoc | 1 + framework-docs/modules/ROOT/pages/core/aop/ataspectj.adoc | 1 + .../modules/ROOT/pages/core/aop/introduction-proxies.adoc | 1 + framework-docs/modules/ROOT/pages/core/aop/mixing-styles.adoc | 1 + framework-docs/modules/ROOT/pages/core/aop/resources.adoc | 1 + framework-docs/modules/ROOT/pages/core/appendix.adoc | 1 + framework-docs/modules/ROOT/pages/core/beans.adoc | 1 + framework-docs/modules/ROOT/pages/core/beans/dependencies.adoc | 1 + framework-docs/modules/ROOT/pages/core/beans/java.adoc | 1 + .../modules/ROOT/pages/core/expressions/language-ref.adoc | 1 + framework-docs/modules/ROOT/pages/data-access.adoc | 1 + framework-docs/modules/ROOT/pages/data-access/orm.adoc | 1 + .../modules/ROOT/pages/data-access/transaction/resources.adoc | 1 + .../data-access/transaction/solutions-to-common-problems.adoc | 1 + .../ROOT/pages/data-access/transaction/tx-decl-vs-prog.adoc | 1 + framework-docs/modules/ROOT/pages/integration.adoc | 1 + framework-docs/modules/ROOT/pages/integration/cache.adoc | 1 + framework-docs/modules/ROOT/pages/integration/cache/plug.adoc | 1 + .../modules/ROOT/pages/integration/cache/specific-config.adoc | 1 + framework-docs/modules/ROOT/pages/integration/jmx/resources.adoc | 1 + framework-docs/modules/ROOT/pages/languages.adoc | 1 + framework-docs/modules/ROOT/pages/languages/groovy.adoc | 1 + framework-docs/modules/ROOT/pages/languages/kotlin.adoc | 1 + .../modules/ROOT/pages/languages/kotlin/classes-interfaces.adoc | 1 + .../modules/ROOT/pages/languages/kotlin/requirements.adoc | 1 + framework-docs/modules/ROOT/pages/testing.adoc | 1 + framework-docs/modules/ROOT/pages/testing/annotations.adoc | 1 + .../annotations/integration-spring/annotation-bootstrapwith.adoc | 1 + .../integration-spring/annotation-recordapplicationevents.adoc | 1 + framework-docs/modules/ROOT/pages/testing/appendix.adoc | 1 + framework-docs/modules/ROOT/pages/testing/introduction.adoc | 1 + .../modules/ROOT/pages/testing/spring-mvc-test-framework.adoc | 1 + .../pages/testing/spring-mvc-test-framework/server-filters.adoc | 1 + .../pages/testing/spring-mvc-test-framework/server-htmlunit.adoc | 1 + .../testing/spring-mvc-test-framework/server-resources.adoc | 1 + .../testing/spring-mvc-test-framework/server-static-imports.adoc | 1 + .../ROOT/pages/testing/spring-mvc-test-framework/server.adoc | 1 + .../modules/ROOT/pages/testing/testcontext-framework.adoc | 1 + framework-docs/modules/ROOT/pages/web.adoc | 1 + framework-docs/modules/ROOT/pages/web/webflux-webclient.adoc | 1 + .../modules/ROOT/pages/web/webflux-webclient/client-testing.adoc | 1 + framework-docs/modules/ROOT/pages/web/webflux.adoc | 1 + .../modules/ROOT/pages/web/webflux/controller/ann-methods.adoc | 1 + .../pages/web/webflux/controller/ann-methods/typeconversion.adoc | 1 + framework-docs/modules/ROOT/pages/web/webflux/http2.adoc | 1 + framework-docs/modules/ROOT/pages/web/webflux/security.adoc | 1 + framework-docs/modules/ROOT/pages/web/webflux/uri-building.adoc | 1 + framework-docs/modules/ROOT/pages/web/webmvc-view.adoc | 1 + .../modules/ROOT/pages/web/webmvc-view/mvc-thymeleaf.adoc | 1 + .../modules/ROOT/pages/web/webmvc-view/mvc-xml-marshalling.adoc | 1 + framework-docs/modules/ROOT/pages/web/webmvc.adoc | 1 + framework-docs/modules/ROOT/pages/web/webmvc/mvc-config.adoc | 1 + .../ROOT/pages/web/webmvc/mvc-controller/ann-methods.adoc | 1 + framework-docs/modules/ROOT/pages/web/webmvc/mvc-http2.adoc | 1 + framework-docs/modules/ROOT/pages/web/webmvc/mvc-security.adoc | 1 + .../modules/ROOT/pages/web/webmvc/mvc-servlet/config.adoc | 1 + framework-docs/modules/ROOT/pages/web/websocket.adoc | 1 + framework-docs/modules/ROOT/pages/web/websocket/stomp.adoc | 1 + .../modules/ROOT/pages/web/websocket/stomp/authorization.adoc | 1 + .../modules/ROOT/pages/web/websocket/stomp/benefits.adoc | 1 + 62 files changed, 62 insertions(+) diff --git a/framework-docs/modules/ROOT/pages/core/aop-api.adoc b/framework-docs/modules/ROOT/pages/core/aop-api.adoc index c3c3e571f8f..e159cf1867d 100644 --- a/framework-docs/modules/ROOT/pages/core/aop-api.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop-api.adoc @@ -1,5 +1,6 @@ [[aop-api]] = Spring AOP APIs +:page-section-summary-toc: 1 The previous chapter described the Spring's support for AOP with @AspectJ and schema-based aspect definitions. In this chapter, we discuss the lower-level Spring AOP APIs. For common diff --git a/framework-docs/modules/ROOT/pages/core/aop-api/advisor.adoc b/framework-docs/modules/ROOT/pages/core/aop-api/advisor.adoc index 8bdccc6a73f..2eac0521085 100644 --- a/framework-docs/modules/ROOT/pages/core/aop-api/advisor.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop-api/advisor.adoc @@ -1,5 +1,6 @@ [[aop-api-advisor]] = The Advisor API in Spring +:page-section-summary-toc: 1 In Spring, an Advisor is an aspect that contains only a single advice object associated with a pointcut expression. diff --git a/framework-docs/modules/ROOT/pages/core/aop-api/extensibility.adoc b/framework-docs/modules/ROOT/pages/core/aop-api/extensibility.adoc index b6b9eb68305..8882dfd2da5 100644 --- a/framework-docs/modules/ROOT/pages/core/aop-api/extensibility.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop-api/extensibility.adoc @@ -1,5 +1,6 @@ [[aop-extensibility]] = Defining New Advice Types +:page-section-summary-toc: 1 Spring AOP is designed to be extensible. While the interception implementation strategy is presently used internally, it is possible to support arbitrary advice types in diff --git a/framework-docs/modules/ROOT/pages/core/aop/ataspectj.adoc b/framework-docs/modules/ROOT/pages/core/aop/ataspectj.adoc index 7adfe44de78..952aca1f76c 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/ataspectj.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/ataspectj.adoc @@ -1,5 +1,6 @@ [[aop-ataspectj]] = @AspectJ support +:page-section-summary-toc: 1 @AspectJ refers to a style of declaring aspects as regular Java classes annotated with annotations. The @AspectJ style was introduced by the diff --git a/framework-docs/modules/ROOT/pages/core/aop/introduction-proxies.adoc b/framework-docs/modules/ROOT/pages/core/aop/introduction-proxies.adoc index de27700eaa3..d13db919685 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/introduction-proxies.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/introduction-proxies.adoc @@ -1,5 +1,6 @@ [[aop-introduction-proxies]] = AOP Proxies +:page-section-summary-toc: 1 Spring AOP defaults to using standard JDK dynamic proxies for AOP proxies. This enables any interface (or set of interfaces) to be proxied. diff --git a/framework-docs/modules/ROOT/pages/core/aop/mixing-styles.adoc b/framework-docs/modules/ROOT/pages/core/aop/mixing-styles.adoc index 5b1bb320188..84bb7c41ada 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/mixing-styles.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/mixing-styles.adoc @@ -1,5 +1,6 @@ [[aop-mixing-styles]] = Mixing Aspect Types +:page-section-summary-toc: 1 It is perfectly possible to mix @AspectJ style aspects by using the auto-proxying support, schema-defined `` aspects, `` declared advisors, and even proxies diff --git a/framework-docs/modules/ROOT/pages/core/aop/resources.adoc b/framework-docs/modules/ROOT/pages/core/aop/resources.adoc index 8de6cc35808..e95cb1f9955 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/resources.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/resources.adoc @@ -1,5 +1,6 @@ [[aop-resources]] = Further Resources +:page-section-summary-toc: 1 More information on AspectJ can be found on the https://www.eclipse.org/aspectj[AspectJ website]. diff --git a/framework-docs/modules/ROOT/pages/core/appendix.adoc b/framework-docs/modules/ROOT/pages/core/appendix.adoc index 5993dea520c..deaf39c5c68 100644 --- a/framework-docs/modules/ROOT/pages/core/appendix.adoc +++ b/framework-docs/modules/ROOT/pages/core/appendix.adoc @@ -1,5 +1,6 @@ [[core.appendix]] = Appendix +:page-section-summary-toc: 1 diff --git a/framework-docs/modules/ROOT/pages/core/beans.adoc b/framework-docs/modules/ROOT/pages/core/beans.adoc index f5b17d5fe46..7def6a8c23a 100644 --- a/framework-docs/modules/ROOT/pages/core/beans.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans.adoc @@ -1,5 +1,6 @@ [[beans]] = The IoC Container +:page-section-summary-toc: 1 This chapter covers Spring's Inversion of Control (IoC) container. diff --git a/framework-docs/modules/ROOT/pages/core/beans/dependencies.adoc b/framework-docs/modules/ROOT/pages/core/beans/dependencies.adoc index aa670335d81..e22058a1ff3 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/dependencies.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/dependencies.adoc @@ -1,5 +1,6 @@ [[beans-dependencies]] = Dependencies +:page-section-summary-toc: 1 A typical enterprise application does not consist of a single object (or bean in the Spring parlance). Even the simplest application has a few objects that work together to diff --git a/framework-docs/modules/ROOT/pages/core/beans/java.adoc b/framework-docs/modules/ROOT/pages/core/beans/java.adoc index 146880ab052..9cb9f492b6e 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/java.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/java.adoc @@ -1,5 +1,6 @@ [[beans-java]] = Java-based Container Configuration +:page-section-summary-toc: 1 This section covers how to use annotations in your Java code to configure the Spring container. It includes the following topics: diff --git a/framework-docs/modules/ROOT/pages/core/expressions/language-ref.adoc b/framework-docs/modules/ROOT/pages/core/expressions/language-ref.adoc index c6c7e138d03..f920ac60470 100644 --- a/framework-docs/modules/ROOT/pages/core/expressions/language-ref.adoc +++ b/framework-docs/modules/ROOT/pages/core/expressions/language-ref.adoc @@ -1,5 +1,6 @@ [[expressions-language-ref]] = Language Reference +:page-section-summary-toc: 1 This section describes how the Spring Expression Language works. It covers the following topics: diff --git a/framework-docs/modules/ROOT/pages/data-access.adoc b/framework-docs/modules/ROOT/pages/data-access.adoc index 0c13876f245..df232e910fa 100644 --- a/framework-docs/modules/ROOT/pages/data-access.adoc +++ b/framework-docs/modules/ROOT/pages/data-access.adoc @@ -1,5 +1,6 @@ [[spring-data-tier]] = Data Access +:page-section-summary-toc: 1 This part of the reference documentation is concerned with data access and the interaction between the data access layer and the business or service layer. diff --git a/framework-docs/modules/ROOT/pages/data-access/orm.adoc b/framework-docs/modules/ROOT/pages/data-access/orm.adoc index 5bf7a8ea176..c4f0acb9c86 100644 --- a/framework-docs/modules/ROOT/pages/data-access/orm.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/orm.adoc @@ -1,5 +1,6 @@ [[orm]] = Object Relational Mapping (ORM) Data Access +:page-section-summary-toc: 1 This section covers data access when you use Object Relational Mapping (ORM). diff --git a/framework-docs/modules/ROOT/pages/data-access/transaction/resources.adoc b/framework-docs/modules/ROOT/pages/data-access/transaction/resources.adoc index 62672974575..ca14bac7e4e 100644 --- a/framework-docs/modules/ROOT/pages/data-access/transaction/resources.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/transaction/resources.adoc @@ -1,5 +1,6 @@ [[transaction-resources]] = Further Resources +:page-section-summary-toc: 1 For more information about the Spring Framework's transaction support, see: diff --git a/framework-docs/modules/ROOT/pages/data-access/transaction/solutions-to-common-problems.adoc b/framework-docs/modules/ROOT/pages/data-access/transaction/solutions-to-common-problems.adoc index 2c5ecd6e66e..669760b534f 100644 --- a/framework-docs/modules/ROOT/pages/data-access/transaction/solutions-to-common-problems.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/transaction/solutions-to-common-problems.adoc @@ -1,5 +1,6 @@ [[transaction-solutions-to-common-problems]] = Solutions to Common Problems +:page-section-summary-toc: 1 This section describes solutions to some common problems. diff --git a/framework-docs/modules/ROOT/pages/data-access/transaction/tx-decl-vs-prog.adoc b/framework-docs/modules/ROOT/pages/data-access/transaction/tx-decl-vs-prog.adoc index b90bd9b0ff1..ece5dd419cf 100644 --- a/framework-docs/modules/ROOT/pages/data-access/transaction/tx-decl-vs-prog.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/transaction/tx-decl-vs-prog.adoc @@ -1,5 +1,6 @@ [[tx-decl-vs-prog]] = Choosing Between Programmatic and Declarative Transaction Management +:page-section-summary-toc: 1 Programmatic transaction management is usually a good idea only if you have a small number of transactional operations. For example, if you have a web application that diff --git a/framework-docs/modules/ROOT/pages/integration.adoc b/framework-docs/modules/ROOT/pages/integration.adoc index e4de8269afd..4ab4774f755 100644 --- a/framework-docs/modules/ROOT/pages/integration.adoc +++ b/framework-docs/modules/ROOT/pages/integration.adoc @@ -1,5 +1,6 @@ [[spring-integration]] = Integration +:page-section-summary-toc: 1 This part of the reference documentation covers Spring Framework's integration with a number of technologies. diff --git a/framework-docs/modules/ROOT/pages/integration/cache.adoc b/framework-docs/modules/ROOT/pages/integration/cache.adoc index 689a031b22c..2f763a709d3 100644 --- a/framework-docs/modules/ROOT/pages/integration/cache.adoc +++ b/framework-docs/modules/ROOT/pages/integration/cache.adoc @@ -1,5 +1,6 @@ [[cache]] = Cache Abstraction +:page-section-summary-toc: 1 Since version 3.1, the Spring Framework provides support for transparently adding caching to an existing Spring application. Similar to the xref:data-access/transaction.adoc[transaction] diff --git a/framework-docs/modules/ROOT/pages/integration/cache/plug.adoc b/framework-docs/modules/ROOT/pages/integration/cache/plug.adoc index a4fb38ebb88..56e3aa482ca 100644 --- a/framework-docs/modules/ROOT/pages/integration/cache/plug.adoc +++ b/framework-docs/modules/ROOT/pages/integration/cache/plug.adoc @@ -1,5 +1,6 @@ [[cache-plug]] = Plugging-in Different Back-end Caches +:page-section-summary-toc: 1 Clearly, there are plenty of caching products out there that you can use as a backing store. For those that do not support JSR-107 you need to provide a `CacheManager` and a diff --git a/framework-docs/modules/ROOT/pages/integration/cache/specific-config.adoc b/framework-docs/modules/ROOT/pages/integration/cache/specific-config.adoc index ddddb0ea147..c05c6bda3bd 100644 --- a/framework-docs/modules/ROOT/pages/integration/cache/specific-config.adoc +++ b/framework-docs/modules/ROOT/pages/integration/cache/specific-config.adoc @@ -1,5 +1,6 @@ [[cache-specific-config]] = How can I Set the TTL/TTI/Eviction policy/XXX feature? +:page-section-summary-toc: 1 Directly through your cache provider. The cache abstraction is an abstraction, not a cache implementation. The solution you use might support various data diff --git a/framework-docs/modules/ROOT/pages/integration/jmx/resources.adoc b/framework-docs/modules/ROOT/pages/integration/jmx/resources.adoc index 8c38b77fd46..369ccbf2c19 100644 --- a/framework-docs/modules/ROOT/pages/integration/jmx/resources.adoc +++ b/framework-docs/modules/ROOT/pages/integration/jmx/resources.adoc @@ -1,5 +1,6 @@ [[jmx-resources]] = Further Resources +:page-section-summary-toc: 1 This section contains links to further resources about JMX: diff --git a/framework-docs/modules/ROOT/pages/languages.adoc b/framework-docs/modules/ROOT/pages/languages.adoc index b41773c13e0..ec451606e98 100644 --- a/framework-docs/modules/ROOT/pages/languages.adoc +++ b/framework-docs/modules/ROOT/pages/languages.adoc @@ -1,5 +1,6 @@ [[languages]] = Language Support +:page-section-summary-toc: 1 diff --git a/framework-docs/modules/ROOT/pages/languages/groovy.adoc b/framework-docs/modules/ROOT/pages/languages/groovy.adoc index d0833c2e801..745101a9937 100644 --- a/framework-docs/modules/ROOT/pages/languages/groovy.adoc +++ b/framework-docs/modules/ROOT/pages/languages/groovy.adoc @@ -1,5 +1,6 @@ [[groovy]] = Apache Groovy +:page-section-summary-toc: 1 Groovy is a powerful, optionally typed, and dynamic language, with static-typing and static compilation capabilities. It offers a concise syntax and integrates smoothly with any diff --git a/framework-docs/modules/ROOT/pages/languages/kotlin.adoc b/framework-docs/modules/ROOT/pages/languages/kotlin.adoc index 3a6b2482076..c6beb7f4a6c 100644 --- a/framework-docs/modules/ROOT/pages/languages/kotlin.adoc +++ b/framework-docs/modules/ROOT/pages/languages/kotlin.adoc @@ -1,5 +1,6 @@ [[kotlin]] = Kotlin +:page-section-summary-toc: 1 https://kotlinlang.org[Kotlin] is a statically typed language that targets the JVM (and other platforms) which allows writing concise and elegant code while providing diff --git a/framework-docs/modules/ROOT/pages/languages/kotlin/classes-interfaces.adoc b/framework-docs/modules/ROOT/pages/languages/kotlin/classes-interfaces.adoc index 63a87b34651..5dd4520dd9f 100644 --- a/framework-docs/modules/ROOT/pages/languages/kotlin/classes-interfaces.adoc +++ b/framework-docs/modules/ROOT/pages/languages/kotlin/classes-interfaces.adoc @@ -1,5 +1,6 @@ [[kotlin-classes-interfaces]] = Classes and Interfaces +:page-section-summary-toc: 1 The Spring Framework supports various Kotlin constructs, such as instantiating Kotlin classes through primary constructors, immutable classes data binding, and function optional parameters diff --git a/framework-docs/modules/ROOT/pages/languages/kotlin/requirements.adoc b/framework-docs/modules/ROOT/pages/languages/kotlin/requirements.adoc index 6c453db075a..80a2b48fc15 100644 --- a/framework-docs/modules/ROOT/pages/languages/kotlin/requirements.adoc +++ b/framework-docs/modules/ROOT/pages/languages/kotlin/requirements.adoc @@ -1,5 +1,6 @@ [[kotlin-requirements]] = Requirements +:page-section-summary-toc: 1 Spring Framework supports Kotlin 1.3+ and requires https://search.maven.org/artifact/org.jetbrains.kotlin/kotlin-stdlib[`kotlin-stdlib`] diff --git a/framework-docs/modules/ROOT/pages/testing.adoc b/framework-docs/modules/ROOT/pages/testing.adoc index 6339dbbe14b..ee17a98bb36 100644 --- a/framework-docs/modules/ROOT/pages/testing.adoc +++ b/framework-docs/modules/ROOT/pages/testing.adoc @@ -1,5 +1,6 @@ [[testing]] = Testing +:page-section-summary-toc: 1 This chapter covers Spring's support for integration testing and best practices for unit testing. The Spring team advocates test-driven development (TDD). The Spring team has diff --git a/framework-docs/modules/ROOT/pages/testing/annotations.adoc b/framework-docs/modules/ROOT/pages/testing/annotations.adoc index 6e0ce2f52cd..ba8c15c9b30 100644 --- a/framework-docs/modules/ROOT/pages/testing/annotations.adoc +++ b/framework-docs/modules/ROOT/pages/testing/annotations.adoc @@ -1,5 +1,6 @@ [[integration-testing-annotations]] = Annotations +:page-section-summary-toc: 1 This section covers annotations that you can use when you test Spring applications. It includes the following topics: diff --git a/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-bootstrapwith.adoc b/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-bootstrapwith.adoc index be83db1212f..5769b3d3d3f 100644 --- a/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-bootstrapwith.adoc +++ b/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-bootstrapwith.adoc @@ -1,5 +1,6 @@ [[spring-testing-annotation-bootstrapwith]] = `@BootstrapWith` +:page-section-summary-toc: 1 `@BootstrapWith` is a class-level annotation that you can use to configure how the Spring TestContext Framework is bootstrapped. Specifically, you can use `@BootstrapWith` to diff --git a/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-recordapplicationevents.adoc b/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-recordapplicationevents.adoc index 51a1c210002..fbd7f0cf03f 100644 --- a/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-recordapplicationevents.adoc +++ b/framework-docs/modules/ROOT/pages/testing/annotations/integration-spring/annotation-recordapplicationevents.adoc @@ -1,5 +1,6 @@ [[spring-testing-annotation-recordapplicationevents]] = `@RecordApplicationEvents` +:page-section-summary-toc: 1 `@RecordApplicationEvents` is a class-level annotation that is used to instruct the _Spring TestContext Framework_ to record all application events that are published in the diff --git a/framework-docs/modules/ROOT/pages/testing/appendix.adoc b/framework-docs/modules/ROOT/pages/testing/appendix.adoc index 580253377df..b831676c579 100644 --- a/framework-docs/modules/ROOT/pages/testing/appendix.adoc +++ b/framework-docs/modules/ROOT/pages/testing/appendix.adoc @@ -1,4 +1,5 @@ [[testing.appendix]] = Appendix +:page-section-summary-toc: 1 diff --git a/framework-docs/modules/ROOT/pages/testing/introduction.adoc b/framework-docs/modules/ROOT/pages/testing/introduction.adoc index 71bf53da367..8618c99a44c 100644 --- a/framework-docs/modules/ROOT/pages/testing/introduction.adoc +++ b/framework-docs/modules/ROOT/pages/testing/introduction.adoc @@ -1,5 +1,6 @@ [[testing-introduction]] = Introduction to Spring Testing +:page-section-summary-toc: 1 Testing is an integral part of enterprise software development. This chapter focuses on the value added by the IoC principle to xref:testing/unit.adoc[unit testing] and on the benefits diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework.adoc index 19ed8922155..ec1900709d2 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-framework]] = MockMvc +:page-section-summary-toc: 1 The Spring MVC Test framework, also known as MockMvc, provides support for testing Spring MVC applications. It performs full Spring MVC request handling but via mock request and diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-filters.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-filters.adoc index 4dd5c1abd34..ad3c33b5192 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-filters.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-filters.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-server-filters]] = Filter Registrations +:page-section-summary-toc: 1 When setting up a `MockMvc` instance, you can register one or more Servlet `Filter` instances, as the following example shows: diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-htmlunit.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-htmlunit.adoc index fda2259ef34..03895dfa44e 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-htmlunit.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-htmlunit.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-server-htmlunit]] = HtmlUnit Integration +:page-section-summary-toc: 1 Spring provides integration between xref:testing/spring-mvc-test-framework/server.adoc[MockMvc] and https://htmlunit.sourceforge.io/[HtmlUnit]. This simplifies performing end-to-end testing diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-resources.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-resources.adoc index 21a6592973e..7444c1038fb 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-resources.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-resources.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-server-resources]] = Further Examples +:page-section-summary-toc: 1 The framework's own tests include {spring-framework-main-code}/spring-test/src/test/java/org/springframework/test/web/servlet/samples[ diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-static-imports.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-static-imports.adoc index a082636a620..21ccea19311 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-static-imports.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server-static-imports.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-server-static-imports]] = Static Imports +:page-section-summary-toc: 1 When using MockMvc directly to perform requests, you'll need static imports for: diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server.adoc index f319cabb9ac..2368a5a96c4 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-framework/server.adoc @@ -1,5 +1,6 @@ [[spring-mvc-test-server]] = Overview +:page-section-summary-toc: 1 You can write plain unit tests for Spring MVC by instantiating a controller, injecting it with dependencies, and calling its methods. However such tests do not verify request diff --git a/framework-docs/modules/ROOT/pages/testing/testcontext-framework.adoc b/framework-docs/modules/ROOT/pages/testing/testcontext-framework.adoc index 0acb1ddcb73..0cf24faa9aa 100644 --- a/framework-docs/modules/ROOT/pages/testing/testcontext-framework.adoc +++ b/framework-docs/modules/ROOT/pages/testing/testcontext-framework.adoc @@ -1,5 +1,6 @@ [[testcontext-framework]] = Spring TestContext Framework +:page-section-summary-toc: 1 The Spring TestContext Framework (located in the `org.springframework.test.context` package) provides generic, annotation-driven unit and integration testing support that is diff --git a/framework-docs/modules/ROOT/pages/web.adoc b/framework-docs/modules/ROOT/pages/web.adoc index 2cfb7be73e5..76ebcfc9068 100644 --- a/framework-docs/modules/ROOT/pages/web.adoc +++ b/framework-docs/modules/ROOT/pages/web.adoc @@ -1,5 +1,6 @@ [[spring-web]] = Web on Servlet Stack +:page-section-summary-toc: 1 This part of the documentation covers support for Servlet-stack web applications built on the Servlet API and deployed to Servlet containers. Individual chapters include xref:web/webmvc.adoc#mvc[Spring MVC], diff --git a/framework-docs/modules/ROOT/pages/web/webflux-webclient.adoc b/framework-docs/modules/ROOT/pages/web/webflux-webclient.adoc index 4b4a7c845b5..effa703ab60 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux-webclient.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux-webclient.adoc @@ -1,5 +1,6 @@ [[webflux-client]] = WebClient +:page-section-summary-toc: 1 Spring WebFlux includes a client to perform HTTP requests with. `WebClient` has a functional, fluent API based on Reactor, see xref:web-reactive.adoc#webflux-reactive-libraries[Reactive Libraries], diff --git a/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-testing.adoc b/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-testing.adoc index 756e5172c51..8b1393cc52b 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-testing.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-testing.adoc @@ -1,5 +1,6 @@ [[webflux-client-testing]] = Testing +:page-section-summary-toc: 1 To test code that uses the `WebClient`, you can use a mock web server, such as the https://github.com/square/okhttp#mockwebserver[OkHttp MockWebServer]. To see an example diff --git a/framework-docs/modules/ROOT/pages/web/webflux.adoc b/framework-docs/modules/ROOT/pages/web/webflux.adoc index 57b07ca6a16..a9487c93739 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux.adoc @@ -2,6 +2,7 @@ :chapter: webflux [[spring-webflux]] = Spring WebFlux +:page-section-summary-toc: 1 The original web framework included in the Spring Framework, Spring Web MVC, was purpose-built for the Servlet API and Servlet containers. The reactive-stack web framework, diff --git a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods.adoc b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods.adoc index 7c073797e8b..6930c9dbda1 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods.adoc @@ -1,5 +1,6 @@ [[webflux-ann-methods]] = Handler Methods +:page-section-summary-toc: 1 [.small]#xref:web/webmvc/mvc-controller/ann-methods.adoc[See equivalent in the Servlet stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/typeconversion.adoc b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/typeconversion.adoc index c1b58f2bdd5..ca61ec37c5c 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/typeconversion.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/typeconversion.adoc @@ -1,5 +1,6 @@ [[webflux-ann-typeconversion]] = Type Conversion +:page-section-summary-toc: 1 [.small]#xref:web/webmvc/mvc-controller/ann-methods/typeconversion.adoc[See equivalent in the Servlet stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webflux/http2.adoc b/framework-docs/modules/ROOT/pages/web/webflux/http2.adoc index 0ae23f06610..39f080c1017 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/http2.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/http2.adoc @@ -1,5 +1,6 @@ [[webflux-http2]] = HTTP/2 +:page-section-summary-toc: 1 [.small]#xref:web/webmvc/mvc-http2.adoc[See equivalent in the Servlet stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webflux/security.adoc b/framework-docs/modules/ROOT/pages/web/webflux/security.adoc index 9f0e759098a..4c448e3cba7 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/security.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/security.adoc @@ -1,5 +1,6 @@ [[webflux-web-security]] = Web Security +:page-section-summary-toc: 1 [.small]#xref:web/webmvc/mvc-security.adoc[See equivalent in the Servlet stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webflux/uri-building.adoc b/framework-docs/modules/ROOT/pages/web/webflux/uri-building.adoc index 4df30015105..559fcd2479e 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/uri-building.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/uri-building.adoc @@ -1,5 +1,6 @@ [[webflux-uri-building]] = URI Links +:page-section-summary-toc: 1 [.small]#xref:web/webmvc/mvc-uri-building.adoc[See equivalent in the Servlet stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc-view.adoc b/framework-docs/modules/ROOT/pages/web/webmvc-view.adoc index d0547f6fa6d..e6af04b7fe2 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc-view.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc-view.adoc @@ -1,5 +1,6 @@ [[mvc-view]] = View Technologies +:page-section-summary-toc: 1 [.small]#xref:web/webflux-view.adoc[See equivalent in the Reactive stack]# The use of view technologies in Spring MVC is pluggable. Whether you decide to use diff --git a/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-thymeleaf.adoc b/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-thymeleaf.adoc index 53c69f2a37a..48cf0c6d5ab 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-thymeleaf.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-thymeleaf.adoc @@ -1,5 +1,6 @@ [[mvc-view-thymeleaf]] = Thymeleaf +:page-section-summary-toc: 1 [.small]#xref:web/webflux-view.adoc#webflux-view-thymeleaf[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-xml-marshalling.adoc b/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-xml-marshalling.adoc index 2b8ccd547db..74f65108f21 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-xml-marshalling.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc-view/mvc-xml-marshalling.adoc @@ -1,5 +1,6 @@ [[mvc-view-xml-marshalling]] = XML Marshalling +:page-section-summary-toc: 1 The `MarshallingView` uses an XML `Marshaller` (defined in the `org.springframework.oxm` package) to render the response content as XML. You can explicitly set the object to be diff --git a/framework-docs/modules/ROOT/pages/web/webmvc.adoc b/framework-docs/modules/ROOT/pages/web/webmvc.adoc index 4578acc9528..d75c3c84250 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc.adoc @@ -2,6 +2,7 @@ :chapter: mvc [[spring-web-mvc]] = Spring Web MVC +:page-section-summary-toc: 1 Spring Web MVC is the original web framework built on the Servlet API and has been included in the Spring Framework from the very beginning. The formal name, "Spring Web MVC," diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config.adoc index 0b3446d5066..a29ad9a6e2b 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config.adoc @@ -1,5 +1,6 @@ [[mvc-config]] = MVC Config +:page-section-summary-toc: 1 [.small]#xref:web/webflux/dispatcher-handler.adoc#webflux-framework-config[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods.adoc index d5717e459c1..853e26607d9 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods.adoc @@ -1,5 +1,6 @@ [[mvc-ann-methods]] = Handler Methods +:page-section-summary-toc: 1 [.small]#xref:web/webflux/controller/ann-methods.adoc[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-http2.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-http2.adoc index 429b619ac64..17a10e537f7 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-http2.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-http2.adoc @@ -1,5 +1,6 @@ [[mvc-http2]] = HTTP/2 +:page-section-summary-toc: 1 [.small]#xref:web/webflux/http2.adoc[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-security.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-security.adoc index d704b7e176c..5b6aca1f70a 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-security.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-security.adoc @@ -1,5 +1,6 @@ [[mvc-web-security]] = Web Security +:page-section-summary-toc: 1 [.small]#xref:web/webflux/security.adoc[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/config.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/config.adoc index 8a230334445..64fcc6e1be6 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/config.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/config.adoc @@ -1,5 +1,6 @@ [[mvc-servlet-config]] = Web MVC Config +:page-section-summary-toc: 1 [.small]#xref:web/webflux/dispatcher-handler.adoc#webflux-framework-config[See equivalent in the Reactive stack]# diff --git a/framework-docs/modules/ROOT/pages/web/websocket.adoc b/framework-docs/modules/ROOT/pages/web/websocket.adoc index 79665ef428b..d9fd668f030 100644 --- a/framework-docs/modules/ROOT/pages/web/websocket.adoc +++ b/framework-docs/modules/ROOT/pages/web/websocket.adoc @@ -1,5 +1,6 @@ [[websocket]] = WebSockets +:page-section-summary-toc: 1 [.small]#xref:web/webflux-websocket.adoc[See equivalent in the Reactive stack]# This part of the reference documentation covers support for Servlet stack, WebSocket diff --git a/framework-docs/modules/ROOT/pages/web/websocket/stomp.adoc b/framework-docs/modules/ROOT/pages/web/websocket/stomp.adoc index cc66fcb400e..405d956c8a1 100644 --- a/framework-docs/modules/ROOT/pages/web/websocket/stomp.adoc +++ b/framework-docs/modules/ROOT/pages/web/websocket/stomp.adoc @@ -1,5 +1,6 @@ [[websocket-stomp]] = STOMP +:page-section-summary-toc: 1 The WebSocket protocol defines two types of messages (text and binary), but their content is undefined. The protocol defines a mechanism for client and server to negotiate a diff --git a/framework-docs/modules/ROOT/pages/web/websocket/stomp/authorization.adoc b/framework-docs/modules/ROOT/pages/web/websocket/stomp/authorization.adoc index 38ba93b459f..5866ec3dc52 100644 --- a/framework-docs/modules/ROOT/pages/web/websocket/stomp/authorization.adoc +++ b/framework-docs/modules/ROOT/pages/web/websocket/stomp/authorization.adoc @@ -1,5 +1,6 @@ [[websocket-stomp-authorization]] = Authorization +:page-section-summary-toc: 1 Spring Security provides {docs-spring-security}/servlet/integrations/websocket.html#websocket-authorization[WebSocket sub-protocol authorization] diff --git a/framework-docs/modules/ROOT/pages/web/websocket/stomp/benefits.adoc b/framework-docs/modules/ROOT/pages/web/websocket/stomp/benefits.adoc index a4bcb1fdff1..31e3e7f3224 100644 --- a/framework-docs/modules/ROOT/pages/web/websocket/stomp/benefits.adoc +++ b/framework-docs/modules/ROOT/pages/web/websocket/stomp/benefits.adoc @@ -1,5 +1,6 @@ [[websocket-stomp-benefits]] = Benefits +:page-section-summary-toc: 1 Using STOMP as a sub-protocol lets the Spring Framework and Spring Security provide a richer programming model versus using raw WebSockets. The same point can be