svn commit: r478666 - in /maven/plugins/trunk/maven-changelog-plugin/src/site: apt/examples/modifying-scm-links.apt site.xml

[de...@apache.org]

Author: dennisl
Date: Thu Nov 23 12:49:27 2006
New Revision: 478666

URL: http://svn.apache.org/viewvc?view=rev&rev=478666
Log:
[MCHANGELOG-16] when using svn, links are wrong

o Add documentation about the new configuration option.

Added:
    maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt   (with props)
Modified:
    maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml

Added: maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt?view=auto&rev=478666
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt (added)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt Thu Nov 23 12:49:27 2006
@@ -0,0 +1,56 @@
+ ------
+ Modifying SCM Links
+ ------
+ Dennis Lundberg
+ ------
+ November 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
+
+
+Modifying SCM Links
+
+  The plugin normally works out of the box with the most popular web frontends
+  for SCM systems. If for some reason the links to the web frontend for your
+  SCM system are not correct, you can tweak the links by configuring the plugin
+  properly. This is done with the <<<\<displayFileDetailUrl\>>>> element.
+
+  To your aid you have a special token <<<%FILE%>>> that corresponds to the
+  relative path to the file in your repository. The path starts at the
+  project's root in your SCM system.
+
+  The following configuration will use alternate URLs to your SCM system:
+
++-----+
+<project>
+  ...
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changelog-plugin</artifactId>
+        <configuration>
+          <displayFileDetailUrl>http://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup</displayFileDetailUrl>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+  ...
+</project>
++-----+

Propchange: maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/modifying-scm-links.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml?view=diff&rev=478666&r1=478665&r2=478666
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml Thu Nov 23 12:49:27 2006
@@ -25,6 +25,7 @@
       <item name="FAQ" href="faq.html"/>
     </menu>
     <menu name="Examples">
+      <item name="Modifying SCM Links" href="/examples/modifying-scm-links.html"/>
       <item name="Selecting Reports" href="/examples/selecting-reports.html"/>
       <item name="Using Date Type" href="/examples/configuration-date-type.html"/>
       <item name="Using Range Type" href="/examples/configuration-range-type.html"/>