From 1872f3c4c954257169cff50840fa916b23d14ee0 Mon Sep 17 00:00:00 2001 From: Scott Murphy Date: Sat, 4 Nov 2023 18:52:04 -0500 Subject: [PATCH] Basic configuration documentation. --- CONFIGURATION.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONFIGURATION.md diff --git a/CONFIGURATION.md b/CONFIGURATION.md new file mode 100644 index 0000000..084b470 --- /dev/null +++ b/CONFIGURATION.md @@ -0,0 +1,26 @@ +# XML Configuration Defaults + +The following is `/WEB-INF/sitemesh3.xml` file that shows default settings that may be overriden. These settings are not required because this configuration is demonstrating what the default setting is and what you would change if you would prefer something else. +```xml + + org.sitemesh.config.MetaTagBasedDecoratorSelector + /WEB-INF/decorators/ + true + +``` + +Decorator Mapping Support +```xml + + + + + +``` + +| Option | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| decorator-selector | The Decorator Selector to be used. This controls how decorators are applied to content. This can be done based on path, meta tags, request attributes, etc. Examples include `MetaTagBasedDecoratorSelector`, `PathBasedDecoratorSelector`, `RequestAttributeDecoratorSelector`. The default is `MetaTagBasedDecoratorSelector` | +| decorator-prefix | The default prefix/location of decorators. You can set this to blank `""` if you wish to have decorators in more than one location. The default value is `/WEB-INF/decorators/` | +| include-error-pages | If an error occurs inside a decorator, should the error page be shown or ignored. This is only the behavior for errors that happen inside a decorator. The default is value is `true` | +| mapping | Specifies a PathBasedDecoratorSelector mapping using a `path` and (`decorator` or `exclude`) attributes. Use `decorator` if you want to apply the specified decorator to that path or `exclude` if you want that path excluded from decoration. | \ No newline at end of file