Skip to content

Commit 0b1536e

Browse files
committed
missing model sections viewport, conformsTo
1 parent 2beb713 commit 0b1536e

File tree

2 files changed

+39
-6
lines changed

2 files changed

+39
-6
lines changed

source/presentation/4.0/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ The Manifest's [`items`][prezi-40-model-items] property is an ordered list of _C
174174

175175
Manifests have descriptive, technical and linking properties. The required properties of Manifests are [`id`][prezi-40-model-id], [`type`][prezi-40-model-type], [`items`][prezi-40-model-items] and [`label`][prezi-40-model-label]. Other commonly used properties include [`summary`][prezi-40-model-summary], [`metadata`][prezi-40-model-metadata], [`rights`][prezi-40-model-rights], [`thumbnail`][prezi-40-model-thumbnail], [`homepage`][prezi-40-model-homepage] and [`provider`][prezi-40-model-provider].
176176

177-
(👀) [Model Documentation](model/#manifest)
177+
(👀) [Model Documentation](model/#Manifest)
178178

179179

180180
```jsonc
@@ -288,7 +288,7 @@ Scenes may also have the [`duration`][prezi-40-model-duration] property in the s
288288

289289
Scenes can have time-based and image content in them as well as 3D content. See model for how to do this.
290290

291-
[👀 Model Documentation](model/#containers)
291+
[👀 Model Documentation](model/#Containers)
292292

293293

294294
## Annotations
@@ -591,7 +591,7 @@ The example demonstrates the use of the common descriptive properties [`label`][
591591
* The Painting Annotation is a member of the [`items`][prezi-40-model-items] property of an Annotation Page. While in this case there is only one Annotation Page and one Annotation, the mechanism is needed for consistency when there are multiple Annotation Pages, and it allows for Annotation Pages in general to be separate resources on the web.
592592
* The [`metadata`][prezi-40-model-metadata] label and value pairs are for display to the user rather than for machines to interpret.
593593
* The [`rights`][prezi-40-model-rights] property is always a single string value which is a URI.
594-
* Any resource can have a [`provider`][prezi-40-model-provider] property which a client can display to the user. This typically tells the user who the publisher is and how they might be contacted. The value of this property is an [Agent](model/#agent).
594+
* Any resource can have a [`provider`][prezi-40-model-provider] property which a client can display to the user. This typically tells the user who the publisher is and how they might be contacted. The value of this property is an [Agent](model/#Agent).
595595
* The [`service`][prezi-40-model-service] property specifies a software application that a client might interact with to gain additional information or functionality, in this case, the IIIF Image API. Images in IIIF do not require an Image Service---we have included one here as an example, but do not include a service in the following image examples for brevity.
596596
{: .note}
597597

@@ -2881,13 +2881,13 @@ This example also shows how the [`fileSize`][prezi-40-model-fileSize] property c
28812881

28822882
In many of the examples in this specification an image resource has an associated [IIIF Image API][image-api] Service. This is the most common use of [`service`][prezi-40-model-service] in IIIF, but other types of service are defined by IIIF specifications or available as extensions. Rather than just offer the link for download, the client is expected to interact with the service on the user's behalf. For the Image API, this usually means generating multiple requests for image tiles at the appropriate zoom level. For the [IIIF Search API][search-api], this means accepting user query terms, sending them to the search service endpoint, and rendering the results for further interaction (typically navigation to the result location within the Manifest).
28832883

2884-
Further IIIF Services are provided by the [IIIF Authorization Flow API](auth-stable-version), which provides endpoints for a client to learn about a user's current access to a resource, and guide them through the publisher's access control arrangements if they do not have permission, so that they can (if authorised) acquire whatever credentials the publisher requires.
2884+
Further IIIF Services are provided by the [IIIF Authorization Flow API][auth-stable-version], which provides endpoints for a client to learn about a user's current access to a resource, and guide them through the publisher's access control arrangements if they do not have permission, so that they can (if authorised) acquire whatever credentials the publisher requires.
28852885

28862886
Ad hoc third party services can be developed for specific needs (with no expectation that a general-purpose IIIF client would know what to do with them).
28872887

28882888
## Content State
28892889

2890-
Links to resources and services build up a web of linked _*content*_ for human and machine consumers to interact with. The [IIIF Content State API](contenstate-stable-version) defines mechanisms for IIIF software implementations to exchange references to this content, including arbitrarily fine-grained pointers into large IIIF resources. A Content State is simply a fragment of the IIIF Presentation API, wrapped in a _Content State Annotation_, with enough information for software receiving that fragment to load it and (typically) direct the user's attention to the referenced point. A bookmark or citation could be passed between users via save and load functionality in viewers that understand Content State.
2890+
Links to resources and services build up a web of linked _*content*_ for human and machine consumers to interact with. The [IIIF Content State API][contenstate-stable-version] defines mechanisms for IIIF software implementations to exchange references to this content, including arbitrarily fine-grained pointers into large IIIF resources. A Content State is simply a fragment of the IIIF Presentation API, wrapped in a _Content State Annotation_, with enough information for software receiving that fragment to load it and (typically) direct the user's attention to the referenced point. A bookmark or citation could be passed between users via save and load functionality in viewers that understand Content State.
28912891

28922892
```
28932893
(region of a Canvas that is partOf a Manifest)

source/presentation/4.0/model.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1152,7 +1152,7 @@ An Agent _MAY_ have the following properties: [id](#id), [seeAlso](#seeAlso) and
11521152
A Quantity expresses a quantity through a numerical value and associated unit of measurement. The value of `unit` _MUST_ be drawn from the list of possible units, or a registered extension. The definition of `unit` defines the [list of possible unit values](#unit).
11531153

11541154
__Properties__<br/>
1155-
A Quantity _MUST_ have the following properties: [type](#type), [quantityValue](#value), and [unit](#unit).<br/><br/>
1155+
A Quantity _MUST_ have the following properties: [type](#type), [quantityValue](#quantityValue), and [unit](#unit).<br/><br/>
11561156
A Quantity _MAY_ have the following properties: [id](#id) and [label](#label).
11571157
{: .note}
11581158

@@ -1446,6 +1446,24 @@ The value _MUST_ be string, which defines an RGB color. It SHOULD be a hex value
14461446
```
14471447

14481448

1449+
### conformsTo
1450+
{: #conformsTo}
1451+
1452+
The specification that the fragment identifier in the `value` property of a `FragmentSelector` conforms to. The value allows clients to correctly interpret the fragment identifier syntax. For example, a `FragmentSelector` using the media fragments specification would have a `conformsTo` value of `http://www.w3.org/TR/media-frags/`.
1453+
1454+
For more information about `conformsTo`, see the [Web Annotation Data Model](https://www.w3.org/TR/annotation-model/#fragment-selector).
1455+
1456+
The value _MUST_ be a string, and _MUST_ be an absolute URI.
1457+
1458+
* A FragmentSelector _MAY_ have the `conformsTo` property.<br/>
1459+
Clients _SHOULD_ process `conformsTo` on a FragmentSelector.
1460+
1461+
{% include api/code_header.html %}
1462+
``` json-doc
1463+
{ "conformsTo": "http://www.w3.org/TR/media-frags/" }
1464+
```
1465+
1466+
14491467
### duration
14501468
{: #duration}
14511469

@@ -3074,6 +3092,21 @@ The value of the `via` property _MUST_ be an array of strings, and each string _
30743092
```
30753093

30763094

3095+
### viewHeight
3096+
{: #viewHeight}
3097+
3098+
The height of the visible region for an OrthographicCamera, in the coordinate space of the Scene. Unlike a PerspectiveCamera which uses a field of view angle, an OrthographicCamera defines its visible region by a rectangular volume. The `viewHeight` gives the vertical extent of that region in Scene coordinate units; the corresponding horizontal extent is derived proportionally from the aspect ratio of the client's viewport.
3099+
3100+
The value _MUST_ be a positive floating point number in the coordinate space of the Scene. If this property is not specified, then the default value is client-dependent.
3101+
3102+
* An OrthographicCamera _SHOULD_ have the `viewHeight` property.<br/>
3103+
Clients _SHOULD_ process the `viewHeight` property on OrthographicCameras.
3104+
3105+
```json-doc
3106+
{ "viewHeight": 40.0 }
3107+
```
3108+
3109+
30773110
### viewingDirection
30783111
{: #viewingDirection}
30793112

0 commit comments

Comments
 (0)