You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by oc...@apache.org on 2006/08/01 10:47:38 UTC
svn commit: r427492 - in /maven/plugins/trunk/maven-site-plugin/src/site: ./
apt/ apt/examples/ fml/
Author: oching
Date: Tue Aug 1 01:47:37 2006
New Revision: 427492
URL: http://svn.apache.org/viewvc?rev=427492&view=rev
Log:
Updated the plugin docs.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-site-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt Tue Aug 1 01:47:37 2006
@@ -6,6 +6,24 @@
May 11, 2005
------
+ ~~ Copyright 2005-2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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 a Skin for the Maven 2 Site Plugin
* About
@@ -18,6 +36,8 @@
* An optional Velocity template for an alternate HTML rendering of the site.
+ For a sample skin, see {{{http://svn.apache.org/viewvc/maven/skins/trunk/maven-classic-skin}http://svn.apache.org/viewvc/maven/skins/trunk/maven-classic-skin}}
+
* Building
A skin is built like any other JAR - with a <<<packaging>>> of <<<jar>>>. No additional plugins are needed.
@@ -40,4 +60,3 @@
The format of the velocity template is currently out of scope for this document. To attempt this, start by copying
<<<default-site.vm>>> from the <<<doxia-site-renderer>>> JAR to <<<src/main/resources/META-INF/maven/site.vm>>>
and modify it to your needs.
-
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt Tue Aug 1 01:47:37 2006
@@ -6,6 +6,24 @@
July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
+
Excluding Modules
To exclude specific modules from the site to be generated, you can use the <<<excludeModules>>> parameter.
@@ -36,8 +54,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<configuration>
- <excludeModules>
- </excludeModules>
+ <excludeModules>fml</excludeModules>
</configuration>
</plugin>
</plugins>
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt Tue Aug 1 01:47:37 2006
@@ -8,6 +8,23 @@
July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
Configuring the Site Descriptor
@@ -15,9 +32,7 @@
For example, aside from the report distributions you want to put additional content to your site. In order for them
to be accessible in the generated site, you must configure your site descriptor.
-* Site Descriptor
-
- For more references of the site descriptor, here's a link {{{http://maven.apache.org/site.html}http://maven.apache.org/site.html}}.
+* Publish Date
With the out-of box Velocity template, the "Last Published" position could be configurable.
By default, the position is on the left but you could change it.
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt Tue Aug 1 01:47:37 2006
@@ -6,6 +6,24 @@
July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
+
Configuring Site Run
For the <<<site:run>>> goal, you can configure which port to use to start up the site as well as the directory where
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt Tue Aug 1 01:47:37 2006
@@ -8,6 +8,23 @@
July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
Changing the Template File
@@ -32,4 +49,5 @@
</project>
+-----+
- And execute the site goal from your project.
\ No newline at end of file
+ And execute the site goal from your project. For more information about Velocity, see
+ {{{http://jakarta.apache.org/velocity/}http://jakarta.apache.org/velocity/}}.
\ No newline at end of file
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt Tue Aug 1 01:47:37 2006
@@ -6,6 +6,23 @@
13 July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
Maven 2 Site Plugin
@@ -20,7 +37,8 @@
specified in the \<distributionManagement\> section of the pom.
* {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site descriptor to the list of files to be
- installed/deployed.
+ installed/deployed. For more references of the site descriptor, here's a link
+ {{{http://maven.apache.org/site.html}http://maven.apache.org/site.html}}.
* {{{site-mojo.html}site:site}} is used generate a site for the project.
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt Tue Aug 1 01:47:37 2006
@@ -8,6 +8,23 @@
17 July 2006
------
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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
+
Usage
@@ -88,4 +105,6 @@
mvn site:run
+-----+
- The server will, by default, be started on http://localhost:8080/.
+ The server will, by default, be started on http://localhost:8080/. See
+ {{{http://jetty.mortbay.org/jetty/index.html}http://jetty.mortbay.org/jetty/index.html}} for more information about
+ the Jetty server.
Modified: maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml Tue Aug 1 01:47:37 2006
@@ -1,4 +1,21 @@
<?xml version="1.0"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed 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.
+ -->
+
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="How do I integrate static (x)html into my Maven site">
Modified: maven/plugins/trunk/maven-site-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/site.xml?rev=427492&r1=427491&r2=427492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/site.xml Tue Aug 1 01:47:37 2006
@@ -1,22 +1,20 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-/*
- * Copyright 2001-2005 The Apache Software Foundation.
- *
- * Licensed 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.
- */
--->
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed 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.
+ -->
<project name="Maven Site plugin">
<bannerLeft>