You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ibatis.apache.org by Richard Sullivan <it...@gmail.com> on 2006/09/19 17:24:10 UTC
Fwd: developer guide for Data Mapper 2.2 seems to be missing section numbering
Hi folks,
The section numbering for the developer guide of Data Mapper 2.2 seems
to have got lost.
This makes reading the documentation quite difficult.
I downloaded from the guide from
http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
which is the link on the "iBATIS for Java Downloads" page.
The OpenOffice version from Subversion seems to have the same problem.
Hopefully somebody can fix this (I am a complete ibatis newbie).
Hope it helps,
Richard Sullivan
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Ah, that explains it. Richard, you were looking at a different document,
mostly written by Ted Husted for the .NET version -- but it's fairly cross
platform.
That document is available under the .NET download section.
http://ibatis.apache.org/dotnetdownloads.cgi
Clinton
On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
>
> Hi Clinton,
>
> Sometime last year I downloaded the devguide. Sorry I've no idea
> which version it was from but the file is dated August 5 2005. I'm
> going to try attaching it here.
> It has section numbering and prints beautifully. It is a pleasure to
> read. Unfortunately I can't say the same for the current version (no
> offense meant but it rambles on like a drunk :=). Did you somehow
> change your documentation generation ?
> Hope it helps,
> Richard
>
>
>
> On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> >
> > I don't think there ever was section numbering. There are section
> headers,
> > page numbers and a Table of Contents.
> >
> > Clinton
> >
> >
> > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > Hi folks,
> > >
> > > The section numbering for the developer guide of Data Mapper 2.2 seems
> > > to have got lost.
> > > This makes reading the documentation quite difficult.
> > >
> > > I downloaded from the guide from
> > >
> >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > which is the link on the "iBATIS for Java Downloads" page.
> > >
> > > The OpenOffice version from Subversion seems to have the same problem.
> > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > >
> > > Hope it helps,
> > > Richard Sullivan
> > >
> >
> >
>
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
We could also revisit the idea of using the Confluence wiki for
documentation....it can export to PDF (but only a page at a time I think).
Clinton
On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
>
> There was a change from Microsoft Word to Open Office format. But other
> than that, I haven't touched the documentation since August 2005 (I'm
> ashamed to say).
>
> But looking through the current one on the website...no it doesn't have
> section numbers....but it has a TOC and section headers....it's not a Tom
> Clancy novel, it's tech docs, so don't expect a fun read. That's not an
> excuse, just the way it is.
>
> I don't recommend reading it front to back anyway. It's a reference. Try
> the examples and look up/search for what you need.
>
> I somewhat agree with Larry about DocBook....but does anyone know of a
> good, simple docbook tool? Ted uses a commercial one that I tried and hated
> (but I suppose that was 3 years ago).
>
> Any others? (I know OOo supports DocBook, but it doesn't do such a great
> job...it hosed the document completely when I tried the conversion).
>
> Cheers,
> Clinton
>
>
> On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> >
> > LOL, I like that "rambles on like a drunk".
> >
> > I am not sure what the status is of the dev guide, but I do know that
> > it has needed work for some time, and has been neglected because of
> > other projects.
> >
> > IMO, it would be best if we could somehow convert it to something like
> > docbook, and generate it from that. Any volunteers?
> >
> > Larry
> >
> >
> > On 9/20/06, Richard Sullivan < itexpert.sullivan@gmail.com> wrote:
> > > Hi Clinton,
> > >
> > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > which version it was from but the file is dated August 5 2005. I'm
> > > going to try attaching it here.
> > > It has section numbering and prints beautifully. It is a pleasure to
> > > read. Unfortunately I can't say the same for the current version (no
> > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > change your documentation generation ?
> > > Hope it helps,
> > > Richard
> > >
> > >
> > >
> > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > >
> > > > I don't think there ever was section numbering. There are section
> > headers,
> > > > page numbers and a Table of Contents.
> > > >
> > > > Clinton
> > > >
> > > >
> > > > On 9/19/06, Richard Sullivan < itexpert.sullivan@gmail.com> wrote:
> > > > > Hi folks,
> > > > >
> > > > > The section numbering for the developer guide of Data Mapper 2.2seems
> > > > > to have got lost.
> > > > > This makes reading the documentation quite difficult.
> > > > >
> > > > > I downloaded from the guide from
> > > > >
> > > >
> > http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > >
> > > > > The OpenOffice version from Subversion seems to have the same
> > problem.
> > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > >
> > > > > Hope it helps,
> > > > > Richard Sullivan
> > > > >
> > > >
> > > >
> > >
> > >
> > >
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
There was a change from Microsoft Word to Open Office format. But other
than that, I haven't touched the documentation since August 2005 (I'm
ashamed to say).
But looking through the current one on the website...no it doesn't have
section numbers....but it has a TOC and section headers....it's not a Tom
Clancy novel, it's tech docs, so don't expect a fun read. That's not an
excuse, just the way it is.
I don't recommend reading it front to back anyway. It's a reference. Try
the examples and look up/search for what you need.
I somewhat agree with Larry about DocBook....but does anyone know of a good,
simple docbook tool? Ted uses a commercial one that I tried and hated (but
I suppose that was 3 years ago).
Any others? (I know OOo supports DocBook, but it doesn't do such a great
job...it hosed the document completely when I tried the conversion).
Cheers,
Clinton
On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
>
> LOL, I like that "rambles on like a drunk".
>
> I am not sure what the status is of the dev guide, but I do know that
> it has needed work for some time, and has been neglected because of
> other projects.
>
> IMO, it would be best if we could somehow convert it to something like
> docbook, and generate it from that. Any volunteers?
>
> Larry
>
>
> On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > Hi Clinton,
> >
> > Sometime last year I downloaded the devguide. Sorry I've no idea
> > which version it was from but the file is dated August 5 2005. I'm
> > going to try attaching it here.
> > It has section numbering and prints beautifully. It is a pleasure to
> > read. Unfortunately I can't say the same for the current version (no
> > offense meant but it rambles on like a drunk :=). Did you somehow
> > change your documentation generation ?
> > Hope it helps,
> > Richard
> >
> >
> >
> > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > >
> > > I don't think there ever was section numbering. There are section
> headers,
> > > page numbers and a Table of Contents.
> > >
> > > Clinton
> > >
> > >
> > > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > Hi folks,
> > > >
> > > > The section numbering for the developer guide of Data Mapper 2.2seems
> > > > to have got lost.
> > > > This makes reading the documentation quite difficult.
> > > >
> > > > I downloaded from the guide from
> > > >
> > >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > which is the link on the "iBATIS for Java Downloads" page.
> > > >
> > > > The OpenOffice version from Subversion seems to have the same
> problem.
> > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > >
> > > > Hope it helps,
> > > > Richard Sullivan
> > > >
> > >
> > >
> >
> >
> >
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
Oh, come on now...who edits the XML by hand?
Let's look at it if you are using somthing like XMLMind's (free) XXE:
Edit > Insert After... > programlisting > (paste sample code)
No, it's not "mother-in-law simple", but we're all pretty technical
people or we'd be using Access to "develop applications" instead of
Java or C#.
This argument doesn't hold much water, IMO. :-)
However, on the flip side of this, we can then use SVN to easily see
the changes in the file over time. We can also take that example code
and generate HTML help for windows, Java help, an Eclipse help file, a
M$ Word doc, an RTF, a PDF, or plain old html.
Larry
On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> Let's look at how much fun it is to do XML examples with DocBook...
>
> <programlisting><?xml version="1.0" encoding="UTF-8" ?>
>
> <!DOCTYPE sqlMapConfig
> PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"
> "http://ibatis.apache.org/dtd/sql-map-config-2.dtd">
>
> <!-- Always ensure to use the correct XML header as above! -->
>
> <sqlMapConfig>
> ...
>
> Eww....this would not make me want to update our docs more often..... ;-)
>
> Clinton
>
>
>
>
>
> On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> > OK, just for fun I converted the tutorial to docbook. The dev guide is
> > going to be a bigger project that I wanted to do this morning.
> >
> > I have not committed it yet, but it is attached in case anyone wants
> > to look at it or try to tweak the build to generate a PDF from it. It
> > looks like you can generate Javahelp and Eclipse help files from this,
> > too. That might be interesting...
> >
> > If anyone has an example of how to generate a pdf from it using ant,
> > I'd convert the dev guide and wire the generation into the build.
> >
> > Larry
> >
> >
> > On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> > > LOL, I like that "rambles on like a drunk".
> > >
> > > I am not sure what the status is of the dev guide, but I do know that
> > > it has needed work for some time, and has been neglected because of
> > > other projects.
> > >
> > > IMO, it would be best if we could somehow convert it to something like
> > > docbook, and generate it from that. Any volunteers?
> > >
> > > Larry
> > >
> > >
> > > On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > Hi Clinton,
> > > >
> > > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > > which version it was from but the file is dated August 5 2005. I'm
> > > > going to try attaching it here.
> > > > It has section numbering and prints beautifully. It is a pleasure to
> > > > read. Unfortunately I can't say the same for the current version (no
> > > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > > change your documentation generation ?
> > > > Hope it helps,
> > > > Richard
> > > >
> > > >
> > > >
> > > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > > >
> > > > > I don't think there ever was section numbering. There are section
> headers,
> > > > > page numbers and a Table of Contents.
> > > > >
> > > > > Clinton
> > > > >
> > > > >
> > > > > On 9/19/06, Richard Sullivan < itexpert.sullivan@gmail.com> wrote:
> > > > > > Hi folks,
> > > > > >
> > > > > > The section numbering for the developer guide of Data Mapper 2.2
> seems
> > > > > > to have got lost.
> > > > > > This makes reading the documentation quite difficult.
> > > > > >
> > > > > > I downloaded from the guide from
> > > > > >
> > > > >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > > >
> > > > > > The OpenOffice version from Subversion seems to have the same
> problem.
> > > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > > >
> > > > > > Hope it helps,
> > > > > > Richard Sullivan
> > > > > >
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > >
> >
> >
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Let's look at how much fun it is to do XML examples with DocBook...
<programlisting><?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMapConfig
PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-config-2.dtd">
<!-- Always ensure to use the correct XML header as above! -->
<sqlMapConfig>
...
Eww....this would not make me want to update our docs more often..... ;-)
Clinton
On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
>
> OK, just for fun I converted the tutorial to docbook. The dev guide is
> going to be a bigger project that I wanted to do this morning.
>
> I have not committed it yet, but it is attached in case anyone wants
> to look at it or try to tweak the build to generate a PDF from it. It
> looks like you can generate Javahelp and Eclipse help files from this,
> too. That might be interesting...
>
> If anyone has an example of how to generate a pdf from it using ant,
> I'd convert the dev guide and wire the generation into the build.
>
> Larry
>
>
> On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> > LOL, I like that "rambles on like a drunk".
> >
> > I am not sure what the status is of the dev guide, but I do know that
> > it has needed work for some time, and has been neglected because of
> > other projects.
> >
> > IMO, it would be best if we could somehow convert it to something like
> > docbook, and generate it from that. Any volunteers?
> >
> > Larry
> >
> >
> > On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > > Hi Clinton,
> > >
> > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > which version it was from but the file is dated August 5 2005. I'm
> > > going to try attaching it here.
> > > It has section numbering and prints beautifully. It is a pleasure to
> > > read. Unfortunately I can't say the same for the current version (no
> > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > change your documentation generation ?
> > > Hope it helps,
> > > Richard
> > >
> > >
> > >
> > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > >
> > > > I don't think there ever was section numbering. There are section
> headers,
> > > > page numbers and a Table of Contents.
> > > >
> > > > Clinton
> > > >
> > > >
> > > > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > > Hi folks,
> > > > >
> > > > > The section numbering for the developer guide of Data Mapper 2.2seems
> > > > > to have got lost.
> > > > > This makes reading the documentation quite difficult.
> > > > >
> > > > > I downloaded from the guide from
> > > > >
> > > >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > >
> > > > > The OpenOffice version from Subversion seems to have the same
> problem.
> > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > >
> > > > > Hope it helps,
> > > > > Richard Sullivan
> > > > >
> > > >
> > > >
> > >
> > >
> > >
> >
>
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
Well, if he is still opposed, we can suggest M$ Word, then when he
says "GAH! NO! PLEASE! ANYTHING BUT THAT!!!" We can slip this idea in
under the radar. ;-)
On a serious note, I think there are advantages to using docbook.
I used XmlMind's XXE and it is a decent (free) editor. It's not as
easy to use as OO, but it's not an 800lb gorilla either.
Larry
On 9/20/06, Jeff Butler <je...@gmail.com> wrote:
>
> If you convert to Eclipse help files, then maybe we could host a searchable
> "info center" - that would be awesome!
>
> I do remember that Clinton was resistant to moving away from OpenOffice the
> last time this came up, so maybe we should see if his opinion has changed
> about it.
>
>
> Jeff Butler
>
>
>
>
> On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> > OK, just for fun I converted the tutorial to docbook. The dev guide is
> > going to be a bigger project that I wanted to do this morning.
> >
> > I have not committed it yet, but it is attached in case anyone wants
> > to look at it or try to tweak the build to generate a PDF from it. It
> > looks like you can generate Javahelp and Eclipse help files from this,
> > too. That might be interesting...
> >
> > If anyone has an example of how to generate a pdf from it using ant,
> > I'd convert the dev guide and wire the generation into the build.
> >
> > Larry
> >
> >
> > On 9/20/06, Larry Meadors < lmeadors@apache.org> wrote:
> > > LOL, I like that "rambles on like a drunk".
> > >
> > > I am not sure what the status is of the dev guide, but I do know that
> > > it has needed work for some time, and has been neglected because of
> > > other projects.
> > >
> > > IMO, it would be best if we could somehow convert it to something like
> > > docbook, and generate it from that. Any volunteers?
> > >
> > > Larry
> > >
> > >
> > > On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > Hi Clinton,
> > > >
> > > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > > which version it was from but the file is dated August 5 2005. I'm
> > > > going to try attaching it here.
> > > > It has section numbering and prints beautifully. It is a pleasure to
> > > > read. Unfortunately I can't say the same for the current version (no
> > > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > > change your documentation generation ?
> > > > Hope it helps,
> > > > Richard
> > > >
> > > >
> > > >
> > > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > > >
> > > > > I don't think there ever was section numbering. There are section
> headers,
> > > > > page numbers and a Table of Contents.
> > > > >
> > > > > Clinton
> > > > >
> > > > >
> > > > > On 9/19/06, Richard Sullivan < itexpert.sullivan@gmail.com> wrote:
> > > > > > Hi folks,
> > > > > >
> > > > > > The section numbering for the developer guide of Data Mapper 2.2
> seems
> > > > > > to have got lost.
> > > > > > This makes reading the documentation quite difficult.
> > > > > >
> > > > > > I downloaded from the guide from
> > > > > >
> > > > >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > > >
> > > > > > The OpenOffice version from Subversion seems to have the same
> problem.
> > > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > > >
> > > > > > Hope it helps,
> > > > > > Richard Sullivan
> > > > > >
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > >
> >
> >
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
I just talked to the guys at XMLMind, and it sounds like they are
willing to give Apache members licenses to the Pro version of XXE (and
have in some cases already).
http://www.xmlmind.com/xmleditor/proedition.html
http://www.xmlmind.com/xmleditor/features.html
Larry
On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
>
> Don't get us wrong Richard, we're not on your case. Your points are all
> valid, and we want to take them seriously.
>
> I want a solution that:
>
> Improves the quality of our documentation
> Improves the timeliness of our documentation
> Improves community involvement>> my wife and baby need some love and
> attention too.
>
> Hehe...not all open source developers are single, university undergrads with
> all the time in the world. :-)
>
> I think Larry and Brandon and myself have 3 wives and 8 children among us
> (well, we don't share them or anything -- but Larry does live in Montana).
>
> So don't think you're unique or that we have any more time than you. Open
> Source is about sharing time to produce great software (and documentation).
>
> The story of Little Red Hen comes to mind (and makes a good bedtime story
> for our kids).
>
> Cheers,
> Clinton
>
>
> On 9/21/06, Richard Sullivan <it...@gmail.com> wrote:
> > >>Why haven't *you* added the section numbers?
> > Typical answer of an opensource geek. Sheesh I suddenly feel an urge
> > to write this friggin JDBC by hand after all. OK, if IBATIS works for
> > me I'll do the doc ;=) Just don't hold your breath - my wife and baby
> > need some love and attention too.
> > Now you guys check out the wiki/docbook thing and get off my case ;=)
> > R.
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Don't get us wrong Richard, we're not on your case. Your points are all
valid, and we want to take them seriously.
I want a solution that:
- Improves the quality of our documentation
- Improves the timeliness of our documentation
- Improves community involvement
>> my wife and baby need some love and attention too.
Hehe...not all open source developers are single, university undergrads with
all the time in the world. :-)
I think Larry and Brandon and myself have 3 wives and 8 children among us
(well, we don't share them or anything -- but Larry does live in Montana).
So don't think you're unique or that we have any more time than you. Open
Source is about sharing time to produce great software (and documentation).
The story of Little Red Hen comes to mind (and makes a good bedtime story
for our kids).
Cheers,
Clinton
On 9/21/06, Richard Sullivan <it...@gmail.com> wrote:
>
> >>Why haven't *you* added the section numbers?
> Typical answer of an opensource geek. Sheesh I suddenly feel an urge
> to write this friggin JDBC by hand after all. OK, if IBATIS works for
> me I'll do the doc ;=) Just don't hold your breath - my wife and baby
> need some love and attention too.
> Now you guys check out the wiki/docbook thing and get off my case ;=)
> R.
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
On 9/21/06, Richard Sullivan <it...@gmail.com> wrote:
> my wife and baby need some love and attention too.
Speaking of which..any news Mr. Begin? Isn't your little project
running behind schedule now?
Larry
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Richard Sullivan <it...@gmail.com>.
>>Why haven't *you* added the section numbers?
Typical answer of an opensource geek. Sheesh I suddenly feel an urge
to write this friggin JDBC by hand after all. OK, if IBATIS works for
me I'll do the doc ;=) Just don't hold your breath - my wife and baby
need some love and attention too.
Now you guys check out the wiki/docbook thing and get off my case ;=)
R.
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Wait a minute...you're the perfect person to ask Richard!
Since you've been fairly critical of the docs and you think section numbers
are important:
Why haven't *you* added the section numbers?
You can find Open Office at:
http://www.OpenOffice.org
You can find the source docs at
http://svn.apache.org/repos/asf/ibatis/trunk/java/docs/en/
Attach your mods to a JIRA issue and we'll implement them.
Clinton
On 9/21/06, Richard Sullivan <it...@gmail.com> wrote:
>
> Wow I just asked about section numbers and now you guys are all
> salivating about docbook. Fine with me as long as some day the
> section numbers appear in the Java version of the docs ;=)
>
> How about a wiki that stores everything in docbook format ?
>
> See
>
> http://doc-book.sourceforge.net/homepage/
>
> No idea how well it works - just googled it.
>
> Good luck,
> Richard
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Dude, I seriously can't believe the section numbers are so important to
you. I've never noticed section numbers in anything I've read. Cest la
vie. ;-)
In any case, we shouldn't confuse the tools and formats with content.
Obviously any of the aforementioned approaches can include section numbers.
Good or bad documentation can be written with any tool.
Cheers,
Clinton
On 9/21/06, Richard Sullivan <it...@gmail.com> wrote:
>
> Wow I just asked about section numbers and now you guys are all
> salivating about docbook. Fine with me as long as some day the
> section numbers appear in the Java version of the docs ;=)
>
> How about a wiki that stores everything in docbook format ?
>
> See
>
> http://doc-book.sourceforge.net/homepage/
>
> No idea how well it works - just googled it.
>
> Good luck,
> Richard
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Richard Sullivan <it...@gmail.com>.
Wow I just asked about section numbers and now you guys are all
salivating about docbook. Fine with me as long as some day the
section numbers appear in the Java version of the docs ;=)
How about a wiki that stores everything in docbook format ?
See
http://doc-book.sourceforge.net/homepage/
No idea how well it works - just googled it.
Good luck,
Richard
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Richard Sullivan <it...@gmail.com>.
>>I seriously can't believe the section numbers are so important to you.
Of course not. I wouldn't have cared about numbering except that
while I found the content of the devguide very good I had difficulty
navigating it. I wanted to jump in to something like "complex
mapping" but I found it difficult to figure out where one topic ended
and another began. The numbering in the .NOT version solved this
problem nicely. Maybe more whitespace, pagebreaks and a bigger
difference in font sizes in the headings would work too.
Anyway I'll stop whining now and RTFM with or without the numbers.
Don't forget to check out the Wiki over Docbook idea from my last mail
though ;=)
Ciao,
Richard
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
Hey cool, my bad. :)
Larry
On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> Actually...Ruby people will chew you out for this. :-)
>
> The docs are part of Ruby (kinda like Javadoc) but are included with the
> app...by practice.
>
> http://ibatis.apache.org/docs/ruby/
>
>
> Clinton
>
> On 9/21/06, Larry Meadors <lm...@apache.org> wrote:
> > Haha, what are you saying?
> >
> > lmeadors@gnomer ~/projects/ibatis/trunk/rb $ ls docs/
> > total 0
> > drwxr-xr-x 3 users 72 Aug 9 09:58 .
> > drwxr-xr-x 6 users 152 Aug 9 09:58 ..
> > drwxr-xr-x 7 users 328 Aug 9 10:00 .svn
> >
> > There are *no* ruby docs. :)
> >
> > Larry
> >
> > On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> > > >> Looks like the .NET guys are using DocBook, I wonder how they do it
> and
> > > like it?
> > >
> > > No fair, .NET people are smarter! Not as smart as Ruby people but....
> > >
> > > >> XXE
> > >
> > > So far it sounds like XXE is about as good as OOo. The multi-format and
> > > diffing is nice, but at the expense of some of the other equally
> valuable
> > > criteria -- not enough to switch IMHO. I think PDF is the only really
> > > important format. Who wants to read HTML over PDF? (BTW- Check out
> Foxit
> > > Reader people!!!!!) :-)
> > >
> > > I'd like to hear from someone in the community. My list of acceptance
> > > criterea could be missing something or include stuff that people don't
> care
> > > about. For example, if our users don't care about Downloadable,
> Printable,
> > > and Bundleable - and would trade them for more up-to-date docs - then we
> may
> > > just want to use Confluence.
> > >
> > > Thoughts?
> > >
> > > Clinton
> > >
> > >
> > > On 9/21/06, Larry Meadors < lmeadors@apache.org> wrote:
> > > > On 9/21/06, Clinton Begin < clinton.begin@gmail.com> wrote:
> > > > > I'm not resistant ... I just haven't heard any better alternatives.
> > > >
> > > > ..and I am not so crazy about DocBook either, just wanting to explore
> it
> > > more.
> > > >
> > > > > Developer/Author criteria:
> > > > >
> > > > > Accessible - OOo is free.
> > > >
> > > > So is XMLMind's XXE.
> > > >
> > > >
> > > > > Easy - OOo is WYSIWYG, familiar word processing paradigm.
> > > >
> > > > So is XMLMind's XXE, *to some extent*. You don't get to choose fonts,
> > > > etc, because the idea is that you are capturing content and structure
> > > > then applying styles to it later - instead of implying structure from
> > > > styles.
> > > >
> > > > The free version allegedly has a spell checker...but it sucks, unless
> > > > "Chekc Miy speeling" is all spelled right.
> > > >
> > > > > Portable - OOo is available for all desktop platforms that I know
> of.
> > > >
> > > > XXE is just Java.
> > > >
> > > > > Participative - OOo fails at this, it does not seem to encourage
> > > > > participation despite the above accessibility and ease of use.
> > > >
> > > > Yeah...hmm, XXE sucks at this, too. I guess you can modularize the
> > > > document, so that people can work on different sections at the same
> > > > time easily, so that's useful. But as far as easy collaboration, it's
> > > > no WIKI. ;-)
> > > >
> > > > > Quick Changes/Deployment - OOo fails at this too -- modifying the
> docs
> > > and
> > > > > deploying the result is a PITA and therefore discourages
> > > > > updating.
> > > >
> > > > Same as above. A docbook file is like source. It would have to be
> > > > rendered, then deployed, just like the current docs (the PDF part of
> > > > the current docs, I mean). It could be automated though.
> > > >
> > > > > User/Reader criteria:
> > > > > Printable - OOo can produce PDFs.
> > > >
> > > > XXE, too.
> > > >
> > > >
> > > > > "Bundlable" - OOo can produce PDFs that can be included with the
> distro
> > > (and
> > > > > is now).
> > > >
> > > > XXE, too - and it can be easily automated with ant.
> > > >
> > > >
> > > > > "Downloadable" - OOo can produce PDFs.
> > > >
> > > > Check.
> > > >
> > > >
> > > > > Multi-format - OOo can actually export to PDF, HTML and
> > > DocBook....although
> > > > > it sucks at the latter two
> > > >
> > > > DocBook rules here. Period.
> > > >
> > > >
> > > > > Searchable - OOo has good search facilities, as does PDF (google can
> > > search
> > > > > them), we can export to HTML for web search.
> > > >
> > > > DocBook can provide all of these formats, too. XXE has a search
> > > > feature, so you can search in the editor reasonably well. It work with
> > > > multi-file documents as well.
> > > >
> > > > > Other alternatives discussed so far:
> > > > >
> > > > > Confluence excels at Participative and Quick Changes, but fails in
> many
> > > > > others including Printable, Downloadable, Bundlable -- unless one
> page
> > > at a
> > > > > time is good enough.
> > > > >
> > > > > DocBook exels at Multi-format output but fails on Accessible, Easy,
> and
> > > > > Participative.
> > > > > Others I'm forgetting?
> > > > >
> > > > > Thoughts?
> > > >
> > > > I hate XML as much as the next guy. But XXE makes it pretty painless
> > > > (after the initial shock of "How do I set the font?!") to edit DocBook
> > > > documents.
> > > >
> > > > Looks like the .NET guys are using DocBook, I wonder how they do it
> and
> > > like it?
> > > >
> > > > Larry
> > > >
> > >
> > >
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
Actually...Ruby people will chew you out for this. :-)
The docs are part of Ruby (kinda like Javadoc) but are included with the
app...by practice.
http://ibatis.apache.org/docs/ruby/
Clinton
On 9/21/06, Larry Meadors <lm...@apache.org> wrote:
>
> Haha, what are you saying?
>
> lmeadors@gnomer ~/projects/ibatis/trunk/rb $ ls docs/
> total 0
> drwxr-xr-x 3 users 72 Aug 9 09:58 .
> drwxr-xr-x 6 users 152 Aug 9 09:58 ..
> drwxr-xr-x 7 users 328 Aug 9 10:00 .svn
>
> There are *no* ruby docs. :)
>
> Larry
>
> On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> > >> Looks like the .NET guys are using DocBook, I wonder how they do it
> and
> > like it?
> >
> > No fair, .NET people are smarter! Not as smart as Ruby people but....
> >
> > >> XXE
> >
> > So far it sounds like XXE is about as good as OOo. The multi-format and
> > diffing is nice, but at the expense of some of the other equally
> valuable
> > criteria -- not enough to switch IMHO. I think PDF is the only really
> > important format. Who wants to read HTML over PDF? (BTW- Check out
> Foxit
> > Reader people!!!!!) :-)
> >
> > I'd like to hear from someone in the community. My list of acceptance
> > criterea could be missing something or include stuff that people don't
> care
> > about. For example, if our users don't care about Downloadable,
> Printable,
> > and Bundleable - and would trade them for more up-to-date docs - then we
> may
> > just want to use Confluence.
> >
> > Thoughts?
> >
> > Clinton
> >
> >
> > On 9/21/06, Larry Meadors <lm...@apache.org> wrote:
> > > On 9/21/06, Clinton Begin < clinton.begin@gmail.com> wrote:
> > > > I'm not resistant ... I just haven't heard any better alternatives.
> > >
> > > ..and I am not so crazy about DocBook either, just wanting to explore
> it
> > more.
> > >
> > > > Developer/Author criteria:
> > > >
> > > > Accessible - OOo is free.
> > >
> > > So is XMLMind's XXE.
> > >
> > >
> > > > Easy - OOo is WYSIWYG, familiar word processing paradigm.
> > >
> > > So is XMLMind's XXE, *to some extent*. You don't get to choose fonts,
> > > etc, because the idea is that you are capturing content and structure
> > > then applying styles to it later - instead of implying structure from
> > > styles.
> > >
> > > The free version allegedly has a spell checker...but it sucks, unless
> > > "Chekc Miy speeling" is all spelled right.
> > >
> > > > Portable - OOo is available for all desktop platforms that I know
> of.
> > >
> > > XXE is just Java.
> > >
> > > > Participative - OOo fails at this, it does not seem to encourage
> > > > participation despite the above accessibility and ease of use.
> > >
> > > Yeah...hmm, XXE sucks at this, too. I guess you can modularize the
> > > document, so that people can work on different sections at the same
> > > time easily, so that's useful. But as far as easy collaboration, it's
> > > no WIKI. ;-)
> > >
> > > > Quick Changes/Deployment - OOo fails at this too -- modifying the
> docs
> > and
> > > > deploying the result is a PITA and therefore discourages
> > > > updating.
> > >
> > > Same as above. A docbook file is like source. It would have to be
> > > rendered, then deployed, just like the current docs (the PDF part of
> > > the current docs, I mean). It could be automated though.
> > >
> > > > User/Reader criteria:
> > > > Printable - OOo can produce PDFs.
> > >
> > > XXE, too.
> > >
> > >
> > > > "Bundlable" - OOo can produce PDFs that can be included with the
> distro
> > (and
> > > > is now).
> > >
> > > XXE, too - and it can be easily automated with ant.
> > >
> > >
> > > > "Downloadable" - OOo can produce PDFs.
> > >
> > > Check.
> > >
> > >
> > > > Multi-format - OOo can actually export to PDF, HTML and
> > DocBook....although
> > > > it sucks at the latter two
> > >
> > > DocBook rules here. Period.
> > >
> > >
> > > > Searchable - OOo has good search facilities, as does PDF (google can
> > search
> > > > them), we can export to HTML for web search.
> > >
> > > DocBook can provide all of these formats, too. XXE has a search
> > > feature, so you can search in the editor reasonably well. It work with
> > > multi-file documents as well.
> > >
> > > > Other alternatives discussed so far:
> > > >
> > > > Confluence excels at Participative and Quick Changes, but fails in
> many
> > > > others including Printable, Downloadable, Bundlable -- unless one
> page
> > at a
> > > > time is good enough.
> > > >
> > > > DocBook exels at Multi-format output but fails on Accessible, Easy,
> and
> > > > Participative.
> > > > Others I'm forgetting?
> > > >
> > > > Thoughts?
> > >
> > > I hate XML as much as the next guy. But XXE makes it pretty painless
> > > (after the initial shock of "How do I set the font?!") to edit DocBook
> > > documents.
> > >
> > > Looks like the .NET guys are using DocBook, I wonder how they do it
> and
> > like it?
> > >
> > > Larry
> > >
> >
> >
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
Haha, what are you saying?
lmeadors@gnomer ~/projects/ibatis/trunk/rb $ ls docs/
total 0
drwxr-xr-x 3 users 72 Aug 9 09:58 .
drwxr-xr-x 6 users 152 Aug 9 09:58 ..
drwxr-xr-x 7 users 328 Aug 9 10:00 .svn
There are *no* ruby docs. :)
Larry
On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> >> Looks like the .NET guys are using DocBook, I wonder how they do it and
> like it?
>
> No fair, .NET people are smarter! Not as smart as Ruby people but....
>
> >> XXE
>
> So far it sounds like XXE is about as good as OOo. The multi-format and
> diffing is nice, but at the expense of some of the other equally valuable
> criteria -- not enough to switch IMHO. I think PDF is the only really
> important format. Who wants to read HTML over PDF? (BTW- Check out Foxit
> Reader people!!!!!) :-)
>
> I'd like to hear from someone in the community. My list of acceptance
> criterea could be missing something or include stuff that people don't care
> about. For example, if our users don't care about Downloadable, Printable,
> and Bundleable - and would trade them for more up-to-date docs - then we may
> just want to use Confluence.
>
> Thoughts?
>
> Clinton
>
>
> On 9/21/06, Larry Meadors <lm...@apache.org> wrote:
> > On 9/21/06, Clinton Begin < clinton.begin@gmail.com> wrote:
> > > I'm not resistant ... I just haven't heard any better alternatives.
> >
> > ..and I am not so crazy about DocBook either, just wanting to explore it
> more.
> >
> > > Developer/Author criteria:
> > >
> > > Accessible - OOo is free.
> >
> > So is XMLMind's XXE.
> >
> >
> > > Easy - OOo is WYSIWYG, familiar word processing paradigm.
> >
> > So is XMLMind's XXE, *to some extent*. You don't get to choose fonts,
> > etc, because the idea is that you are capturing content and structure
> > then applying styles to it later - instead of implying structure from
> > styles.
> >
> > The free version allegedly has a spell checker...but it sucks, unless
> > "Chekc Miy speeling" is all spelled right.
> >
> > > Portable - OOo is available for all desktop platforms that I know of.
> >
> > XXE is just Java.
> >
> > > Participative - OOo fails at this, it does not seem to encourage
> > > participation despite the above accessibility and ease of use.
> >
> > Yeah...hmm, XXE sucks at this, too. I guess you can modularize the
> > document, so that people can work on different sections at the same
> > time easily, so that's useful. But as far as easy collaboration, it's
> > no WIKI. ;-)
> >
> > > Quick Changes/Deployment - OOo fails at this too -- modifying the docs
> and
> > > deploying the result is a PITA and therefore discourages
> > > updating.
> >
> > Same as above. A docbook file is like source. It would have to be
> > rendered, then deployed, just like the current docs (the PDF part of
> > the current docs, I mean). It could be automated though.
> >
> > > User/Reader criteria:
> > > Printable - OOo can produce PDFs.
> >
> > XXE, too.
> >
> >
> > > "Bundlable" - OOo can produce PDFs that can be included with the distro
> (and
> > > is now).
> >
> > XXE, too - and it can be easily automated with ant.
> >
> >
> > > "Downloadable" - OOo can produce PDFs.
> >
> > Check.
> >
> >
> > > Multi-format - OOo can actually export to PDF, HTML and
> DocBook....although
> > > it sucks at the latter two
> >
> > DocBook rules here. Period.
> >
> >
> > > Searchable - OOo has good search facilities, as does PDF (google can
> search
> > > them), we can export to HTML for web search.
> >
> > DocBook can provide all of these formats, too. XXE has a search
> > feature, so you can search in the editor reasonably well. It work with
> > multi-file documents as well.
> >
> > > Other alternatives discussed so far:
> > >
> > > Confluence excels at Participative and Quick Changes, but fails in many
> > > others including Printable, Downloadable, Bundlable -- unless one page
> at a
> > > time is good enough.
> > >
> > > DocBook exels at Multi-format output but fails on Accessible, Easy, and
> > > Participative.
> > > Others I'm forgetting?
> > >
> > > Thoughts?
> >
> > I hate XML as much as the next guy. But XXE makes it pretty painless
> > (after the initial shock of "How do I set the font?!") to edit DocBook
> > documents.
> >
> > Looks like the .NET guys are using DocBook, I wonder how they do it and
> like it?
> >
> > Larry
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
>> Looks like the .NET guys are using DocBook, I wonder how they do it and
like it?
No fair, .NET people are smarter! Not as smart as Ruby people but....
>> XXE
So far it sounds like XXE is about as good as OOo. The multi-format and
diffing is nice, but at the expense of some of the other equally valuable
criteria -- not enough to switch IMHO. I think PDF is the only really
important format. Who wants to read HTML over PDF? (BTW- Check out Foxit
Reader people!!!!!) :-)
I'd like to hear from someone in the community. My list of acceptance
criterea could be missing something or include stuff that people don't care
about. For example, if our users don't care about Downloadable, Printable,
and Bundleable - and would trade them for more up-to-date docs - then we may
just want to use Confluence.
Thoughts?
Clinton
On 9/21/06, Larry Meadors <lm...@apache.org> wrote:
>
> On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> > I'm not resistant ... I just haven't heard any better alternatives.
>
> ..and I am not so crazy about DocBook either, just wanting to explore it
> more.
>
> > Developer/Author criteria:
> >
> > Accessible - OOo is free.
>
> So is XMLMind's XXE.
>
>
> > Easy - OOo is WYSIWYG, familiar word processing paradigm.
>
> So is XMLMind's XXE, *to some extent*. You don't get to choose fonts,
> etc, because the idea is that you are capturing content and structure
> then applying styles to it later - instead of implying structure from
> styles.
>
> The free version allegedly has a spell checker...but it sucks, unless
> "Chekc Miy speeling" is all spelled right.
>
> > Portable - OOo is available for all desktop platforms that I know of.
>
> XXE is just Java.
>
> > Participative - OOo fails at this, it does not seem to encourage
> > participation despite the above accessibility and ease of use.
>
> Yeah...hmm, XXE sucks at this, too. I guess you can modularize the
> document, so that people can work on different sections at the same
> time easily, so that's useful. But as far as easy collaboration, it's
> no WIKI. ;-)
>
> > Quick Changes/Deployment - OOo fails at this too -- modifying the docs
> and
> > deploying the result is a PITA and therefore discourages
> > updating.
>
> Same as above. A docbook file is like source. It would have to be
> rendered, then deployed, just like the current docs (the PDF part of
> the current docs, I mean). It could be automated though.
>
> > User/Reader criteria:
> > Printable - OOo can produce PDFs.
>
> XXE, too.
>
>
> > "Bundlable" - OOo can produce PDFs that can be included with the distro
> (and
> > is now).
>
> XXE, too - and it can be easily automated with ant.
>
>
> > "Downloadable" - OOo can produce PDFs.
>
> Check.
>
>
> > Multi-format - OOo can actually export to PDF, HTML and
> DocBook....although
> > it sucks at the latter two
>
> DocBook rules here. Period.
>
>
> > Searchable - OOo has good search facilities, as does PDF (google can
> search
> > them), we can export to HTML for web search.
>
> DocBook can provide all of these formats, too. XXE has a search
> feature, so you can search in the editor reasonably well. It work with
> multi-file documents as well.
>
> > Other alternatives discussed so far:
> >
> > Confluence excels at Participative and Quick Changes, but fails in many
> > others including Printable, Downloadable, Bundlable -- unless one page
> at a
> > time is good enough.
> >
> > DocBook exels at Multi-format output but fails on Accessible, Easy, and
> > Participative.
> > Others I'm forgetting?
> >
> > Thoughts?
>
> I hate XML as much as the next guy. But XXE makes it pretty painless
> (after the initial shock of "How do I set the font?!") to edit DocBook
> documents.
>
> Looks like the .NET guys are using DocBook, I wonder how they do it and
> like it?
>
> Larry
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
On 9/21/06, Clinton Begin <cl...@gmail.com> wrote:
> I'm not resistant ... I just haven't heard any better alternatives.
..and I am not so crazy about DocBook either, just wanting to explore it more.
> Developer/Author criteria:
>
> Accessible - OOo is free.
So is XMLMind's XXE.
> Easy - OOo is WYSIWYG, familiar word processing paradigm.
So is XMLMind's XXE, *to some extent*. You don't get to choose fonts,
etc, because the idea is that you are capturing content and structure
then applying styles to it later - instead of implying structure from
styles.
The free version allegedly has a spell checker...but it sucks, unless
"Chekc Miy speeling" is all spelled right.
> Portable - OOo is available for all desktop platforms that I know of.
XXE is just Java.
> Participative - OOo fails at this, it does not seem to encourage
> participation despite the above accessibility and ease of use.
Yeah...hmm, XXE sucks at this, too. I guess you can modularize the
document, so that people can work on different sections at the same
time easily, so that's useful. But as far as easy collaboration, it's
no WIKI. ;-)
> Quick Changes/Deployment - OOo fails at this too -- modifying the docs and
> deploying the result is a PITA and therefore discourages
> updating.
Same as above. A docbook file is like source. It would have to be
rendered, then deployed, just like the current docs (the PDF part of
the current docs, I mean). It could be automated though.
> User/Reader criteria:
> Printable - OOo can produce PDFs.
XXE, too.
> "Bundlable" - OOo can produce PDFs that can be included with the distro (and
> is now).
XXE, too - and it can be easily automated with ant.
> "Downloadable" - OOo can produce PDFs.
Check.
> Multi-format - OOo can actually export to PDF, HTML and DocBook....although
> it sucks at the latter two
DocBook rules here. Period.
> Searchable - OOo has good search facilities, as does PDF (google can search
> them), we can export to HTML for web search.
DocBook can provide all of these formats, too. XXE has a search
feature, so you can search in the editor reasonably well. It work with
multi-file documents as well.
> Other alternatives discussed so far:
>
> Confluence excels at Participative and Quick Changes, but fails in many
> others including Printable, Downloadable, Bundlable -- unless one page at a
> time is good enough.
>
> DocBook exels at Multi-format output but fails on Accessible, Easy, and
> Participative.
> Others I'm forgetting?
>
> Thoughts?
I hate XML as much as the next guy. But XXE makes it pretty painless
(after the initial shock of "How do I set the font?!") to edit DocBook
documents.
Looks like the .NET guys are using DocBook, I wonder how they do it and like it?
Larry
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
I'm not resistant ... I just haven't heard any better alternatives. Here
are some criteria (my assumptions) to consider.
(I'm going to reserve my right make up some words here ;-)
Developer/Author criteria:
- Accessible - OOo is free.
- Easy - OOo is WYSIWYG, familiar word processing paradigm.
- Portable - OOo is available for all desktop platforms that I know
of.
- Participative - OOo fails at this, it does not seem to encourage
participation despite the above accessibility and ease of use.
- Quick Changes/Deployment - OOo fails at this too -- modifying the
docs and deploying the result is a PITA and therefore discourages
updating.
User/Reader criteria:
- Printable - OOo can produce PDFs.
- "Bundlable" - OOo can produce PDFs that can be included with the
distro (and is now).
- "Downloadable" - OOo can produce PDFs.
- Multi-format - OOo can actually export to PDF, HTML and
DocBook....although it sucks at the latter two
- Searchable - OOo has good search facilities, as does PDF (google can
search them), we can export to HTML for web search.
Other alternatives discussed so far:
- Confluence excels at Participative and Quick Changes, but fails in
many others including Printable, Downloadable, Bundlable -- unless one page
at a time is good enough.
- DocBook exels at Multi-format output but fails on Accessible, Easy,
and Participative.
- Others I'm forgetting?
Thoughts?
Cheers,
Clinton
On 9/20/06, Jeff Butler < jeffgbutler@gmail.com> wrote:
>
> If you convert to Eclipse help files, then maybe we could host a
> searchable "info center" - that would be awesome!
>
> I do remember that Clinton was resistant to moving away from OpenOffice
> the last time this came up, so maybe we should see if his opinion has
> changed about it.
>
> Jeff Butler
>
>
>
> On 9/20/06, Larry Meadors <lmeadors@apache.org > wrote:
> >
> > OK, just for fun I converted the tutorial to docbook. The dev guide is
> > going to be a bigger project that I wanted to do this morning.
> >
> > I have not committed it yet, but it is attached in case anyone wants
> > to look at it or try to tweak the build to generate a PDF from it. It
> > looks like you can generate Javahelp and Eclipse help files from this,
> > too. That might be interesting...
> >
> > If anyone has an example of how to generate a pdf from it using ant,
> > I'd convert the dev guide and wire the generation into the build.
> >
> > Larry
> >
> >
> > On 9/20/06, Larry Meadors < lmeadors@apache.org> wrote:
> > > LOL, I like that "rambles on like a drunk".
> > >
> > > I am not sure what the status is of the dev guide, but I do know that
> > > it has needed work for some time, and has been neglected because of
> > > other projects.
> > >
> > > IMO, it would be best if we could somehow convert it to something like
> > > docbook, and generate it from that. Any volunteers?
> > >
> > > Larry
> > >
> > >
> > > On 9/20/06, Richard Sullivan <itexpert.sullivan@gmail.com > wrote:
> > > > Hi Clinton,
> > > >
> > > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > > which version it was from but the file is dated August 5 2005. I'm
> > > > going to try attaching it here.
> > > > It has section numbering and prints beautifully. It is a pleasure
> > to
> > > > read. Unfortunately I can't say the same for the current version
> > (no
> > > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > > change your documentation generation ?
> > > > Hope it helps,
> > > > Richard
> > > >
> > > >
> > > >
> > > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > > >
> > > > > I don't think there ever was section numbering. There are section
> > headers,
> > > > > page numbers and a Table of Contents.
> > > > >
> > > > > Clinton
> > > > >
> > > > >
> > > > > On 9/19/06, Richard Sullivan < itexpert.sullivan@gmail.com> wrote:
> > > > > > Hi folks,
> > > > > >
> > > > > > The section numbering for the developer guide of Data Mapper 2.2seems
> > > > > > to have got lost.
> > > > > > This makes reading the documentation quite difficult.
> > > > > >
> > > > > > I downloaded from the guide from
> > > > > >
> > > > >
> > http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > > >
> > > > > > The OpenOffice version from Subversion seems to have the same
> > problem.
> > > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > > >
> > > > > > Hope it helps,
> > > > > > Richard Sullivan
> > > > > >
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > >
> >
> >
> >
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Jeff Butler <je...@gmail.com>.
If you convert to Eclipse help files, then maybe we could host a searchable
"info center" - that would be awesome!
I do remember that Clinton was resistant to moving away from OpenOffice the
last time this came up, so maybe we should see if his opinion has changed
about it.
Jeff Butler
On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
>
> OK, just for fun I converted the tutorial to docbook. The dev guide is
> going to be a bigger project that I wanted to do this morning.
>
> I have not committed it yet, but it is attached in case anyone wants
> to look at it or try to tweak the build to generate a PDF from it. It
> looks like you can generate Javahelp and Eclipse help files from this,
> too. That might be interesting...
>
> If anyone has an example of how to generate a pdf from it using ant,
> I'd convert the dev guide and wire the generation into the build.
>
> Larry
>
>
> On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> > LOL, I like that "rambles on like a drunk".
> >
> > I am not sure what the status is of the dev guide, but I do know that
> > it has needed work for some time, and has been neglected because of
> > other projects.
> >
> > IMO, it would be best if we could somehow convert it to something like
> > docbook, and generate it from that. Any volunteers?
> >
> > Larry
> >
> >
> > On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > > Hi Clinton,
> > >
> > > Sometime last year I downloaded the devguide. Sorry I've no idea
> > > which version it was from but the file is dated August 5 2005. I'm
> > > going to try attaching it here.
> > > It has section numbering and prints beautifully. It is a pleasure to
> > > read. Unfortunately I can't say the same for the current version (no
> > > offense meant but it rambles on like a drunk :=). Did you somehow
> > > change your documentation generation ?
> > > Hope it helps,
> > > Richard
> > >
> > >
> > >
> > > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > > >
> > > > I don't think there ever was section numbering. There are section
> headers,
> > > > page numbers and a Table of Contents.
> > > >
> > > > Clinton
> > > >
> > > >
> > > > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > > Hi folks,
> > > > >
> > > > > The section numbering for the developer guide of Data Mapper 2.2seems
> > > > > to have got lost.
> > > > > This makes reading the documentation quite difficult.
> > > > >
> > > > > I downloaded from the guide from
> > > > >
> > > >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > > which is the link on the "iBATIS for Java Downloads" page.
> > > > >
> > > > > The OpenOffice version from Subversion seems to have the same
> problem.
> > > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > > >
> > > > > Hope it helps,
> > > > > Richard Sullivan
> > > > >
> > > >
> > > >
> > >
> > >
> > >
> >
>
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
OK, just for fun I converted the tutorial to docbook. The dev guide is
going to be a bigger project that I wanted to do this morning.
I have not committed it yet, but it is attached in case anyone wants
to look at it or try to tweak the build to generate a PDF from it. It
looks like you can generate Javahelp and Eclipse help files from this,
too. That might be interesting...
If anyone has an example of how to generate a pdf from it using ant,
I'd convert the dev guide and wire the generation into the build.
Larry
On 9/20/06, Larry Meadors <lm...@apache.org> wrote:
> LOL, I like that "rambles on like a drunk".
>
> I am not sure what the status is of the dev guide, but I do know that
> it has needed work for some time, and has been neglected because of
> other projects.
>
> IMO, it would be best if we could somehow convert it to something like
> docbook, and generate it from that. Any volunteers?
>
> Larry
>
>
> On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> > Hi Clinton,
> >
> > Sometime last year I downloaded the devguide. Sorry I've no idea
> > which version it was from but the file is dated August 5 2005. I'm
> > going to try attaching it here.
> > It has section numbering and prints beautifully. It is a pleasure to
> > read. Unfortunately I can't say the same for the current version (no
> > offense meant but it rambles on like a drunk :=). Did you somehow
> > change your documentation generation ?
> > Hope it helps,
> > Richard
> >
> >
> >
> > On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> > >
> > > I don't think there ever was section numbering. There are section headers,
> > > page numbers and a Table of Contents.
> > >
> > > Clinton
> > >
> > >
> > > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > > Hi folks,
> > > >
> > > > The section numbering for the developer guide of Data Mapper 2.2 seems
> > > > to have got lost.
> > > > This makes reading the documentation quite difficult.
> > > >
> > > > I downloaded from the guide from
> > > >
> > > http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > > which is the link on the "iBATIS for Java Downloads" page.
> > > >
> > > > The OpenOffice version from Subversion seems to have the same problem.
> > > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > > >
> > > > Hope it helps,
> > > > Richard Sullivan
> > > >
> > >
> > >
> >
> >
> >
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Larry Meadors <lm...@apache.org>.
LOL, I like that "rambles on like a drunk".
I am not sure what the status is of the dev guide, but I do know that
it has needed work for some time, and has been neglected because of
other projects.
IMO, it would be best if we could somehow convert it to something like
docbook, and generate it from that. Any volunteers?
Larry
On 9/20/06, Richard Sullivan <it...@gmail.com> wrote:
> Hi Clinton,
>
> Sometime last year I downloaded the devguide. Sorry I've no idea
> which version it was from but the file is dated August 5 2005. I'm
> going to try attaching it here.
> It has section numbering and prints beautifully. It is a pleasure to
> read. Unfortunately I can't say the same for the current version (no
> offense meant but it rambles on like a drunk :=). Did you somehow
> change your documentation generation ?
> Hope it helps,
> Richard
>
>
>
> On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
> >
> > I don't think there ever was section numbering. There are section headers,
> > page numbers and a Table of Contents.
> >
> > Clinton
> >
> >
> > On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > > Hi folks,
> > >
> > > The section numbering for the developer guide of Data Mapper 2.2 seems
> > > to have got lost.
> > > This makes reading the documentation quite difficult.
> > >
> > > I downloaded from the guide from
> > >
> > http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > > which is the link on the "iBATIS for Java Downloads" page.
> > >
> > > The OpenOffice version from Subversion seems to have the same problem.
> > > Hopefully somebody can fix this (I am a complete ibatis newbie).
> > >
> > > Hope it helps,
> > > Richard Sullivan
> > >
> >
> >
>
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Richard Sullivan <it...@gmail.com>.
Hi Clinton,
Sometime last year I downloaded the devguide. Sorry I've no idea
which version it was from but the file is dated August 5 2005. I'm
going to try attaching it here.
It has section numbering and prints beautifully. It is a pleasure to
read. Unfortunately I can't say the same for the current version (no
offense meant but it rambles on like a drunk :=). Did you somehow
change your documentation generation ?
Hope it helps,
Richard
On 9/20/06, Clinton Begin <cl...@gmail.com> wrote:
>
> I don't think there ever was section numbering. There are section headers,
> page numbers and a Table of Contents.
>
> Clinton
>
>
> On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
> > Hi folks,
> >
> > The section numbering for the developer guide of Data Mapper 2.2 seems
> > to have got lost.
> > This makes reading the documentation quite difficult.
> >
> > I downloaded from the guide from
> >
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> > which is the link on the "iBATIS for Java Downloads" page.
> >
> > The OpenOffice version from Subversion seems to have the same problem.
> > Hopefully somebody can fix this (I am a complete ibatis newbie).
> >
> > Hope it helps,
> > Richard Sullivan
> >
>
>
Re: developer guide for Data Mapper 2.2 seems to be missing section numbering
Posted by Clinton Begin <cl...@gmail.com>.
I don't think there ever was section numbering. There are section headers,
page numbers and a Table of Contents.
Clinton
On 9/19/06, Richard Sullivan <it...@gmail.com> wrote:
>
> Hi folks,
>
> The section numbering for the developer guide of Data Mapper 2.2 seems
> to have got lost.
> This makes reading the documentation quite difficult.
>
> I downloaded from the guide from
> http://cvs.apache.org/dist/ibatis/ibatis.java/docs/iBATIS-SqlMaps-2_en.pdf
> which is the link on the "iBATIS for Java Downloads" page.
>
> The OpenOffice version from Subversion seems to have the same problem.
> Hopefully somebody can fix this (I am a complete ibatis newbie).
>
> Hope it helps,
> Richard Sullivan
>