Pliant talk forum

Pliant talk forum

Discussion: documentation tree

Discussion for a documentation tree standard allowing
transparent national language access
Message posted by pom on 2002/04/13 16:27:46
The transparent access to the prefered available language (as defined
by the available translations and the language preference list sent by
the browser) may be implemented using a virtual tree performing URL
translation.

For the style to be aware of the used language, the simple way to proceed
is to encode in the URL the used language, what would be done in case of
spearated trees.

I propose the following scheme under /pliantdocs :

/style -> style definitions
/babel/fr -> french doc
/babel/en -> english doc 
/babel/pt -> portuguese doc
/babel/universal -> universaly pertinent files (include the virtual_tree.page
                    performing URL translation)
The aim of having 'babel' is to ensure a good language recognition from URL.
Message posted by pom on 2002/04/13 16:32:06
The principe of language resolution would be the following:
 If my preference language list is:

 pt-BR, fr-FR  (Brazilian, then French)

and if I ask for /babel/universal/index.html

Then:

 "true" /babel/universal/index.html will be tried first
 then /babel/pt/index.html
 then /babel/fr/index.html
 then /babel/en/index.html  (as "en" is always assumed to be a default choice)
Message posted by maybe Marcus on 2002/04/13 18:42:00
Interesting idea.

Since I am not very familiar with the virtual tree mechanism yet, I need some
clarification: suppose we have already translated all documents to, lets say,
Brazilian-portuguese. And I want to access the translated version for the .page
 format specification, whose English version is currently available at /pliant/protocol/http/.
 What would be the URL for this document according to your scheme?

Will all translated documents for a language, lets say Korean, going to be 
stored at the root of /pliantdocs/babel/kr/?
Message posted by pom on 2002/04/13 21:27:16
1/ the idea is to move all the documentation under /pliantdocs
(Hubert seems to be ok with this). So, the english version would be
/pliantdocs/babel/en/pliant/protocol/http/... and the korean one
/pliantdocs/babel/kr/pliant/protocol/http/...
Message posted by pom on 2002/04/13 21:29:36
In all the case, the standard URL for accessing the doc that used to
be in /pliant/protocol/http/index.page (for instance) would be
/pliantdocs/universal/pliant/protocol/http/index.html
It would result in the search of the appropriate translation by itself.
I will provide quite soon some example so that you can get familiar with this.
Message posted by maybe Marcus on 2002/04/13 22:19:01
> 1/ the idea is to move all the documentation under /pliantdocs
> (Hubert seems to be ok with this). So, the english version would be
> /pliantdocs/babel/en/pliant/protocol/http/... and the korean one
>  /pliantdocs/babel/kr/pliant/protocol/http/...

So I should also change the intro of the 'Pliant Documentation Conventions' page.
Because we will not have code and documentation sharing the same branch
of the Pliant tree.
Message posted by maybe Marcus on 2002/04/13 22:24:29
> 1/ the idea is to move all the documentation under /pliantdocs
> (Hubert seems to be ok with this). So, the english version would be
> /pliantdocs/babel/en/pliant/protocol/http/... and the korean one
>  /pliantdocs/babel/kr/pliant/protocol/http/...

So I should also change the intro of the 'Pliant Documentation Conventions' page.
Because we will not have code and documentation sharing the same branch
of the Pliant tree.