------
 Creating Skins
 ------
 Brett Porter
 ------
 May 11, 2005
 ------

 ~~ 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/guides/mini/guide-apt-format.html


Creating Skins

* About

  A Maven 2 site skin contains the following elements:

    * Resources to copy into each project (such as images used by the CSS)

    * A couple of css files, containing the visual styling.

    * An optional Velocity template for an alternate HTML rendering of the site.

* Building

  A skin is built like any other JAR - with a <<<packaging>>> of <<<jar>>>.
  No additional plugins are needed.

  Resources should be put in the normal <<<src/main/resources>>> directory.

  Once the JAR is built and deployed, it can be used by projects.

* Constructing the CSS

  <<More information is needed here on constructing the CSS.>>

  If you are interested in constructing your own CSS, it is recommended that
  you copy an existing skin's <<<maven-theme.css>>> file and modify it to suit
  your needs.

* Customizing the HTML output with a Velocity template

  <<Details on the Velocity template variables and use should be included>>.

  The format of the Velocity template is currently out of scope for this
  document. To attempt this, start by copying
  <<<{{{https://svn.apache.org/repos/asf/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm}default-site.vm}}>>>
  to <<<src/main/resources/META-INF/maven/site.vm>>> in your project and then
  modify it to your needs.

* Examples of existing skins

  A list of links to skins that can be used as inspiration can be found on
  {{{http://docs.codehaus.org/display/MAVENUSER/Maven+Skins}the wiki}}.