[Gambas-devel] Well, I kept my promise

[richard terry]

On Wednesday 09 December 2009 19:35:04 Kadaitcha Man wrote:

I've not followed this debate in great detail but will make a few comments.

As someone with a lame brain, I always find documentation hard to follow and 
think this sample is an improvement as it seems to have everything including 
examples on the same page.

Personally I've struggled for hours trying to understand some of the 
documentation as I'm not a professional programmer nor have any formal 
programming training, so my brain o bvioulsy dosn't 'work correctly' when it 
comes to intrepretting documentation.

I think gambas is brilliant and cannot thank Benoit and all the other 
developers enough for such a fantastic tool, that even people like myself can 
be productive in, as well as their almost instant response to requests for 
improvements and bug fixes.

The issue of  documentation has been raised often on these lists and  seems to 
be a real stumbling block for spreading the fame and place in the sun that 
gambas should quite rightly have.

As has been raised before on this list, together we must all have a treasure 
trove of code samples which could be shared if some mechanism could be found 
to do so.

Also, as I've previously stated (and would be happy to contribute to) we need 
something like the wxPython demo, which illustrates the use of all common and 
more complex controls. The existing samples are a help, but need augmentation.


Regards

Richard


> This what I think the Gambas documentation ought to look like;
> everything the programmer needs in one place, not spread out all over
> the planet.
> 
> Create a directory and extract the attached files then just launch
>  index.html.
> 
> There are some issues to be resolved before I start work on this:
> 
> 1) The Gambas prawn/shrimp looks really immature. I recommend a new
> and more technical logo, such as, erm, anything other than a prawn or
> shrimp.
> 
> 2) Fonts, style, layout, colours and what goes in the navigation panel
> on the left needs to be decided on.
> 
> 3) The wiki is arcane and ugly so I intend to rewrite the help text
> for the Gambas help browser, not for the wiki. Someone else can take
> on that burden.
> 
> Notes:
> 
> The Download link for the example works. All other links go back to
> index.html. I intend to include as many working examples as I can.
> The colour for the table headings came from a random pixel on the
> prawn. It isn't too bad but I think there is too much white.
> The text under comments is Lorem Ipsum gibberish pseudo-Latin. It
> isn't meant to make sense so please don't ask.
> 
> Ok, I know some of you love the prawn, but really, ask yourself, does
> it look mature? Does it say, "HEY! I represent a mature, technical
> product!"?
> 
> If you said yes to either question, get your head read :)
> 
> Comments, feedback and rude suggestions welcome.
> 
> PS: I'm serious about the wiki. I won't touch it.
>