Re: Aligning plugin artifacts with normal projects
As well, Ant already has an xml format for it's properties. See http://ant.apache.org/manual/CoreTasks/xmlproperty.html -- dIon Gillard, Multitask Consulting Blog: http://blogs.codehaus.org/people/dion/ Work: http://www.multitask.com.au Rafal Krzewski <[EMAIL PROTECTED]> wrote on 27/06/2003 06:20:10 PM: > [EMAIL PROTECTED] wrote: > > >>We also need it for documentation. Its quite common for people to ask > >>'what property do I set to do' because there are so many > >>undocumented properties. If there was a metadata file that described > >>plugin properties, it could be used to generate the xdocs. > > > > There is one. It's called plugin.properties, and it can be used to > > generate the xdocs :-) > > We could probably make a contract that the comment block directly above > the property contains it's description, but I'm not sure if this is > what we really want? > > Generating an xdoc from the property files itself has an advantage > of "on the spot" documentation, just like JavaDoc - you can read it in > the Java source, but also in the generated HTML pages. We also don't > have two files that need to be kept in sync (humans *always* forget...) > > We could go the other way around, and generated plugin.properties files > from the metadata, to lift the need for synchronizing files. > Descriptions in the metadata file could be emmited into the file as > well. The metadata file would be xml (seems natural to me), so we > could have a schema for it and take advantage of validation. On the > other hand, should we really introduce a new format for specifying > properties? > > Given the choice I'd probably stay with .properties files only, > and write the PropertyDoc thingy. > > > The reason the documentation is lacking is noone has been willing to > > do it. > > True. No matter which way we go - metadata files, or "PropertiesDoc" > plugin maintainers will have to fill in the descriptions anyway... > > R. > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] >
RE: Aligning plugin artifacts with normal projects
> > We also need it for documentation. Its quite common for people to ask > > 'what property do I set to do' because there are so many > > undocumented properties. If there was a metadata file that described > > plugin properties, it could be used to generate the xdocs. > There is one. It's called plugin.properties, and it can be used to > generate the xdocs :-) > > The reason the documentation is lacking is noone has been willing to do > it. > -- I think we soon will need more flexibility with documentation of properties. Sorry for being ridiculous (I know even English documentation su..) I suppose that we might need also localized documentation of the properties (translation) and possibly also definition of some constrains for those properties. If we have it: we can finally imagine that somebody will write a GUI front-end to maven which will dynamically create user interface. I really would prefer to use maven integrated with my Eclipse :) Michal - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
[EMAIL PROTECTED] wrote: >>We also need it for documentation. Its quite common for people to ask >>'what property do I set to do' because there are so many >>undocumented properties. If there was a metadata file that described >>plugin properties, it could be used to generate the xdocs. > > There is one. It's called plugin.properties, and it can be used to > generate the xdocs :-) We could probably make a contract that the comment block directly above the property contains it's description, but I'm not sure if this is what we really want? Generating an xdoc from the property files itself has an advantage of "on the spot" documentation, just like JavaDoc - you can read it in the Java source, but also in the generated HTML pages. We also don't have two files that need to be kept in sync (humans *always* forget...) We could go the other way around, and generated plugin.properties files from the metadata, to lift the need for synchronizing files. Descriptions in the metadata file could be emmited into the file as well. The metadata file would be xml (seems natural to me), so we could have a schema for it and take advantage of validation. On the other hand, should we really introduce a new format for specifying properties? Given the choice I'd probably stay with .properties files only, and write the PropertyDoc thingy. > The reason the documentation is lacking is noone has been willing to > do it. True. No matter which way we go - metadata files, or "PropertiesDoc" plugin maintainers will have to fill in the descriptions anyway... R. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
Brian Ewins <[EMAIL PROTECTED]> wrote on 26/06/2003 06:29:09 PM: > Michal Maczka wrote: > > > > > I think we should go step further and get rid of plugin.properties file... > > in favour of metadata file. > > It can look like: > [snip] > > BTW: We anyway need plugin metadata file which can be used by IDEs. > > Agree 100%. > > We also need it for documentation. Its quite common for people to ask > 'what property do I set to do' because there are so many > undocumented properties. If there was a metadata file that described > plugin properties, it could be used to generate the xdocs. There is one. It's called plugin.properties, and it can be used to generate the xdocs :-) The reason the documentation is lacking is noone has been willing to do it. -- dIon Gillard, Multitask Consulting Blog: http://blogs.codehaus.org/people/dion/ Work: http://www.multitask.com.au
RE: Aligning plugin artifacts with normal projects
On Thu, 2003-06-26 at 08:23, Michal Maczka wrote: > I like this idea! I agree, that is a good idea. It definitely allows using the same tools throughout the source code. Having the little niggly bits for reading plugin.jelly and plugin.properties causes some problems internally. I think this is the best idea so far. > mm > > > -Original Message- > > From: Mark H. Wilkinson [mailto:[EMAIL PROTECTED] > > Sent: Thursday, June 26, 2003 11:10 AM > > To: Maven Developers List > > Subject: Re: Aligning plugin artifacts with normal projects > > > > On Wed, 2003-06-25 at 22:58, Jason van Zyl wrote: > > > Hi, > > > > > > We had a quick chat in IRC about aligning plugin artifacts with normal > > > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > > > and the simple project.properties instead of plugin.properties. > > > > Responses seem to be suggesting that it's not unheard of for a plugin > > project to use maven.xml and project.properties at build time. I'd have > > thought the obvious solution to make this all more consistent would be > > to move the run-time executable parts of the plugin somewhere under the > > src directory rather than having everything dumped in the project root > > as at the moment: > > > > plugin > > project.xml > > project.properties > > maven.xml > > /src > > /java > > /org... > > /maven > > maven.xml > > project.properties > > /xdocs > > > > This would tighten up the distinction between project metadata and > > build-time stuff (project root) and run-time artifacts (somewhere under > > src). > > > > -Mark. > > > > > > - > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://tambora.zenplex.org In short, man creates for himself a new religion of a rational and technical order to justify his work and to be justified in it. -- Jacques Ellul, The Technological Society - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
On Thu, 2003-06-26 at 01:40, [EMAIL PROTECTED] wrote: > How would we be able to differentiate then between the properties a plugin > exposes and those it uses for it's own purposes? The plugin plugin uses > plugin.properties to generate docs. Ok, it looks like we will keep both in order to make a distinction between building the plugin and running the plugin. I jumped the gun a bit. That's why I asked. > -- > dIon Gillard, Multitask Consulting > Blog: http://blogs.codehaus.org/people/dion/ > Work: http://www.multitask.com.au > > > Jason van Zyl <[EMAIL PROTECTED]> wrote on 26/06/2003 07:58:52 AM: > > > Hi, > > > > We had a quick chat in IRC about aligning plugin artifacts with normal > > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > > and the simple project.properties instead of plugin.properties. > > > > I think this alignment would make explaining plugins work as they now do > > work the same as a normal project. > > > > I can change all the plugins in CVS but admittedly plugins outside the > > ones we store will have to change the file names if we make the change. > > I would like to make the plugins more consistent with normal projects > > for 1.0 if there are no objections. > > > > -- > > jvz. > > > > Jason van Zyl > > [EMAIL PROTECTED] > > http://tambora.zenplex.org > > > > In short, man creates for himself a new religion of a rational > > and technical order to justify his work and to be justified in it. > > > > -- Jacques Ellul, The Technological Society > > > > > > - > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > -- jvz. Jason van Zyl [EMAIL PROTECTED] http://tambora.zenplex.org In short, man creates for himself a new religion of a rational and technical order to justify his work and to be justified in it. -- Jacques Ellul, The Technological Society - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Aligning plugin artifacts with normal projects
On Thu, 2003-06-26 at 01:27, Vincent Massol wrote: > ATM I have different properties in plugin.properties and in > project.properties. The ones in project.properties are used to build the > plugin only and they must not be used when the user uses the plugin. > > How do we deal with this? Again I can leave them separate. As I'm refactoring I'm just popping out questions to users to make sure I don't bonk anyone. > Thanks > -Vincent > > > -Original Message- > > From: Jason van Zyl [mailto:[EMAIL PROTECTED] > > Sent: 25 June 2003 23:59 > > To: Maven Developers List > > Subject: Aligning plugin artifacts with normal projects > > > > Hi, > > > > We had a quick chat in IRC about aligning plugin artifacts with normal > > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > > and the simple project.properties instead of plugin.properties. > > > > I think this alignment would make explaining plugins work as they now > do > > work the same as a normal project. > > > > I can change all the plugins in CVS but admittedly plugins outside the > > ones we store will have to change the file names if we make the > change. > > I would like to make the plugins more consistent with normal projects > > for 1.0 if there are no objections. > > > > -- > > jvz. > > > > Jason van Zyl > > [EMAIL PROTECTED] > > http://tambora.zenplex.org > > > > In short, man creates for himself a new religion of a rational > > and technical order to justify his work and to be justified in it. > > > > -- Jacques Ellul, The Technological Society > > > > > > - > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://tambora.zenplex.org In short, man creates for himself a new religion of a rational and technical order to justify his work and to be justified in it. -- Jacques Ellul, The Technological Society - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Aligning plugin artifacts with normal projects
I like this idea! mm > -Original Message- > From: Mark H. Wilkinson [mailto:[EMAIL PROTECTED] > Sent: Thursday, June 26, 2003 11:10 AM > To: Maven Developers List > Subject: Re: Aligning plugin artifacts with normal projects > > On Wed, 2003-06-25 at 22:58, Jason van Zyl wrote: > > Hi, > > > > We had a quick chat in IRC about aligning plugin artifacts with normal > > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > > and the simple project.properties instead of plugin.properties. > > Responses seem to be suggesting that it's not unheard of for a plugin > project to use maven.xml and project.properties at build time. I'd have > thought the obvious solution to make this all more consistent would be > to move the run-time executable parts of the plugin somewhere under the > src directory rather than having everything dumped in the project root > as at the moment: > > plugin > project.xml > project.properties > maven.xml > /src > /java > /org... > /maven > maven.xml > project.properties > /xdocs > > This would tighten up the distinction between project metadata and > build-time stuff (project root) and run-time artifacts (somewhere under > src). > > -Mark. > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
On Wed, 2003-06-25 at 22:58, Jason van Zyl wrote: > Hi, > > We had a quick chat in IRC about aligning plugin artifacts with normal > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > and the simple project.properties instead of plugin.properties. Responses seem to be suggesting that it's not unheard of for a plugin project to use maven.xml and project.properties at build time. I'd have thought the obvious solution to make this all more consistent would be to move the run-time executable parts of the plugin somewhere under the src directory rather than having everything dumped in the project root as at the moment: plugin project.xml project.properties maven.xml /src /java /org... /maven maven.xml project.properties /xdocs This would tighten up the distinction between project metadata and build-time stuff (project root) and run-time artifacts (somewhere under src). -Mark. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
Stealing my ideas and passing them off as your own eh :P
http://wiki.codehaus.org/general/Maven_2fPluginMetadata
Michal Maczka wrote:
-Original Message-
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]
Sent: Thursday, June 26, 2003 7:41 AM
To: Maven Developers List
Subject: Re: Aligning plugin artifacts with normal projects
How would we be able to differentiate then between the properties a plugin
exposes and those it uses for it's own purposes? The plugin plugin uses
plugin.properties to generate docs.
I have exactly the same doubts.
I think we should go step further and get rid of plugin.properties file...
in favour of metadata file.
It can look like:
foo
baa
foo
maven-foo-plugin
So when plugin is loaded all properties (native and imported from another
plugins)are directly accessibly in it's context.
So we even don't need:
${plugin.getProperty('maven.compile.target')} ---> ${maven.compile.target}
or
${pom.getPluginContext('maven-foo-plugin').getVariable('bar')} --> ${foo}
There is one problem here: some goal's might not need some properties, so
loading them while plugin starts might be expensive.
We I hope we can find solution for that.
It is much simpler then what you have proposed and more powerful
BTW: We anyway need plugin metadata file which can be used by IDEs.
Michal
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
Michal Maczka wrote: I think we should go step further and get rid of plugin.properties file... in favour of metadata file. It can look like: [snip] BTW: We anyway need plugin metadata file which can be used by IDEs. Agree 100%. We also need it for documentation. Its quite common for people to ask 'what property do I set to do' because there are so many undocumented properties. If there was a metadata file that described plugin properties, it could be used to generate the xdocs. However it isn't just plugins that need this - normal projects use additional properties to configure things in their maven.xml. So properties should appear as a standard report. -Baz Privacy and Confidentiality Notice The information contained in this E-Mail message is intended only for the person or persons to whom it is addressed. Such information is confidential and privileged and no mistake in transmission is intended to waive or compromise such privilege. If you have received it in error, please destroy it and notify us on the telephone number printed above. If you do not receive complete and legible copies, please telephone us immediately. Any opinions expressed herein including attachments are those of the author only. i-documentsystems Ltd. does not accept responsibility for the accuracy or completeness of the information provided or for any changes to this Email, however made, after it was sent. (Please note that it is your responsibility to scan this message for viruses). - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Aligning plugin artifacts with normal projects
> -Original Message-
> From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]
> Sent: Thursday, June 26, 2003 7:41 AM
> To: Maven Developers List
> Subject: Re: Aligning plugin artifacts with normal projects
>
> How would we be able to differentiate then between the properties a plugin
> exposes and those it uses for it's own purposes? The plugin plugin uses
> plugin.properties to generate docs.
I have exactly the same doubts.
I think we should go step further and get rid of plugin.properties file...
in favour of metadata file.
It can look like:
foo
baa
foo
maven-foo-plugin
So when plugin is loaded all properties (native and imported from another
plugins)are directly accessibly in it's context.
So we even don't need:
${plugin.getProperty('maven.compile.target')} ---> ${maven.compile.target}
or
${pom.getPluginContext('maven-foo-plugin').getVariable('bar')} --> ${foo}
There is one problem here: some goal's might not need some properties, so
loading them while plugin starts might be expensive.
We I hope we can find solution for that.
It is much simpler then what you have proposed and more powerful
BTW: We anyway need plugin metadata file which can be used by IDEs.
Michal
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
I could only find it on the Jelly site :) - Brett Ben Walding wrote: irc.codehaus.org:6667 #maven Probably is documented, but I have no idea where :) Martin Skopp wrote: -- Web Developer f2 network ~ everything essential 02 8596 4437 - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
irc.codehaus.org:6667 #maven Probably is documented, but I have no idea where :) Martin Skopp wrote: On Wed, 2003-06-25 at 23:58, Jason van Zyl wrote: We had a quick chat in IRC about aligning plugin artifacts with normal Is there a special maven channel where you guy hang around? Could one provide server and channelname? Forgive me if it's somewhere documented... Thanks - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
On Wed, 2003-06-25 at 23:58, Jason van Zyl wrote: > We had a quick chat in IRC about aligning plugin artifacts with normal Is there a special maven channel where you guy hang around? Could one provide server and channelname? Forgive me if it's somewhere documented... Thanks -- Martin Skopp Riege Software International GmbH Support: mailto:[EMAIL PROTECTED], Information: http://www.riege.com This email is intended to be viewed with a nonproportional font. Public Key on http://www.keyserver.net, Key-ID: 3D4027B5 Fingerprint: 1970 C78D 9A1D 99FA 5CE4 5C0D 29E6 6A95 3D40 27B5 - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Aligning plugin artifacts with normal projects
How would we be able to differentiate then between the properties a plugin exposes and those it uses for it's own purposes? The plugin plugin uses plugin.properties to generate docs. -- dIon Gillard, Multitask Consulting Blog: http://blogs.codehaus.org/people/dion/ Work: http://www.multitask.com.au Jason van Zyl <[EMAIL PROTECTED]> wrote on 26/06/2003 07:58:52 AM: > Hi, > > We had a quick chat in IRC about aligning plugin artifacts with normal > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > and the simple project.properties instead of plugin.properties. > > I think this alignment would make explaining plugins work as they now do > work the same as a normal project. > > I can change all the plugins in CVS but admittedly plugins outside the > ones we store will have to change the file names if we make the change. > I would like to make the plugins more consistent with normal projects > for 1.0 if there are no objections. > > -- > jvz. > > Jason van Zyl > [EMAIL PROTECTED] > http://tambora.zenplex.org > > In short, man creates for himself a new religion of a rational > and technical order to justify his work and to be justified in it. > > -- Jacques Ellul, The Technological Society > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] >
RE: Aligning plugin artifacts with normal projects
ATM I have different properties in plugin.properties and in project.properties. The ones in project.properties are used to build the plugin only and they must not be used when the user uses the plugin. How do we deal with this? Thanks -Vincent > -Original Message- > From: Jason van Zyl [mailto:[EMAIL PROTECTED] > Sent: 25 June 2003 23:59 > To: Maven Developers List > Subject: Aligning plugin artifacts with normal projects > > Hi, > > We had a quick chat in IRC about aligning plugin artifacts with normal > Maven Projects. By this I mean using maven.xml instead of plugin.jelly > and the simple project.properties instead of plugin.properties. > > I think this alignment would make explaining plugins work as they now do > work the same as a normal project. > > I can change all the plugins in CVS but admittedly plugins outside the > ones we store will have to change the file names if we make the change. > I would like to make the plugins more consistent with normal projects > for 1.0 if there are no objections. > > -- > jvz. > > Jason van Zyl > [EMAIL PROTECTED] > http://tambora.zenplex.org > > In short, man creates for himself a new religion of a rational > and technical order to justify his work and to be justified in it. > > -- Jacques Ellul, The Technological Society > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
