w3c / wpub

W3C Web Publications
https://w3c.github.io/wpub/
Other
78 stars 19 forks source link

Wording for D. Examples for bidirectional texts #443

Closed r12a closed 5 years ago

r12a commented 5 years ago

D. Examples for bidirectional texts https://w3c.github.io/wpub/#app-bidi-examples

The table in this appendix jumbles up a bunch of different things.

Do you want it to show how RLM/LRM can be prepended to a string in JSON to indicate the intended base direction? (If so, the examples should use javascript escapes, rather than HTML escapes.) (This is the kind of thing that rows 3 and 4 appear to be aiming at.)

Or do you want it to show how a consumer would wrap the string in markup/characters, to show how to apply the base direction in the target location when used? (which seems to be implied by the location of the link at the moment)

The second row of the table also shows how one can use characters to embed a different base direction within a string. Do you really need this? We don't mention string-internal bidi controls in the rest of the spec - only how to set the overall directional context for the string as a whole.

If you want to achieve more than one of the above, i think you will need to break up the table and add a bunch of introductory and explanatory text.

iherman commented 5 years ago

@r12a, the intention is

Do you want it to show how RLM/LRM can be prepended to a string in JSON to indicate the intended base direction?

Definitely this. Ie, what the user must put into JSON to achieve the display in the last column.

If you have better examples for these, I would really welcome it. I've just taken this from the activity stream document...

r12a commented 5 years ago

Then, i think that in section 2.6.3.4.2 Item-specific Language, you need to move

(See § D. Examples for bidirectional texts.

to the end of the preceding Note (and add the final paren).

I'll send a proposed rewrite of the appendix by email.