openjpa-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Patrick Linskey" <plins...@gmail.com>
Subject Re: Tools for maintaining OpenJPA documentation
Date Sat, 16 Jun 2007 05:45:37 GMT
> For editing docbook, I just use an text editor, and then periodically
> use the "xmllint" console application to ensure that I haven't
> violated the DTD. I believe xmllint is available for all platforms,
> and I use the following command:

I believe that xmllint is part of the libxml2 package, for those of
you using Debian, Ubuntu, fink, or cygwin.

-Patrick

On 6/13/07, Marc Prud'hommeaux <mprudhom@apache.org> wrote:
> Kevin-
>
> Personally, I've never found an XML editing tool that had good
> support for maintaining the format and preserving the chunking style
> of our docbook, but I haven't looked again at tools in the past
> couple of years: there may have been improvements to docbook tooling
> since that time. If you do wind up researching this, I for one would
> be interested in hearing about your results.
>
> For editing docbook, I just use an text editor, and then periodically
> use the "xmllint" console application to ensure that I haven't
> violated the DTD. I believe xmllint is available for all platforms,
> and I use the following command:
>
>     xmllint --noout --valid openjpa-project/src/doc/manual/manual.xml
>
> That just validates syntax. Once I have made a major edit, you can
> just build the docs and make sure they look OK to you (you might need
> to first increase memory by setting MAVEN_OPTS=-Xmx512m):
>
>    mvn -f openjpa-project/pom.xml process-resources -Pdocbook-profile
>
> It's hardly a WYSIWYG process, but once you are comfortable with the
> docbook XML format, I've found that using a plain text editor is good
> enough.
>
>
>
> On Jun 14, 2007, at 4:22 AM, robert burrell donkin wrote:
>
> > On 6/13/07, Kevin Sutter <kwsutter@gmail.com> wrote:
> >>
> >> Just trying to start a new thread on this topic since my reply to
> >> an SVN
> >> commit message went unanswered...  :-)
> >>
> >> What kind of tools are being used to maintain the OpenJPA manual?
> >> The
> >> documentation updates that I have done have all been pretty minor,
> >> so I
> >> haven't been too concerned with messing up the tags in the
> >> documentation
> >> xml
> >> files.  But, some of the updates that I would like to do require some
> >> fairly
> >> extensive changes.  I'm afraid that I just start to edit these xml
> >> files
> >> with my favorite editor that I might get myself into a tag mess
> >> that I
> >> can't
> >> recover from...
> >
> >
> > is it docbook?
> >
> > if so there are editors around (eg
> > http://wiki.docbook.org/topic/DocBookAuthoringTools) but hopefully
> > someone
> > more cluefull will jump in with version details...
> >
> > - robert
>
>


-- 
Patrick Linskey
202 669 5907

Mime
View raw message