[Gridflow-dev] common patterns and protocols

Alexandre Castonguay acastonguay at artengine.ca
Wed Jan 26 22:56:33 EST 2005


I just read the 'int' and 'float' descriptions in architecture.html and it 
makes sense to me but I wonder how the uninitiated can grasp it.

It would be worthwhile in my opinion to create a glossary for absolute 
beginners whose content could illustrate things like the wrapping around of 
values.  It could coexist within architecture.html or be presented in a 
separate page.

I like the idea of the wiki style documentation (hyperlinking of terms) that 
Mathieu suggests.  But Mathieu, how do you propose that we do it in the doc 
right now?  



On Tuesday 25 January 2005 10:02, Mathieu Bouchard wrote:
> On Sat, 22 Jan 2005, Stéphanie Brodeur wrote:
> > Mathieu Bouchard <matju at sympatico.ca> wrote:
> >
> > I think it is a good idea to add a glossary of terms to the gridflow
> > documentation. What you have suggested is informative and should be
> > added.  I also think there should be basic terms, which could seem
> > obvious, but that are essential for beginners to understand. I was
> > thinking of terms like grid, int, float, array... and explainning them
> > in simple terms (some of the terms are explained in the manual but I
> > think all the definitions should be together in the same glossary,
> > even if it means repeating their definitions.)
> Yeah, int and float and such are already explained in architecture.html; i
> was thinking that this file could _become_ the glossary and be internally
> hyperlinked and that the other doc files could hyperlink a LOT towards the
> glossary too. What do you think?
> But then it begins to smell a lot like a wiki. I mean a real wiki: if you
> only have seen Tiki, that's a bunch of tools in which there is a wiki
> among other things.
> Examples of sites that are (almost) pure wikis may be:
> 	http://c2.com/cgi/wiki (the oldest wiki! the original)
> 	http://wikipedia.org/ (the most famous wiki, encyclopedia-style)
> 	http://everything2.com/ (the biggest wiki i know, berserk-style)
> 	http://planetmath.org/ (a smaller wiki)
> 	http://rubygarden.org/ruby
> If you already know what a wiki is, I'm sorry, it's just that it's still
> amazing how many people don't, although it certainly is 100 or 1000 times
> more popular than, say, 5 years ago. (I worked at a software company back
> then and found out I was the only one knowing what a wiki is)
> The two defining characteristics, IMHO, are:
>   1. internal hyperlinks that appear automatically or are very easy
>      to create (more so than in HTML).
>   2. easily editable from the web.
> Personally I wouldn't aim too high, and I would have (1) but not (2), the
> CVS being enough for our needs. Does that sound reasonable?
> _____________________________________________________________________
> Mathieu Bouchard -=- Montréal QC Canada -=- http://artengine.ca/matju
> _______________________________________________
> Gridflow-dev mailing list
> Gridflow-dev at ns.artengine.ca
> http://ns.artengine.ca/mailman/listinfo/gridflow-dev

More information about the Gridflow-dev mailing list