[Fluxus] Few tricky questions

[Dave Griffiths]

Hi Adrien,

On Wed, 2010-02-24 at 12:30 +0100, Adrien Rocher wrote:
> > > I have test the accent in fluxus by adding some in the helpmap
> file.
> > > It recognize ot well. Just keyboard characters not working.
> > 
> > What OS are you using? On linux I don't think its possible, on OSX
> it
> > might work.
> 
> I'm on Debian Linux with one of the last git version.

Yep, the keyboard is broken. My attempts up to now to figure out what
glut does with multibyte characters on Linux have been unsuccessful so
far. I'm still looking for a fix though.

> > French translations would be great! Although it's a lot of work...
> 
> I'd be glad to help in this software. I'm not too skilled in c++ dev
> but progressing in scheme.  ;-)
> If I want to add translation to git repo, do I need an read/write
> access to the repo, or it's possible to make push request on savannah
> without special access?

You don't need to know C++ (or scheme for that matter) to do the
function reference docs - well, you just need to know what a comment
is :) 

The help is split into sections which are specified at the top of each
file like this:

// StartSectionDoc-en
// primitives
// Primitives are objects that you can render. There isn't really much
// else in a fluxus scene, except lights, a camera and lots of
// primitives.
// Example:
// EndSectionDoc

Sometimes multiple files have the same section header (it doesn't always
make sense to have one per file). Then each function has something like
this:

// StartFunctionDoc-en
// build-cube
// Returns: primitiveid-number
// Description:
// A simple cube, texture mapped placement per face.
// Example:
// (define mynewcube (build-cube))
// EndFunctionDoc

You just need to add StartSectionDoc-fr and StartFunctionDoc-fr versions
of these comments. The position in the code doesn't matter, but it's a
good idea to keep them in the same place so we can change them at the
same time and keep it neat and tidy. This does mean these files will
fill up with much more documentation than code, but that's ok I think,
the guts of the fluxus code is elsewhere.

I've added "fr" to makehelpmap.scm - you should be able to put:
(set-help-locale! "fr")
In your .fluxus.scm to select the french help.

Git is fairly simple, you need to get an account on savannah, then do:

git clone login at git.sv.gnu.org:/srv/git/fluxus.git

Make your changes in the code comments, then regenerate the helpmap.scm:

cd docs
./makehelpmap.scm
cd ..
sudo scons install

Run fluxus and check the docs are appearing as you expected in the help.
When you are finished:

git commit -a -m "I added some French translations!"
git push

I tend to forget to push (or even commit) as you may have noticed. 

Occasionally you should do 'git pull' to get changes other people have
made to the code.

Most importantly, don't worry about breaking everything - version
control means it's ok to do that :)

cheers,

dave