Issue Details (XML | Word | Printable)

Key: MPANNOUNCEMENT-15
Type: Wish Wish
Status: Closed Closed
Resolution: Fixed
Priority: Minor Minor
Assignee: Vincent Massol
Reporter: Shinobu Kawai
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Maven 1.x Announcement Plugin

A way to override the team name in "The ${pom.groupId} team"

Created: 27/Oct/04 09:46 PM   Updated: 01/Nov/04 10:24 AM   Resolved: 01/Nov/04 10:24 AM
Component/s: None
Affects Version/s: 1.4
Fix Version/s: 1.4

Time Tracking:
Not Specified

File Attachments: 1. Text File announcement.teamname.patch (2 kB)



 Description  « Hide

It would be cool if there was a way to override the team name in the announcement.jsl.

Something like

maven.announcement.teamname = ${pom.groupId}

and use this instead of ${pom.groupId} in the jsl.



Shinobu Kawai added a comment - 28/Oct/04 01:20 AM

The patch to grant my wish.


Felipe Leme added a comment - 28/Oct/04 06:48 AM

Hi Shinobu,

Can't you just use a customized announcements.jsl instead?

My only concern with this type of improvement is that we will be add another property for just a specific part of the announcement. Why not on other parts as well?

Anyway, let's wait for Vincent's opinion.

– Felipe

PS: in case we decide to fix it, could you please provide a full patch, including modifications on xdocs/plugin.properties (explaining the new property), xdocs/changes.xml (with this new fix), project.xml (adding yourself as contributor), plugin.properties (setting the property and it's default value) and the changes itself (in this case, announcement.jsl)?


Shinobu Kawai added a comment - 28/Oct/04 08:11 AM

Hi Felipe,

Oops, I overlooked this guy:
maven.announcement.stylesheet.path

I guess I can live with that. I don't like copy and pasting, though.

  1. And if you do decide to add the new property, sure I can make the full patch.

Best regards,
– Shinobu Kawai


Felipe Leme added a comment - 28/Oct/04 08:52 AM

I agree with you, a property is better than a full copy-and-paste. I'm just worried we would be 'bloating' the plugin with more properties (I already added a lot in the past issue

Anyway, let's wait for a third opinion (i.e., Vincente .


Vincent Massol added a comment - 31/Oct/04 07:18 AM

Hi,

The feature of choosing the group name is already implemented in the plugin. It is using the POM groupId name. I'd like to know why this is not enough and what is the rationale behind choosing another property for this.

Note: I'm not against it, I'd just like to better understand in other to offer the best possible design for this

Thanks


Shinobu Kawai added a comment - 31/Oct/04 08:07 AM

Hi Vincent,

This all came from my plugin devolpment, the Maven DocCheck Plugin.
http://maven-doccheck.sourceforge.net/

This plugin produces a report using Sun's Doc Check Doclet. The doclet itself is made in Sun. I thought the phrase "The doccheck team" could be taken to refer to the Sun team, whereas the plugin itself is by a different team (me!). In order to avoid confusion, I wanted to emphasize that the release was made by "The Maven-DocCheck team". Hence, the new property proposal.
http://maven-doccheck.sourceforge.net/announcements/announcement-1.4-0.1.txt

  1. In retrospect, I guess I could have used "maven-doccheck-plugin" as my group id in the first place.

Best regards,
– Shinobu Kawai


Vincent Massol added a comment - 01/Nov/04 09:31 AM

Thanks for the details. What would you think if we change the template to use ${pom.name} instead?

It would say: "The ${pom.name} team ..."

Or simply "We are pleased to announce..." and sign with "-The development team"?


Shinobu Kawai added a comment - 01/Nov/04 09:50 AM

Hey, that'll be perfect!


Vincent Massol added a comment - 01/Nov/04 10:03 AM

Which one do you prefer:

1/ the use of ${pom.name}
or
2/ the use of "We are pleased..."
?


Shinobu Kawai added a comment - 01/Nov/04 10:07 AM

I like
1/ the use of ${pom.name}
better, but wouldn't complain if it were the other.


Vincent Massol added a comment - 01/Nov/04 10:24 AM

Done.