 | 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: | Stefan Kleineikenscheidt (stef...@kleineikenscheidt.de) | |
| Date: | Sep 7, 2004 11:49:38 am | |
| List: | org.apache.maven.users | |
Hi Carlos,
the only thing i can say is: Wiki. :)
I've found out that documentation is collaborative work and isn't done in one step. Therefore wiki is a perfect fit: One starts off with writing together some information, others add comment or organize that information. Wiki is the tool to make editing and re-editing really easy.
At present, the problem with the wiki approach is that the documentation in Wiki syntax doesn't transform very well into other formats. To fix this, i've started working a Maven plugin in for Atlassians Confluence Wiki: It retrieves Wiki pages as listed in the project's navigation.xml and transforms them into XDocs. After that Maven's PDF plugin and the Xdoc plugin take over.
My two cents, -Stefan
-----Original Message----- From: Carlos Sanchez [mailto:apa...@carlos.cousas.net] Sent: Tuesday, September 07, 2004 7:15 PM To: 'Maven Users List' Subject: [Poll] Writing documentation with Maven
Hi all,
I'd like to start a thread about how do you write your documentation to be integrated with Maven. Maybe I can give away some GMail invites to those participating, it's not much, but as you may know open source doesn't pay the bills, at least not MY bills ;-)
1. What format do you use to write documentation? A. xdoc B. html C. docbook D. latex E. who needs documentation?
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
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
3. Would you like to use another format instead of answered in (1) and why?
Leave your name here if you'd like a Gmail invite.
Regards
Carlos Sanchez A Coruña, Spain http://www.jroller.com/page/carlossg/Weblog
Oness Project http://oness.sourceforge.net