Skip to content

Commit

Permalink
Move explanation under mustard.
Browse files Browse the repository at this point in the history
The example note should be preceeded by the explanation.
  • Loading branch information
aphillips committed Feb 9, 2023
1 parent 676694b commit a54cf2f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,15 @@ <h3>Concatenation of strings</h3>
<p class="advisement">When a specification needs to suggest the creation or generation of a display name or other string value and the value could potentially come from multiple sub-strings, guidance SHOULD be provided about how to avoid problems with text directionality.</p>
</div>

<p>Specifications for APIs, protocols, or document formats sometimes require an implementation or end user to create display names or descriptions. When such a string is assembled from separate parts, it can result in problems with presentation or understanding due to the way that the <cite>Unicode Bidirectional Algorithm</cite> [[UAX9]] processes the assembled string.</p>

<aside class="example" title="Example of bidi generation guidance">
<p>Here is an example of a Note that you can include in your specification when recommending that implementations generate displayable [=natural language=] values:</p>
<div class="note" role="note" id="bidi-gen-note-example">
<p class="example_note">If <em><code>_field_name_</code></em> contains or might contain [= bidirectional text =], care should be used to ensure that the string will display correctly without the application needing to process the string. For more information see <a href="https://www.w3.org/International/questions/qa-bidi-unicode-controls"><cite>How to use Unicode controls for bidi text</cite></a></p>
</div>
</aside>

<p>Specifications for APIs, protocols, or document formats sometimes require an implementation or end user to create display names or descriptions. When such a string is assembled from separate parts, it can result in problems with presentation or understanding due to the way that the <cite>Unicode Bidirectional Algorithm</cite> [[UAX9]] processes the assembled string.</p>

<aside class="example" title="Spillover issues in a generated display name">
<p>Suppose a specification provides a field in an API that is meant to be filled in by the implementation at runtime. One example of this is the <code>label</code> field in the [[window-placement]] API. The value of <code>label</code> might take various different implementation-dependent forms that include natural language text generated by the system or user-agent.</p>

Expand Down

0 comments on commit a54cf2f

Please sign in to comment.