Re: EN-Revision comments Vs Docbook revision attributes
| From: | Hannes Magnusson | Date: | Sat, 06 Oct 2007 11:36:07 +0000 |
| Subject: | Re: EN-Revision comments Vs Docbook revision attributes | ||
| References: | 1 2 3 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969378217@lists.php.net to get a copy of this message | ||
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
Index: ja/reference/strings/functions/strpos.xml =================================================================== RCS file: /repository/phpdoc-ja/reference/strings/functions/strpos.xml,v retrieving revision 1.10 diff -u -p -r1.10 strpos.xml --- ja/reference/strings/functions/strpos.xml 11 Aug 2007 04:15:46 -0000 1.10 +++ ja/reference/strings/functions/strpos.xml 6 Oct 2007 11:23:11 -0000 @@ -1,7 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.10 $ --> -<!-- EN-Revision: 1.14 Maintainer: hirokawa Status: ready --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos"> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos" revision="1.14"> <refnamediv> <refname>strpos</refname> <refpurpose>æååãæåã«ç¾ããå ´æãè¦ã¤ãã</refpurpose> Index: en/reference/strings/functions/strpos.xml =================================================================== RCS file: /repository/phpdoc/en/reference/strings/functions/strpos.xml,v retrieving revision 1.14 diff -u -p -r1.14 strpos.xml --- en/reference/strings/functions/strpos.xml 20 Jun 2007 22:25:31 -0000 1.14 +++ en/reference/strings/functions/strpos.xml 6 Oct 2007 11:23:11 -0000 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.14 $ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos"> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos" revision="1.14"> <refnamediv> <refname>strpos</refname> <refpurpose>Find position of first occurrence of a string</refpurpose>
Index: ja/reference/strings/functions/strpos.xml =================================================================== RCS file: /repository/phpdoc-ja/reference/strings/functions/strpos.xml,v retrieving revision 1.10 diff -u -p -r1.10 strpos.xml --- ja/reference/strings/functions/strpos.xml 11 Aug 2007 04:15:46 -0000 1.10 +++ ja/reference/strings/functions/strpos.xml 6 Oct 2007 11:23:11 -0000 @@ -1,7 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.10 $ --> -<!-- EN-Revision: 1.14 Maintainer: hirokawa Status: ready --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos"> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos" revision="1.14"> <refnamediv> <refname>strpos</refname> <refpurpose>æååãæåã«ç¾ããå ´æãè¦ã¤ãã</refpurpose> Index: en/reference/strings/functions/strpos.xml =================================================================== RCS file: /repository/phpdoc/en/reference/strings/functions/strpos.xml,v retrieving revision 1.14 diff -u -p -r1.14 strpos.xml --- en/reference/strings/functions/strpos.xml 20 Jun 2007 22:25:31 -0000 1.14 +++ en/reference/strings/functions/strpos.xml 6 Oct 2007 11:23:11 -0000 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.14 $ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos"> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.strpos" revision="1.14"> <refnamediv> <refname>strpos</refname> <refpurpose>Find position of first occurrence of a string</refpurpose>