[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: Making KDE docs
From:       Lauri Watts <lauri () kde ! org>
Date:       2001-07-15 14:42:47
[Download RAW message or body]

On Sunday 15 July 2001 14:34, Martin Heni wrote:
> Hiya,
>
> can anybody help me in compiling the KDE docs. They seem
> to be as index.docbook docbook files in the ../doc directories.
> Unfortunately with me neither a 'make' nor a 'docbook2html index.docbook'
> seem to work. First is not doing anything and second misses
> tons of docbook files/dependencies. So I think I obviously miss something
> fundamental.
> Maybe someone could tell me what files/directories of the cvs are
> needed to make html docs out of the index.docbooks and installing
> these?
>
> Thanks a lot,
> Martin

Hi Martin,

First, you need a recent copy of libxml.   2.3.13 is new enough, 2.4 was just 
released.  You can get this from www.xmlsoft.org, or you can use the copy in 
kdesupport.

Then you need to have up to date kdelibs/kdoctools.  All the documentation 
tools are in there.

From there, you will get some new tools:

help: (the help kio-slave, to view documentation in Khelpcenter)
meinproc (the processor, transforms the docbook to html, and takes the place 
of kdb2html and docbook2html)
checkXML (for checking and validating docs you are writing)

You will probably need to rm config.cache and reconfigure in kdelibs, to 
ensure your new libxml2 is picked up.    If you watch the configure output, 
you will get a message when the libxml2 check is done, if configure can't 
find the copy you installed.  

When everything is working properly, make runs meinproc with some parameters 
to validate the document, to generate html, and then compress the results 
into a tar.bz2 file.  This tar.bz2 file is what gets installed and used by 
the help kio-slave.  

You can run "meinproc index.docbook" if you just want to check the HTML 
output without compressing it, but it will look quite odd, as you will be 
missing the images and CSS stylesheets that give it the layout.  If you want 
to just check you have valid documents, use "checkXML  index.docbook", it's 
much quicker.

So, this is maybe more than you asked, but there seems to be a lot of 
confusion on what is doing what, so I thought I would make it all in one 
answer.

HTH,

-- 
Lauri Watts
 
>> Visit http://master.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<

[prev in list] [next in list] [prev in thread] [next in thread]