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

Update document per JLReq TF discussions #17

Merged
merged 38 commits into from May 28, 2020

Conversation

himorin
Copy link
Contributor

@himorin himorin commented Apr 27, 2020

@himorin
Copy link
Contributor Author

himorin commented Apr 28, 2020

  1. reorder of sections

new version (5.5) and previous version (3.2) are marked as n.0 (section 0 of new version) or p.0 (section 0 of previous version), in this memo.
subsections (block with heading text but no numbering) are marked with numbers from 1, like "ルビ処理のむつかしさ" in "0 はじめに" of ver 3.2 as p.0.1

  • part of n.0, comes from p.0.2
    • first 2 paragraphs are newly added (one similar from JLReq abstract)
    • last 2 paragraphs are from last 2 paragraphs of p.0.2
  • n.1.1 is from p.0.1 and part of p.0.2
    • 1st line is newly added
    • last paragraph is from 1st paragraph of p.0.2 (last sentence removed)
  • n.1.2 is from p.1.1
    • 2nd sentense of n.1.2 (1) is newly added
    • p.1.1 (2) is removed
    • 2nd sentense of n.1.2 (2) is newly added
    • n.1.2 (3-5) is almost newly added (or reworded with detail)
  • n.1.3 is from p.1.2 (the same without figure reference)
  • n.2.1 is from p.2.1 (the same without figure reference)
  • n.2.2 is from p.2.2
    • 2nd sentense in leading paragraph is newly added
    • (1),(2),(3),(5) is (almost) the same
    • leading paragraphs in (4) is reworded (newly added)
  • n.2.3 is from p.2.3
    • leading paragraphs are newly added (modified from leading paragraphs of (1),(2) in p.2.3)
    • leading paragraph in (1),(2),(3) are simplified to one line
    • 1st bullet in p.2.3 (1),(2),(3) is migrated into leading paragraphs (removed)
    • adding condition of 'solid setting' to each bullets in (1),(2),(3) - other than these keep the same
    • n.2.3 (4),(5) are from p.2.3 (4),(5)
  • n.2.4 is from p.2.4
    • adding one sentense for 2-level method into leading paragraph
    • the same for others
  • n.3 is newly added
  • p.3 was removed from document
  1. reorder of notes (side note)

numbers are count from 1st one, as n.n1 or p.n1

  • note n.n1 'Ruby as notes', from p.n3

    • newly addrd 3rd and later paragraphs
  • note n.n2 'Protrusion of ruby from base characters', from p.n1 (all reworded with new figures)

  • note n.n3 'Protruding over surrounding characters', from p.n6 (kept as the same)

  • note n.n4 'Wrap opportunities', from p.n2 (kept as the same)

  • note n.n6 'Wrap opportunities in group-ruby', from p.n7 (kept as the same)

  • note n.n5 newly added

  • note n.n7 for section n.3 newly added

  • note p.n3, p.n4 removed

  • note p.n8, p.n9, p.n10 for section p.3 removed

  1. figures

figures without integrated description could be copied from Japanese one (no need to translate), and marked as '(ok)' below.

@himorin
Copy link
Contributor Author

himorin commented Apr 28, 2020

At this point, following are finished (need to be checked)

  • reorder of (sub-)sections and updating text
  • replace of figures which are updated
  • moved notes to updated positions and updating text

@himorin himorin requested review from kidayasuo, r12a and xfq May 11, 2020 08:27
@himorin himorin changed the title [WIP] Update document per JLReq TF discussions Update document per JLReq TF discussions May 11, 2020
index.html Outdated
Comment on lines 66 to 68
<p class="checkme">This document describes simple method of processing for Ruby
in Japanese layout realized with technologies like CSS, SVG, and XML-FO,
as references to rendering engine implementors.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document describes simple method of processing for Ruby in Japanese layout realized with technologies like CSS, SVG, and XML-FO, as references to rendering engine implementors.

Maybe change it to something like:

This document describes a simple method of ruby composition for Japanese layout realized with technologies like CSS, SVG, and XML-FO, as basic information for implementations.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about with updated?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use lowercase for "ruby", since it is lowercase in HTML, CSS, and many other places like the What is ruby? i18n article.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

in Japanese layout realized with technologies like CSS, SVG, and XML-FO,
as references to rendering engine implementors.
Unlike
<a href="https://www.w3.org/TR/jlreq/"><abbr title="Requirements for Japanese Text Layout">JLReq</abbr></a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm leaning towards leaving only one link of jlreq here (i.e., only use [[JLREQ]]), but have no strong opinion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this part is to have abbr tag for JLreq, so let me keep this as is.

