Hello,
The second discussion on translated manuals recommendations, this time
on output manual name.
In the following LL corresponds to a full language specification, with
@documentlanguage, @documentscript and @documentlanguagevariants.
In many cases, the manual file name is a project name that is not
translatable. Having a manual file name or parts of it that could be
translated also happens, for example if there are several manuals for
a project and one manual has 'tutorial' in its file name, that
part could be translated.
For the translated manual output file location, my proposal is to have
the language specification in the manual name. That way there is no
need for specific installation location nor manual name mapping.
I propose
main_manual_name-LL or main_manual_name_LL
if the manual name is not translatable. If the manual name is
translatable, it could be possible to translate the manual name, using:
translated_manual_name
or
translated_manual_name-LL
but it seems somewhat more complex to me for tools like gendoc.sh that
could process automatically translated manuals.
Other options could have been main_manual_name.LL, but . is usually used
for extensions, and LL/main_manual_name but it requires some changes in
the converters and Info readers, which I would like to avoid.
All the output manuals could be installed in the same directory in the
the default case.
The split manuals names would naturally be constructed similarly.
For htmlxref, it could be possible to have some automatic
generalisation when there is no existing entry, ie, when there is a
language in the output file name like mymanual-LL, possibly with a check
of matching @documentl* in the tree and there is
mymanual node ${GS}/something/mymanual/mymanual
occurences of mymanual in the path would become mymanual-LL. Also we
could extend htmlxref with list of languages with translations for a
manual.
Remarks, thoughts?
--
Pat
