Pliant talk forum

Pliant talk forum

Discussion: length of documentation file

The original doc and the today english one use very long file.
French .page doc uses shorter one.
What is better ?
Message posted by michel on 2002/05/05 15:09:46
Marcus, I think that for the future we have to adopt a common philosophy.
Please, with the PDI team test both  en and fr .page docs 
(just by turning your favorite choice on your browser). 
Imagine you have else to learn it for the first time, 
else you are searching a unique instruction,
else you want to print a part of thr doc,
else you have to update one topics.
It is not so evident, I will do as you will decide.
Message posted by maybe Marcus on 2002/05/05 17:18:56
Please correct me if I misunderstood your point.

Since a .page file ultimately will be browsed by a user, its
'real' length should only be a drudgery for us (translating or reviewing the 
code). 

For users, even though the .page code is in fact long, it should not 'seem' long.
That is, its pages should be organized in such a way that a page should rarely
be longer than one-and-half screens (to avoid annoying scroll-downs), and should
provide a friendly navigation mechanism.

For instance, consider page.page, it is a lengthy .page file, but it has been
structured in such a way that, if the user wants, one can read it from the top
down, or jump back and forth to the section of one's preference.

In fact, as you well observed, the original documentation is really (and virtually)
long. I am currently burning my brains to restructure and shorten them (virtually).
Message posted by michel on 2002/05/05 17:29:00

My target when designing the french version to propose a presentation easier to read.
And my question is : do I succeed ot not ? It's difficult for me to know.
Message posted by marcus on 2002/05/05 23:44:53
I have visited your documentation of the .page file format. It is ok. I parti-
cularly liked the fact that you have added to the 'button' instruction two
usages for it when combined with the reload_page and go_backward instructions.

I will do that as well to my documentation.

As far as the arrangement of things on the page, you are on the right track.

However, I have a poor command of the French language to be able to review its
contents.

Addressing an old question of yours, unfortunately, I live in Ontario, a 
province whose predominant language (99% in Toronto) is English. Hence,
 it's quite hard to find people fluent in written French...