Skin

This is a reference for the skin descriptor used in Doxia Sitetools, stored as META-INF/maven/skin.xml.

An XSD is available at:

https://maven.apache.org/xsd/skin-2.1.0.xsd


<skin xmlns="http://maven.apache.org/SKIN/2.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SKIN/2.1.0 http://maven.apache.org/xsd/skin-2.1.0.xsd">
  <prerequisites>
    <doxia-sitetools/>
  </prerequisites>

  <encoding/>

  <resource-conditions>
    <resource-condition>
      <resource-name/>
      <vtl-condition/>
    </resource-condition>
  </resource-conditions>
</skin>

skin

The <skin> element is the root of the skin descriptor.

Element	Type	Since	Description
`prerequisites`	`Prerequisites`		Describes the prerequisites in the build environment for using this skin.
`encoding`	`String`		Encoding of text content, like the Velocity template itself.
`resource-conditions/resource-condition*`	`List<ResourceCondition>`	2.1.0	(Many) Resource conditions

prerequisites

Describes the prerequisites a skin can have.

Element	Type	Since	Description
`doxia-sitetools`	`String`		The minimum version of Doxia Sitetools required to use the resulting skin. Default value: `2.0.0-M12`

resource-condition

Describes the condition for including a specific Skin resource. If multiple conditions are defined for a single resource only the first matching condition determines the outcome. Resources not matching a condition will always be included.

Element	Type	Since	Description
`resource-name*`	`List<String>`	2.1.0	(Many) A resource name to which this condition applies. Refers to the relative path within the JAR (i.e. must always use "/" as separator and must not start with a slash). Multiple resource names can be specified sharing the same condition.
`vtl-condition`	`String`	2.1.0	The Velocity (VTL) expression to be evaluated to decide if the resource should be included. Only if the condition evaluates to true, the resource will be included.