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/06/29 12:24:45 UTC
Plugin properties suggestion
Hi,
This is a suggestion of how to create and document plugin properties easier.
- Create an xml file called properties.xml with the following DTD.
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, maybe in the future
there will be support for reading properties directly from it.
Here is the DTD
<?xml version="1.0" encoding="ISO-8859-1"?>
<!ELEMENT properties (
property*)>
<!ELEMENT property (#PCDATA)>
<!ATTLIST property
name CDATA #REQUIRED
default CDATA #IMPLIED ""
required (true|false) #IMPLIED "false"
>
And an example
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE properties SYSTEM "properties.dtd">
<properties>
<property name="maven.aspectj.debug" default="false">
If true, run in debug mode
</property>
</properties>
What do you think?
Regards
Carlos Sanchez
A Coruña, Spain
Oness Project
http://oness.sourceforge.net
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Plugin properties suggestion
Posted by Carlos Sanchez <ap...@carlos.cousas.net>.
> -----Original Message-----
> From: Jerome Lacoste [mailto:jerome@coffeebreaks.org]
> Sent: Tuesday, June 29, 2004 2:03 PM
> To: dev@maven.apache.org
> Subject: RE: Plugin properties suggestion
>
> On Tue, 2004-06-29 at 13:49, Eric Pugh wrote:
> > I like the idea..
>
> me too
>
> > Would the next logical step be to verify as well that anything in
> > plugin.properties was listed in the properties.xml file? It seems
> > that pretty much anything in plugin.properties should be documented.
>
> sounds good to me.
This seems easy
>
> > You could also apply the same logic to goals as well.
>
> In that case, maybe the proposal should be reworked into
> using an XML file called plugin-doc.xml where properties are
> just a sub part of the full tree. Goals would be added.
>
> That makes it more extensible, and then you don't have
> hundreds of files for your doc.
It's different for goals as you can't generate the jelly script from the
xml.
Maybe the inverse, document goals in plugin.jelly and transform it into a
xdoc file.
>
> Jerome
>
>
>
> ---------------------------------------------------------------------
> 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: Plugin properties suggestion
Posted by Jerome Lacoste <je...@coffeebreaks.org>.
On Tue, 2004-06-29 at 13:49, Eric Pugh wrote:
> I like the idea..
me too
> Would the next logical step be to verify as well that
> anything in plugin.properties was listed in the properties.xml file? It
> seems that pretty much anything in plugin.properties should be documented.
sounds good to me.
> You could also apply the same logic to goals as well.
In that case, maybe the proposal should be reworked into using an XML
file called plugin-doc.xml where properties are just a sub part of the
full tree. Goals would be added.
That makes it more extensible, and then you don't have hundreds of files
for your doc.
Jerome
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Plugin properties suggestion
Posted by Eric Pugh <ep...@upstate.com>.
I like the idea.. Would the next logical step be to verify as well that
anything in plugin.properties was listed in the properties.xml file? It
seems that pretty much anything in plugin.properties should be documented.
You could also apply the same logic to goals as well.
Eric
> -----Original Message-----
> From: Carlos Sanchez [mailto:apache@carlos.cousas.net]
> Sent: Tuesday, June 29, 2004 12:25 PM
> To: 'Maven Developers List'
> Subject: Plugin properties suggestion
>
>
> Hi,
>
> This is a suggestion of how to create and document plugin
> properties easier.
>
> - Create an xml file called properties.xml with the following DTD.
> 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, maybe in the future
> there will be support for reading properties directly from it.
>
> Here is the DTD
>
> <?xml version="1.0" encoding="ISO-8859-1"?>
> <!ELEMENT properties (
> property*)>
>
> <!ELEMENT property (#PCDATA)>
>
> <!ATTLIST property
> name CDATA #REQUIRED
> default CDATA #IMPLIED ""
> required (true|false) #IMPLIED "false"
> >
>
>
>
> And an example
>
> <?xml version="1.0" encoding="ISO-8859-1"?>
> <!DOCTYPE properties SYSTEM "properties.dtd">
> <properties>
> <property name="maven.aspectj.debug" default="false">
> If true, run in debug mode
> </property>
> </properties>
>
>
> What do you think?
>
>
> Regards
>
> Carlos Sanchez
> A Coruña, Spain
>
> Oness Project
> http://oness.sourceforge.net
>
>
>
>
> ---------------------------------------------------------------------
> 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