Bad file names convention for spanish and portuguese documentation
Subject: Bad file names convention for spanish and portuguese documentation
From: Vadim V. Zhytnikov
Date: Wed, 21 Sep 2005 23:32:44 +0300
Hi!
Since Maxima new release is close and Spanish
and Portuguese documentation will be included
into it I have to stress once again that current naming
convention for these two translation is a bad design
choice. Let me explain how I see right naming convention
and why current convention is bad.
In we have original English documentation sources (.texi)
/doc/info/maxima.texi
/doc/info/Affine.texi
...
then Spanish translation should be named
/doc/info/es/maxima.texi
/doc/info/es/Affine.texi
...
Portuguese
/doc/info/pt/maxima.texi
/doc/info/pt/Affine.texi
...
In general for any other
/doc/info//maxima.texi
...
The important point here is the same
file names for each language. Language is
distinguished by directory name not by
file name. No extra .es or _pt !
Accordingly processed documentation (.info, .html, .pdf)
should go into
/info/maxima.info
/info/es/maxima.info
/info/pt/maxima.info
In general documentation goes into
/info//maxima.info
or
/info/./maxima.info
if language have several standard encodings.
Why this is important? Such clean naming
convention greatly facilitates design of
documentation browsers - Maxima's describe,
xmaxima html browser, TeXmacs etc.
If we try to make these browsers language aware
we have to do only one very simple thing - choose
documentation directory according to user
locale:
/info/$LANG/maxima.info
if $LANG is not C, POSIX or en.
And this is done once and forever
for all possible languages - we need not modify
browser code with new translation.
Best wishes,
Vadim
--
Vadim V. Zhytnikov