Re: More visual project descriptor documentation
[EMAIL PROTECTED] writes: > Jim Crossley <[EMAIL PROTECTED]> wrote on 18/03/2004 10:57:54 PM: [...] >> Some visual way of distinguishing the required elements from the [...] > How about bold for required and strikethrough or italic for > deprecated? I like it! - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
Ok. I replied too quickly :-) > -Message d'origine- > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > Envoyé : jeudi 18 mars 2004 23:09 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > Found the unsub duplicate. Thanks. > -- > dIon Gillard, Multitask Consulting > > > > "Arnaud Heritier" <[EMAIL PROTECTED]> wrote on 19/03/2004 08:39:31 AM: > > > There's also the tag duplicated 2 times. > > > > Same thing for mailingLists/mailingList/unsubscribe. > > > > dependencies/dependency/properties can be simplified > > > > Arnaud. > > > > > -Message d'origine- > > > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > > Envoyé : jeudi 18 mars 2004 22:09 > > > À : Maven Users List > > > Objet : RE: More visual project descriptor documentation > > > > > > Fixing that now. > > > -- > > > dIon Gillard, Multitask Consulting > > > > > > > > > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 18/03/2004 07:26:05 > PM: > > > > > > > +1 for me. > > > > > > > > there's just a little error with the organization end tag: > > > > > > > > > > > > Arnaud. > > > > > > > > -Message d'origine- > > > > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > > > Envoyé : jeudi 18 mars 2004 02:20 > > > > À : Maven Users List > > > > Objet : RE: More visual project descriptor documentation > > > > > > > > > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 > PM: > > > > > > > > > I like it. > > > > > Can't you reduce the space between lines ?? > > > > > Maybe you can use a source tag to enclose your description ?? > > > > > > > > I fixed my copy of the xdoc plugin, and regenerated the URL using a > > > source > > > > tag and some more indentation. > > > > > > > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > > > > descriptor.html > > > > > > > > Better? > > > > -- > > > > dIon Gillard, Multitask Consulting > > > > > > > > > - > > > > 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] > > - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
> -Message d'origine- > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > Envoyé : jeudi 18 mars 2004 23:09 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > "Arnaud Heritier" <[EMAIL PROTECTED]> wrote on 19/03/2004 08:39:31 AM: > > > There's also the tag duplicated 2 times. > > Fixed that. > > > Same thing for mailingLists/mailingList/unsubscribe. > > ? I can't see a duplication for mailingLists etc.. > > > dependencies/dependency/properties can be simplified > > That one was intentional. I was trying to show that there can be nested > elements for properties rather than text. Ok. Arnaud. > -- > dIon Gillard, Multitask Consulting
RE: More visual project descriptor documentation
Found the unsub duplicate. Thanks. -- dIon Gillard, Multitask Consulting "Arnaud Heritier" <[EMAIL PROTECTED]> wrote on 19/03/2004 08:39:31 AM: > There's also the tag duplicated 2 times. > > Same thing for mailingLists/mailingList/unsubscribe. > > dependencies/dependency/properties can be simplified > > Arnaud. > > > -Message d'origine- > > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > Envoyé : jeudi 18 mars 2004 22:09 > > À : Maven Users List > > Objet : RE: More visual project descriptor documentation > > > > Fixing that now. > > -- > > dIon Gillard, Multitask Consulting > > > > > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 18/03/2004 07:26:05 PM: > > > > > +1 for me. > > > > > > there's just a little error with the organization end tag: > > > > > > > > > Arnaud. > > > > > > -Message d'origine- > > > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > > Envoyé : jeudi 18 mars 2004 02:20 > > > À : Maven Users List > > > Objet : RE: More visual project descriptor documentation > > > > > > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > > > > > > > I like it. > > > > Can't you reduce the space between lines ?? > > > > Maybe you can use a source tag to enclose your description ?? > > > > > > I fixed my copy of the xdoc plugin, and regenerated the URL using a > > source > > > tag and some more indentation. > > > > > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > > > descriptor.html > > > > > > Better? > > > -- > > > dIon Gillard, Multitask Consulting > > > > > > - > > > 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: More visual project descriptor documentation
"Arnaud Heritier" <[EMAIL PROTECTED]> wrote on 19/03/2004 08:39:31 AM: > There's also the tag duplicated 2 times. Fixed that. > Same thing for mailingLists/mailingList/unsubscribe. ? I can't see a duplication for mailingLists etc.. > dependencies/dependency/properties can be simplified That one was intentional. I was trying to show that there can be nested elements for properties rather than text. -- dIon Gillard, Multitask Consulting
RE: More visual project descriptor documentation
There's also the tag duplicated 2 times. Same thing for mailingLists/mailingList/unsubscribe. dependencies/dependency/properties can be simplified Arnaud. > -Message d'origine- > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > Envoyé : jeudi 18 mars 2004 22:09 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > Fixing that now. > -- > dIon Gillard, Multitask Consulting > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 18/03/2004 07:26:05 PM: > > > +1 for me. > > > > there's just a little error with the organization end tag: > > > > > > Arnaud. > > > > -Message d'origine- > > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > Envoyé : jeudi 18 mars 2004 02:20 > > À : Maven Users List > > Objet : RE: More visual project descriptor documentation > > > > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > > > > > I like it. > > > Can't you reduce the space between lines ?? > > > Maybe you can use a source tag to enclose your description ?? > > > > I fixed my copy of the xdoc plugin, and regenerated the URL using a > source > > tag and some more indentation. > > > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > > descriptor.html > > > > Better? > > -- > > dIon Gillard, Multitask Consulting > > > > - > > 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: More visual project descriptor documentation
Fixing that now. -- dIon Gillard, Multitask Consulting "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 18/03/2004 07:26:05 PM: > +1 for me. > > there's just a little error with the organization end tag: > > > Arnaud. > > -Message d'origine- > De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > Envoyé : jeudi 18 mars 2004 02:20 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > > "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > > > I like it. > > Can't you reduce the space between lines ?? > > Maybe you can use a source tag to enclose your description ?? > > I fixed my copy of the xdoc plugin, and regenerated the URL using a source > tag and some more indentation. > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > descriptor.html > > Better? > -- > dIon Gillard, Multitask Consulting > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] >
Re: More visual project descriptor documentation
Jim Crossley <[EMAIL PROTECTED]> wrote on 18/03/2004 10:57:54 PM: > [EMAIL PROTECTED] writes: > > > I'd like to suggest a more visual way of documenting the project > > descriptor. > > Looks great. > > > Comments?? > > Some visual way of distinguishing the required elements from the > optional ones might be nice. My first thought was color, but since > the tags are links, that might be a little confusing. Maybe just > asterisks beside the required ones? How about bold for required and strikethrough or italic for deprecated? -- dIon Gillard, Multitask Consulting
RE: More visual project descriptor documentation
On Thu, 2004-03-18 at 10:33, Sonnek, Ryan wrote: > What about adding a column to the documentation area for "required" tags? > This would allow the layout to be verbose and users can click on the tag > name to see if it is required. the documentation already has "Optional" > next to many of the tags, but it is not visually distinct since it is in the > description column. If a new column was added for the sole purpose of > displaying the required status, it'd be a bit easier to read. Ultimately the page describing the model will be generated from this: http://cvs.apache.org/viewcvs.cgi/maven-components/maven-model/maven.mdo?rev=1.22&view=auto I am already generating the model sources, the XSD, the xpp3 unmarshaller and marshaller and the xdoc: http://maven.apache.org/maven.html Certainly not finished by any stretch of the imagination, but the maven.mdo will be augmented to provide any information that is useful. Optional fields will definitely be added as they are required for the correct generation of the XSD: http://maven.apache.org/~jvanzyl/maven.xsd As you can see there's nothing there to allow optional fields yet, but it's coming. Ultimately, I want any artifact that is useful and stems from the model to be generated so that it remains up-to-date with changes in the model. This has been the biggest problem with Maven which I hope remedy soon. So even that sample full document at the top of Dion's can be generated and I will incorporate that if desired. This week and next week are plugin weeks the following week will be work on the new xdoc plugin: http://cvs.apache.org/viewcvs.cgi/maven-components/maven-xdoc/ Which will produce nice sites like: http://groovy.codehaus.org/ And do it pretty much instaneously. I can currently generate the xhtml for the Maven site in under a second. > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://maven.apache.org happiness is like a butterfly: the more you chase it, the more it will elude you, but if you turn your attention to other things, it will come and sit softly on your shoulder ... -- Thoreau - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: More visual project descriptor documentation
On Thu, 2004-03-18 at 00:39, matthew.hawthorne wrote: > >>http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html > > This is very cool. This version is much better IMO. > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://maven.apache.org happiness is like a butterfly: the more you chase it, the more it will elude you, but if you turn your attention to other things, it will come and sit softly on your shoulder ... -- Thoreau - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
What about adding a column to the documentation area for "required" tags? This would allow the layout to be verbose and users can click on the tag name to see if it is required. the documentation already has "Optional" next to many of the tags, but it is not visually distinct since it is in the description column. If a new column was added for the sole purpose of displaying the required status, it'd be a bit easier to read. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
Looks great! > -Original Message- > From: matthew.hawthorne [mailto:[EMAIL PROTECTED] > Sent: Wednesday, March 17, 2004 11:40 PM > To: Maven Users List > Subject: Re: More visual project descriptor documentation > > >>http://maven.apache.org/~dion/maven.apache.org/reference/project- > descriptor.html > > This is very cool. > > - > 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: More visual project descriptor documentation
[EMAIL PROTECTED] writes: > I'd like to suggest a more visual way of documenting the project > descriptor. Looks great. > Comments?? Some visual way of distinguishing the required elements from the optional ones might be nice. My first thought was color, but since the tags are links, that might be a little confusing. Maybe just asterisks beside the required ones? Jim - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
+1 for me. there's just a little error with the organization end tag: Arnaud. -Message d'origine- De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Envoyé : jeudi 18 mars 2004 02:20 À : Maven Users List Objet : RE: More visual project descriptor documentation "Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > I like it. > Can't you reduce the space between lines ?? > Maybe you can use a source tag to enclose your description ?? I fixed my copy of the xdoc plugin, and regenerated the URL using a source tag and some more indentation. http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html Better? -- dIon Gillard, Multitask Consulting - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: RE : More visual project descriptor documentation
I'm agree with you Sébastien. There's always a lack of documentations in maven. Everybody is invited to help to write or enhance the doc. This problem is not a Maven problem but more generally an opensource problem. For example it was the same problem with Tomcat or Struts. At the beginning, there was a lot of good ideas but the documentation was poor. After several years, this projects are well documented. It's a question of time. A good developer is not necessarily a good author. So all help is appreciated !!! Arnaud. -Message d'origine- De : Sébastien BRUNOT [mailto:[EMAIL PROTECTED] Envoyé : mercredi 17 mars 2004 17:55 À : 'Maven Users List' Objet : RE : More visual project descriptor documentation . Anyway, i have a pray for maven authors : please DOCUMENT WHAT YOU DO ! Some clients of mine rejected maven because of the lack of real documentation (example : What is the list of variable used by maven and its different plugins ? What is The grammaticaly correct syntax for a jelly expression ?). Sebastien - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE : RE : More visual project descriptor documentation
In fact, it is not documented at all. Sebastien -Message d'origine- De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Envoyé : jeudi 18 mars 2004 01:06 À : Maven Users List Objet : RE : More visual project descriptor documentation There currently is a complete project.xml as part of the documentation. See http://maven.apache.org/start/integrate.html It's not terribly well documented though. -- dIon Gillard, Multitask Consulting Sébastien BRUNOT <[EMAIL PROTECTED]> wrote on 18/03/2004 03:54:51 AM: > Hi, > > Another idea could be the release of a sample COMPLETE project.xml > documented. The documentation need to be completed first (for example > : what is the connection string for a subversion repository ?). Here > is my personal file for that (named project.xml.template) : > > < BEGINING OF THE FILE > == > == > ===> > > > > > 3 > > > SampleJ2EE > > > A Sample J2EE project to compare ant versus maven build > process > > > 1.0-SNAPSHOT > > > > > Octo Technology > > http://www.octo.com/ > > http://images/octo-logo.jpg > > > > 2003 > > > com.octo.j2ee.sample > > > /images/project-logo.jpg > > > > > > > This project is a sample J2EE project that is build with maven. > The following maven sub projects are used : TO BE CONTINUED > > > > > How to use maven for building a j2ee project. > > > > http://localhost/samplej2ee > > > > > > localhost > > > C:/Documents and Settings/sbrunot/Mes > documents/www/samplej2ee > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > Sebastien Brunot > > sbrunot > > [EMAIL PROTECTED] > > Octo Technology > > > developer > > > > > 1 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > [EMAIL PROTECTED] > > src/java > > > > > > > > > > > > > > > > > src/test > > > > > > > > **/*Test.java > > > > > **/NaughtyTest.java > > > > > > > > src/conf > > > > > > *.properties > > > > > > > > > > > > > > > > > > > > > > < END OF THE FILE > > > > > Anyway, i have a pray for maven authors : please DOCUMENT WHAT YOU DO ! > Some clients of mine rejected maven because of > the lack of real documentation (example : What is the list of variable > used by maven and its different plugins ? What is > The grammaticaly correct syntax for a jelly expression ?). > > Sebastien > > -Message d'origine- > De : Jean-Marc Lavoie [mailto:[EMAIL PROTECTED] > Envoyé : mercredi 17 mars 2004 16:47 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > > The representation is great, it will be perfect with the proposed > enhancements. > > > My in first experience with maven projects, I had to create all the > folder structure, with some errors. Then I discoved the genapp plugin. > The plugin provides a sample POMS that prov
Re: More visual project descriptor documentation
"Marco Tedone" <[EMAIL PROTECTED]> wrote on 18/03/2004 06:54:33 PM: > As far as I'm concerned, the description of each descriptor element is > pretty pour (Maven is still young!) and waiting for an official book on > Maven (coming soon), e newcomer has got only the descriptor documentation > (and the mailing list!) to get started. I believe that adding documentation > to each element, with the view of a newcomer that has to migrate to > Maven...let's say from Ant, would save hours of work and frustration. > Nothing avoids you from adding the same type of docs also under the > integration page. Sure. The more the merrier. Have a look at the example for sourceModifications that's up there now. If I add one for resources in a similar place would that be helpful? -- dIon Gillard, Multitask Consulting
Re: More visual project descriptor documentation
As far as I'm concerned, the description of each descriptor element is pretty pour (Maven is still young!) and waiting for an official book on Maven (coming soon), e newcomer has got only the descriptor documentation (and the mailing list!) to get started. I believe that adding documentation to each element, with the view of a newcomer that has to migrate to Maven...let's say from Ant, would save hours of work and frustration. Nothing avoids you from adding the same type of docs also under the integration page. Marco - Original Message - From: <[EMAIL PROTECTED]> To: "Maven Users List" <[EMAIL PROTECTED]> Sent: Thursday, March 18, 2004 7:53 AM Subject: Re: More visual project descriptor documentation > "Marco Tedone" <[EMAIL PROTECTED]> wrote on 18/03/2004 06:25:03 PM: > > > Would it be possible to add concrete but simple examples of the possible > > different uses of and ? > > Do you mean in the links section? > > My preference would be to beef up the documentation below the links. > > I would have thought the example in the integration section ( > http://maven.apache.org/~dion/maven.apache.org/start/integrate.html ) > would have done for resources, and yep, an example for sourceModifications > would be in order too. > -- > dIon Gillard, Multitask Consulting > - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: More visual project descriptor documentation
"Marco Tedone" <[EMAIL PROTECTED]> wrote on 18/03/2004 06:25:03 PM: > Would it be possible to add concrete but simple examples of the possible > different uses of and ? Do you mean in the links section? My preference would be to beef up the documentation below the links. I would have thought the example in the integration section ( http://maven.apache.org/~dion/maven.apache.org/start/integrate.html ) would have done for resources, and yep, an example for sourceModifications would be in order too. -- dIon Gillard, Multitask Consulting
Re: More visual project descriptor documentation
Would it be possible to add concrete but simple examples of the possible different uses of and ? - Original Message - From: <[EMAIL PROTECTED]> To: "Maven Users List" <[EMAIL PROTECTED]> Sent: Thursday, March 18, 2004 7:22 AM Subject: Re: More visual project descriptor documentation > I just updated it again > -- > dIon Gillard, Multitask Consulting > > > > "Marco Tedone" <[EMAIL PROTECTED]> wrote on 18/03/2004 06:06:53 PM: > > > I can't see the element in there. Am I missing something? > > > > - Original Message - > > From: "Incze Lajos" <[EMAIL PROTECTED]> > > To: "Maven Users List" <[EMAIL PROTECTED]> > > Sent: Thursday, March 18, 2004 2:50 AM > > Subject: Re: More visual project descriptor documentation > > > > > > > > > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > > descriptor.html > > > > > > > > Better? > > > > -- > > > > dIon Gillard, Multitask Consulting > > > > > > Seems pretty usable. > > > > > > incze > > > > > > - > > > 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] > > > - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: More visual project descriptor documentation
I just updated it again -- dIon Gillard, Multitask Consulting "Marco Tedone" <[EMAIL PROTECTED]> wrote on 18/03/2004 06:06:53 PM: > I can't see the element in there. Am I missing something? > > - Original Message - > From: "Incze Lajos" <[EMAIL PROTECTED]> > To: "Maven Users List" <[EMAIL PROTECTED]> > Sent: Thursday, March 18, 2004 2:50 AM > Subject: Re: More visual project descriptor documentation > > > > > > http://maven.apache.org/~dion/maven.apache.org/reference/project- > descriptor.html > > > > > > Better? > > > -- > > > dIon Gillard, Multitask Consulting > > > > Seems pretty usable. > > > > incze > > > > - > > 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: More visual project descriptor documentation
I can't see the element in there. Am I missing something? - Original Message - From: "Incze Lajos" <[EMAIL PROTECTED]> To: "Maven Users List" <[EMAIL PROTECTED]> Sent: Thursday, March 18, 2004 2:50 AM Subject: Re: More visual project descriptor documentation > > http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html > > > > Better? > > -- > > dIon Gillard, Multitask Consulting > > Seems pretty usable. > > incze > > - > 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: More visual project descriptor documentation
http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html This is very cool. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: More visual project descriptor documentation
> http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html > > Better? > -- > dIon Gillard, Multitask Consulting Seems pretty usable. incze - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
"Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > I like it. > Can't you reduce the space between lines ?? > Maybe you can use a source tag to enclose your description ?? I fixed my copy of the xdoc plugin, and regenerated the URL using a source tag and some more indentation. http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html Better? -- dIon Gillard, Multitask Consulting
RE : More visual project descriptor documentation
There currently is a complete project.xml as part of the documentation. See http://maven.apache.org/start/integrate.html It's not terribly well documented though. -- dIon Gillard, Multitask Consulting Sébastien BRUNOT <[EMAIL PROTECTED]> wrote on 18/03/2004 03:54:51 AM: > Hi, > > Another idea could be the release of a sample COMPLETE project.xml > documented. The documentation need to be completed first (for example : > what is the connection string for a subversion repository ?). Here is my > personal file for that (named project.xml.template) : > > < BEGINING OF THE FILE > > ===> > > > > > 3 > > > SampleJ2EE > > > A Sample J2EE project to compare ant versus maven build > process > > > 1.0-SNAPSHOT > > > > > Octo Technology > > http://www.octo.com/ > > http://images/octo-logo.jpg > > > > 2003 > > > com.octo.j2ee.sample > > > /images/project-logo.jpg > > > > > > > This project is a sample J2EE project that is build with maven. > The following maven sub projects are used : TO BE CONTINUED > > > > > How to use maven for building a j2ee project. > > > > http://localhost/samplej2ee > > > > > > localhost > > > C:/Documents and Settings/sbrunot/Mes > documents/www/samplej2ee > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > Sebastien Brunot > > sbrunot > > [EMAIL PROTECTED] > > Octo Technology > > > developer > > > > > 1 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > [EMAIL PROTECTED] > > src/java > > > > > > > > > > > > > > > > > src/test > > > > > > > > **/*Test.java > > > > > **/NaughtyTest.java > > > > > > > > src/conf > > > > > > *.properties > > > > > > > > > > > > > > > > > > > > > > < END OF THE FILE > > > > > Anyway, i have a pray for maven authors : please DOCUMENT WHAT YOU DO ! > Some clients of mine rejected maven because of > the lack of real documentation (example : What is the list of variable > used by maven and its different plugins ? What is > The grammaticaly correct syntax for a jelly expression ?). > > Sebastien > > -Message d'origine- > De : Jean-Marc Lavoie [mailto:[EMAIL PROTECTED] > Envoyé : mercredi 17 mars 2004 16:47 > À : Maven Users List > Objet : RE: More visual project descriptor documentation > > > The representation is great, it will be perfect with the proposed > enhancements. > > > My in first experience with maven projects, I had to create all the > folder structure, with some errors. Then I discoved the genapp plugin. > The plugin provides a sample POMS that provides a really great start. I > think the plugin should be introduced in the "getting started" section > to allow user not to start from scratch. This would remove lot of > questions like resouces in jars, jars creation, JUnits, what to include >
RE: More visual project descriptor documentation
"Heritier Arnaud" <[EMAIL PROTECTED]> wrote on 17/03/2004 09:45:30 PM: > I like it. > Can't you reduce the space between lines ?? > Maybe you can use a source tag to enclose your description ?? Source tags can't include links in the current xdoc plugin. They get ignored. And as I'm not the owner of the xdoc plugin, I can't fix it. -- dIon Gillard, Multitask Consulting
RE: More visual project descriptor documentation
"Sonnek, Ryan" <[EMAIL PROTECTED]> wrote on 18/03/2004 02:19:07 AM: > I think this is a GREAT idea, but the periods used to indent leave much to > be desired. Also, It is very difficult to visually distinguish the correct > nesting for the tags. I would recommend using 4 spaces ( ) for each > layer to make it more usable. I wish I could but xdoc has a few bugs that don't let me use 's in the source. Anyone happen to know the unicode equivalent? That way I could use &#; -- dIon Gillard, Multitask Consulting
RE : More visual project descriptor documentation
Hi, Another idea could be the release of a sample COMPLETE project.xml documented. The documentation need to be completed first (for example : what is the connection string for a subversion repository ?). Here is my personal file for that (named project.xml.template) : < BEGINING OF THE FILE ===> 3 SampleJ2EE A Sample J2EE project to compare ant versus maven build process 1.0-SNAPSHOT Octo Technology http://www.octo.com/ http://images/octo-logo.jpg 2003 com.octo.j2ee.sample /images/project-logo.jpg This project is a sample J2EE project that is build with maven. The following maven sub projects are used : TO BE CONTINUED How to use maven for building a j2ee project. http://localhost/samplej2ee localhost C:/Documents and Settings/sbrunot/Mes documents/www/samplej2ee Sebastien Brunot sbrunot [EMAIL PROTECTED] Octo Technology developer 1 [EMAIL PROTECTED] src/java src/test **/*Test.java **/NaughtyTest.java src/conf *.properties < END OF THE FILE > Anyway, i have a pray for maven authors : please DOCUMENT WHAT YOU DO ! Some clients of mine rejected maven because of the lack of real documentation (example : What is the list of variable used by maven and its different plugins ? What is The grammaticaly correct syntax for a jelly expression ?). Sebastien -Message d'origine- De : Jean-Marc Lavoie [mailto:[EMAIL PROTECTED] Envoyé : mercredi 17 mars 2004 16:47 À : Maven Users List Objet : RE: More visual project descriptor documentation The representation is great, it will be perfect with the proposed enhancements. My in first experience with maven projects, I had to create all the folder structure, with some errors. Then I discoved the genapp plugin. The plugin provides a sample POMS that provides a really great start. I think the plugin should be introduced in the "getting started" section to allow user not to start from scratch. This would remove lot of questions like resouces in jars, jars creation, JUnits, what to include in the file, and malformed project files as you start with a working pom. Then the section you're working one would become an advance topic, as people getting there would already have something working for most of the cases, instead of getting there to create new pom sections. > -Original Message- > From: Erik Husby [mailto:[EMAIL PROTECTED] > Sent: Wednesday, March 17, 2004 10:31 AM > To: Maven Users List > Subject: Re: More visual project descriptor documentation > > > Definitely a step in the right direction. I too think that more > indentation is required. > > Also, visually indicating what elements are required and which are > optional would be good. I am sure that this can get tricky but would > really help. Or perhaps we can gather a set of example POM's > along the > lines of: > > 1. A basic POM that can compile, jar, and test a project. > 2. A POM that can compile, jar, test, and install a jar into a local > repository. > 3. A POM that can compile, jar, test, install, and generate a site. > > And I am sure that there are some others that would spring to mind. > > -- > Erik Husby > Team Lead for Software Quality Automation > Genome Center at MIT > Rm. 2192 > 320 Charles St > Cambridge, MA 02141-2023 > mobile: 781.354.6669 > office: 617.258.9227 > [EMAIL PROTECTED] > > > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > -
RE: More visual project descriptor documentation
The representation is great, it will be perfect with the proposed enhancements. My in first experience with maven projects, I had to create all the folder structure, with some errors. Then I discoved the genapp plugin. The plugin provides a sample POMS that provides a really great start. I think the plugin should be introduced in the "getting started" section to allow user not to start from scratch. This would remove lot of questions like resouces in jars, jars creation, JUnits, what to include in the file, and malformed project files as you start with a working pom. Then the section you're working one would become an advance topic, as people getting there would already have something working for most of the cases, instead of getting there to create new pom sections. > -Original Message- > From: Erik Husby [mailto:[EMAIL PROTECTED] > Sent: Wednesday, March 17, 2004 10:31 AM > To: Maven Users List > Subject: Re: More visual project descriptor documentation > > > Definitely a step in the right direction. I too think that more > indentation is required. > > Also, visually indicating what elements are required and which are > optional would be good. I am sure that this can get tricky but would > really help. Or perhaps we can gather a set of example POM's > along the > lines of: > > 1. A basic POM that can compile, jar, and test a project. > 2. A POM that can compile, jar, test, and install a jar into a local > repository. > 3. A POM that can compile, jar, test, install, and generate a site. > > And I am sure that there are some others that would spring to mind. > > -- > Erik Husby > Team Lead for Software Quality Automation > Genome Center at MIT > Rm. 2192 > 320 Charles St > Cambridge, MA 02141-2023 > mobile: 781.354.6669 > office: 617.258.9227 > [EMAIL PROTECTED] > > > > - > 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: More visual project descriptor documentation
Definitely a step in the right direction. I too think that more indentation is required. Also, visually indicating what elements are required and which are optional would be good. I am sure that this can get tricky but would really help. Or perhaps we can gather a set of example POM's along the lines of: 1. A basic POM that can compile, jar, and test a project. 2. A POM that can compile, jar, test, and install a jar into a local repository. 3. A POM that can compile, jar, test, install, and generate a site. And I am sure that there are some others that would spring to mind. -- Erik Husby Team Lead for Software Quality Automation Genome Center at MIT Rm. 2192 320 Charles St Cambridge, MA 02141-2023 mobile: 781.354.6669 office: 617.258.9227 [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
I think this is a GREAT idea, but the periods used to indent leave much to be desired. Also, It is very difficult to visually distinguish the correct nesting for the tags. I would recommend using 4 spaces ( ) for each layer to make it more usable. Ryan > -Original Message- > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > Sent: Tuesday, March 16, 2004 11:43 PM > To: [EMAIL PROTECTED] > Subject: More visual project descriptor documentation > > I'd like to suggest a more visual way of documenting the project > descriptor. > > Look at > http://maven.apache.org/~dion/maven.apache.org/reference/project- > descriptor.html > for a start. > > The idea is to show the XML format and structure with links to > documentation. That way people can easily see the structure of the file > and understand it. > > Comments?? > -- > dIon Gillard, Multitask Consulting - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: More visual project descriptor documentation
I like it. Can't you reduce the space between lines ?? Maybe you can use a source tag to enclose your description ?? Arnaud. -Message d'origine- De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Envoyé : mercredi 17 mars 2004 06:43 À : [EMAIL PROTECTED] Objet : More visual project descriptor documentation I'd like to suggest a more visual way of documenting the project descriptor. Look at http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html for a start. The idea is to show the XML format and structure with links to documentation. That way people can easily see the structure of the file and understand it. Comments?? -- dIon Gillard, Multitask Consulting - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
More visual project descriptor documentation
I'd like to suggest a more visual way of documenting the project descriptor. Look at http://maven.apache.org/~dion/maven.apache.org/reference/project-descriptor.html for a start. The idea is to show the XML format and structure with links to documentation. That way people can easily see the structure of the file and understand it. Comments?? -- dIon Gillard, Multitask Consulting
