You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by he...@apache.org on 2007/01/07 16:22:34 UTC

svn commit: r493746 - in /velocity/site/tools: src/site/ src/site/apt/ velocity-site-doxia-renderer/src/site/ velocity-site-doxia-renderer/src/site/apt/ velocity-site-doxia-renderer/src/site/resources/images/ velocity-site-news/extension/src/site/ velo...

Author: henning
Date: Sun Jan  7 07:22:33 2007
New Revision: 493746

URL: http://svn.apache.org/viewvc?view=rev&rev=493746
Log:
Update Documentation


Added:
    velocity/site/tools/velocity-site-news/src/
    velocity/site/tools/velocity-site-news/src/site/
    velocity/site/tools/velocity-site-news/src/site/apt/
    velocity/site/tools/velocity-site-news/src/site/apt/index.apt
    velocity/site/tools/velocity-site-news/src/site/resources/
    velocity/site/tools/velocity-site-news/src/site/resources/xsd/
    velocity/site/tools/velocity-site-news/src/site/resources/xsd/news-1.0.0.xsd
    velocity/site/tools/velocity-site-news/src/site/site.xml   (with props)
    velocity/site/tools/velocity-site-news/src/site/xdoc/
    velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml   (with props)
    velocity/site/tools/velocity-site-skin/src/site/
    velocity/site/tools/velocity-site-skin/src/site/site.xml   (with props)
Removed:
    velocity/site/tools/velocity-site-doxia-renderer/src/site/resources/images/
    velocity/site/tools/velocity-site-news/extension/src/site/resources/images/
    velocity/site/tools/velocity-site-news/plugin/src/site/resources/images/
Modified:
    velocity/site/tools/src/site/apt/index.apt
    velocity/site/tools/src/site/site.xml
    velocity/site/tools/velocity-site-doxia-renderer/src/site/apt/index.apt
    velocity/site/tools/velocity-site-doxia-renderer/src/site/site.xml
    velocity/site/tools/velocity-site-news/extension/src/site/apt/index.apt
    velocity/site/tools/velocity-site-news/extension/src/site/site.xml
    velocity/site/tools/velocity-site-news/plugin/src/site/apt/index.apt
    velocity/site/tools/velocity-site-news/plugin/src/site/site.xml

Modified: velocity/site/tools/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/velocity/site/tools/src/site/apt/index.apt?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/src/site/apt/index.apt (original)
+++ velocity/site/tools/src/site/apt/index.apt Sun Jan  7 07:22:33 2007
@@ -1,9 +1,13 @@
+ ----
+ Velocity Site Tools
+ ----
+
 Velocity Site Tools
 
  Here are a number of minor, maven-related, projects located that are
  used when generating and maintaining the Velocity Site.
 
-* Velocity Site Doxia Renderer
+* Velocity Doxia Renderer
 
  This is a Maven extension that is used to generate parts of the site not
  from static APT or Xdoc files but from Velocity templates.
@@ -15,7 +19,7 @@
  {{{http://svn.apache.org/repos/asf/velocity/site/site/pom.xml}Site
  POM}}) and gets read and parsed from there.
 
-* Velocity Site News Plugin / Extension
+* Velocity News Plugin / Extension
 
  This is a Maven extension in two parts. The extension provides a model
  to read an XML file containing news items to display on the site. 
@@ -35,5 +39,4 @@
  use a custom template to render out the pages, we were able to sneak
  a RSS auto-subscription link into the header of each page, thus showing
  up the RSS feed in all Velocity site pages.
-
 

Modified: velocity/site/tools/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/src/site/site.xml?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/src/site/site.xml (original)
+++ velocity/site/tools/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -4,16 +4,16 @@
   <bannerLeft>
     <name>Apache Velocity</name>
     <src>/images/velocity_project_wide.png</src>
-    <href>http:/velocity.apache.org/</href>
+    <href>http://velocity.apache.org/</href>
   </bannerLeft>
 
   <bannerRight>
-    <name>Site Modules</name>
+    <name>Velocity Site Tools</name>
   </bannerRight>
 
   <poweredBy>
     <logo name="Apache Velocity" 
