root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity
spring-framework/src/docs/asciidoc/web.adoc

22 lines
778 B
Plaintext
Raw Normal View History

Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
[[spring-web]]
Web documentation update Issue: SPR-15149
2017-09-13 02:57:47 +08:00
= Web on Servlet Stack
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
:doc-root: https://docs.spring.io
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
Fix link references between documents Issue: SPR-14997
2017-03-29 20:20:12 +08:00
:toc: left
:toclevels: 2
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Web documentation update Issue: SPR-15149
2017-09-13 02:57:47 +08:00
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 <<mvc,Spring MVC>>,
<<mvc-view,View Technologies>>, <<mvc-cors,CORS Support>>, and <<websocket,WebSocket Support>>.
The next section covers support for <<reactive-web.adoc#spring-reactive-web,reactive web>> applications.
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Provide distinct Web and Reactive Web sections This change allows much more usable TOC for the reactive stack and will make WebFlux documentation easier to contribute thanks to a clearer split between both stacks. Issue: SPR-15149
2017-08-23 22:00:26 +08:00
include::web/webmvc.adoc[leveloffset=+1]
Move up CORS section The CORS section is now ahead of "Integrating with other web frameworks" and "WebSocket Support".
2016-07-25 23:44:12 +08:00
Provide distinct Web and Reactive Web sections This change allows much more usable TOC for the reactive stack and will make WebFlux documentation easier to contribute thanks to a clearer split between both stacks. Issue: SPR-15149
2017-08-23 22:00:26 +08:00
include::web/webmvc-view.adoc[leveloffset=+1]
include::web/webmvc-cors.adoc[leveloffset=+1]
include::web/websocket.adoc[leveloffset=+1]
Add chapter on Spring Web Reactive support Issue: SPR-14497
2016-07-26 06:33:43 +08:00
Prepare Web section for Servlet vs Reactive content Refer to both Servlet and reactive stacks in web.adoc Move web-integration.adoc to the very end Link in web-flux-functional.adoc Insert "Spring Web MVC" or "Servlet" prefix in chapter titles Issue: SPR-15149
2017-08-17 18:45:11 +08:00