Reply to topic

Calligra is awesome! Documentation is not.

oakraider4life
Registered Member
Posts
8
Karma
0
OS
I love KDE, and the more KDE apps I integrate into my everyday workflow, the more I love KDE. As soon as I got calligra working the way I had hoped to, I had no problem blasting LibreOffice from my hard drive. Calligra it dripping with awesome tools that are capable of totallay changing the way I work; Words is the best document editor I've ecountered, plan is a one of a kind app for an office suite, Kexi is the graphical frontend I never even knew I wanted to MySQL (although it seems to have problems interacting with MySQL...), and I could go on. However, the one problem that all of these Calligra apps share is that they are constructed differently than comparable applications (not necessarily a bad thing), but have little to no documentation directing how to use them (the problem ocurrs). Given the quality of these apps, I have no doubt in my mind that the Calligra team spends an ungodly amount of time developing; I'd rather they spend their time developing an mazing application set than writing documentation on how to use a mediocre application set. However, Calligra could benefit greatly from a community wiki. I know Calligra has a development wiki, but a development wiki serves a very different purpose from an instructional wiki. I feel like if there were some place that community members could go to write documentation on the various suite applications, it would make them much more accessible. As someone who just had to resolve an issue on his own with a Calligra application, I would love to be able to go document my problem somewhere so someone encountering the same issue doesn't hit the same hangup I did.

Considering how well documented the rest of the KDE apps are, I think it's time for Calligra to join them as a well buil AND well documented application set.
boemann
KDE Developer
Posts
80
Karma
0
OS
Hi

You are so right, and from a Calligra Words point of view at least that is exactly what I'm hoping for.

That said, we do have a community wiki (it's on userbase: http://userbase.kde.org/Words ) but even more so an effort to writing new documentation for Words has just begun by Irina and Myriam.

I'll make sure they follow up with a post here so the efforts can be coordinated.
User avatar irina_r
Alumni
Posts
73
Karma
0
OS
We have indeed started to write documentation; I'm working on a beginners' tutorial and we have a plan to document everything, starting with what people actually ask for because they want to use it. So please if you'd like something specific documented, mention it in the "What needs to be documented" thread http://forum.kde.org/viewtopic.php?f=249&t=107447&hilit=calligra+author. It's also useful to mention things that need to be documented in general, but we're being pragmatic and giving priority to users' immediate needs.

Anyone who can contribute, even if it's only a few paragraphs, please contact me and/or Mamarok and we'll integrate it into what we already have. This is not to invalidate userbase --in fact we do plan to have everything also on userbase-- but especially with a new application it's also important to have a coordinated body of documentation that (especially new) users can rely on not to change the moment they leave the page.


claus_chr
Registered Member
Posts
40
Karma
1
OS
In fact, UserBase (http://userbase.kde.org) is a community wiki for all KDE apps. We already have at least a partial handbook for Kexi and are very much looking forward to the new Words handbook. However, there are many more awsome applications in the Calligra suite. While writing a manual is a major undertaking (and should be coordinated with the developers), anyone can contribute a tutorial, or share their favorite tips and tricks so feel free to join us. There is a short guide for new contributors here: http://userbase.kde.org/Tasks_and_Tools. See you on UserBase :)
User avatar jstaniek
Moderator
Posts
880
Karma
2
OS
Hi oakraider4life, thanks for your feedback. Regarding Kexi we have http://userbase.kde.org/Kexi, a place for everyone, we're starting its 4th year of activity. Documentation, Tutorials and Samples are good fit there.

In particular we have pretty much actual handbook at http://userbase.kde.org/Kexi/Handbook. As the page says, this is original Kexi handbook for Kexi 2.x. It is always most up-to-date version. When you press F1 in Kexi you see exactly this documentation. We have only one active contributor, we're looking for more to make it more complete! And it never was easier to contribute - just as always coordination is needed. Userbase is preferred tool for documentation works within some Calligra apps including Kexi and Krita (this change from unfriendly pre-internet approach using docbook happened just when Calligra was born).


Best regards,
Jarosław Staniek
Image

KEXI - Open Source Visual DB Apps Builder
• Request feature or fix for KEXI here
May I help you? Please mention your app's version and OS when asking for help
User avatar jstaniek
Moderator
Posts
880
Karma
2
OS
Update: just created central page listing all available handbooks: http://userbase.kde.org/Calligra/Handbooks

(may be incomplete)


Best regards,
Jarosław Staniek
Image

KEXI - Open Source Visual DB Apps Builder
• Request feature or fix for KEXI here
May I help you? Please mention your app's version and OS when asking for help
darrenedale
Registered Member
Posts
3
Karma
0
I'm using Calligra 2.7.1 on Kubuntu 13.04 with packages from the backports PPA.

It looks to me like a lot of functions in Sheets are not fully documented. In many cases, the types and names of the inputs to the functions, and the output from the functions, is documented but no actual description. For example, I recently used the statistical TTEST() function with some data. The function takes four inputs and provides a single output. The first two inputs are the two data ranges to use in the t-test and are arrays, the third is called "type" and the fourth "mode", both of which are integers. Being familiar with t-tests I can guess at what the third and fourth inputs are for but I have no idea what values I should supply to get the t-test I need.

So my questions are:

1. has this function been documented in the function help and is it down to my distro package maintainers not building the help properly?
2. what values do I provide to "type" to get a) an unrelated (unpaired) test and b) a related (paired) test (my assumption is that I set "mode" to 1 to get a 1-tailed test and 2 to get a 2-tailed test, but please correct this if I'm wrong).
3. if the documentation is indeed missing from Calligra and it's not down to the Kubuntu package maintainer, how can I go about updating the function help for this (and maybe other) functions in the Calligra source?

If someone can point me to the correct source code files I can probably work this out for myself.

Thanks.
lueck
Mentor
Posts
216
Karma
2
darrenedale wrote:1. has this function been documented in the function help and is it down to my distro package maintainers not building the help properly?

Documentation in function help + handbook (english) is part of ubuntu pacḱage calligrasheets with the application

3. if the documentation is indeed missing from Calligra and it's not down to the Kubuntu package maintainer, how can I go about updating the function help for this (and maybe other) functions in the Calligra source?
If someone can point me to the correct source code files I can probably work this out for myself.

Help used in Functions dialog and Handbook is build/generated from xml-Files in
https://projects.kde.org/projects/calli ... /functions
darrenedale
Registered Member
Posts
3
Karma
0
Thanks Lueck, I'll check that out. :)
darrenedale
Registered Member
Posts
3
Karma
0
OK, so that was pretty easy - nice clean and understandable code and clear XML files! ;D

Where should I look for instructions on submitting my changes for review?
lueck
Mentor
Posts
216
Karma
2
darrenedale wrote:Where should I look for instructions on submitting my changes for review?

http://techbase.kde.org/Development/Review_Board
karengcguire
Registered Member
Posts
1
Karma
0
I totally agree with that too. Hope they get to improve that part of the product.

best online pokies

 
Reply to topic

Bookmarks



Who is online

Registered users: Baidu [Spider], Bing [Bot], Exabot [Bot], Google [Bot], Sogou [Bot]