diff --git a/xdoc/xdocs/index.xml b/xdoc/xdocs/index.xml index 29326e18..12331675 100644 --- a/xdoc/xdocs/index.xml +++ b/xdoc/xdocs/index.xml @@ -9,12 +9,16 @@

- This plug-in provides the primary mechanism that is used to produce - the Maven documentation. + The Xdoc plugin is the primary mechanism used to produce the + Maven-generated documentation as well as any user supplied + "xdocs". An xdoc is an XML document conforming to a small and + simple set of tags. Maven uses this format extensively. All + Maven-generated reports are first generated as an xdoc, which + is then transformed to HTML via this plugin.

- The documentation is mainly in Anakia format. More information - along with samples, can be found at: + The documentation is mainly in Anakia format. More + information along with samples, can be found at:

- There is addition to the anakia format. You can use the footer tag for including - text or images just below the navigation menu and above the copyright notice. - This tag is only usefull in the navigation.xml file.
- Here is an example :
- footer tag for including text or images just below + the navigation menu and above the copyright notice. This tag is + only usefull in the navigation.xml file and should be placed + within the body element. For example: +

+ - ]]> -
- The footer should be placed within the body element. + ]]> +

+ In addition to xdocs, users may wish to include other types of + files such as images, their own HTML files, PDFs, etc. By + default, this plugin will copy all files located in the + maven.docs.src directory (xdocs by + default) to the final generated site.