maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vsive...@apache.org
Subject svn commit: r651943 - in /maven/shared/trunk/maven-doxia-tools/src/site: apt/index.apt apt/usage.apt site.xml
Date Sun, 27 Apr 2008 13:25:18 GMT
Author: vsiveton
Date: Sun Apr 27 06:25:16 2008
New Revision: 651943

URL: http://svn.apache.org/viewvc?rev=651943&view=rev
Log:
o create an usage page and move the documentation inside
o clarify description

Added:
    maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt   (with props)
Modified:
    maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt
    maven/shared/trunk/maven-doxia-tools/src/site/site.xml

Modified: 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=651943&r1=651942&r2=651943&view=diff
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt (original)
+++ maven/shared/trunk/maven-doxia-tools/src/site/apt/index.apt Sun Apr 27 06:25:16 2008
@@ -3,7 +3,7 @@
  ------
  Dennis Lundberg
  ------
- 2008-03-22
+ 2008-04-27
  ------
 
  ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,43 +29,10 @@
 
 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" );
-        ...
-    }
-
-    ...
-}
-+-----
+  This shared component has some utilities that are useful when integrating Doxia in Maven,
+  mainly for site generation and report creation. The main entry point is the
+  {{{apidocs/org/apache/maven/doxia/tools/SiteTool.html}SiteTool}} Plexus component.
+
+* Usage
+
+  Instructions on how to use the integration of Doxia in Maven can be found {{{usage.html}here}}.

Added: maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt?rev=651943&view=auto
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt (added)
+++ maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt Sun Apr 27 06:25:16 2008
@@ -0,0 +1,69 @@
+ ------
+ Usage
+ ------
+ Dennis Lundberg
+ Vincent Siveton
+ ------
+ 2008-04-27
+ ------
+
+ ~~ 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
+
+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" );
+        ...
+    }
+
+    ...
+}
++-----
+
+* References
+
+  [[1]] {{{apidocs/org/apache/maven/doxia/tools/SiteTool.html}SiteTool API}}
+
+  []
\ No newline at end of file

Propchange: maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/shared/trunk/maven-doxia-tools/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: 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=651943&r1=651942&r2=651943&view=diff
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/site/site.xml (original)
+++ maven/shared/trunk/maven-doxia-tools/src/site/site.xml Sun Apr 27 06:25:16 2008
@@ -23,6 +23,7 @@
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html" />
+      <item name="Usage" href="usage.html" />
     </menu>
     <menu ref="reports" />
   </body>



Mime
View raw message