Skip to content

Commit 5b983c4

Browse files
author
André L F S Bacci
committed
Improve documentation.
1 parent b5d917c commit 5b983c4

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

scripts/translation/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# Some useful scripts for maintaining translation consistency of manual
1+
# Useful scripts for maintaining translation consistency of manual
22

33
Some of these scripts only test some file contents or XML structure
44
of translated files against their equivalents on `en/` directory.
5-
Others will try modify the translations in place, changing the
5+
Others will try to modify the translations in place, changing the
66
translated files. Use with care.
77

88
Not all translations are identical, or use the same conventions.
99
So not all scripts will be of use for all translations. The
1010
assumptions of each script are described in each file.
1111

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.
15+
1216
The `lib/` directory contains common code and functionality
1317
across these scripts.
1418

@@ -25,9 +29,9 @@ expected format.
2529
## qaxml.a.php
2630

2731
`qaxml.a.php` checks if all updated translated files have
28-
the same tag-attribute-value triples. Tag's attributes are extensively
32+
the same tag-attribute-value triplets. Tag's attributes are extensively
2933
utilized in manual for linking and XIncluding. Translated files with
30-
missing os mistyped attributes may cause build failing or missing
34+
missing or mistyped attributes may cause build failing or missing
3135
parts not copied by XIncludes.
3236

3337
## qaxml.e.php
@@ -40,7 +44,7 @@ may indicate mistyped or wrongly traduced parts.
4044

4145
`qaxml.p.php` checks if all updated translated files have
4246
the same processing instructions as the original files. Unbalanced entities
43-
may cause compilation errors, as they are utilized on manual in the build
47+
may cause compilation errors, as they are utilized in the manual build
4448
process.
4549

4650
## qaxml.t.php
@@ -52,9 +56,9 @@ source texts and target translations may cause compilation errors.
5256
Usage: `php qaxml.t.php [--detail] [tag[,tag]]`
5357

5458
`[tag[,tag]]` is a comma separated tag list to check their
55-
contents, as some tag's contents are expected *not* be translated.
59+
contents, as some tag contents are expected *not* be translated.
5660

57-
`--detail` will also print line defintions of each mismatched tag,
61+
`--detail` will also print line definitions of each mismatched tag,
5862
to facilitate bitsecting.
5963

6064
## Suggested execution
@@ -101,8 +105,8 @@ php doc-base/scripts/translation/qaxml.t.php varname
101105

102106
## Maintainers with spaces
103107

104-
The regex on `RevtagParser` was narrowed to not accept maintainer's names
105-
with spaces. This need to be confirmed on all active translations, or
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
106110
the regex modified to accept spaces again.
107111

108112
## en/chmonly

0 commit comments

Comments
 (0)