Author: hboutemy
Date: Tue Sep 13 21:23:48 2011
New Revision: 1170357
URL: http://svn.apache.org/viewvc?rev=1170357&view=rev
Log:
added an introduction to the component
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
(with props)
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt?rev=1170357&view=auto
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
(added)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
Tue Sep 13 21:23:48 2011
@@ -0,0 +1,46 @@
+ -----
+ Introduction
+ -----
+ Hervé Boutemy
+ ------
+ 2011-09-13
+ ------
+
+~~ 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/doxia/references/apt-format.html
+
+Doxia Site Tools - Site Renderer
+
+ The Site Renderer handles the rendering of sites, assembling a common site
decoration with a collection of documents.
+
+ A default site decoration is included (see <<<default-site.vm>>>), but other
decorations can be used at will, either
+ as standalone template or packaged in a <<skin>> artifact (containing a
<<<META-INF/maven/site.vm>>> template).
+
+ Documents can be dynamically generated with Doxia Sink API, like Maven
reports, or simply read from static files,
+ eventually processed by Velocity when their file names end in <<<.vm>>>.
+
+* Doxia Site Skins
+
+ Site decoration can be customized with skins.
+
+ Maven team provides {{{/skins/}a collection of skins}} for projects use, but
+ {{{http://docs.codehaus.org/display/MAVENUSER/Maven+Skins}more skins are
listed in MAVENUSER wiki}}.
+
+ Some documentation is available on
{{{/plugins/maven-site-plugin/examples/creatingskins.html}how to write a new
skin}}.
Propchange:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
