You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/03/22 23:22:07 UTC
svn commit: r640098 - in /maven/shared/trunk/maven-doxia-tools/src/site: ./
apt/ apt/index.apt site.xml
Author: dennisl
Date: Sat Mar 22 15:22:05 2008
New Revision: 640098
URL: http://svn.apache.org/viewvc?rev=640098&view=rev
Log:
o Add a minimal site.
Added:
maven/shared/trunk/maven-doxia-tools/src/site/
maven/shared/trunk/maven-doxia-tools/src/site/apt/
maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt (with props)
maven/shared/trunk/maven-doxia-tools/src/site/site.xml (with props)
Added: maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt?rev=640098&view=auto
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt (added)
+++ maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt Sat Mar 22 15:22:05 2008
@@ -0,0 +1,71 @@
+ ------
+ Introduction
+ ------
+ Dennis Lundberg
+ ------
+ 2008-03-22
+ ------
+
+ ~~ 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
+
+
+Maven Doxia Tools
+
+ This shared component has some utilities that are useful when working with
+ site generation and report creation. The main entry point is the
+ {{{apidocs/org/apache/maven/doxia/tools/SiteTool.html}SiteTool}} Plexus
+ component.
+
+
+* Using the SiteTool in a Mojo
+
++-----
+...
+import org.apache.maven.doxia.tools.SiteTool;
+...
+
+/**
+ * Your own mojo.
+ */
+public class YourOwnMojo extends AbstractMojo
+{
+ ...
+
+ /**
+ * SiteTool.
+ *
+ * @component
+ */
+ protected SiteTool siteTool;
+
+ ...
+
+ public someMethod()
+ {
+ List localesList = siteTool.getAvailableLocales( locales );
+ String relativePath = siteTool.getRelativePath( "C:/foo/child",
+ "C:/foo/master" );
+ ...
+ }
+
+ ...
+}
++-----
Propchange: maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Added: maven/shared/trunk/maven-doxia-tools/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/site/site.xml?rev=640098&view=auto
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/site/site.xml (added)
+++ maven/shared/trunk/maven-doxia-tools/src/site/site.xml Sat Mar 22 15:22:05 2008
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+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.
+-->
+
+<project>
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html" />
+ </menu>
+ <menu ref="reports" />
+ </body>
+</project>
Propchange: maven/shared/trunk/maven-doxia-tools/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Re: svn commit: r640098 - in /maven/shared/trunk/maven-doxia-tools/src/site: ./ apt/ apt/index.apt site.xml
Posted by Vincent Siveton <vi...@gmail.com>.
Thanks for this Dennis.
Vincent
2008/3/22, dennisl@apache.org <de...@apache.org>:
> Author: dennisl
> Date: Sat Mar 22 15:22:05 2008
> New Revision: 640098
>
> URL: http://svn.apache.org/viewvc?rev=640098&view=rev
> Log:
> o Add a minimal site.
>
> Added:
> maven/shared/trunk/maven-doxia-tools/src/site/
> maven/shared/trunk/maven-doxia-tools/src/site/apt/
> maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt (with props)
> maven/shared/trunk/maven-doxia-tools/src/site/site.xml (with props)
>
> Added: maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt
> URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt?rev=640098&view=auto
> ==============================================================================
> --- maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt (added)
> +++ maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt Sat Mar 22 15:22:05 2008
> @@ -0,0 +1,71 @@
> + ------
> + Introduction
> + ------
> + Dennis Lundberg
> + ------
> + 2008-03-22
> + ------
> +
> + ~~ 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
> +
> +
> +Maven Doxia Tools
> +
> + This shared component has some utilities that are useful when working with
> + site generation and report creation. The main entry point is the
> + {{{apidocs/org/apache/maven/doxia/tools/SiteTool.html}SiteTool}} Plexus
> + component.
> +
> +
> +* Using the SiteTool in a Mojo
> +
> ++-----
> +...
> +import org.apache.maven.doxia.tools.SiteTool;
> +...
> +
> +/**
> + * Your own mojo.
> + */
> +public class YourOwnMojo extends AbstractMojo
> +{
> + ...
> +
> + /**
> + * SiteTool.
> + *
> + * @component
> + */
> + protected SiteTool siteTool;
> +
> + ...
> +
> + public someMethod()
> + {
> + List localesList = siteTool.getAvailableLocales( locales );
> + String relativePath = siteTool.getRelativePath( "C:/foo/child",
> + "C:/foo/master" );
> + ...
> + }
> +
> + ...
> +}
> ++-----
>
> Propchange: maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt
> ------------------------------------------------------------------------------
> svn:eol-style = native
>
> Added: maven/shared/trunk/maven-doxia-tools/src/site/site.xml
> URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/site/site.xml?rev=640098&view=auto
> ==============================================================================
> --- maven/shared/trunk/maven-doxia-tools/src/site/site.xml (added)
> +++ maven/shared/trunk/maven-doxia-tools/src/site/site.xml Sat Mar 22 15:22:05 2008
> @@ -0,0 +1,29 @@
> +<?xml version="1.0" encoding="ISO-8859-1"?>
> +
> +<!--
> +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.
> +-->
> +
> +<project>
> + <body>
> + <menu name="Overview">
> + <item name="Introduction" href="index.html" />
> + </menu>
> + <menu ref="reports" />
> + </body>
> +</project>
>
> Propchange: maven/shared/trunk/maven-doxia-tools/src/site/site.xml
> ------------------------------------------------------------------------------
> svn:eol-style = native
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org