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

List:       koffice-devel
Subject:    Re: developers documentation
From:       Nicolas Goutte <nicolasg () snafu ! de>
Date:       2004-02-29 0:27:19
Message-ID: 200402290122.44353.nicolasg () snafu ! de
[Download RAW message or body]

On Friday 27 February 2004 13:19, Raphael Langerhorst wrote:
> Thanks for all your feedback, I integrated the suggestions from Nicolas and
> Thomas, all of them.

Next round of feedback. :-)

In the Qt section, I cannot get the feeling away that you have tried to 
shoehorn a few ideas in one paragraph. (I am not sure how to explain it 
correctly. But readying the section gives me the same feeling as re-reading 
something that I have written where I have tried to put 3 ideas one beside 
another without sufficient connection.)

"developer site of KDE (find the link on the main homepage)": the link is
http://developer.kde.org

In the last sentence about KBugbuster, you are writing "... let's you ...". I 
suppose that you meant "... let you ..." ( as the "'s" would represent a "us" 
here.)

The second last paragraph seems to end abruptly: "Post one patch for every "

In the last paragraph, I do not really see how the ESR's document, which 
question-oriented, relates to patches (even if the document is interesting to 
read.)

>
> Concerning the format of the document...
>
> > Hmm, I found some language issues making me thing you should consider
> > making this a text file or something else that we can control via CVS.
>
> What do you think about docbook format? So it could be integrated into the
> KDE documentation, if it is desired that is. Is plain-text better? Should I
> keep it in the OOo format? Probably it should be something that can be
> transformed to HTML for the web page... (apart from the fact that it's not
> yet ready for any publication)

I think that as you have started with this format, continue with this format. 
It will probably not be part of the KDE documentation, as it is something for 
developers. Such information is more Web-based in KDE.

Sure having it CVS-friendly would be fine too. But using it with KWord, there 
are not many usable file formats that are CVS-friendly. (Text would mean not 
any picture and not any table, RTF would work but would be a little curious, 
HTML cannot be read back in KWord, AbiWord has no table support in KWord...)

>
> Regards,
> Raphael

Have a nice day!

>
> PS: since it's only 5k I attached the revised document
>
> On Thursday 26 February 2004 12:30, Thomas Zander wrote:
> > -----BEGIN PGP SIGNED MESSAGE-----
> > Hash: SHA1
> >
> > Sorry, opens fine in OOo.
> > A spellcheck would be nice as well :)
> > s/allready/already/g
> >
> > I would suggest to not direct a user to the C++ programming at all; just
> > state that this document will not explain it to him. (i.e. say its out of
> > scope).
> >
> > Hmm, I found some language issues making me thing you should consider
> > making this a text file or something else that we can control via CVS..
> >
> > I think this is a nice reference to add to the 'how to send patches':
> > http://www.catb.org/~esr/faqs/smart-questions.html
> >
> > On Thursday 26 February 2004 11:41, Thomas Zander wrote:
> > > Could you post an PDF, I'm not following HEAD.
> > >
> > > On Wednesday 25 February 2004 21:14, Raphael Langerhorst wrote:
> > > > Hi all,
> > > >
> > > > here is a first draft of the KOffice "cookbook", just let me know
> > > > what you think about it. It's the result of the last two hours.
> > > >
> > > > The next chapters will be:
> > > >
> > > > * KOffice in general
> > > >
> > > > * KSpread, KWord, Krita,.............
> > > >
> > > >
> > > > Regards,
> > > > Raphael
> > > >
> > > > PS: it's written in KWord (HEAD) using the OOo filters, should load
> > > > fine.

_______________________________________________
koffice-devel mailing list
koffice-devel@mail.kde.org
https://mail.kde.org/mailman/listinfo/koffice-devel
[prev in list] [next in list] [prev in thread] [next in thread]