23 messages in org.apache.maven.usersRe: [Poll] Writing documentation with...
FromSent OnAttachments
Carlos SanchezSep 7, 2004 10:14 am 
Scott WilliamsSep 7, 2004 10:30 am 
Eric PughSep 7, 2004 10:32 am 
Dion GillardSep 7, 2004 10:35 am 
James MitchellSep 7, 2004 10:38 am 
Kim GoingsSep 7, 2004 10:53 am 
Eric PughSep 7, 2004 11:29 am 
Ryan SonnekSep 7, 2004 11:45 am 
Stefan KleineikenscheidtSep 7, 2004 11:49 am 
Vincent MassolSep 7, 2004 11:52 am 
Carlos SanchezSep 7, 2004 12:17 pm 
M. Sean GilliganSep 7, 2004 12:18 pm 
Jan NielsenSep 7, 2004 12:23 pm 
STRAYER, JON (SBCSI)Sep 7, 2004 12:57 pm 
Jason van ZylSep 7, 2004 2:13 pm 
Jason van ZylSep 7, 2004 2:32 pm 
Martin SkoppSep 8, 2004 12:40 am 
Marcin WerlaSep 8, 2004 12:50 am 
Gidley Ben, SloughSep 8, 2004 1:08 am 
Milos KleintSep 8, 2004 1:11 am 
fabr...@mpsa.comSep 8, 2004 1:26 am 
Jörg SchaibleSep 8, 2004 1:47 am 
Andreas GutherSep 9, 2004 5:04 am 
Actions with this message:
Paste this link in email or IM:
Paste this link in email or IM:
Atom feed for this thread
Paste this URL into your reader:
Subject:Re: [Poll] Writing documentation with MavenActions...
From:Jan Nielsen (jnie@sungardsct.com)
Date:Sep 7, 2004 12:23:58 pm
List:org.apache.maven.users

1. A 2. N/A 4. A. (emacs) 3. xdoc has been sufficient to this point, but we may outgrow the format in the future. As was pointed out in a different reply, a schema for xdoc would be a "Good Thing" (TM), preferably XML Schema but a DTD would be a good first step. A distant second place for this type of documentation is DocBook; I feel it's too broad for most programmers to use effectively (in our shop programmers are responsible for this kind of documentation), including the "simple" version of DocBook.

-Jan

At 11:15 AM 9/7/2004, Carlos Sanchez wrote:

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

Jan Nielsen System Architect Luminis Solutions SunGard SCT

jnie@sungardsct.com http://www.sungardsct.com

+1 801 257 4155 (voice) +1 801 485 6606 (facsimile)

90 South 400 West Salt Lake City, UT 84101