documentation - my contribution

Login or register to post comments
13 replies [Last post]
grossini's picture
Offline
Joined: 01/05/2009

Some week ago I sent this message to kristof:

My first steps on Qcodo where with your 'qcubed manual v05' .

QCubed helped me in porting a Microsoft Access application to web 2.0
intranet application and now I fell bound to make something for Qcubed.

A first reply to this question: "why this framework (QCodo/Qcubed) is
almost forgotten and totally unpopular" is lack of documentation, or
better lack of documentation for orphans of Clipper, Access, Foxbase and other
windows toys.

So, if you agree, I'll use your document as starting point to create an
updated to Qcubed version 2.0.2 guide: "Rapid application development with Qcubed - a step by step introduction guide"

Hope you give me permission to use freely your work to speed my effort.

The manual attached is now complete!!

Alex, I hope my work can have the honor be listed in tutorial so every one can download it
Let me know how this can be arranged?
Gianni

Offline
Joined: 03/31/2008

Love it!
I believe you should actually already have permission to edit the Tutorial wiki page, and create new pages to hold your tutorial, and I for one would love if you did so.

Just go to http://trac.qcu.be/projects/qcubed/wiki/Tutorials and log in with the same account information you use for the forum, then click the Edit this Page button at the bottom of the page.

grossini's picture
Offline
Joined: 01/05/2009

I am not shure about my effort to put the manual part1 and part2 in tutorial page.

The lines I added (copied from first one) do not display the pdf, but the pdf can only be downloaded.

Additionaly the pdf are present in attachment at bottom page and I am not able to remove them.

Can you reorder my damage on tutorial page...

Did you had time to see the content ...

Ciao, Gianni

alex94040's picture
Offline
Joined: 11/06/2008

This is indeed awesome work, thanks much, grossini.

One little data point for you in regards to "qcubed being forgotten and totally unpopular": there are 400+ developers visiting the qcu.be website *every day*.

grossini's picture
Offline
Joined: 01/05/2009

I am one of 400 thank Kristoff manual . But when I talk with developers who could save time around mundane, repeatable tasks, they do not suspect what Qcubed can do for them.

So is time for evangelization !!!....

An updated start manual (as my contribute) can be a good tool for the developers not included in the 400.

Thousand thanks to all people working on this nice framework.

vakopian's picture
Offline
Joined: 04/08/2008

I agree this is immensely important work. Thank you very much for doing it.
Any plans to update it for the 2.0 versions?

-Vartan

grossini's picture
Offline
Joined: 01/05/2009

I revised first 5 chapter of documentation updated (and revised to comply with ) to Qcubed version 2.0.2

If someone is interested if this first part, I can send this partial work.
Update to tutorial will be when all work is completed.

Merry Christmas and happy new year to all QCubed contributors and visitors.

In italiano:
Buon Natale e un nuovo anno pieno di felicità e bellissime sorprese.

alex94040's picture
Offline
Joined: 11/06/2008

Gianni - thanks so much for your continued support, and Merry Christmas and Happy New Year!

I'm looking forward to seeing your work - if you're still having trouble uploading it, just send it over to me (alex94040 at yahoo dot com), and I'll take care of it.

Thanks!!

Offline
Joined: 07/10/2008

Very much appreciated, no doubt!

I agree that the lack of documentation, demo applications, videos and the general idea of how quickly you can iron out an application is what we are missing. Though we have a select few of contributed items, the more the better!

This is definitely a step in that direction.

alex94040's picture
Offline
Joined: 11/06/2008

Folks - I'm going to create a simple process for collaborative editing of this great documentation that Gianni started.

We will use Word for it, as a 100-page document is already authored in it. The easiest way to collaboratively author a Word document is to use Microsoft Office Live (Google Docs chokes on a doc of this size).

If you want to participate in the editing of this document, please
1) Create a Live ID (hotmail) account
2) Send me an email to alex94040 AT yahoo DOT com. In that email, tell me what your Live ID account is, and I'll grant you permissions to edit the document.

Offline
Joined: 07/10/2008

Sounds like a good idea alex.

What about the consistency of the screen shots? Should we have Gianni do those?

alex94040's picture
Offline
Joined: 11/06/2008

Don't know yet about the screenshots, we'll figure it out once the content is getting close to done. My expectation is that the precision of the screenshots won't be very important (they didn't vary too much between the versions).

By the way, here's where the work-in-progress guide lives - http://cid-9551e9fe40137982.office.live.com/view.aspx/Public/qcubed-quic...

If you want to help edit the doc, just send me an email.

Offline
Joined: 11/03/2010

I am a newbie and learning from this doc. Good job. As I progress through it, I will supply feedback if that is OK.

OVERVIEW OF THE GENERATED FILES:

5. includes\models\Todolist.class.php (and other places)

The models sbudirectory shows as "model" (no 's') in my installation.

/*****************************************/

"Additionally, .these global files are created or updated:
17. includes\data_classes\generated\_class_paths.inc.php

18. includes\data_classes\generated\_type_class_paths.inc.php

19. includes\data_classes\generated\QQN.class.php"

I found these files in includes/model/generated/

/*****************************************/

In the example database one of the tables is called user. This is a reserved word in Postgresql and it will not create that table. You may want to change the table name to 'users'. No big deal, but it could frustrate some people - the error message is not obvious.

Maybe more as I work through it. Thanks again.

grossini's picture
Offline
Joined: 01/05/2009

welcome bombay.

alex, we are in the right road for a qcubed evangelization ......

My hw/sw combination is too aged for interaction with document on line.
I am starting an update ....to become live ... in www.live.com
Gianni