Skip to content

Commit 825449a

Browse files
committed
Introduce a link to go back to refdoc index
1 parent cad51d1 commit 825449a

File tree

10 files changed

+27
-6
lines changed

10 files changed

+27
-6
lines changed

src/docs/asciidoc/appendix.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:wiki-spring-framework: https://github.com/spring-projects/spring-framework/wiki
66
:toc: left
77
:toclevels: 2
8+
:docinfo1:
89

910
[[spring-whats-new]]
1011
== What's New in the Spring Framework

src/docs/asciidoc/core.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55
:toc: left
66
:toclevels: 2
7+
:docinfo1:
78

89
This part of the reference documentation covers all of those technologies that are
910
absolutely integral to the Spring Framework.

src/docs/asciidoc/data-access.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55
:toc: left
66
:toclevels: 2
7+
:docinfo1:
78

89
This part of the reference documentation is concerned with data access and the
910
interaction between the data access layer and the business or service layer.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<script>
2+
var rootLink = document.createElement("a");
3+
rootLink.setAttribute("href", "index.html");
4+
rootLink.innerHTML = "<i class=\"fa fa-chevron-left\" aria-hidden=\"true\"></i>&nbsp;&nbsp;Back to index";
5+
var p = document.createElement("p");
6+
p.appendChild(rootLink);
7+
var toc = document.getElementById('toc')
8+
var sectlevel1 = toc.getElementsByClassName("sectlevel1")[0]
9+
toc.insertBefore(p, sectlevel1);
10+
</script>

src/docs/asciidoc/integration.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
:doc-spring-gemfire: {doc-root}/spring-gemfire/docs/current/reference
77
:toc: left
88
:toclevels: 2
9+
:docinfo1:
910

1011
This part of the reference documentation covers the Spring Framework's integration with
1112
a number of Java EE (and related) technologies.

src/docs/asciidoc/kotlin.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55
:toc: left
66
:toclevels: 2
7+
:docinfo1:
78

89
[[introduction]]
910
== Introduction

src/docs/asciidoc/overview.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
== Spring Framework Overview
1+
:toc: left
2+
:toclevels: 1
3+
:docinfo1:
4+
= Spring Framework Overview
25

36
Spring makes it easy to create Java enterprise applications. It provides everything you
47
need beyond the Java language itself. It also provides extensions and support for
@@ -14,7 +17,7 @@ Spring is open source. It has a large and active community that provides continu
1417
based on a diverse range of real-world use cases. This has helped Spring to successfully
1518
evolve over a very long time.
1619

17-
=== What We Mean by "Spring"
20+
== What We Mean by "Spring"
1821

1922
The term, "Spring," means different things in different contexts. It can be used to refer to
2023
the Spring Framework project itself, which is where it all started. Over time, other Spring
@@ -29,7 +32,7 @@ support for different application architectures, including messaging, transactio
2932
persistence, and web. It also includes the servlet-based Spring MVC web framework and, in
3033
parallel, the Spring WebFlux reactive web framework.
3134

32-
=== History of Spring and the Spring Framework
35+
== History of Spring and the Spring Framework
3336

3437
Spring came into being in 2003 as a response to the complexity of the early
3538
https://en.wikipedia.org/wiki/Java_Platform,_Enterprise_Edition[J2EE] specifications.
@@ -62,7 +65,7 @@ among others. It’s important to remember that each project has its own source
6265
issue tracker, and release cadence. See https://spring.io/projects[spring.io/projects] for
6366
the complete list of Spring projects.
6467

65-
=== Design Philosophy
68+
== Design Philosophy
6669

6770
When you learn about a framework, it’s important to know not only what it does but what
6871
principles it follows. Here are the guiding principles of the Spring Framework:
@@ -84,7 +87,7 @@ that are intuitive and that hold up across many versions and many years.
8487
meaningful, current, and accurate Javadoc. It is one of very few projects that can claim
8588
clean code structure with no circular dependencies between packages.
8689

87-
=== Feedback and Contributions
90+
== Feedback and Contributions
8891

8992
For how-to questions or diagnosing or debugging issues, we suggest using StackOverflow,
9093
and we have a https://spring.io/questions[questions page] that lists the suggested tags to use.
@@ -103,7 +106,7 @@ information that is not specific to any one version. For example, it has migrati
103106
notes from earlier versions, comprehensive information on what's new across multiple
104107
versions, contributor guidelines, the Spring Framework code style, and other information.
105108

106-
=== Getting Started
109+
== Getting Started
107110

108111
If you are just getting started with Spring, you may want to begin using the Spring
109112
Framework by creating a http://projects.spring.io/spring-boot/[Spring Boot]-based

src/docs/asciidoc/reactive-web.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55
:toc: left
66
:toclevels: 3
7+
:docinfo1:
78

89
This part of the documentation covers support for reactive stack, web applications built on
910
http://www.reactive-streams.org/[Reactive Streams] and adapted to non-blocking runtimes

src/docs/asciidoc/testing.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:doc-spring-boot: {doc-root}/spring-boot/docs/current/reference
66
:toc: left
77
:toclevels: 2
8+
:docinfo1:
89

910
The adoption of the test-driven-development (TDD) approach to software
1011
development is certainly advocated by the Spring team, and so coverage of Spring's

src/docs/asciidoc/web.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
55
:toc: left
66
:toclevels: 2
7+
:docinfo1:
78

89
This part of the documentation covers support for Servlet stack, web applications built on the
910
Servlet API and deployed to Servlet containers. Individual chapters include <<mvc,Spring MVC>>,

0 commit comments

Comments
 (0)