

![]() | Start a set with this search |
![]() | Include this search in one of my sets |
![]() | Exclude this search from one of my sets |
![]() | Permalink to these results Paste this link in email or IM: |
| Atom feed for tracking future search results Paste this URL into your reader: |
23 messages in org.apache.maven.usersRe: [Poll] Writing documentation with...| From | Sent On | Attachments |
|---|---|---|
| Carlos Sanchez | Sep 7, 2004 10:14 am | |
| Scott Williams | Sep 7, 2004 10:30 am | |
| Eric Pugh | Sep 7, 2004 10:32 am | |
| Dion Gillard | Sep 7, 2004 10:35 am | |
| James Mitchell | Sep 7, 2004 10:38 am | |
| Kim Goings | Sep 7, 2004 10:53 am | |
| Eric Pugh | Sep 7, 2004 11:29 am | |
| Ryan Sonnek | Sep 7, 2004 11:45 am | |
| Stefan Kleineikenscheidt | Sep 7, 2004 11:49 am | |
| Vincent Massol | Sep 7, 2004 11:52 am | |
| Carlos Sanchez | Sep 7, 2004 12:17 pm | |
| M. Sean Gilligan | Sep 7, 2004 12:18 pm | |
| Jan Nielsen | Sep 7, 2004 12:23 pm | |
| STRAYER, JON (SBCSI) | Sep 7, 2004 12:57 pm | |
| Jason van Zyl | Sep 7, 2004 2:13 pm | |
| Jason van Zyl | Sep 7, 2004 2:32 pm | |
| Martin Skopp | Sep 8, 2004 12:40 am | |
| Marcin Werla | Sep 8, 2004 12:50 am | |
| Gidley Ben, Slough | Sep 8, 2004 1:08 am | |
| Milos Kleint | Sep 8, 2004 1:11 am | |
| fabr...@mpsa.com | Sep 8, 2004 1:26 am | |
| Jörg Schaible | Sep 8, 2004 1:47 am | |
| Andreas Guther | Sep 9, 2004 5:04 am |

![]() | Permalink for this message Paste this link in email or IM: |
![]() | Permalink for this thread Paste this link in email or IM: |
| Atom feed for this thread Paste this URL into your reader: |
| Subject: | Re: [Poll] Writing documentation with Maven | Actions... |
|---|---|---|
| From: | M. Sean Gilligan (sean...@msgilligan.com) | |
| Date: | Sep 7, 2004 12:18:45 pm | |
| List: | org.apache.maven.users | |
1. What format do you use to write documentation?
C. DocBook
2. If you didn't choose A, how do you transform your doc to be integrated in a Maven powered site? A. html2xdoc B. docbook plugin C. sdocbook plugin D. latex plugin E. other, please say what F. I don't transform, only link to my docs G. I write it again
B. DocBook plugin (with some custom extension to the docbook2xdoc XSL) E. My custom DocBook plugin (which I hope to release as Open Source someday)
I've found that the docbook2xdoc plugin is (as he disclaimer says) not very
complete and have added extensions to it as I've needed them. I've also found
that for some complex docbook documents, using the DocBook XSL stylesheets to
transform to html and than using html2xdoc works better than docbook2xdoc.
I've also used DocBook Website (extended DTD)
http://docbook.sourceforge.net/projects/website/ to produce a Maven-styled
website (http://www.msgilligan.com/about.html) (My wife, Lisa Valenzuela, did
the XSL and CSS work to give it a Maven look.)
When I find the time (hah) I'd like to finish my custom plugin and release it on
one of the open source sites ( java.net, tigris.org ?) I would also like to
create an xdoc->docbook plugin to convert the various maven-generated reports
and to use DocBook Website to generate the whole project site.
4. What tool do you use to write the docs? A. notepad / vi and similar B. one that is not WYSIWYG (please say what) C. a WYSIWYG editor (please say what) D. an hex editor
A. vi and BBEdit (http://www.bbedit.com) B. jEdit (http://www.jedit.org) C. XXE (XMLMind XML Editor (http://www.xmlmind.com/xmleditor/)
I use vi or BBEdit for real quick edits. jEdit works well for tag based editing
with tag-completion and DTD checking. XXE works will for structured
WYSI-almost-WYG editing.
3. Would you like to use another format instead of answered in (1) and why?
No. I'd just like to see better DocBook integration within Maven, and am
willing, with my limited available time, to contribute to this goal.
Leave your name here if you'd like a Gmail invite.
Sean Gilligan (let me know if you need any more info for the Gmail invite...)
Regards,
Sean
-- --------------------------------------------------------------------------- M. Sean Gilligan : 831-466-9788 x11 Catalla Systems, Inc. ---------------------------------------------------------------------------







