Skip to content

QA: Meta-issue: Bulk XML markup fixes (wrapping <para> and conversion to <simpara> tags) #5155

@Girgias

Description

@Girgias

The PHP documentation XML sources have long suffered from inconsistencies and differing way of using DocBook markup.

We have established recent-ish guidelines on how things should be marked in the style guide but large parts of the manual don't follow it. This makes it harder for new contributors to actually get PRs approved from the get-go as they most likely will copy and paste a nearby XML file.

However, just blanket fixes to doc-en are a no-go as this would affect translations and their ability to track which changes are actually important.

I have created some scripts (that I will at some point add to doc-base) that can perform some XML updates and automatically apply it on translations, and update the REVCHECK hash.
The primary downside of this approach is that this can only be done when all translations for a specific file are up-to-date. The state of translations can be determined by going to https://doc.php.net/ and checking each-language individually.

The purpose of this issue is for me to be able to track which folders have been checked and migrated and if not, what is blocking them.

  • appendices: Need to examine translation status
  • chapters: Need to examine translation status
  • chmonly: Need to examine translation status
  • faq: Need to examine translation status
  • features: Need to examine translation status
  • install: Need to examine translation status
  • language: Need to examine translation status
  • reference:
    • apache: Blocked by IT/RO/TR translations not up to date
    • apcu:
    • array: Blocked by DE/IT/PL/RO/RU/TR/UK translations not up to date
    • bc: Blocked by FR/IT/RU translations not up to date
    • bzip2: Blocked by IT translations not up to date (bzip2: remove function documentation of files without EN Revcheck tags doc-it#92)
    • calendar: Blocked by IT/TR translations not up to date
    • classobj: Blocked by IT/PL/TR translations not up to date
    • cmark:
    • com Blocked by IT/TR translations not up to date
    • componere: Performed wrapping para & conversion to simpara scripts
    • ctype: Blocked by IT/RO translations not up to date
    • cubrid:
    • curl: Blocked by DE/IT/PL/RU/TR/UK/ZH translations not up to date
    • datetime: Blocked by DE/ES/FR/JA/PL/RO/RU/TR/UK/ZH
    • dba:
    • dbase: Blocked by IT/UK translations not up to date
    • dio: Blocked by DE/IT/TR translations not up to date
    • dir: Blocked by DE/ES/FR/IT/PL/RO/RU/TR translations not up to date
    • dom: Blocked by IT/RO/TR translations not up to date
    • ds: Blocked by ES/FR/RU translations not up to date
    • eio: Blocked by markup not being handled by script properly
    • enchant:
    • errorfunc: Blocked by IT/RO/RU/TR translations not up to date
    • ev:
    • event: Blocked by markup not being handled by script properly
    • exec: Blocked by IT/TR translations not up to date
    • exif
    • expect
    • fann: Blocked by ES/FR/RU/ZH translations not up to date
    • fdf:
    • ffi:
    • fileinfo:
    • filesystem: Blocked by DE/ES/FR/IT/JA/PL/RU/TR/UK translations not up to date
    • filter: Performed wrapping para script, but held back by DE translation for simpara conversion
    • fpm:
    • ftp: Blocked by IT/TR/UK translations not up to date
    • funchand: Blocked by DE/PL/TR translations not up to date
    • gearman:
    • gender:
    • geoip:
    • gettext: Blocked by TR translations not up to date
    • gmagick:
    • gmp: Blocked by IT/UK translations not up to date
    • gnupg:
    • hash: Blocked by DE/TR translations not up to date
    • hrtime:
    • ibase:
    • ibm_db2:
    • iconv: Blocked by IT/TR/UK translations not up to date
    • igbinary:
    • image: Blocked by DE/TR translations not up to date
    • imagick: Blocked by DE/ES/FR/RU/TR translations not up to date
    • imap: Blocked by TR translations not up to date
    • info: Blocked by DE/IT/RO/TR/UK translations not up to date
    • inotify:
    • intl: Blocked by ES/FR/JA/RU/TR translations not up to date
    • json: Blocked by DE/FR/PL/RO/RU/TR translations not up to date
    • ldap: Blocked by DE/ES/FR/JA/RU translations not up to date
    • libxml: Blocked by ES/FR/IT/RU/TR
    • lua:
    • luasandbox:
    • lzf:
    • mail: Blocked by IT/PL/RO/RU/TR translations not up to date
    • mailparse:
    • math: Blocked by IT/PL/RU/UK/ZH translations not up to date
    • mbstring: Blocked by RO/TR translations not up to date
    • mcrypt:
    • memcache:
    • memcached: Blocked by script issue (wrapping para tags script error)
    • mhash: Blocked by TR translations not up to date
    • misc: Blocked by DE/IT/RO/TR/UK translations not up to date
    • mongodb: Blocked by RO/RU translations not up to date
    • mqseries: Blocked by script issue
    • mysql:
    • mysql_xdevapi: Blocked by RU translations not up to date
    • mysqli: Blocked by DE/ES/FR/RO/RU/UK/ZH translations not up to date
    • mysqlinfo:
    • mysqlnd:
    • network: Blocked by DE/FR/IT/PL/RU/TR/ZH translations not up to date
    • oauth:
    • oci8: Blocked by IT translations not up to date
    • opcache:
    • openal:
    • openssl: Blocked by DE/ES/FR/JA/RO/RU/TR translations not up to date
    • outcontrol: Blocked by RO/TR translations not up to date
    • parallel:
    • parle:
    • password: Blocked by PL/RU/TR/UK
    • pcntl: Blocked by ES/FR/JA/RU/TR
    • pcre: Blocked by IT/RO/RU/TR
    • pdo: Blocked by DE/FR/RO/RU/TR translations not up to date
    • pdo_cubrid:
    • pdo_dblib: Blocked by TR translations not up to date
    • pdo_firebird: Blocked by TR translations not up to date
    • pdo_ibm: Blocked by TR translations not up to date
    • pdo_informix: Blocked by TR translations not up to date
    • pdo_mysql: Blocked by TR translations not up to date
    • pdo_oci: Blocked by TR translations not up to date
    • pdo_odbc: Blocked by RU/TR translations not up to date
    • pdo_pgsql: Blocked by TR translations not up to date
    • pdo_sqlite: Blocked by TR/UK translations not up to date
    • pdo_sqlsrv:
    • pgsql: Blocked by DE/ES/FR/IT/JA/PL/RU/ZH
    • phar: Blocked by DE/RU translations not up to date
    • phpdbg:
    • posix: Blocked by DE/IT/TR translations not up to date
    • ps:
    • pspell: Blocked by RO/RU translations not up to date
    • pthreads:
    • quickhash:
    • radius:
    • random: Blocked by DE/PL/UK translations not up to date
    • rar:
    • readline:
    • recode: Blocked by script issue
    • reflection: Blocked by PL/RO/RU/TR translations not up to date
    • rnp: Blocked by script issue
    • rpminfo: Blocked by RU translations not up to date
    • rrd:
    • runkit7:
    • scoutapm: Blocked by script issue (scoutapm: remove useless wrapping para tag around XML note entity #5198)
    • seaslog:
    • sem: Blocked by IT translations not up to date (sem: remove function documentation of files without EN Revcheck tags doc-it#93)
    • session: Blocked by ES/DE/FR/JA/RU/TR/ZH/IT translations not up to date
    • shmop: Blocked by IT translations not up to date (shmop: remove function documentation of files without EN Revcheck tags doc-it#94)
    • simdjson:
    • simplexml: Blocked by FR/IT/RU/TR translations not up to date
    • snmp: Blocked by IT translations not up to date (snmp: remove function documentation of files without EN Revcheck tags doc-it#95)
    • soap: Blocked by ES/DE/FR/JA/RU translations not up to date
    • sockets: Blocked by IT/TR translations not up to date
    • sodium:
    • solr: Blocked by script issue (wrapping para tags script error)
    • spl: Blocked by ES/FR/JA/RO/RU/UK translations not up to date
    • sqlite3: Blocked by TR/UK translations not up to date
    • sqlsrv:
    • ssdeep:
    • ssh2:
    • stats: Need to examine translation status
    • stomp:
    • stream: Need to examine translation status
    • strings: Blocked by ES/DE/FR/IT/PL/RO/RU/TR/UK/ZH translations not up to date
    • svm: Blocked by script issue
    • svn:
    • swoole: Blocked by RU translations not up to date
    • sync:
    • taint:
    • tcpwrap:
    • tidy: Blocked by TR translations not up to date
    • tokenizer: Blocked by RO translations not up to date
    • trader: Blocked by RU translations not up to date
    • ui:
    • uodbc: Blocked by IT/RU/TR translations not up to date
    • uopz:
    • url: Blocked by DE/RU/TR translations not up to date
    • v8js:
    • var: Need to examine translation status
    • var_representation: Need to examine translation status
    • varnish:
    • wddx: Need to examine translation status
    • win32service: Need to examine translation status
    • wincache: Need to examine translation status
    • wkhtmltox: Need to examine translation status
    • xattr: Need to examine translation status
    • xdiff: Need to examine translation status
    • xhprof: Need to examine translation status
    • xlswriter: Need to examine translation status
    • xml: Need to examine translation status
    • xmldiff: Need to examine translation status
    • xmlreader: Need to examine translation status
    • xmlrpc: Need to examine translation status
    • xmlwriter: Need to examine translation status
    • xpass: Need to examine translation status
    • xsl: Need to examine translation status
    • yac: Need to examine translation status
    • yaconf: Need to examine translation status
    • yaf: Need to examine translation status
    • yaml: Need to examine translation status
    • yar: Need to examine translation status
    • yaz: Need to examine translation status
    • zip: Need to examine translation status
    • zlib: Need to examine translation status
    • zmq: Need to examine translation status
  • security: Need to examine translation status

Metadata

Metadata

Assignees

Labels

QAQuality Assurance

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions