[Kst] Refresh kst documentation for kst2.x

[Brisset, Nicolas]

HI,

 

so I'm back online only now. I see you've started working on the
subject, I hope you've been able to produce something. It seems nobody
was available to answer your questions below, but I hope you will have
been able to figure them out by yourself. In case you are still
interested in the answers, here they are:

1)      Yes, you only have to edit the .docbook files

2)      Common tasks are a workflow-oriented description how to use kst
(seen from the user perspective, a sort of quick start guide). They
still make sense for kst 2.x. Scripting has changed a lot, and
extensions are currently also pretty different, so just leave those
chapters empty and we'll take care of them.

 

My hope for the result of your work (or call it priorities if you wish)
would be:

-          Obsolete Kst 1.x parts removed (things you no longer find in
kst 2.x, or which have changed significantly like extensions, plugins,
scripting)

-          Common tasks (quick start guide) more or less complete, even
though we will probably have to review it

-          Clear structure with the other chapters available as draft
version, at least for the contents which can be reused from kst 1.x

-          It would be very nice to have the new screenshots (from the
homepage) included, at least for the most important UI elements. But
that may be too much for the given time frame. I could open up a new
task specifically for that.

 

I hope that gives you the answers you wanted. The deadline ends in 5
hours, I hope you will be able to upload your work in time on the
Code-In website, or by posting it here (use svn diff, or put the results
of your work in a .zip or .tar.gz file). 

 

Nicolas

 

Von: kst-bounces at kde.org [mailto:kst-bounces at kde.org] Im Auftrag von
Anirudh Chauhan
Gesendet: Montag, 12. Dezember 2011 18:42
An: kst at kde.org
Betreff: [Kst] Refresh kst documentation for kst2.x

 

Hello,

I am GCI student with the Task,
http://google-melange.appspot.com/gci/task/view/google/gci2011/7120229

with the task to refresh kst documentation for kst2.x, 
(1). I want to know, that do only .docbook files are to be edited?
(2). I also noticed, that the kst2.x has various fields missing in the
documentation, that are present in kst1's documentation like Common
Tasks, Kst Extensions, Working with KstScript

How should I proceed, about in the task, like : it wont be possible for
me to add all the fields present in kst1's documentation to kst2's
documentation, are there any high priority fields in documentation, that
I should focus on, and then if time permits I will add other fields.

Regards,
Anirudh Chauhan





Eurocopter Deutschland GmbH
Sitz der Gesellschaft/Registered Office: Donauwoerth
Registergericht/Registration Court: Amtsgericht Augsburg HRB 16508
Vorsitzender des Aufsichtsrates/Chairman of the Supervisory Board: Dr. Lutz Bertling
Geschaeftsfuehrung/Board of Management:
Dr. Wolfgang Schoder, Vorsitzender/CEO; Friedrich-Wilhelm Hormel; Ralf Barnscheidt

CONFIDENTIALITY NOTICE 

This communication and the information it contains is intended for the addressee(s) named above and for no other persons or organizations. It is confidential and may be legally privileged and protected by law. The unauthorized use, copying or disclosure of this communication or any part of it is prohibited and may be unlawful. 
If you have received this communication in error, kindly notify us by return e-mail and discard and/or delete the communication. Thank you very much. 
It is possible for e-mails to be intercepted or affected by viruses. Whilst we maintain virus checks on our e-mails, we accept no liability for viruses or other material which might be introduced with this message. 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kst/attachments/20111213/55e6039e/attachment.html>