1
+
1
2
# Useful scripts for maintaining translation consistency of manual
2
3
3
4
Some 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
6
7
translated files. Use with care.
7
8
8
9
Not 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.
11
13
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.
15
17
16
18
The ` lib/ ` directory contains common code and functionality
17
19
across these scripts.
@@ -32,18 +34,18 @@ expected format.
32
34
the same tag-attribute-value triplets. Tag's attributes are extensively
33
35
utilized in manual for linking and XIncluding. Translated files with
34
36
missing or mistyped attributes may cause build failing or missing
35
- parts not copied by XIncludes.
37
+ parts, not copied by XIncludes.
36
38
37
39
## qaxml.e.php
38
40
39
41
` qaxml.e.php ` checks if all updated translated files have
40
42
the 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.
42
44
43
45
## qaxml.p.php
44
46
45
47
` 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
47
49
may cause compilation errors, as they are utilized in the manual build
48
50
process.
49
51
@@ -74,6 +76,7 @@ php doc-base/scripts/translation/qaxml.a.php
74
76
php doc-base/scripts/translation/qaxml.e.php
75
77
php doc-base/scripts/translation/qaxml.p.php
76
78
php doc-base/scripts/translation/qaxml.t.php
79
+ php doc-base/scripts/translation/qaxml.w.php
77
80
```
78
81
Tags where is expected no translations:
79
82
```
@@ -101,15 +104,11 @@ php doc-base/scripts/translation/qaxml.t.php literal
101
104
php doc-base/scripts/translation/qaxml.t.php varname
102
105
```
103
106
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
111
108
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.
113
114
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