Thorsten wrote:Okay, some basic feedback:
What do people need in the wiki - compare the snippet page with e.g. the particle system
http://wiki.flightgear.org/Particle_System
that's not a great bit of documentation, but it got me working particle systems within 30 minutes.
Why? Starts from a working example first, then lists all the things I could change on it next - so I have something working, and then I know what I can change.
Canvas snippets leave me in the blank how to proceed
I read
- Code: Select all
var myLayout = canvas.HBoxLayout.new();
and wonder what else I can insert here except HBox layout. Or how I can move the thing around. Or what not. That's the fundamental flaw in all canvas documentation - it's not enough to get something working, the user also needs an idea of what to change, how it can be adapted.
VBox is the only other layouting option available as far as I remember - so everything is made up using vertical/horizontal "boxes" (aka tables).
I am not sure if the simplicity of documenting available/supported XML tags can be easily mapped to a full-fledged programming language like Nasal - but you made a good point that we should probably document supported parameters/attributes or "modes" whenever possible. I think it would make sense to extend the underlying template accordingly and provide a list of documented options.
That said, for the Canvas stuff you're currently working on (i.e. visualizing orbital flights on a moving map), layouts are not necessarily relevant, unless you're intending to get really fancy - i.e. a simple moving map should be possible already - but given your previously outlined requirements, things are much more easily accomplished by using/extending the existing MapStructure framework:
Using Canvas for visualizing orbital flights (cont'd PM)