[Gambas-user] big wiki update for 0.80

Rob sourceforge-raindog2 at ...94...
Sat Jan 3 04:52:25 CET 2004


Thanks to a sick day, the GambasTest wiki has been updated in a 
huge way.  I'm not completely through the todo list but I think 
I got all the show stoppers.  In particular, the help text from 
the old versions of Gambas is finally back in there wherever it 
was available.

http://www.binara.com/gambas-wiki/bin/view/GambasTest/GambasComponent

One of the items on my todo list is to enumerate my file naming 
scheme so Benoit can make the help browser index the files more 
easily.  Here's a stab at it.

The Gambas wiki names for components are broken up into segments, 
like this:

GambasComponentAaaBbbCccDdd

where

Aaa = capitalized name of component (Gb for core component, Qt 
for gb.qt, etc.) as a wiki word, first letter in caps and the 
rest in lowercase.
Bbb = name of class, with StudlyCaps intact if necessary e.g. 
ColumnView.
Ccc = for symbols, this is the type of symbol.  The valid types 
are Property, Event and Constant; for methods, simply omit Ccc 
altogether.
Ddd = the name of the symbol, again with StudlyCaps if needed.

In all cases, punctuation (e.g. leading . or : or _) has been 
stripped where it was present, even though the text of the 
virtual class pages still display the period in the name.

The files end in .txt for the live wiki and .html for the static 
one which is what Benoit will be using for the documentation.  
The static one is generated each day by a cron job that runs at 
0900 GMT.  However, that cron job takes a very long time and you 
may not find the static one updated till 1200-1300 GMT.

Please let me know if there are any cases where this naming 
scheme still falls down ;)  I am quite high on cold medicine now 
and am afraid to do any more work tonight, but I will look over 
the weekend.

Oh yes, and please, add any requests to my todo list at 

http://www.binara.com/gambas-wiki/bin/view/Gambas/WikiExportTodoList

in descending order of urgency for the 1.0 release.  And don't 
forget, all other pages in the GambasTest wiki will be discarded 
after I move the new component docs into the production one!

Rob





More information about the User mailing list