Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[simple-ruby] Publish the Japanese version too ? #7

Closed
r12a opened this issue Mar 25, 2020 · 5 comments
Closed

[simple-ruby] Publish the Japanese version too ? #7

r12a opened this issue Mar 25, 2020 · 5 comments

Comments

@r12a
Copy link
Contributor

r12a commented Mar 25, 2020

Will we publish the Japanese version of this document as well as the English version?

If so, we need to add some links to the top of the file, and with the explanation that this was originally developed in Japanese then translated, a mention that the English version is the authoritative one (in line with W3C policy which seeks to ensure widest possible readership).

@xfq
Copy link
Member

xfq commented Mar 26, 2020

FWIW, I have a bilingual version for personal use here: https://xfq.github.io/testing/jlreq-simple-ruby/docs/simple-ruby/

I can turn it into a PR against the jlreq repo and make English-only the default view (if it's useful), but this document is generally not targeted at Japanese speakers, and publishing a merged document could introduce some complexity for editing.


Here are some notes about the merged document:

I only created the Japanese illustrations for Figure 1-10, though, because: 1) it is hard for me to edit some SVG files by hand, and 2) the illustrations are usually not that difficult to understand, whether it is in English or in Japanese.

One issue I found when merging the English and Japanese documents was the title attribute of the aside element. Initially I wanted to put both the English version and the Japanese version into one <aside> element (like <figure>), but I was not sure how to handle the title attribute. Therefore, for the moment I just created new elements for <aside>.

@frivoal
Copy link

frivoal commented Apr 3, 2020

I think hosting the original Japanese pdf somewhere and linking to it is a good idea, letting people go back to the original source if they want to.

I am less convinced about a bilingual edition, I am concerned that it will decrease readability. If a bilingual version is made, I would strongly recommend hiding the Japanese version by default and allowing it to be revealed, rather than show everything by default and allow things to be hidden. And if we don't make the bilingual version, we side step the trouble @xfq pointed out with the title of figures.

Also, if we have an original document in Japanese, and an official English version, we don't have to maintain the Japanese version in parallel, it just stays as a historical document. If we have both in a single document, they need to be maintained equally. This feels like more work than necessary.

@r12a
Copy link
Contributor Author

r12a commented Apr 3, 2020

+1 to all that. And i think that was the conclusion the i18n WG arrived at too, guided by @himorin. Since we seem to be in agreement to move the doc to a new, dedicated repo i'll do that today and i'll move the japanese doc along with it.

@r12a r12a transferred this issue from w3c/jlreq Apr 3, 2020
@xfq
Copy link
Member

xfq commented Apr 4, 2020

Makes sense to me. I have been (and will continue to) sync my bilingual version with the upstream version, so if anyone finds the bilingual version useful (like me), they can still refer to it.

I have moved the bilingual document to a new URL: https://xfq.github.io/testing/simple-ruby/

@himorin
Copy link
Contributor

himorin commented May 29, 2020

close? (we have links to Japanese version PDF on the header)

@r12a r12a closed this as completed Jun 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants