1.0.0+
The <code><site></code> element is the root of the site decoration descriptor.
1.0.0+
The <code><site></code> element is the root of the site decoration descriptor.
1.0.0+
Banner logo on the masthead of the site to the left.
1.0.0+
Banner logo on the masthead of the site to the right.
1.0.0+
Modify the date published display properties.
1.0.0+
Modify the version published display properties.
1.8.0+
The base url to edit Doxia document sources.
In general, <code>${project.scm.url}</code> value should do the job.
1.0.0+
Powered by logos list.
2.1.0+
The configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side. If the element does not exist, no Mermaid specific scripts will be included in the generated site. If it exists but the "config" field is not set, a default configuration will be used.
1.0.0+
The artifact containing the skin for the site.
1.0.0+
The main site content.
1.0.0+
Custom configuration for use with customized Velocity templates. Data from this field are
accessible in Velocity template from <code>$site.custom</code> variable as DOM content.
Example: <code>$site.custom.getChild( 'customElement' ).getValue()</code>
1.0.0+
The full name of the project site.
1.6.0+
Whether to inherit configuration from a parent project site descriptor (<code>merge</code>)
or not (<code>override</code>).
2.0.0+
Whether this "site.xml" should inherit from a parent "site.xml". If set to "true" it fails the build in case a parent site descriptor cannot be retrieved.
It does not necessarily need to be the direct parent but just a site descriptor anywhere in the parent hierarchy.
1.0.0+
Banner logo on the masthead of the site.
2.0.0+
The image for the link.
1.0.0+
The name to display for the link.
1.0.0+
The href to use for the link.
1.0.1+
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.
2.0.0+
An image. Generates an "img" element (https://html.spec.whatwg.org/#the-img-element).
2.0.0+
The source location. Ends up in the "img src" attribute (https://html.spec.whatwg.org/#attr-img-src).
2.0.0+
Where to place the image relative to the displayed name (left or right).
2.0.0+
The alternative text to use. Ends up in the "img alt" attribute (https://html.spec.whatwg.org/#alt).(
2.0.0+
The width to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "width: ".
2.0.0+
The height to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "height: ".
2.0.0+
The style to use. Ends up in the "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) as is.
1.0.0+
The main content.
1.7.0+
Additional content (like JavaScript) to include in the HEAD block of the generated pages.
1.0.0+
A list of links to display in the navigation.
1.0.0+
A list of breadcrumbs to display in the navigation.
1.0.0+
A list of menus to include in the navigation.
1.7.0+
If present, the contained text will be used instead of the generated copyright text.
1.0.0+
A link in the navigation.
2.0.0+
The image for the link.
1.0.0+
The name to display for the link.
1.0.0+
The href to use for the link.
1.0.1+
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.
1.0.0+
A menu in the navigation.
2.0.0+
The image for the menu.
1.0.0+
A list of menu item.
1.0.0+
The name to display for the menu.
1.0.0+
The way in which the menu is inherited. Can be one of : <code>top</code>, <code>bottom</code> or empty. If empty the menu is not inherited (i.e. won't be exposed in sub projects) which is the default behavior.
Value <code>bottom</code> means it appears below sub project's defined menus, <code>top</code> means it appears above sub project's defined menus.
1.0.0+
If this is a reference, setting to <code>true</code> means that it will be populated
in the site, whereas if it is <code>false</code>, it is populated in the parent and then inherited.
1.0.0+
Mark this menu as reference to a pre-defined menu: <code>reports</code>, <code>modules</code>
or <code>parent</code>. It will be populated at runtime with corresponding pre-defined content.
1.0.0+
A menu item.
1.0.0+
A list of menu item.
2.0.0+
The image for the link.
1.0.0+
Whether to collapse children elements of an item menu (by default).
1.0.0+
A reference to a pre-defined menu item, such as a report (specified by the report goal
name). Any elements explicitly given override those from the pre-defined reference.
1.0.0+
The name to display for the link.
1.0.0+
The href to use for the link.
1.0.1+
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.
1.0.0+
Modify display properties for the date in the header/footer. By default is the publish date.
1.0.0+
Where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
1.0.0+
Date format to use.
1.8.1+
The timezone to use. Use <code>system</code> for the default locale for this instance
of the Java Virtual Machine. Refer to <code>java.util.TimeZone</code> for details.
2.1.0+
The Velocity context key to use as source for the date. Usually one of "publishDate" or "scmLastModified". Must have a value of type <code>java.util.Date</code>.
2.1.0+
The prefix to emit in front of the date. When starting with <code>template.</code> it is assumed to reference a key from the <code>site-renderer.properties</code>, otherwise it is a literal value.
2.1.0+
The Velocity context key to use as source for the date. Used as fallback when the context given in "value" is not available. Must have a value of type <code>java.util.Date</code>. This is useful when the context given in "value" is only available for Doxia source documents (but not for reports).
2.1.0+
The prefix to emit in front of the fallback date. When starting with <code>template.</code> it is assumed to reference a key from the <code>site-renderer.properties</code>, otherwise it is a literal value.
1.0.0+
Power by logo on the navigation.
2.0.0+
The image for the link.
1.0.0+
The name to display for the link.
1.0.0+
The href to use for the link.
1.0.1+
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.
2.1.0+
The configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
2.1.0+
The URL from which to request the javascript used for rendering the diagrams. If not set an embedded version of Mermaid is used (which is automatically deployed to the site).
2.1.0+
The Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
2.1.0+
If Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used. Only considered if "externalJsUrl" is not set.
2.1.0+
The configuration of an external JS file to be embedded in the HTML. Leads to an inclusion via the "script" element.
2.1.0+
The integrity hash to use for the external JS file emitted in the "script" element's "integrity" attribute. Its semantics are described in https://www.w3.org/TR/sri-2/ and its usage is strongly recommended. Some example tools for calculating the value are outlined in https://developer.mozilla.org/en-US/docs/Web/Security/Defenses/Subresource_Integrity#tools_for_generating_sri_hashes.
2.1.0+
The referrerpolicy attribute to use when requesting the external JS file. Its semantics are described in https://www.w3.org/TR/referrer-policy/ and setting it to "no-referrer" prevents sharing unnecessary information with 3rd parties.
2.1.0+
Other attributes to include in the "script" element for this external JS file, in the form of a whitespace separated list of key=value pairs. The keys and values will be included as-is in the generated "script" element, without any validation.
1.0.0+
Modify display properties for version published.
1.0.0+
Where to place the version published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
1.0.0+
A skin artifact declaration.
1.0.0+
The skin group ID.
1.0.0+
The skin artifact ID.
1.0.0+
The skin version.