Module Docs (Version 1)

Documentation Module

The documentation deployment module is responsible for generating the HTML documentation for the API, including links to any other static content such as client libraries.

Configuration

The configuration for the documentation deployment module is specified by the docs element under the modules element in the Enunciate configuration file. The following attributes are supported on the docs element:

attribute	description
docsDir	The "docsDir" attribute is the subdirectory to which the documentation will be put. The default is the root.
splashPackage	The "splashPackage" attribute specifies the package that contains the documentation to use as the introduction to the API documentation. By default, no text is used for the introduction.
copyright	The "copyright" attribute specifies the text for the copyright holder on the web page. By default, there is no copyright information displayed on the webpage.
title	The "title" specifies the title of the generated HTML pages. By default, the title is "Web API".
includeDefaultDownloads	The "includeDefaultDownloads" is a boolean attribute specifying whether the default downloads should be included. The default is "true".
includeExampleXml	The "includeExampleXml" is a boolean attribute specifying whether example XML should be included. The default is "true".
includeExampleJson	The "includeExampleJson" is a boolean attribute specifying whether example JSON should be included. The default is "true" if jackson-xc is on the classpath and "false" otherwise.
includeDeprecatedFieldsInExample	The "includeDeprecatedFieldsInExample" is a boolean attribute specyfing whether deprecated fields should be included in the examples controlled by "includeExampleXml" and "includeExampleJson". The default is "true".
css	The "css" attribute is used to specify the file to be used as the cascading stylesheet for the HTML. If one isn't supplied, a default will be provided.
indexPageName	The "indexPageName" attribute is used to specify the name of the generated index page. Default: "index.html"
xslt	The "xslt" attribute specifies the file that is the XML Stylesheet Transform that will be applied to the documentation XML to generate the HTML docs. If no XSLT is specified, the freemarker XML processing template will be used to process the XML.
xsltURL	The "xsltURL" attribute specifies the URL to the XML Stylesheet Transform that will be applied to the documentation XML to generate the HTML docs. If no XSLT is specified, the freemarker XML processing template will be used to process the XML.
freemarkerXMLProcessingTemplate	The "freemarkerXMLProcessingTemplate" attribute specifies the file that is the freemarker XML processing template to use to generate the site. See the Freemarker XML Processing Guide. If none is supplied, a default one will be used.
freemarkerXMLProcessingTemplateURL	The "freemarkerXMLProcessingTemplateURL" attribute specifies the URL to the freemarker XML processing template to use to generate the site. See the Freemarker XML Processing Guide. If none is supplied, a default one will be used.
freemarkerDocsXMLTemplate	The "freemarkerDocsXMLTemplate" attribute specifies the file that is the freemarker template to use to generate the docs.xml. If none is supplied, a default one will be used.
freemarkerDocsXMLTemplateURL	The "freemarkerDocsXMLTemplateURL" attribute specifies the URL to the freemarker template to use to generate the docs.xml. If none is supplied, a default one will be used.
baseThe "base" attribute specifies a gzipped file or a directory to use as the documentation base. If none is supplied, a default base will be provided.
javadocTagHandling	The "javadocTagHandling" attribute is used to specify the handling of JavaDoc tags. It must be either "OFF" or the FQN of an instance of net.sf.jelly.apt.util.JavaDocTagHandler
groupRestResources	The "groupRestResources" attribute specifies the name of a facet by which REST resources are grouped together. Default: "org.codehaus.enunciate.contract.jaxrs.Resource".

Elements

The docs element supports the following child elements:

download

There can be any number of "download" elements specified. This element is used to indicate another file or Enunciate artifact that is to be included in the "downloads" page. The download element supports the following attributes:

• The "name" attribute specifies a name for the download.
• The "artifact" attribute specifies the id of an Enunciate artifact that is to be included as a download.
• The "file" attribute specifies a file on the filesystem that is to be included as a download. This attribute is ignored if the "artifact" attribute is set.
• The "description" attribute includes a description of the download. This attribute is ignored if the "artifact" attribute is set.

additional-css

You can apply additinoal css files to the generated documentation. Use the "file" attribute to specify the additional css file to apply.

facets

Facet configuration for the module. See Facets.