Skip to content

Commit

Permalink
Updated new properties to camel case
Browse files Browse the repository at this point in the history
  • Loading branch information
HadrienGardeur committed Jul 4, 2024
1 parent 894dbae commit 4deda7e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 5 additions & 5 deletions profiles/divina.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Some publications may contain spreads where the user needs to navigate back and
In order to convey this information, this profile introduces a new property for Link Objects:

<dl>
<dt>meaningful-spread</dt>
<dt>meaningfulSpread</dt>
<dd>Hint that the current resource should be presented in a spread to fully convey the meaning of its content.</dd>
</dl>

Expand Down Expand Up @@ -205,15 +205,15 @@ In order to convey this information, this profile introduces a new property for
"type": "image/jpeg",
"properties": {
"page": "right",
"meaningful-spread": true
"meaningfulSpread": true
}
},
{
"href": "page4.jpg",
"type": "image/jpeg",
"properties": {
"page": "left",
"meaningful-spread": true
"meaningfulSpread": true
}
}
]
Expand All @@ -227,7 +227,7 @@ For publications where a single continuous scroll is required to properly displa
In order to override the default behaviour of displaying all images from the `readingOrder` in a single continuous scroll, this profile also introduces a new property for Link Objects:

<dl>
<dt>break-scroll-before</dt>
<dt>breakScrollBefore</dt>
<dd>Specifies that an item in the reading order should break the current continuous scroll and start a new one.</dd>
</dl>

Expand Down Expand Up @@ -258,7 +258,7 @@ In order to override the default behaviour of displaying all images from the `re
"href": "episode2-image1.jpg",
"type": "image/jpeg",
"properties": {
"break-scroll-before": true
"breakScrollBefore": true
}
},
{
Expand Down
4 changes: 3 additions & 1 deletion properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ The `page` property is meant to provide a hint to reading systems that rely on s

| Key | Semantics | Type | Values | Reference |
| ----- | --------- | -------- | --------- | --------- |
| [`breakScrollBefore`](/profiles/divina.md#42-scrolled-publications) | Hint that the current resource should be presented in a spread to fully convey the meaning of its content. | Boolean | Defaults to `false` | [Divina Profile](/profiles/divina.md) |
| [`contains`](/profiles/epub.md#contains) | Indentifies content contained in the linked resource, that cannot be strictly identified using a media type. | Array | `mathml`, `onix`, `remote-resources`, `js`, `svg` or `xmp` | [EPUB Profile](/profiles/epub.md#properties) |
| [`layout`](/profiles/epub.md#layout) | Hint about the nature of the layout for the linked resources. | String | `fixed` or `reflowable` | [EPUB Profile](/profiles/epub.md#properties) |
| [`encrypted`](/modules/encryption.md) | Indicates how a given resource has been encrypted or obfuscated. | [Encryption Object](/modules/encryption.md#encryption-object) | See the definition of the Encryption Object | [Encryption Module](/modules/encryption.md) |
| [`layout`](/profiles/epub.md#layout) | Hint about the nature of the layout for the linked resources. | String | `fixed` or `reflowable` | [EPUB Profile](/profiles/epub.md#properties) |
| [`meaningfulSpread`](/profiles/divina.md#41-fixed-layout) | Specifies that an item in the reading order should break the current continuous scroll and start a new one. | Boolean | Defaults to `false` | [Divina Profile](/profiles/divina.md) |

## OPDS 2.0

Expand Down
4 changes: 2 additions & 2 deletions schema/extensions/divina/properties.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"title": "Divina Profile - Link Properties",
"type": "object",
"properties": {
"break-scroll-before": {
"breakScrollBefore": {
"description": "Specifies that an item in the reading order should break the current continuous scroll and start a new one.",
"type": "boolean",
"default": false
},
"meaningful-spread": {
"meaningfulSpread": {
"description": "Hint that the current resource should be presented in a spread to fully convey the meaning of its content.",
"type": "boolean",
"default": false
Expand Down

0 comments on commit 4deda7e

Please sign in to comment.