Re: EN-Revision comments Vs Docbook revision attributes

Hannes Magnusson написа:

On 8/30/07, Philip Olson <philip@roshambo.org> wrote:

On Aug 18, 2007, at 8:42 AM, Fernando Correa da Conceição wrote:

Hannes Magnusson escreveu:

Hello all Was there any specific reason why this "EN-Revision" comment magic was chosen over the Docbook revision attribute?

If there's a better way then let's do it... please propose exactly how it'd work and what it would look like. We'd also need to adjust all the translation scripts within docweb (and scripts/) before/while implementing.

(See attached patched for function.strpos on how exactly it will look in the XML) The rules would be the same as CVS Revision, just manually bumped. When not to bump: - WS fixes - (non-important) typos changes - (non-important) grammar changes - Totally irrelevant changes for translations ... When to bump minor version (after the dot): - Minor content fixes - Important typos (referring to wrong function for instance) - Example fixes ... When to bump major version (before the dot): - Security fixes (in examples or text recommendations..) - When adding new section to a page - Otherwise major changes Just use your commonsense when bumping major/minor version. The difference in bumping major vs minor revisions is how the user will see the difference. For instance, if a translation is couple of minor revisions old the end-user will see tiny little yellow warning stating "this translation is little old, no _important_ changes have been done though". If the translation is a whole major revision old the end-user will see a big fat red warning: "This page is out of date! Please consider to view the English version!" -Hannes

Although it should not bother the current work of English writers, the idea of telling the end-user that something is out of date and that, either a minor or a major change was introduced, is great. It is important to have correct translations and since it's not that easy to maintain all the changes, it's substantial to at least inform the end-user. I guess it would increase the build time, since a diff might be needed for each file and not just a simple check whether a file is present or not. -- Kouber Saparev http://kouber.saparev.com