The default value of rendition:flow and testing · Issue #1313 · w3c/epub-specs · GitHub
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.

Sign up for GitHub

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

Jump to bottom

The default value of rendition:flow and testing #1313

Closed
dauwhe opened this issue Apr 3, 2020 · 2 comments · Fixed by #1562 or #1641
Closed

The default value of rendition:flow and testing #1313

dauwhe opened this issue Apr 3, 2020 · 2 comments · Fixed by #1562 or #1641
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Testing Issues about testing Topic-PackageDoc The issue affects package documents

Comments

@dauwhe
Copy link
Contributor

dauwhe commented Apr 3, 2020

We say:

The default value auto MUST be assumed by Reading Systems as the global value if no meta element carrying this property occurs in the metadata section. Reading Systems MAY support only this default value.

I'm trying to figure out if it's possible to violate this rule. The definition of auto is:

The Author does not have a preference for overflow handling. The Reading System MAY render overflow content using its default method or a user preference, whichever is applicable.

So... say a book has no rendition: flow element. The reading system is therefore obligated to... use the auto value, which means it can choose any of the possible values? It could choose to paginate. It could choose to do scrolled-continuous. It could choose to do scrolled-doc.

Is the original MUST statement thus untestable?
@dauwhe dauwhe added Testing Issues about testing Topic-PackageDoc The issue affects package documents labels Apr 3, 2020
@iherman
Copy link
Member

iherman commented Jan 8, 2021

The issue was discussed in a meeting on 2021-01-07

List of resolutions:

  • Resolution No. 2: Change the language for rendition:flow to define the default is auto, but remove the MUST statement/ untestable assertion.
View the transcript

3. The default value of rendition:flow.

See github issue #1313.

Wendy Reid: this came up during testing.
… rendition:flow is a property by which an author can determine if pagination style is scrolled, paginated, or auto.
… if the RS supports it.
… the issue is that the spec says that the default value is auto, and that the RS may choose to support only the default.
… since auto means that its basically the RS's choice, does this make the assertion untestable?.

Brady Duga: i think this is solved by saying that the default is auto, period..
… with the understanding that if authors are not explicit, then they get default functionality.

Wendy Reid: to clarify, W3C says any time we make a MUST statement, the assertion must be accompanied by a test.
… or, the statement shouldn't be MUST.
… if this results in something untestable, we're going to run into issues later.

Ben Schroeter: or change MUST to SHOULD?.

Garth Conboy: that would only mean that the RS SHOULD do whatever it wants. It works around the W3C's testability requirement, but doesn't make much of a functional difference.

Proposed resolution: Change the language for rendition:flow to define the default is auto, but remove the MUST statement/ untestable assertion. (Wendy Reid)

Garth Conboy: +1.

Matthew Chan: +1.

Ben Schroeter: +1.

Toshiaki Koike: +1.

Brady Duga: +1.

Wendy Reid: +1.

Shinya Takami (高見真也): +1.

Masakazu Kitahara: +1.

Resolution #2: Change the language for rendition:flow to define the default is auto, but remove the MUST statement/ untestable assertion.

This was referenced Mar 8, 2021
Closed
Merged
@mattgarrish mattgarrish added the EPUB33 Issues addressed in the EPUB 3.3 revision label Mar 9, 2021
@iherman iherman mentioned this issue Apr 7, 2021
Merged
@dauwhe dauwhe reopened this Apr 7, 2021
@iherman
Copy link
Member

iherman commented Apr 16, 2021

The issue was discussed in a meeting on 2021-04-15

List of resolutions:

View the transcript

2. language around rendition:flow

See github issue #1313.

See github pull request #1616.

Dave Cramer: See Relevant comment within the PR

Dave Cramer: I was concerned that we say RS MUST use auto as a default value, but auto means "RS, do whatever you want"
… not sure that it was testable
… but Dan thinks it is testable
… so maybe we should just undo that resolution
… if it is testable i'm fine with restoring that requirement

Brady Duga: agree. Not worth spending much time on.
… and agree with dlazin's testing method for it

Dave Cramer: yes, we just need to see that things are consistent between having explicit auto value and "implied" auto

Proposed resolution: Merge PR 116 (Wendy Reid)

Brady Duga: +1

Dave Cramer: +1

Wendy Reid: +1

Matthew Chan: +1

Dan Lazin: +1

Masakazu Kitahara: +1

Toshiaki Koike: +1

Marisa DeMeglio: +1

Shinya Takami (高見真也): +1

Resolution #1: Merge PR 1616

@iherman iherman mentioned this issue Apr 16, 2021
Merged
@mattgarrish mattgarrish mentioned this issue Dec 6, 2021
Closed
@mattgarrish mattgarrish added the Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation label Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Testing Issues about testing Topic-PackageDoc The issue affects package documents
Projects
None yet
Milestone
No milestone
3 participants
@iherman @mattgarrish @dauwhe