-          href="http://velocity.apache.org"
+          href="http://velocity.apache.org/"
           img="/images/pbv90x30.png" />
     <logo name="Velocity News Feed" 
           href="http://velocity.apache.org/rss/news.rss"
@@ -28,27 +28,23 @@
 
   <body>
     <breadcrumbs>
-      <item name="Apache" href="http://www.apache.org"/>
+      <item name="Apache" href="http://www.apache.org/"/>
       <item name="Velocity" href="http://velocity.apache.org/"/>
-      <item name="Velocity Site Tools" href="http://velocity.apache.org/site/tools"/>
+      <item name="Velocity Site Tools"/>
     </breadcrumbs>
 
     <links>
-      <item name="Engine" href="engine/devel/index.html"/>
-      <item name="Tools" href="tools/devel/index.html"/>
-      <item name="DVSL" href="dvsl/devel/index.html"/>
+      <item name="Engine" href="http://velocity.apache.org/engine/devel/index.html"/>
+      <item name="Tools" href="http://velocity.apache.org/tools/devel/index.html"/>
+      <item name="DVSL" href="http://velocity.apache.org/dvsl/devel/index.html"/>
     </links>
 
     <menu name="General">
       <item name="Information" href="index.html"/>
     </menu> 
 
-    <menu name="Tools">
-      <item name="Doxia Renderer" href="velocity-site-doxia-renderer/index.html"/>
-      <item name="News Plugin" href="velocity-site-news/index.html"/>
-    </menu>
-
-    ${reports}
+    <menu ref="modules" />
+    <menu ref="reports" />
 
   </body>
 </project>

Modified: velocity/site/tools/velocity-site-doxia-renderer/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-doxia-renderer/src/site/apt/index.apt?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-doxia-renderer/src/site/apt/index.apt (original)
+++ velocity/site/tools/velocity-site-doxia-renderer/src/site/apt/index.apt Sun Jan  7 07:22:33 2007
@@ -1,8 +1,8 @@
  --------
-Velocity Doxia Renderer Module
+ Velocity Site Doxia Renderer
  --------
 
-Velocity Doxia Renderer Module
+Velocity Site Doxia Renderer
 
  This module is an extension for Apache
  Maven. It allows you to generate Xdoc and Apt pages used for the Maven

Modified: velocity/site/tools/velocity-site-doxia-renderer/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-doxia-renderer/src/site/site.xml?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-doxia-renderer/src/site/site.xml (original)
+++ velocity/site/tools/velocity-site-doxia-renderer/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -1,23 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="Velocity Site Doxia Renderer">
-  <publishDate position="bottom" format="yyyy-MM-dd HH:mm:ss"/>
   <bannerRight>
-    <name>Velocity Doxia Renderer</name>
+    <name>Velocity Site Doxia Renderer</name>
   </bannerRight>
 
   <body>
     <breadcrumbs>
-      <item name="Apache" href="http://www.apache.org"/>
-      <item name="Velocity" href="http://velocity.apache.org/"/>
-      <item name="Velocity Site Tools" href="http://velocity.apache.org/site/tools"/>
-      <item name="Velocity Doxia Renderer" href="http://velocity.apache.org/site/tools/velocity-site-doxia-renderer"/>
+      <item name="Velocity Site Doxia Renderer"/>
     </breadcrumbs>
 
-    <menu name="General">
+    <menu name="General" inherit="none">
       <item name="Overview" href="index.html"/>
     </menu> 
 
-    ${reports}
+    <menu ref="modules" />
+
+    <menu ref="reports" />
+
   </body>
 </project>
  

Modified: velocity/site/tools/velocity-site-news/extension/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/extension/src/site/apt/index.apt?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/extension/src/site/apt/index.apt (original)
+++ velocity/site/tools/velocity-site-news/extension/src/site/apt/index.apt Sun Jan  7 07:22:33 2007
@@ -1,6 +1,33 @@
- --------
-Velocity News Plugin
- --------
+ ----
+ Velocity Site News Extension
+ ----
 
