| ----- |
| Doxia Sitetool Decoration Model |
| ----- |
| Hervé Boutemy |
| ----- |
| 2011-08-18 |
| ----- |
| |
| ~~ Licensed to the Apache Software Foundation (ASF) under one |
| ~~ or more contributor license agreements. See the NOTICE file |
| ~~ distributed with this work for additional information |
| ~~ regarding copyright ownership. The ASF licenses this file |
| ~~ to you under the Apache License, Version 2.0 (the |
| ~~ "License"); you may not use this file except in compliance |
| ~~ with the License. You may obtain a copy of the License at |
| ~~ |
| ~~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~~ |
| ~~ Unless required by applicable law or agreed to in writing, |
| ~~ software distributed under the License is distributed on an |
| ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~~ KIND, either express or implied. See the License for the |
| ~~ specific language governing permissions and limitations |
| ~~ under the License. |
| |
| ~~ NOTE: For help with the syntax of this file, see: |
| ~~ http://maven.apache.org/doxia/references/apt-format.html |
| |
| Doxia Sitetool Decoration Model |
| |
| This is strictly the model for Doxia Sitetool Decoration Model, used in maven-site-plugin as <<<site.xml>>> to inject |
| parameters into decoration template: see {{{../doxia-site-renderer/}Doxia Site Renderer}} for more details on site rendering. |
| |
| The following are generated from this model: |
| |
| * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser |
| |
| * A {{{./decoration.html}Descriptor Reference}} |
| |
| * An XSD referenced in the {{{./decoration.html}Descriptor Reference}}. |
| |
| * Inheritance |
| |
| Decoration model can be merged from a parent <<<site.xml>>> into a child <<<site.xml>>> using |
| <<<DecorationModelInheritanceAssembler>>> ({{{./apidocs/org/apache/maven/doxia/site/decoration/inheritance/DecorationModelInheritanceAssembler.html}javadoc}}) |
| with its <<<DefaultDecorationModelInheritanceAssembler>>> implementation |
| ({{{./xref/org/apache/maven/doxia/site/decoration/inheritance/DefaultDecorationModelInheritanceAssembler.html}source}}). |
| |