index.html Outdated
Japanese layout.
Points took in consideration are described in
<a href="#matters-considered-by-the-simple-placement-rules"></a>.
Also layout of dual ruby composition is added in this document which is not
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should "dual ruby" be "double-sided ruby"? (Same below.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

want to get comment from @kidayasuo (and else)...
dual from https://w3c.github.io/jlreq/#n104 (but this uses "dual ruby composition", so might not better to use...)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel "double-sided" communicates what it is a bit better than dual (in Japanese "二重").

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"double-sided-ruby" or "double-sided ruby"? (might be latter one,,,

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer using a compound adjective to modify a noun (i.e., double-sided ruby), instead of creating a compound noun (double-sided-ruby).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated by b965f3a

index.html Outdated Show resolved Hide resolved
@kidayasuo
Copy link
Contributor

kidayasuo commented May 16, 2020

"large number of" → "a large number of".

I found it in two places.

(By the way how I refer the html code like @xfq does? (Kakkoi-!) In case of minor corrections which do not need discussions such as adding "a" or "the" it is easier for both if I can just make the change.)

@xfq
Copy link
Member

xfq commented May 16, 2020

(By the way how I refer the html code like @xfq does? (Kakkoi-!) In case of minor corrections which do not need discussions such as adding "a" or "the" it is easier for both if I can just make the change.)

@kidayasuo You can click the "Files changed" tab on the pull request, find index.html[1] and click "Load diff". Hover over the line of code where you'd like to add a comment, and click the blue comment icon. To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon.

In the comment field, type your comment. Optionally, to suggest a specific change to the line or lines, press cmd+g, then edit the text within the suggestion block. The OP can just click "apply suggestion" to apply your suggestion. This is easier than committing to the branch directly.

Footnotes:

[1] You can also mark other files as "viewed" on the right of the header of the files and they will collapse.

index.html Outdated Show resolved Hide resolved
index.html Outdated
Putting line break within ruby string is not allowed for mono-ruby.
In addition, putting line break within ruby base text is not allowed
for group-ruby.
In contrast, interlinear notes may have large number of characters,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In contrast, interlinear notes may have large number of characters,
In contrast, interlinear notes may have a large number of characters,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed two parts.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated
Comment on lines 169 to 173
With this method, processing may go smoothly for the case with Kana
characters as both preceding and following of ruby base text,
but there is possible case of unbalanced display,
like a combination of Kana character as preceding of ruby base text
and Kanji character as following of ruby base text
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
With this method, processing may go smoothly for the case with Kana
characters as both preceding and following of ruby base text,
but there is possible case of unbalanced display,
like a combination of Kana character as preceding of ruby base text
and Kanji character as following of ruby base text
With this method, it can have an unbalanced look when Kana precedes the
ruby base and Kanji follows, or vice versa.

Simplified.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I somehow feel over-simplified on this point,,. How it is unbalanced might be difficult for those who is not familiar with Japanese?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
With this method, processing may go smoothly for the case with Kana
characters as both preceding and following of ruby base text,
but there is possible case of unbalanced display,
like a combination of Kana character as preceding of ruby base text
and Kanji character as following of ruby base text
This method works well when characters preceding and following the ruby base are both Kana
or both Kanji. It however can have an unbalanced look when one is Kana and the other is Kanji
and if the ruby text is longer than the ruby base.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think so as it explains that it would lay over Kana but not on Kanji. but I agree it might be over-simplified as it removes a whole sentence of the good case. How about this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated by afeab5f

himorin and others added 6 commits May 17, 2020 13:51
Co-authored-by: Yasuo Kida (木田泰夫) <33173251+kidayasuo@users.noreply.github.com>
Co-authored-by: Yasuo Kida (木田泰夫) <33173251+kidayasuo@users.noreply.github.com>
Co-authored-by: Yasuo Kida (木田泰夫) <33173251+kidayasuo@users.noreply.github.com>
himorin added a commit to himorin/simple-ruby that referenced this pull request May 17, 2020
@himorin
Copy link
Contributor Author

himorin commented May 17, 2020

I tried to smooth out the second paragraph (and third so it connect well with the second):
As the original text is not in a technical writing style, sentences tend to be complex. Breaking them up would make it easier (but often you need supplementing subjects and tweaking).

pushed as 88e2a13, could you check @kidayasuo ?

@kidayasuo
Copy link
Contributor

Approving the PR (did I already?). The document will be ready for FPWD once minor pending fixes are complete (Shimono-san said he will finish them by next Monday (in a timezone wherever the Monday comes last :)).

The document has a room for polish but the consensus at jlreq is it will be done after the FPWD.

@himorin
Copy link
Contributor Author

himorin commented May 28, 2020

Thank you for review. I'll remove all checkme and merge this shortly.

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

Successfully merging this pull request may close these issues.

None yet

3 participants