liferay-friendly-url-routes_7_4_0.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

liferay-friendly-url-routes_7_4_0.dtd

<!DOCTYPE routes PUBLIC "-//Liferay//DTD Friendly URL Routes 7.4.0//EN" "http://www.liferay.com/dtd/liferay-friendly-url-routes_7_4_0.dtd">



<routes> Root element

The routes element is the root of the deployment descriptor for a set of Liferay friendly URL mapper routes.

<routes>'s children
NameCardinality
routeAny number
Element's model:

(route*)


<route> Child of routes

The route element contains information on a single route.

<route>'s children
NameCardinality
generated-parameterAny number
ignored-parameterAny number
implicit-parameterAny number
overridden-parameterAny number
patternOnly one
Element's model:

(pattern, generated-parameter*, ignored-parameter*, implicit-parameter*, overridden-parameter*)


<pattern> Child of route

The pattern element specifies the pattern of the mapped friendly URL.


<generated-parameter> Child of route

The generated-parameter element specifies the pattern of a parameter that will be generated from other parameters when a URL is recognized. When a URL is built, these virtual parameters will be parsed from the generated parameter and made available in the route pattern for constructing the URL.

<generated-parameter>'s attributes
NameValuesDefault
name

@name Attribute of generated-parameter

The name attribute specifies the name of the generated parameter.

Required


<ignored-parameter/> Child of route

The ignored-parameter element specifies a parameter that should be ignored and not included in generated URLs. Ignored parameters do not effect URL recognition.

<ignored-parameter>'s attributes
NameValuesDefault
name

This element is always empty.


@name Attribute of ignored-parameter

The name attribute specifies the name of the parameter to be ignored.

Required


<implicit-parameter> Child of route

The implicit-parameter element specifies a parameter that is not present in the route pattern.

<implicit-parameter>'s attributes
NameValuesDefault
name

@name Attribute of implicit-parameter

The name attribute specifies the name of the default URL parameter.

Required


<overridden-parameter> Child of route

The overridden-parameter element specifies a parameter that should be set to a certain value when a URL is recognized. This override value will be set regardless of any preexisting value, including one from a implicit-parameter or one extracted from the URL.

<overridden-parameter>'s attributes
NameValuesDefault
name

@name Attribute of overridden-parameter

The name attribute specifies the name of the parameter to be overridden.

Required