KDevelop Manual

[Lauri Watts]

On Tuesday 26 April 2005 10.07, Joe Dev wrote:
> Hello,
>
> > We haven't had much to do with the kdevelop doc for the last few years,
> > so I am cc'ing there in case they prefer to continue managing their
> > documentation themselves.
>
> So who manages their documentation now?
>
> > Either way, you're welcome to use this list for
> > proofreading/style/docbook assistance if you want.  In fact, if you don't
> > want to write docbook, you can send plain text here and we'll do the
> > markup for you.
>
> I sure will need some help at the beginning.
> But in the long run, I'd prefer to do the markup myself,
> according to your or the KDevelop people's guidelines.
> By the way, in
> http://i18n.kde.org/doc/markup/tags-we-dont-use.html
> you list <formalpara> as a tag you don't use.
> However, it is widely used e.g. in:
> kdevelop/doc/kdevelop/index.docbook.
> So what is true now?
>
> And in http://i18n.kde.org/doc/tools.php,
> how about listing Quanta?
>
> So here is my diff of index.docbook as a first try.
> It's surely not perfect and I'd appreciate corrections.
> Don't hesitate to express criticism;
> it's better to clarify these issues at the beginning,
> before I invest much work.

Sorry to take a couple of days to get back to you.

I have committed a fixed version of the patch, attached.

After a look at the markup, I think most of the use of formalpara would better 
be done with variable lists as they are a better semantic match for what is 
being conveyed than inconsistent use of formalpara's inside listitems.

If there are no objections, I will give this doc a complete markup fixup, 
which I think I could do in a couple of days, and that would make working on 
the actual content a lot easier for everyone concerned.  Not least because 
having it consistently marked up in the same fashion as the rest of the KDE 
docs will make it easier to find examples to copy, and make it easier on the 
translators too.

Regards,
-- 
Lauri Watts
KDE Documentation: http://docs.kde.org
KDE on FreeBSD: http://freebsd.kde.org