Re: [M2] Docbook support
Brett, Do you mean docbook support in Doxia or are you talking about anything else? Jose 2005/10/24, Brett Porter [EMAIL PROTECTED]: There seem to be a few people working on a the docbook support right now. It would be good to see folks collaborating on a solution that covers everyone's needs. - Brett On 10/24/05, Jose Gonzalez Gomez [EMAIL PROTECTED] wrote: 2005/10/24, Jason van Zyl [EMAIL PROTECTED]: On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. I had a working docbook plugin for maven1 capable of generating HTML output based on standard stylesheets, with resolution of links between docbook documents. I'm thinking about porting it to maven2... I could release it as open source if there's enough interest. Thanks, best regards Jose - 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: [M2] Docbook support
On Tue, 2005-10-25 at 09:35 +0200, Jose Gonzalez Gomez wrote: Brett, Do you mean docbook support in Doxia or are you talking about anything else? He meant find a general approach that works. If it can be done in Doxia that's great, otherwise you might need a separate tool. Jose 2005/10/24, Brett Porter [EMAIL PROTECTED]: There seem to be a few people working on a the docbook support right now. It would be good to see folks collaborating on a solution that covers everyone's needs. - Brett On 10/24/05, Jose Gonzalez Gomez [EMAIL PROTECTED] wrote: 2005/10/24, Jason van Zyl [EMAIL PROTECTED]: On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. I had a working docbook plugin for maven1 capable of generating HTML output based on standard stylesheets, with resolution of links between docbook documents. I'm thinking about porting it to maven2... I could release it as open source if there's enough interest. Thanks, best regards Jose - 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] -- jvz. Jason van Zyl jason at maven.org http://maven.apache.org - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
2005/10/25, Jason van Zyl [EMAIL PROTECTED]: On Tue, 2005-10-25 at 09:35 +0200, Jose Gonzalez Gomez wrote: Brett, Do you mean docbook support in Doxia or are you talking about anything else? He meant find a general approach that works. If it can be done in Doxia that's great, otherwise you might need a separate tool. Please, correct me if I'm wrong, as I have made some assumptions from my little knowledge of the inner operations of Maven and Doxia... I think the problem here is trying to match two completely different approaches: 1. In first place, we have Doxia that (I think) was created as a tool to parse and generate documentation in several formats. I guess (correct me if I'm wrong) that the original primary purpose of Doxia was being able to integrate documentation written in several formats in a Maven site. The problem with such an approach is that you have to stablish a common group of elements that all those source formats must share (the Sink interface in Doxia), so if you have a source format richer than that, you're losing in the process. 2. In second place we have Docbook, a format that was created to write technical documentation. The real power of Docbook (IMHO) is not the format itself but the possibility of using almost WYSIWYG editors and the style sheets available that let you generate documentation in a lot of formats: HTML, XHTML, PDF, JavaHelp, Eclipse Help,... Here you have just a source format you use to generate whatever you want, so you don't have the need to limit your output, as you come from a known input. I have the feeling that wahtever you do in Doxia regarding Docbook: 1. You are reinventing the wheel in some sense, as you already have the Docbook stylesheets, and 2. You are losing a lot of the power and richness of Docbook So I have the feeling that this is not the right approach... What I would probably do is drop the docbook support in Doxia (or keep it deliberately simple), as I see no reason to write a Maven site using Docbook: APT or HTML/XHTML are much more adequate to do that. Any way, I think a plugin for managing Docbook files is needed, as I may want to generate project documentation in PDF format, JavaHelp files, whatever that doesn't go directly into the Maven site... this should be included in the build process of the project, as it's just another deliverable, or artifact in the Maven vocabulary. And this should be done using the Docbook stylesheets, as there is a lot of effort put into them, and they're proved and reliable. Also I don't think writing all this support into Doxia is neither sensible nor possible. What do you think about this? Best regards Jose - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
I think you are right on. +1 Quoting Jose Gonzalez Gomez [EMAIL PROTECTED]: 2005/10/25, Jason van Zyl [EMAIL PROTECTED]: On Tue, 2005-10-25 at 09:35 +0200, Jose Gonzalez Gomez wrote: Brett, Do you mean docbook support in Doxia or are you talking about anything else? He meant find a general approach that works. If it can be done in Doxia that's great, otherwise you might need a separate tool. Please, correct me if I'm wrong, as I have made some assumptions from my little knowledge of the inner operations of Maven and Doxia... I think the problem here is trying to match two completely different approaches: 1. In first place, we have Doxia that (I think) was created as a tool to parse and generate documentation in several formats. I guess (correct me if I'm wrong) that the original primary purpose of Doxia was being able to integrate documentation written in several formats in a Maven site. The problem with such an approach is that you have to stablish a common group of elements that all those source formats must share (the Sink interface in Doxia), so if you have a source format richer than that, you're losing in the process. 2. In second place we have Docbook, a format that was created to write technical documentation. The real power of Docbook (IMHO) is not the format itself but the possibility of using almost WYSIWYG editors and the style sheets available that let you generate documentation in a lot of formats: HTML, XHTML, PDF, JavaHelp, Eclipse Help,... Here you have just a source format you use to generate whatever you want, so you don't have the need to limit your output, as you come from a known input. I have the feeling that wahtever you do in Doxia regarding Docbook: 1. You are reinventing the wheel in some sense, as you already have the Docbook stylesheets, and 2. You are losing a lot of the power and richness of Docbook So I have the feeling that this is not the right approach... What I would probably do is drop the docbook support in Doxia (or keep it deliberately simple), as I see no reason to write a Maven site using Docbook: APT or HTML/XHTML are much more adequate to do that. Any way, I think a plugin for managing Docbook files is needed, as I may want to generate project documentation in PDF format, JavaHelp files, whatever that doesn't go directly into the Maven site... this should be included in the build process of the project, as it's just another deliverable, or artifact in the Maven vocabulary. And this should be done using the Docbook stylesheets, as there is a lot of effort put into them, and they're proved and reliable. Also I don't think writing all this support into Doxia is neither sensible nor possible. What do you think about this? Best regards Jose - 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: [M2] Docbook support
On Tue, 2005-10-25 at 17:12 +0200, Jose Gonzalez Gomez wrote: So I have the feeling that this is not the right approach... What I would probably do is drop the docbook support in Doxia (or keep it deliberately simple), as I see no reason to write a Maven site using Docbook: APT or HTML/XHTML are much more adequate to do that. I think keeping the simple format would be fine. Any way, I think a plugin for managing Docbook files is needed, as I may want to generate project documentation in PDF format, JavaHelp files, whatever that doesn't go directly into the Maven site... this should be included in the build process of the project, as it's just another deliverable, or artifact in the Maven vocabulary. And this should be done using the Docbook stylesheets, as there is a lot of effort put into them, and they're proved and reliable. Also I don't think writing all this support into Doxia is neither sensible nor possible. What do you think about this? If you want full blown docbook support then I think you are right in that a separate plug-in would probably make more sense. I think we'd be happy to host a docbook plug-in at the Mojo project: http://mojo.codehaus.org Best regards Jose - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl jason at maven.org http://maven.apache.org - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
2005/10/24, Jason van Zyl [EMAIL PROTECTED]: On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. I had a working docbook plugin for maven1 capable of generating HTML output based on standard stylesheets, with resolution of links between docbook documents. I'm thinking about porting it to maven2... I could release it as open source if there's enough interest. Thanks, best regards Jose - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
There seem to be a few people working on a the docbook support right now. It would be good to see folks collaborating on a solution that covers everyone's needs. - Brett On 10/24/05, Jose Gonzalez Gomez [EMAIL PROTECTED] wrote: 2005/10/24, Jason van Zyl [EMAIL PROTECTED]: On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. I had a working docbook plugin for maven1 capable of generating HTML output based on standard stylesheets, with resolution of links between docbook documents. I'm thinking about porting it to maven2... I could release it as open source if there's enough interest. Thanks, best regards Jose - 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: [M2] Docbook support
We have a patch to apply (DOXIA-20). It will be a good start for everyone. Emmanuel Brett Porter a écrit : There seem to be a few people working on a the docbook support right now. It would be good to see folks collaborating on a solution that covers everyone's needs. - Brett On 10/24/05, Jose Gonzalez Gomez [EMAIL PROTECTED] wrote: 2005/10/24, Jason van Zyl [EMAIL PROTECTED]: On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. I had a working docbook plugin for maven1 capable of generating HTML output based on standard stylesheets, with resolution of links between docbook documents. I'm thinking about porting it to maven2... I could release it as open source if there's enough interest. Thanks, best regards Jose - 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: [M2] Docbook support
On Mon, 2005-10-24 at 23:56 +0200, Emmanuel Venisse wrote: We have a patch to apply (DOXIA-20). It will be a good start for everyone. The patch has been applied. -- Trygve - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
On Fri, 2005-10-21 at 13:27 +0200, Jose Gonzalez Gomez wrote: Thanks a lot, I'll try to take a look at it as soon as possible. Anyway, I've been taking a look at the head revision of org.codehaus.doxia.module.docbook.DocBookParser.java, and I doubt that this parser is going to generate anything close to useful. I had the feeling that this class was copied from some other parser (maybe the xdoc parser, as indicated in the header comment): most of the tags used there are not part of the Docbook format, and there are some commonly used tags missing. It's simplified docbook and is definitely geared toward site documentation, but decent PDFs can be produced. If you have existing tools that work with full docbook I would say stick with them. What's in Doxia is simplified docbook support. -- jvz. Jason van Zyl jason at maven.org http://maven.apache.org People develop abstractions by generalizing from concrete examples. Every attempt to determine the correct abstraction on paper without actually developing a running system is doomed to failure. No one is that smart. A framework is a resuable design, so you develop it by looking at the things it is supposed to be a design of. The more examples you look at, the more general your framework will be. -- Ralph Johnson Don Roberts, Patterns for Evolving Frameworks - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
Jose Gonzalez Gomez a écrit : 2005/10/20, Emmanuel Venisse [EMAIL PROTECTED]: Jason van Zyl a écrit : On Thu, 2005-10-20 at 11:28 +0200, Jose Gonzalez Gomez wrote: Hi there, In the announcement docbook support is mentioned, but I haven't been able to find anything about it in the docs. I've also found some thread talking about docbook support in Doxia, but its web says nothing about it. Finally the plugin matrix mentions a docbook plugin that seems to be M2 ready... what's the situation? Docbook is supported by Doxia but we haven't tested it very thoroughly. Emm, is docbook working? I don't know. I never used docbook documents The support is in Doxia for sure which is the hard part. If we have to expose it that would only take 30 minutes. I'm very interested in it, so If somebody has those 30 minutes to expose it I would be willing to test it and share the result. I would also like the know if there is interest enough in adding this support, as I had written a simple plugin for M1, and I've been thinking in porting it to M2, but I wouldn't like to spend time on reinventing the wheel if there is somebody already working on this. I added support of docbook document in site generation. If you want to try it, checkout m2 trunk and bootstrap it. put your docbook documents in src/site/docbook I think docbook parser in doxia isn't finished but it's a start. By the way, congrats for the 2.0 release!!! Thanks in advance, best regards Jose - 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] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
On Thu, 2005-10-20 at 11:28 +0200, Jose Gonzalez Gomez wrote: Hi there, In the announcement docbook support is mentioned, but I haven't been able to find anything about it in the docs. I've also found some thread talking about docbook support in Doxia, but its web says nothing about it. Finally the plugin matrix mentions a docbook plugin that seems to be M2 ready... what's the situation? Docbook is supported by Doxia but we haven't tested it very thoroughly. Emm, is docbook working? The support is in Doxia for sure which is the hard part. If we have to expose it that would only take 30 minutes. By the way, congrats for the 2.0 release!!! Thanks in advance, best regards Jose - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl jason at maven.org http://maven.apache.org We know what we are, but know not what we may be. -- Shakespeare - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [M2] Docbook support
Jason van Zyl a écrit : On Thu, 2005-10-20 at 11:28 +0200, Jose Gonzalez Gomez wrote: Hi there, In the announcement docbook support is mentioned, but I haven't been able to find anything about it in the docs. I've also found some thread talking about docbook support in Doxia, but its web says nothing about it. Finally the plugin matrix mentions a docbook plugin that seems to be M2 ready... what's the situation? Docbook is supported by Doxia but we haven't tested it very thoroughly. Emm, is docbook working? I don't know. I never used docbook documents The support is in Doxia for sure which is the hard part. If we have to expose it that would only take 30 minutes. By the way, congrats for the 2.0 release!!! Thanks in advance, best regards Jose - 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: [M2] Docbook support
2005/10/20, Emmanuel Venisse [EMAIL PROTECTED]: Jason van Zyl a écrit : On Thu, 2005-10-20 at 11:28 +0200, Jose Gonzalez Gomez wrote: Hi there, In the announcement docbook support is mentioned, but I haven't been able to find anything about it in the docs. I've also found some thread talking about docbook support in Doxia, but its web says nothing about it. Finally the plugin matrix mentions a docbook plugin that seems to be M2 ready... what's the situation? Docbook is supported by Doxia but we haven't tested it very thoroughly. Emm, is docbook working? I don't know. I never used docbook documents The support is in Doxia for sure which is the hard part. If we have to expose it that would only take 30 minutes. I'm very interested in it, so If somebody has those 30 minutes to expose it I would be willing to test it and share the result. I would also like the know if there is interest enough in adding this support, as I had written a simple plugin for M1, and I've been thinking in porting it to M2, but I wouldn't like to spend time on reinventing the wheel if there is somebody already working on this. By the way, congrats for the 2.0 release!!! Thanks in advance, best regards Jose - 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: [M2] Docbook support
Yes, we will use Maven's docbook support. -Original Message- From: Jose Gonzalez Gomez [mailto:[EMAIL PROTECTED] Sent: Thursday, October 20, 2005 12:10 PM To: Maven Users List Subject: Re: [M2] Docbook support 2005/10/20, Emmanuel Venisse [EMAIL PROTECTED]: Jason van Zyl a écrit : On Thu, 2005-10-20 at 11:28 +0200, Jose Gonzalez Gomez wrote: Hi there, In the announcement docbook support is mentioned, but I haven't been able to find anything about it in the docs. I've also found some thread talking about docbook support in Doxia, but its web says nothing about it. Finally the plugin matrix mentions a docbook plugin that seems to be M2 ready... what's the situation? Docbook is supported by Doxia but we haven't tested it very thoroughly. Emm, is docbook working? I don't know. I never used docbook documents The support is in Doxia for sure which is the hard part. If we have to expose it that would only take 30 minutes. I'm very interested in it, so If somebody has those 30 minutes to expose it I would be willing to test it and share the result. I would also like the know if there is interest enough in adding this support, as I had written a simple plugin for M1, and I've been thinking in porting it to M2, but I wouldn't like to spend time on reinventing the wheel if there is somebody already working on this. By the way, congrats for the 2.0 release!!! Thanks in advance, best regards Jose - 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] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
