Please review this PR for simplifying the `symbol` description and examples

Hi all,

I'm in the process of making a PR for cleaning up `symbol` as we discussed on Monday [0]. Some things to note have popped up. You can view the before and after state of the symbols section of the spec (in easy-to-read HTML form) by following the links in the PR: https://github.com/w3c/personalization-semantics/pull/207



// Removing the option of including spaces in conjugated symbols

The spec talks about cases where conjugation is needed, e.g. to incorporate gender into a concept. The spec is conflicted on whether the format should include a space either side of the plus sign or not (an example has "15691+14707" for "her name", but the text says a space is preferred, and so does the GitHub wiki page about it [1]).

My initial thought is that having spaces either side of the plus sign is a bad idea, because if we _do_ allow multiple space-separated symbol values later, it will make parsing those either much harder or impracticable. So I have kept conjugation for now, as it seems to have small semantic scope, but with _no_ spaces around the plus sign.

We will need to either update, or mark as deprecated, the wiki page [1] on this.

[1] https://w3c.github.io/personalization-semantics/content/#symbol-explanation



// Should the link to the wiki page be removed, or made a note?

It doesn't seem like a good idea to have the link to the GitHub wiki page (which is now out-of-date, per the above section) within the body text. Perhaps an Editor's Note for now, or maybe we no longer need it?


// The example of using `symbol` with an image, to provide symbols for the `alt` text

I really like this example, but perhaps we can't really include it because of the multiple symbol attribute values issue that this PR is intended to fix. For now I made it as if the image only contained one word of text, but in practice this will very rarely be the case.

So I think we probably have to remove it?


Thanks in advance for any input you may have.

best regards,


Matthew

[0] https://www.w3.org/2022/05/02-personalization-minutes.html#t05

[1] https://w3c.github.io/personalization-semantics/content/#symbol-explanation

-- 
Matthew Tylee Atkinson (he/him)
--
Senior Accessibility Engineer
TPG Interactive
https://www.tpgi.com

A Vispero Company
https://www.vispero.com

--
This message is intended to be confidential and may be legally privileged. It is intended solely for the addressee. If you are not the intended recipient, please delete this message from your system and notify us immediately.
Any disclosure, copying, distribution or action taken or omitted to be taken by an unintended recipient in reliance on this message is prohibited and may be unlawful.

Received on Friday, 6 May 2022 17:26:48 UTC