Author: dennisl
Date: Thu Jul 5 14:27:16 2007
New Revision: 553641
URL: http://svn.apache.org/viewvc?view=rev&rev=553641
Log:
o Go through the documentation and add some formating, fix minor typos and
insert a couple of notes for recurring questions from the user list.
o Add a page on how to use the new headingDateFormat.
Added:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt
(with props)
Modified:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/configuration-date-type.apt
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/selecting-reports.apt
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt?view=auto&rev=553641
==============================================================================
---
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt
(added)
+++
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt
Thu Jul 5 14:27:16 2007
@@ -0,0 +1,59 @@
+ ------
+ Changing the Heading Date Format
+ ------
+ Dennis Lundberg
+ ------
+ July 2007
+ ------
+
+ ~~ 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/guides/mini/guide-apt-format.html
+
+
+Changing the Heading Date Format
+
+ If you are using one of the types <<<date>>> or <<<range>>>, the headings of
+ the reports will have dates in them. Starting with version 2.1 of the plugin,
+ it is possible to configure the format of these dates.
+
+ This is done with the <<<\<headingDateFormat\>>>> configuration element. It
+ takes a string of characters, the same that is used in the
+
{{{http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html}SimpleDateFormat}}
+ class, and uses them to format the dates in the headings to your liking.
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ <configuration>
+ <type>range</type>
+ <range>30</range>
+ <headingDateFormat>dd MMM, yyyy</headingDateFormat>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----+
Propchange:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/changing-heading-date-format.apt
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/configuration-date-type.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/configuration-date-type.apt?view=diff&rev=553641&r1=553640&r2=553641
==============================================================================
---
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/configuration-date-type.apt
(original)
+++
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/configuration-date-type.apt
Thu Jul 5 14:27:16 2007
@@ -34,6 +34,10 @@
activities between Aug 1, 2005 to Sept 1, 2005. Please note that the date
range is inclusive.
+ <<Note:>> The <<<\<dateFormat\>>>> configuration is used <<only>> when
+ parsing the dates that come from your SCM. It is <<not>> used to format the
+ dates in the report.
+
+-----+
<project>
...
Modified:
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/selecting-reports.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/selecting-reports.apt?view=diff&rev=553641&r1=553640&r2=553641
==============================================================================
---
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/selecting-reports.apt
(original)
+++
maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/selecting-reports.apt
Thu Jul 5 14:27:16 2007
@@ -29,12 +29,17 @@
Selecting Reports
- The plugin normally generates 3 reports: changelog, dev-activity and
- file-activity. It is possible to configure the plugin so that only a few of
- these reports are generated. This is done using <<<\<reportSets\>>>>.
+ The plugin normally generates 3 reports: <<<changelog>>>, <<<dev-activity>>>
+ and <<<file-activity>>>. By default all three reports are generated. It is
+ possible to configure the plugin so that only a few of these reports are
+ generated. This is done using <<<\<reportSets\>>>>.
- The following configuration will generate only the changelog and
file-activity
- reports.
+ The following configuration will generate only the <<<changelog>>> and
+ <<<file-activity>>> reports.
+
+ <<Note:>> The <<<reportSets>>> element is not part of the <<<configuration>>>
+ element. Instead, the <<<configuration>>> is found inside the
+ <<<reportSet>>> element.
+-----+
<project>
Modified: maven/plugins/trunk/maven-changelog-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/usage.apt?view=diff&rev=553641&r1=553640&r2=553641
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/apt/usage.apt Thu Jul
5 14:27:16 2007
@@ -27,8 +27,8 @@
Usage
- The reports may use either <<<range>>>, <<<date>>>, or <<<tag>>> as the basis
- for generating the reports. Only one can be set. The change sets can be
+ The reports may use either <<<range>>>, <<<date>>>, or <<<tag>>> as the type
+ for generating the reports. Only one type can be set. The change sets can be
configured by setting the correct parameter for the chosen type. If <<<type>>>
"date" is chosen, then the parameter <<<dates>>> should contain the start and
stop dates for the date range. Similar configurations should be made for the
@@ -54,7 +54,7 @@
Aside from the required plugin configuration parameters needed to generate the
reports, all reports will refer to the <<<scm>>> elements inside the project
- descriptor for other details regarding the connection to the project's SCM.
+ descriptor for details regarding the connection to the project's SCM.
Here is an example of the scm element inside the <<<pom.xml>>>:
-------------------
@@ -73,8 +73,9 @@
<<<scm>>> elements. It can be found
{{{http://maven.apache.org/ref/current/maven-model/maven.html#class_scm}here}}.
- When you execute <<<mvn site>>>, you will see that the changelog, dev-activity
- and file-activity reports are included in the generated site.
+ When you execute <<<mvn site>>>, you will see that the <<<changelog>>>,
+ <<<dev-activity>>> and <<<file-activity>>> reports are included in the
+ generated site.
Sample Changelog report:
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=553641&r1=553640&r2=553641
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml Thu Jul 5
14:27:16 2007
@@ -28,6 +28,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
+ <item name="Changing the Heading Date Format"
href="/examples/changing-heading-date-format.html"/>
<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"/>