-Velocity News Plugin
+Velocity Site News Extension
 
+ This is the basic element of the Velocity Site News module. It contains the processing
+ logic and the Doxia Macro.
+
+* Adding the Velocity Site News Extension to your POM
+
+ The extension gets added to your POM as follows:
+
++--
+<project>
+  <build>
+...
+    <extensions>
+      <extension>
+        <groupId>org.apache.velocity.site</groupId>
+        <artifactId>velocity-site-news-extension</artifactId>
+        <version>1.1.0</version>
+      </extension>
+...
+    </extensions>
+  </build>
+</project>
++--
+
+ Without this extension, the
+ {{{http://velocity.apache.org/site/tools/velocity-site-news-plugin/}plugin}}
+ does not work!
+ 

Modified: velocity/site/tools/velocity-site-news/extension/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/extension/src/site/site.xml?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/extension/src/site/site.xml (original)
+++ velocity/site/tools/velocity-site-news/extension/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -1,29 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project name="Velocity News Plugin">
+<project name="Velocity Site News Extension">
   <publishDate position="bottom" format="yyyy-MM-dd HH:mm:ss"/>
-  <bannerLeft>
-    <name>Velocity News Plugin</name>
-    <src>/images/velocity_project_wide.png</src>
-    <href>http:/velocity.apache.org/</href>
-  </bannerLeft>
-
-  <poweredBy>
-    <logo name="Apache Velocity" 
-          href="http://velocity.apache.org"
-          img="/images/pbv90x30.png" />
-  </poweredBy>
+  <bannerRight>
+    <name>Velocity Site News Extension</name>
+  </bannerRight>
 
   <body>
     <breadcrumbs>
-      <item name="Apache" href="http://www.apache.org"/>
-      <item name="Velocity" href="http://velocity.apache.org/"/>
+      <item name="Extension" />
     </breadcrumbs>
 
     <menu name="General">
       <item name="Overview" href="index.html"/>
     </menu> 
 
-    ${reports}
+    <menu ref="modules" />
+
+    <menu ref="reports" />
+
   </body>
 </project>
  

Modified: velocity/site/tools/velocity-site-news/plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/plugin/src/site/apt/index.apt?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/plugin/src/site/apt/index.apt (original)
+++ velocity/site/tools/velocity-site-news/plugin/src/site/apt/index.apt Sun Jan  7 07:22:33 2007
@@ -1,6 +1,49 @@
- --------
-Velocity News Plugin
- --------
+ ----
+ Velocity Site News Plugin
+ ----
 
-Velocity News Plugin
+Velocity Site News Plugin
+
+ This is the plugin that generates the various news formats.
+
+* Adding the Velocity Site news Plugin to your POM
+
+ The plugin runs as a reporting plugin, so it must be added to the reporting section of your POM:
+
++--
+<project>
+...
+  <reporting>
+    <plugins>
+...
+      <plugin>
+        <groupId>org.apache.velocity.site</groupId>
+        <artifactId>velocity-site-news-plugin</artifactId>
+        <configuration>
+          <baseUrl>... your base URL here...</baseUrl>
+          <newsfile>... your news file name here ...</newsfile>
+        </configuration>
+      </plugin>
+...
+    </plugins>
+  </reporting>
+...
+</project>
++--
+
+* Configuration of the reporting plugin
+
+  * <baseUrl> - As RSS feeds must have an absolute path for their links and the maven
+    site build tries to use relative links everywhere, you must configure the final
+    deployment location of your site here so that the RSS generator can put absolute
+    links into the RSS feed. The baseUrl should end with a </>.
+
+  * <newsfile> (default is <<<news>>>) - The base name to look up the XML file to parse
+    and to generate the full news page and the RSS feed. The default
+    looks for <<<src/site/news.xml>>>, generates <<<news.html>>> and a
+    feed under <<<rss/news.rss>>>.
+
+
+  
+ 
 

Modified: velocity/site/tools/velocity-site-news/plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/plugin/src/site/site.xml?view=diff&rev=493746&r1=493745&r2=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/plugin/src/site/site.xml (original)
+++ velocity/site/tools/velocity-site-news/plugin/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -1,29 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project name="Velocity News Plugin">
+<project name="Velocity Site News Plugin">
   <publishDate position="bottom" format="yyyy-MM-dd HH:mm:ss"/>
-  <bannerLeft>
-    <name>Velocity News Plugin</name>
-    <src>/images/velocity_project_wide.png</src>
-    <href>http:/velocity.apache.org/</href>
-  </bannerLeft>
-
-  <poweredBy>
-    <logo name="Apache Velocity" 
-          href="http://velocity.apache.org"
-          img="/images/pbv90x30.png" />
-  </poweredBy>
+  <bannerRight>
+    <name>Velocity Site News Plugin</name>
+  </bannerRight>
 
   <body>
     <breadcrumbs>
-      <item name="Apache" href="http://www.apache.org"/>
-      <item name="Velocity" href="http://velocity.apache.org/"/>
+      <item name="Plugin" />
     </breadcrumbs>
 
     <menu name="General">
       <item name="Overview" href="index.html"/>
     </menu> 
 
-    ${reports}
+    <menu ref="modules" />
+
+    <menu ref="reports" />
+
   </body>
 </project>
  

Added: velocity/site/tools/velocity-site-news/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/src/site/apt/index.apt?view=auto&rev=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/src/site/apt/index.apt (added)
+++ velocity/site/tools/velocity-site-news/src/site/apt/index.apt Sun Jan  7 07:22:33 2007
@@ -0,0 +1,113 @@
+ ----
+ Velocity Site News
+ ----
+
+Velocity Site News
+
+ The Velocity Site News module consists of a plugin and an extension to the
+ Maven core. It allows you to create and maintain a list of news items for 
+ your site which can be displayed as a standalone page, as part of another
+ page or an RSS news feed.
+
+* Creating news items
+
+ The news items are stored in XML format in <<<src/site/news.xml>>>. This
+ is an example news item:
+
++--
+  <item id="very-important-news">
+    <date>2007-01-07</date>
+    <headline>The grass is greener over there</headline>
+    <categories>
+      <category>general</category>
+      <category>grass</category>
+    </categories>
+    <text><![CDATA[
+      The grass is greener {{{http://www.apache.org}over there}}.
+    ]]></text>
+  </item>
++--
+
+ The text of a news item is actually APT formatted text, so all the formatting
+ like links, text-formatting or lists can be used.
+
+ The formal definition for the items is available {{{news.html}here}}, we also
+ offer an
+ {{{http://velocity.apache.org/site/tools/velocity-site-news/xsd/news-1.0.0.xsd}XSD
+ file}} to validate your news items with an XSD-capable editor.
+
+* Displaying news items
+
+ There are three ways to include news items in your site.
+
+** Display as a page
+
+ All news items are rendered on a single page in reverse chronological order (latest
+ first). This page is called <<<news.html>>> by default but this can be changed with
+ a plugin setting (see below). 
+
+** Display as part of a page
+
+ If you want to display some teasers on your web site cover page, you can include a
+ Doxia macro that renders these teasers for you. Similar to Javadoc, the first full
+ sentence (that ends with '. ' (dot - space)) is rendered as teaser. 
+
+ This macro can be included as <<<%\{news|count=3\}>>> on an Apt page (note that the
+ macro <<must>> start in the first column of your page!) or as <<<\<macro id="news" count="3" /\>>>>
+ on an xdoc page (note that the id fields prevents you from including the macro
+ twice on a page, this is considered a Doxia problem and might change in the future).
+
+** Display as RSS feed
+
+ The news items are also available as an RSS 2.0 feed written as <<<rss/news.rss>>> (if
+ you change the name of the news page above, this feed name will also change).
+
+ Due to the nature of the maven site build, all links of the site are relative. However, the
+ RSS specification requires you to put absolute links into your feed. To make this 
+ possible, you must configure the final deploy location of your site in the news plugin
+ (see below) if you want to use the RSS feed.
+
+* Configuring the news module
+
+ You must include both the plugin and the extension in your POM. 
+
++--
+<project>
+...
+  <reporting>
+    <plugins>
+...
+      <plugin>
+        <groupId>org.apache.velocity.site</groupId>
+        <artifactId>velocity-site-news-plugin</artifactId>
+        <configuration>
+          <baseUrl>... your base URL here...</baseUrl>
+          <newsfile>... your news file name here ...</newsfile>
+        </configuration>
+      </plugin>
+...
+    </plugins>
+  </reporting>
+...
+  <build>
+...
+    <extensions>
+      <extension>
+        <groupId>org.apache.velocity.site</groupId>
+        <artifactId>velocity-site-news-extension</artifactId>
+        <version>1.1.0</version>
+      </extension>
+...
+    </extensions>
+  </build>
+</project>
++--
+
+ Details can be found on the
+ {{{http://velocity.apache.org/site/tools/velocity-site-news-plugin/}plugin}}
+ and
+ {{{http://velocity.apache.org/site/tools/velocity-site-news-extension/}extension}}
+ home pages.
+
+
+ 

Added: velocity/site/tools/velocity-site-news/src/site/resources/xsd/news-1.0.0.xsd
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/src/site/resources/xsd/news-1.0.0.xsd?view=auto&rev=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/src/site/resources/xsd/news-1.0.0.xsd (added)
+++ velocity/site/tools/velocity-site-news/src/site/resources/xsd/news-1.0.0.xsd Sun Jan  7 07:22:33 2007
@@ -0,0 +1,91 @@
+<?xml version="1.0"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://maven.apache.org/POM/4.0.0" xmlns="http://maven.apache.org/POM/4.0.0">
+  <xs:element name="news" type="NewsModel">
+    <xs:annotation>
+      <xs:documentation source="version">1.0.0</xs:documentation>
+      <xs:documentation source="description">
+         The &lt;code&gt;&amp;lt;news&amp;gt;&lt;/code&gt; element is the root of the news items.
+         The following table lists all of the possible child elements.
+      </xs:documentation>
+    </xs:annotation>
+  </xs:element>
+  <xs:complexType name="NewsModel">
+    <xs:annotation>
+      <xs:documentation source="version">1.0.0</xs:documentation>
+      <xs:documentation source="description">
+         The &lt;code&gt;&amp;lt;news&amp;gt;&lt;/code&gt; element is the root of the news items.
+         The following table lists all of the possible child elements.
+      </xs:documentation>
+    </xs:annotation>
+    <xs:all>
+      <xs:element name="item" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            A news item.
+          </xs:documentation>
+        </xs:annotation>
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="item" minOccurs="0" maxOccurs="unbounded" type="Item"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:all>
+  </xs:complexType>
+  <xs:complexType name="Item">
+    <xs:annotation>
+      <xs:documentation source="version">1.0.0</xs:documentation>
+      <xs:documentation source="description">
+        A single news item
+      </xs:documentation>
+    </xs:annotation>
+    <xs:all>
+      <xs:element name="id" minOccurs="0" type="xs:string">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            Id of this entry.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="date" minOccurs="0" type="xs:string">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            Posting date of this entry.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="headline" minOccurs="0" type="xs:string">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            Headline of this entry.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="text" minOccurs="0" type="xs:string">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            Content of this item in apt format.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="categories" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation source="version">1.0.0</xs:documentation>
+          <xs:documentation source="description">
+            These are the categories under which the item will be filed.
+          </xs:documentation>
+        </xs:annotation>
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="category" minOccurs="0" maxOccurs="unbounded" type="xs:string"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:all>
+  </xs:complexType>
+</xs:schema>
\ No newline at end of file

Added: velocity/site/tools/velocity-site-news/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/src/site/site.xml?view=auto&rev=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/src/site/site.xml (added)
+++ velocity/site/tools/velocity-site-news/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="Velocity Site News">
+  <publishDate position="bottom" format="yyyy-MM-dd HH:mm:ss"/>
+  <bannerRight>
+    <name>Velocity Site News</name>
+  </bannerRight>
+
+  <body>
+    <breadcrumbs>
+      <item name="Velocity Site News" />
+    </breadcrumbs>
+
+    <menu name="General">
+      <item name="Overview" href="index.html"/>
+      <item name="News file format" href="news.html" />
+    </menu> 
+
+    <menu ref="modules" />
+
+    <menu ref="reports" />
+
+  </body>
+</project>
+ 
+

Propchange: velocity/site/tools/velocity-site-news/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: velocity/site/tools/velocity-site-news/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = Id Author Date Revision

Added: velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml?view=auto&rev=493746
==============================================================================
--- velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml (added)
+++ velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml Sun Jan  7 07:22:33 2007
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<document>
+  <properties>
+    <title>News</title>
+  </properties>
+  <body>
+    <section name="News">
+      <p>
+    <p>This is a reference for the news items used in the Velocity Site News Plugin.</p>
+    <p>An XSD is available at:</p>
+    <ul>
+      <li><a href="http://velocity.apache.org/site/tools/velocity-site-news/xsd/news-1.0.0.xsd">http://velocity.apache.org/site/tools/velocity-site-news/xsd/news-1.0.0.xsd</a> for Maven 2.0.</li>
+    </ul>
+  </p>
+      <source>
+&lt;<a href="#class_news">news</a>&gt;
+  &lt;<a href="#class_item">item</a> id=.. &gt;
+    &lt;date/&gt;
+    &lt;headline/&gt;
+    &lt;text/&gt;
+    &lt;categories/&gt;
+  &lt;/item&gt;
+&lt;/news&gt;
+</source>
+      <a name="class_news"/>
+      <subsection name="news">
+        <p>
+         The <code>&lt;news&gt;</code> element is the root of the news items.
+         The following table lists all of the possible child elements.
+      </p>
+        <table>
+          <tr>
+            <th>Element</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>
+              <code>item</code>
+            </td>
+            <td><b>List</b>  
+            A news item.
+          </td>
+          </tr>
+        </table>
+      </subsection>
+      <a name="class_item"/>
+      <subsection name="item">
+        <p>
+        A single news item
+      </p>
+        <table>
+          <tr>
+            <th>Element</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>
+              <code>id</code>
+            </td>
+            <td>
+            Id of this entry.
+          </td>
+          </tr>
+          <tr>
+            <td>
+              <code>date</code>
+            </td>
+            <td>
+            Posting date of this entry.
+          </td>
+          </tr>
+          <tr>
+            <td>
+              <code>headline</code>
+            </td>
+            <td>
+            Headline of this entry.
+          </td>
+          </tr>
+          <tr>
+            <td>
+              <code>text</code>
+            </td>
+            <td>
+            Content of this item in apt format.
+          </td>
+          </tr>
+          <tr>
+            <td>
+              <code>categories</code>
+            </td>
+            <td>
+            These are the categories under which the item will be filed.
+          </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>

Propchange: velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: velocity/site/tools/velocity-site-news/src/site/xdoc/news.xml
------------------------------------------------------------------------------
    svn:keywords = Id Author Date Revision

Added: velocity/site/tools/velocity-site-skin/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/tools/velocity-site-skin/src/site/site.xml?view=auto&rev=493746
==============================================================================
--- velocity/site/tools/velocity-site-skin/src/site/site.xml (added)
+++ velocity/site/tools/velocity-site-skin/src/site/site.xml Sun Jan  7 07:22:33 2007
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="Velocity Site Skin">
+  <publishDate position="bottom" format="yyyy-MM-dd HH:mm:ss"/>
+  <bannerRight>
+    <name>Velocity Site Skin</name>
+  </bannerRight>
+
+  <body>
+    <breadcrumbs>
+      <item name="Velocity Site Skin" />
+    </breadcrumbs>
+
+    <menu name="General">
+      <item name="Overview" href="index.html"/>
+    </menu> 
+
+    <menu ref="modules" />
+
+    <menu ref="reports" />
+
+  </body>
+</project>
+ 
+

Propchange: velocity/site/tools/velocity-site-skin/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: velocity/site/tools/velocity-site-skin/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = Id Author Date Revision