Translations in `entities.acronyms.ent` are not reflected in the rendered output
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 52/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- php
- Ambito
- build-system, documentation
Direzione di ricerca
Traccia come la lingua fluisce da doc-base/configure.php:662 a manual.xml e come render.php seleziona la propria lingua, quindi confronta il tutto con il template php/infrastructure build-docs-lang-rsync. Riproduci localmente l'output dell'acronimo pt_BR e verifica che i titoli localizzati e gli ID dei feed specifici della lingua vengano generati in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- PHP
- Stelle
- 91
- Fork
- 59
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di php/phd
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Can <subtitle> not be used? Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
-
Half of `doc-pl` is all bold Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
-
enhancement
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
-
Rendering issue on Warning Apertabug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 42/100
Issue simili
-
Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Automattic/safe-publish#594 ·
-
needs-triage Platform(Default)
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
HttpClient
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
symfony/symfony-docs#23092 ·
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100