You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Carlos Sanchez <ap...@carlos.cousas.net> on 2004/07/01 11:47:56 UTC
Generate plugin.properties and properties documentation from a common file
I've just submitted the patch to JIRA.
Comments, please?
Carlos Sanchez
A Coruña, Spain
Oness Project
http://oness.sourceforge.net
> -----Original Message-----
> From: jira@codehaus.org [mailto:jira@codehaus.org]
> Sent: Thursday, July 01, 2004 11:43 AM
> To: dev@maven.apache.org
> Subject: [jira] Created: (MPPLUGIN-21) Autogenerate
> plugin.properties and properties documentation
>
> Message:
>
> A new issue has been created in JIRA.
>
> ---------------------------------------------------------------------
> View the issue:
> http://jira.codehaus.org/browse/MPPLUGIN-21
>
> Here is an overview of the issue:
> ---------------------------------------------------------------------
> Key: MPPLUGIN-21
> Summary: Autogenerate plugin.properties and properties
> documentation
> Type: New Feature
>
> Status: Open
> Priority: Minor
>
> Original Estimate: Unknown
> Time Spent: Unknown
> Remaining: Unknown
>
> Project: maven-plugin-plugin
>
> Assignee: Carlos Sanchez
> Reporter: Carlos Sanchez
>
> Created: Thu, 1 Jul 2004 5:43 AM
> Updated: Thu, 1 Jul 2004 5:43 AM
>
> Description:
> As sent to the developer list this is a suggestion of how to
> create and document plugin properties easier.
>
> - Create an xml file called plugin-properties.xml
>
> In the plugin project:
> - Process it to generate the properties.xml xdoc using
> <report>maven-plugin-plugin</report>
> - Process it to generate the plugin.properties file (goal
> plugin:generate-properties), maybe in the future there will
> be support for reading properties directly from it.
>
>
> Just one issue, I wasn't able to add a newline character in a
> jsl file:
> <jsl:template match="property">
> <j:set var="name"><x:expr select="@name"/></j:set>
> <j:set var="default"><x:expr select="@default"/></j:set>
> ${name}=${default}<!-- Here there should be a newline -->
> </jsl:template>
>
>
> Examples:
>
> The base file
> http://maven.apache.org/reference/plugins/aspectj/plugin-properties.xml
>
> The generated documentation
> http://maven.apache.org/reference/plugins/aspectj/properties.html
>
> The DTD
>
http://maven.apache.org/reference/plugins/aspectj/plugin_properties_1_0.dtd
>
>
>
>
> ---------------------------------------------------------------------
> JIRA INFORMATION:
> This message is automatically generated by JIRA.
>
> If you think it was sent incorrectly contact one of the
> administrators:
> http://jira.codehaus.org/secure/Administrators.jspa
>
> If you want more information on JIRA, or have a bug to report see:
> http://www.atlassian.com/software/jira
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org For
> additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Generate plugin.properties and properties documentation from a common file
Posted by Carlos Sanchez <ap...@carlos.cousas.net>.
Done, attached new patch in jira
http://jira.codehaus.org/browse/MPPLUGIN-21
> -----Original Message-----
> From: Dion Gillard [mailto:dion.gillard@gmail.com]
> Sent: Friday, July 02, 2004 1:41 AM
> To: Maven Developers List
> Subject: Re: Generate plugin.properties and properties
> documentation from a common file
>
> On Fri, 2 Jul 2004 00:15:00 +0200, Carlos Sanchez
> <ap...@carlos.cousas.net> wrote:
> >
> > Hi Dion,
> >
> > Yes, it's true, no doc, no test. Just a "demo" ;) but it
> will be done.
> > I've only tested it with the aspectj and plugin plugins.
> >
> > What I need first is how to add a newline character in a jsl file:
> > <jsl:template match="property">
> > <j:set var="name"><x:expr select="@name"/></j:set>
> > <j:set var="default"><x:expr select="@default"/></j:set>
> > ${name}=${default}<!-- Here there should be a newline -->
> > </jsl:template>
>
> I think you could do this with a
> <j:whitespace trim="false">
> ${name}=${default}
> </j:whitespace>
>
> Untested tho.
>
> > And upload the dtd to the web server if you agree with name
> and folder
> >
> > <!DOCTYPE plugin-properties PUBLIC
> > "-//Apache Software Foundation//DTD Maven Plugin
> Properties
> > Definition 1.0//EN"
> > "http://maven.apache.org/dtds/plugin-properties_1_0.dtd">
> >
> > Or maybe
> >
> "http://maven.apache.org/reference/plugins/plugin/src/dtds/plugin-prop
> > erties
> > _1_0.dtd"
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org For
> additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Generate plugin.properties and properties documentation from a common file
Posted by Dion Gillard <di...@gmail.com>.
On Fri, 2 Jul 2004 00:15:00 +0200, Carlos Sanchez
<ap...@carlos.cousas.net> wrote:
>
> Hi Dion,
>
> Yes, it's true, no doc, no test. Just a "demo" ;) but it will be done.
> I've only tested it with the aspectj and plugin plugins.
>
> What I need first is how to add a newline character in a jsl file:
> <jsl:template match="property">
> <j:set var="name"><x:expr select="@name"/></j:set>
> <j:set var="default"><x:expr select="@default"/></j:set>
> ${name}=${default}<!-- Here there should be a newline -->
> </jsl:template>
I think you could do this with a
<j:whitespace trim="false">
${name}=${default}
</j:whitespace>
Untested tho.
> And upload the dtd to the web server if you agree with name and folder
>
> <!DOCTYPE plugin-properties PUBLIC
> "-//Apache Software Foundation//DTD Maven Plugin Properties
> Definition 1.0//EN"
> "http://maven.apache.org/dtds/plugin-properties_1_0.dtd">
>
> Or maybe
> "http://maven.apache.org/reference/plugins/plugin/src/dtds/plugin-properties
> _1_0.dtd"
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Generate plugin.properties and properties documentation from a common file
Posted by Carlos Sanchez <ap...@carlos.cousas.net>.
Hi Dion,
Yes, it's true, no doc, no test. Just a "demo" ;) but it will be done.
I've only tested it with the aspectj and plugin plugins.
What I need first is how to add a newline character in a jsl file:
<jsl:template match="property">
<j:set var="name"><x:expr select="@name"/></j:set>
<j:set var="default"><x:expr select="@default"/></j:set>
${name}=${default}<!-- Here there should be a newline -->
</jsl:template>
And upload the dtd to the web server if you agree with name and folder
<!DOCTYPE plugin-properties PUBLIC
"-//Apache Software Foundation//DTD Maven Plugin Properties
Definition 1.0//EN"
"http://maven.apache.org/dtds/plugin-properties_1_0.dtd">
Or maybe
"http://maven.apache.org/reference/plugins/plugin/src/dtds/plugin-properties
_1_0.dtd"
Regards
Carlos Sanchez
A Coruña, Spain
Oness Project
http://oness.sourceforge.net
> -----Original Message-----
> From: Dion Gillard [mailto:dion.gillard@gmail.com]
> Sent: Thursday, July 01, 2004 3:57 PM
> To: Maven Developers List
> Subject: Re: Generate plugin.properties and properties
> documentation from a common file
>
> This makes it available, and looks ok.
>
> However, I didn't see any docs for it, or any tests.
>
> I'm happy it can do the job, but to adopt it, we need to
> document it, have it tested, and convert maven-plugins over
> to use it too.
>
> On Thu, 1 Jul 2004 11:47:56 +0200, Carlos Sanchez
> <ap...@carlos.cousas.net> wrote:
> >
> > I've just submitted the patch to JIRA.
> >
> > Comments, please?
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org For
> additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Generate plugin.properties and properties documentation from a common file
Posted by Dion Gillard <di...@gmail.com>.
This makes it available, and looks ok.
However, I didn't see any docs for it, or any tests.
I'm happy it can do the job, but to adopt it, we need to document it,
have it tested, and convert maven-plugins over to use it too.
On Thu, 1 Jul 2004 11:47:56 +0200, Carlos Sanchez
<ap...@carlos.cousas.net> wrote:
>
> I've just submitted the patch to JIRA.
>
> Comments, please?
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org