Translations in `entities.acronyms.ent` are not reflected in the rendered output
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 52/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- php
- Área
- build-system, documentation
Línea de trabajo
Rastrea cómo fluye el idioma desde doc-base/configure.php:662 hacia manual.xml y cómo render.php selecciona su idioma, y luego compáralo con la plantilla php/infrastructure build-docs-lang-rsync. Reproduce localmente la salida del acrónimo pt_BR y verifica que los títulos localizados y los IDs de feed específicos del idioma se generen de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
Translating acronym expansions has no effect on the rendered localized manual. Here is what I see for CLI in pt_BR.
Translation: https://github.com/php/doc-pt_br/blob/d4429c51d33261cd7be1d6622e44da7212e7ba05/entities/entities.acronyms.ent#L95
Interface/Interpretador de Linha de Comando
Rendered output: https://www.php.net/manual/pt_BR/features.commandline.php
<abbr title="Command Line Interpreter/Interface">CLI</abbr>
Cause and options
Option 1: fix in the build
render.php reads <language>/entities/entities.acronyms.ent directly. #262 added support for other languages, but when nothing is specified, render.php takes the language to be the default en.
Passing --lang pt_BR in my local build produced the correct output:
-<abbr title="Command Line Interpreter/Interface">CLI</abbr>
+<abbr title="Interface/Interpretador de Linha de Comando">CLI</abbr>
So if the goal is only to fix the published manual, I think adding the language option to the build is the smallest change:
https://github.com/php/infrastructure/blob/61b6f2989bbfeae5dab7c7b293e954e6858a46f0/roles/properties/rsync/templates/build-docs-lang-rsync#L10-L16
Option 2: fix in render.php
Letting render.php pick up the language that configure.php was given may be the more fundamental fix. In most of the CI/CD setups and documentation across php/infrastructure, php/doc-base, php/phd and php/doc-*, render.php is called without a language. If it were the default, nobody would have to pass the option.
(I ran into this while translating entities.acronyms.ent, when I could not see the result in my local build.)
PhD is a bit complex for me, but the pieces to carry this setting through seem to already exist:
- Produced:
doc-base/configure.php:662writes<!ENTITY LANG '$lang'> - Used:
doc-base/manual.xml:34reads it in<set ... xml:lang="&LANG;">
I see no reason to give configure and render different languages, so making them agree when nothing is specified seems reasonable to me.
A small trade-off
Either way, the document IDs served in the Atom feeds contain the language, so the ID of every entry already published would change. For example, the ja feed:
https://www.php.net/manual/ja/feeds/features.commandline.atom
<id>tag:php.net,2009-10-13:/manual/en/file/features.commandline</id>
The ja document identifies itself as en. If anyone is subscribed to these, they would see every entry as new one time.
That feed URL is not linked from anywhere in the current manual, so I doubt many people are subscribed. The IDs also collide across all languages today, so I think having each feed identify its own language is worth the one-time churn.
- Lenguaje dominante
- PHP
- Estrellas
- 91
- Forks
- 59
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de php/phd
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Can <subtitle> not be used? Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
-
Half of `doc-pl` is all bold Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 42/100
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
-
Rendering issue on Warning Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
Issues similares
-
Solved site promotion gate fails on runner PHP patch drift (expects 8.2.33, runner installs 8.2.34) Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Automattic/blocks-engine#2161 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Automattic/static-site-importer#1824 ·
-
[Chore] Keep one viget-block-generator skill and replicate it, instead of four tracked copies Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Cannot reset column width Abierto0. Needs triage bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
0. Needs triage 35-feedback bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100