Mailing-List: contact dev-help@ibatis.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@ibatis.apache.org
DomainKey-Status: good
DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws;
        s=beta; d=gmail.com;
        h=received:message-id:date:from:sender:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references:x-google-sender-auth;
        b=jwSHAad2jI0ZnXp9VQz1uFFVvwV282M6huDN5tv6mVdLL5/4MzPCpaG4+HJYx4r57vHcvoPGCyglAdAtAThwmlb68xC7oHsbtMjE2/WNKJohMa55ywy2pe2sSxv+eKUCzRow2pU59fEMz9WSG6Op2NVzmNExRX3FrVcLRlQfxzA=
Message-ID: <8b3ce3790610040537v67af648bj106206a2eba3ee88@mail.gmail.com>
Date: Wed, 4 Oct 2006 08:37:43 -0400
From: "Ted Husted" <husted@apache.org>
Sender: ted.husted@gmail.com
To: dev@ibatis.apache.org
Subject: Re: New iBATIS Documentation Format
In-Reply-To: <16178eb10610031939m70e15ad1r28ed5bb6bfefdbad@mail.gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
References: <16178eb10610021744x7101cccr4dc671ccc2033be0@mail.gmail.com>
	 <8b3ce3790610031805i72ffe889j2aee34822856157d@mail.gmail.com>
	 <16178eb10610031939m70e15ad1r28ed5bb6bfefdbad@mail.gmail.com>

On 10/3/06, Clinton Begin <clinton.begin@gmail.com> wrote:
> I don't think Brandon was suggesting we continue to use OOo with DocBook.  I
> can attest to the poor quality of the DocBook output from OOo....
>
> But it's a good way to start.  We can export to DocBook, then clean it up (a
> lot).  From that point on, we use XXE or a text editor...

I'll try it again, but the last time I used XXE, I found it cumbersome
and distracting. OO is at least unobstrusive.

Personally, I like the way the Struts 2 documentation is heading.

* http://cwiki.apache.org/WW/home.html

The focus is on short guides, FAQs, and reference material that work
well in an online format. As a printed book, it would totally suck,
but as an online guide, it's great. The best part is that we are able
to single-source a lot of material from the JavaDocs and sample
applications using a Confluence macro. The system clips snippets from
the source material into the page, like a live cut and paste. All the
material in tag guides is being sucked in from the JavaDocs.

* http://cwiki.apache.org/WW/tag-reference.html

The autoexport macro is also working well for us, and some people are
working on some very attractive templates to dress up the HTML. For
the distribution, we just bundle in a snapshot of the HTML export.
Click. Done.

Realistically, any future contributions I would make will probably be
via Confluence anyway, so I'll stay out of the DocBook discussions.

-Ted.