1+
12# Useful scripts for maintaining translation consistency of manual
23
34Some of these scripts only test some file contents or XML structure
@@ -6,12 +7,13 @@ Others will try to modify the translations in place, changing the
67translated files. Use with care.
78
89Not all translations are identical, or use the same conventions.
9- So not all scripts will be of use for all translations. The
10- assumptions of each script are described in each file.
10+ Even two translators working on one language may havedifferent
11+ opinions on how much synchronization is wanted. So not all scripts
12+ will be of use for all translations.
1113
12- It 's also possible to silence each alert indempendly. These scripts
13- will output ` --add-ignore ` commands that, if executed, will omit
14- the specific warming in future executions.
14+ Because of aboce, it 's possible to silence each alert indempendly.
15+ These scripts will output ` --add-ignore ` commands that, if executed,
16+ will omit the specific warming in future executions.
1517
1618The ` lib/ ` directory contains common code and functionality
1719across these scripts.
@@ -32,18 +34,18 @@ expected format.
3234the same tag-attribute-value triplets. Tag's attributes are extensively
3335utilized in manual for linking and XIncluding. Translated files with
3436missing or mistyped attributes may cause build failing or missing
35- parts not copied by XIncludes.
37+ parts, not copied by XIncludes.
3638
3739## qaxml.e.php
3840
3941` qaxml.e.php ` checks if all updated translated files have
4042the same external entities as the original files. Unbalanced entities
41- may indicate mistyped or wrongly traduced parts.
43+ may indicate mistyped or wrongly translated parts.
4244
4345## qaxml.p.php
4446
4547` qaxml.p.php ` checks if all updated translated files have
46- the same processing instructions as the original files. Unbalanced entities
48+ the same processing instructions as the original files. Unbalanced PIs
4749may cause compilation errors, as they are utilized in the manual build
4850process.
4951
@@ -74,6 +76,7 @@ php doc-base/scripts/translation/qaxml.a.php
7476php doc-base/scripts/translation/qaxml.e.php
7577php doc-base/scripts/translation/qaxml.p.php
7678php doc-base/scripts/translation/qaxml.t.php
79+ php doc-base/scripts/translation/qaxml.w.php
7780```
7881Tags where is expected no translations:
7982```
@@ -101,15 +104,11 @@ php doc-base/scripts/translation/qaxml.t.php literal
101104php doc-base/scripts/translation/qaxml.t.php varname
102105```
103106
104- # Migration
105-
106- ## Maintainers with spaces
107-
108- The regex on ` RevtagParser ` is narrowed to not accept maintainer names
109- with spaces. This needs to be confirmed on all active translations, or
110- the regex modified to accept spaces again.
107+ ## Initial alerts execution
111108
112- ## en/chmonly
109+ The first execution of these scripts may generate an inordinate amount of
110+ alerts. It's advised to initially run each command separately, and work the
111+ alerts on a case by case basis. After all interesting cases are observed,
112+ it's possible to rerun the command, and ` grep ` the output for ` --add-ignore `
113+ lines, and to mass ignore the residual alerts.
113114
114- ` en/chmonly ` is ignored on revcheck, but it appears translatable. If it's a
115- ` en/ ` only directory, this should be uncommented on RevcheckIgnore.
0 commit comments