Skip to content

Improve documentation of matrix variables. #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28780,6 +28780,38 @@ Note that to enable the use of matrix variables, you must set the
`removeSemicolonContent` property of `RequestMappingHandlerMapping` to `false`. By
default it is set to `true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above text should not be deleted IMO. It covers those who use neither the MVC namespace nor the MVC Java config. It makes sense to keep it as information on where the configuration setting lives. Then the tip explains how it relates to MVC namespace and Java config users.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is redundant information to me (I didn't delete it, I moved it). Would be this useful when not using Java config? If so, that's what I am missing.


[TIP]
====

The MVC Java config and the MVC namespace both provide options for enabling the use of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be useful to add a reference to the section on "Advanced Customizations with MVC Java Config" since the above is not possible to do with the @EnableWebMvc/WebMvcConfigurer combo which is the starting point for using the MVC java config.

matrix variables.

If you are using Java config, The <<mvc-config-advanced-java, Advanced Customizations
with MVC Java Config>> section describes how the `RequestMappingHandlerMapping` can
be customized.

In the MVC namespace, the `<mvc:annotation-driven>` element has an
`enableMatrixVariables` attribute that should be set to `true`. By default it is set
to `false`.

[source,xml,indent=0]
[subs="verbatim,quotes"]
----
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">

<mvc:annotation-driven enableMatrixVariables="true"/>

</beans>
----
====

[[mvc-ann-requestmapping-consumes]]
===== Consumable Media Types
Expand Down