w3c / ruby-t2s-req

Text to Speech of Electronic Documents Containing Ruby: User Requirements
https://w3c.github.io/ruby-t2s-req/
Other
0 stars 4 forks source link

Rewrite of the section "Alternatives to ruby" thoroughly. #24

Closed murata2makoto closed 2 years ago

murata2makoto commented 2 years ago

To address #23, I have completely rewritten this section. But some references are not added yet, since I cannot find them in Specref.


:boom: Error: 500 Internal Server Error :boom:

PR Preview failed to build. (Last tried on Jan 23, 2022, 4:36 AM UTC).

More PR Preview relies on a number of web services to run. There seems to be an issue with the following one: :rotating_light: [Spec Generator](https://www.w3.org/2015/labs/) - Spec Generator is the web service used to build specs that rely on ReSpec. :link: [Related URL](https://labs.w3.org/spec-generator/?type=respec&url=https%3A%2F%2Frawcdn.githack.com%2FJapan-Daisy-Consortium%2Fruby-t2s-req%2Fd6714ef7fe3fe5cfa5b032bf006524d99288fa35%2Findex.html%3FisPreview%3Dtrue) ``` 😭 Sorry, there was an error generating the HTML. Please report this issue! Specification: https://rawcdn.githack.com/Japan-Daisy-Consortium/ruby-t2s-req/d6714ef7fe3fe5cfa5b032bf006524d99288fa35/index.html?isPreview=true&publishDate=2022-01-23 ReSpec version: 28.2.2 File a bug: https://github.com/w3c/respec/ Error: Error: Evaluation failed: Timeout: document.respec.ready didn't resolve in 27932ms. at ExecutionContext._evaluateInternal (/u/spec-generator/node_modules/puppeteer/lib/cjs/puppeteer/common/ExecutionContext.js:221:19) at runMicrotasks () at processTicksAndRejections (node:internal/process/task_queues:96:5) at async ExecutionContext.evaluate (/u/spec-generator/node_modules/puppeteer/lib/cjs/puppeteer/common/ExecutionContext.js:110:16) at async generateHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:221:12) at async toHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:92:18) at async Object.generate [as respec] (/u/spec-generator/generators/respec.js:14:44) at async /u/spec-generator/server.js:203:44 ``` _If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please [file an issue](https://github.com/tobie/pr-preview/issues/new?title=Error%20not%20surfaced%20properly&body=See%20w3c/ruby-t2s-req%2324.)._
himorin commented 2 years ago

For PLS, how about PLS ([[PRONUNCIATION-LEXICON]]) or just leavel as PLS without spec link? (lines 645, 660, 663) Or in line 610, add abbreviation as [[PRONUNCIATION-LEXICON]] (PLS}?

himorin commented 2 years ago

Reading through the whole section, I somehow felt that words ruby are better to be replaced with ruby annotation. How do you think?

(this is the last comment)

murata2makoto commented 2 years ago

@himorin

Reading through the whole section, I somehow felt that words ruby are better to be replaced with ruby annotation. How do you think?

I have used "ruby" and "ruby annotation" interchangeably. Do other ruby specs use these term differently?

himorin commented 2 years ago

I suppose simple-ruby uses ruby as a concept of ルビ, and ruby annotation as characters attached to its base text. (after all proposed PR merged...)

murata2makoto commented 2 years ago

So, does "ruby" mean attaching ruby annotations to base text or the combination of base text and a ruby annotation? In other words, ruby annotations never contain base text, but "ruby" refers to both base text and ruby annotations. This makes sense.

himorin commented 2 years ago

Yes for ruby annotations points only attached characters to its base text and never contain its base text. (there seems no clear text of this definition in simple-ruby, and might better to add some...)

r12a commented 2 years ago

I have used "ruby" and "ruby annotation" interchangeably. Do other ruby specs use these term differently?

I advise to keep those terms clearly separated. I understand 'ruby' to be a general term to describe some annotated text and its annotations, equivalent to the <ruby> element. For the actual annotations, specifically, i would use 'ruby annotation' (better than the ambiguous 'ruby text'), which corresponds in markup to the rt element(s). That approach also ties in with the definitions in the CSS Ruby spec, although CSS has more definitions because of its focus on the HTML and CSS structural elements.