w3c / w3c/dapt

Clarify use of paragraphs in Script Events

Open
#302 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

editorial
Dominant language
HTML
Stars
11
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Context: https://github.com/w3c/dapt/pull/300#discussion_r2168444001

The spec says that a script event can contain "Zero or more Text objects, each being either Original or Translation"
In my use cases, there will be only at most 1 Original text object and at most 1 Translated text object (of a given language). The spec is not as strict as that, therefore you could theoretically have 2 original text objects and each text object could have a different represents attribute.
I would suggest adding text somewhere in the spec that describes the use case of 2 similar text objects in the same script event.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Script Events section of the specification and the discussion in https://github.com/w3c/dapt/pull/300#discussion_r2168444001. Clarify how multiple Original or Translation Text objects, including differing represents values, are intended to be used; done when the specification explicitly describes that use case.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.