doxia-integration-tools/src/site/apt/usage.apt

 ------
 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;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
...

/**
 * Your own mojo.
 */
@Mojo( name = "your-own" )
public class YourOwnMojo extends AbstractMojo
{
    ...

    /**
     * SiteTool.
     */
    @Component
    protected SiteTool siteTool;

    ...

    public someMethod()
    {
        List localesList = siteTool.getSiteLocales( locales );
        String relativePath = siteTool.getRelativePath( "C:/foo/child",
                                                        "C:/foo/master" );
        ...
    }

    ...
}
+-----

* References

  [[1]] {{{./apidocs/org/apache/maven/doxia/tools/SiteTool.html}SiteTool API}}

  []