Author: hboutemy
Date: Mon Dec 28 13:58:52 2015
New Revision: 1721921
URL: http://svn.apache.org/viewvc?rev=1721921&view=rev
Log:
[DOXIASITETOOLS-137] added documentation on how site is rendered, merging
documents and decoration
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/doxia-site-renderer.odg
(with props)
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/resources/
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/resources/doxia-site-renderer.png
(with props)
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/doxia-site-renderer.odg
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/doxia-site-renderer.odg?rev=1721921&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/doxia-site-renderer.odg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm?rev=1721921&r1=1721920&r2=1721921&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt.vm
Mon Dec 28 13:58:52 2015
@@ -29,18 +29,20 @@
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 a standalone template or packaged in a <<skin>> artifact (containing a
<<<META-INF/maven/site.vm>>> template).
+ The Site Renderer handles the rendering of sites, assembling a common site
decoration (also called <a skin>)
+ with a collection of documents.
Documents can be dynamically generated with
{{{/doxia/doxia/doxia-sink-api/}Doxia Sink API}}, like Maven reports,
- or simply read from static files written in
{{{/doxia/references/index.html}markup supported by Doxia Parser}},
- eventually processed by Velocity if their file names end in <<<.vm>>>.
+ or simply read from static files written in
{{{/doxia/references/index.html}markup supported by Doxia Parsers}},
+ eventually processed by
{{{http://velocity.apache.org/engine/releases/velocity-1.5/}Velocity}}
+ if their file names end in <<<.vm>>>.
+
+[doxia-site-renderer.png]
* Doxia Site Skins
- Site decoration can be customized with skins.
+ A default site decoration is included (see <<<default-site.vm>>>), but other
decorations can be used at will, either
+ as a standalone template or packaged in a <<skin>> artifact (containing a
<<<META-INF/maven/site.vm>>> template).
Maven team provides {{{/skins/}a collection of skins}} for projects use.
@@ -128,7 +130,7 @@ Doxia Site Tools - Site Renderer
~~| <<<context>>> | (causes RuntimeException)
~~| <<<link>>> | (causes NullPointerException)
- See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L416}DefaultSiteRenderer.createDocumentVelocityContext(...)}}>>>
+ See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L440}DefaultSiteRenderer.createDocumentVelocityContext(...)}}>>>
source for more details.
** Maven Site Plugin
@@ -171,5 +173,5 @@ Doxia Site Tools - Site Renderer
| <<<title>>> | <<<String>>> | The title of the
document, including the project or site name |
*---------------------------------+----------------------+-------------------------------+
- See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L504}DefaultSiteRenderer.createSiteTemplateVelocityContext(...)}}>>>
+ See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L528}DefaultSiteRenderer.createSiteTemplateVelocityContext(...)}}>>>
source for more details.
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/resources/doxia-site-renderer.png
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/resources/doxia-site-renderer.png?rev=1721921&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/resources/doxia-site-renderer.png
------------------------------------------------------------------------------
svn:mime-type = image/png
