Bug 134360 - kst documentation needs to be updated.
Summary: kst documentation needs to be updated.
Status: RESOLVED FIXED
Alias: None
Product: kst
Classification: Applications
Component: general (show other bugs)
Version: 1.x
Platform: Compiled Sources Linux
: NOR wishlist
Target Milestone: ---
Assignee: kst
URL:
Keywords:
: 92147 (view as bug list)
Depends on:
Blocks:
 
Reported: 2006-09-20 01:47 UTC by Duncan Hanson
Modified: 2007-12-13 01:01 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Duncan Hanson 2006-09-20 01:47:06 UTC
Version:            (using KDE KDE 3.5.1)
Installed from:    Compiled From Sources

hi all,

i'm planning on going through the kst documentation to make sure everything is up to date. has anyone had experience with any glaring issues in the current docs?

do we think that the time is ripe to polish up the kstscript documentation and put it into the main docbook? there's alot of functionality there which is getting overlooked...

regards,
duncan.
Comment 1 George Staikos 2006-09-20 01:55:26 UTC
 That would be great, Duncan!  I think the important things are:
1) Add the new features
2) New screenshots where appropriate
3) Use cases / examples
Comment 2 George Staikos 2006-09-29 05:09:08 UTC
On Tuesday 26 September 2006 18:11, Duncan Hanson wrote:

> I've been going through the current documentation. Most of the updates look
> fairly minor- ie. retaking screenshots to reflect interface changes.


  Please commit your changes regularly in case anyone else has some additions 
- we don't want to have too many conflicts.

> Kst is big enough now that I think it would be useful to compartmentalize
> the tutorials section, a la MATLAB, Mathematica, and IDL. There would be
> small, specific tutorials for users who want quick introductions to say,
> writing a JavaScript or fitting a function. The more basic tutorial
> information (how to zoom in on plots, etc.) can be moved into the 'Getting
> Started' section of the introduction- which is already a kind of
> mini-tutorial itself. The 'common tasks' entries would move into the
> tutorials group. Does this sound good?


  Sure sounds good to me!

> Here are the new features I have noted:
>
> - Annotation objects.
> - JavaScripting.


  This one should be called KstScript.

> - The view manager.
> - CSD data type.
> - New data sources: qimage, healpix (does this even work properly?),
> fitsimage, LFIIO.


  And NAD.

> and..
>
> - A few plugins. I'll leave these until the new plugin situation is
> finalized. Hopefully we'll be able to clean up the entire plugin section
> using the new interface, i.e. weighted fits can be absorbed into their
> unweighted counterparts with the more powerful plugin dialog. That will be
> really nice.


  Yes.  It might be best for Adam to take this one on since he's done so much 
on it already.
Comment 3 Andrew Walker 2007-05-07 21:15:49 UTC
Should include documentation on how to use a plugin in an equation.
Comment 4 Andrew Walker 2007-05-07 21:17:39 UTC
*** Bug 92147 has been marked as a duplicate of this bug. ***
Comment 5 Andrew Walker 2007-12-13 01:01:06 UTC
The documentation has been updated. A new bug will be entered later to update the documentation to the 1.6 version of Kst.