Skip to content

Commit

Permalink
Merge branch 'master' into gh-pages to publish minor formatting changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
philbarker committed Jun 3, 2024
2 parents a0317ca + a3d0c28 commit 5a75011
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,5 @@ bundle exec jekyll serve
```

The current version of the spec master branch is available at [https://k12ocx.github.io/k12ocx-specs/](https://k12ocx.github.io/k12ocx-specs/).

![Powered by LRMI + DCMI](/images/LRMI-DCMI.png)
Binary file added images/LRMI-DCMI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 15 additions & 17 deletions manifest/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ There are currently two proposals for how to sequence the content. One approach

We recommend this information is provided as linked data encoded in JSON-LD (or potentially RDFa).

!!! note "Editor's note"
for more information about the thinking behind this approach see [Structure and sequence of book- or course-like resources](https://docs.google.com/document/d/1CDIcyoYtg9WeWpno_wyuNRJmqyn80_hVKjpKBjIG7GE/edit#heading=h.e3fwche8pgr6).
**Note:**
For more information about the thinking behind this approach see [Structure and sequence of book- or course-like resources](https://docs.google.com/document/d/1CDIcyoYtg9WeWpno_wyuNRJmqyn80_hVKjpKBjIG7GE/edit#heading=h.e3fwche8pgr6).


## An Unordered Aggregation
Expand Down Expand Up @@ -55,7 +55,7 @@ Properties of sdo:CreativeWork
| ------------- | ------------- | ------------------------------------------ |
| `sdo:hasPart` | sdo:CreativeWork | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense) |

!!! note
**Note:**
All the schema.org types are subtypes of sdo:CreativeWork and so may be used wherever sdo:CreativeWork is the expected type. The leniency of domain and range specification in schema.org allows us to treat the OER Schema types as if they were CreativeWorks.

### Example
Expand Down Expand Up @@ -105,21 +105,18 @@ A module comprises two topics, one of the topics comprises three lessons
]
}
```
!!! note "Editor's Note"
hacking the context for sdo:hasPart to be stricter than schema.org's own and to generate links not values.
**Note:**
The context for sdo:hasPart is stricter than schema.org's own in order to generate links not values.

!!! note "Editor's Note"
do folk prefer their JSON-LD examples as separate linked objects, as above, or as nested objects?

!!! note
**Note:**
The identifiers should be different to the URLs of specific instances of these resources. They identify relationships that are true for any instance of these resources, and as such they identify an abstract resource of which specific instances are manifestations. Appending `#A` to the URL of the official or authoritative web page for the resource is a useful pattern for generating a different URI but still using a URI that will provide human users with a meaningful link.

!!! note
**Note:**
Further information about the resources could be provided here, such as the URL to locate the content (`sdo:url`) and the name (`sdo:name`) of the resource, however this would duplicate information in the sitemap used to [locate]({{ site.baseurl }}{% link manifest/locate.md %}) the resources, and embedded markup used to [describe]({{ site.baseurl }}{% link inpage/index.md %}) the resources.

## An Ordered Aggregation

!!! note "open issue"
**Open issue:**
there are two options for ordering the component resources in an aggregation. Option 1 is a JSON array (i.e. an ordered list) of identifiers specifying a default order. This mirrors the approach taken for W3C Web Publications (ePub for the web). Option 2 is inspired by OAI-ORE and leverages schema.org ItemLists. Option 2 is conceptually and practically far more complex, however it may be more robust, and may more useful for providing information about next & previous components within the files for each component. It remains an open issue as to whether the extra complexity is manageable or necessary. [See issue on github](https://github.com/K12OCX/k12ocx-specs/issues/34)

## An Ordered Aggregation - Option 1
Expand All @@ -130,7 +127,7 @@ We provide information about the default logical and pedagogically appropriate s
| ---------- | ----------------------- |
| OCX extensions | `ocx` |

!!! note "Open issue"
**Open issue:**
We should declare ocx properties properly and provide info at context URI [see github issue](https://github.com/K12OCX/k12ocx-specs/issues/35)

### Recommended Properties
Expand All @@ -140,9 +137,10 @@ We provide information about the default logical and pedagogically appropriate s

The default order is only one permitted ordering. The ordering presented to the student or other user may be changed for many reasons, for example, remixing the content or adaptive delivery.

!!! note
**Note:**
JSON-LD arrays are unordered by default (in contrast with regular JSON). Ordering can be enforced using the `@list` JSON-LD keyword.

**Note:**
In JSON-LD lists of lists are not allowed. Therefor the ordering for each level of a hierarchical aggregation must be specified separately.

### Example
Expand Down Expand Up @@ -234,7 +232,7 @@ Properties of a sdo:ItemList.
| `sdo:itemListOrder` | Text | The type of ordering. Permitted values are Ascending, Descending, Unordered. |
| `sdo:numberOfItems` | Integer | The number of items in the ItemList |

!!! note
**Note:**
the order of elements in the mark-up is not sufficient for indicating the order of items in the list. Use ListItem with a 'position' property in such cases.

Properties of a sdo:ListItem
Expand All @@ -246,7 +244,7 @@ Properties of a sdo:ListItem
| `sdo:position` | Integer | The position of an item in a series or sequence of items |
| `sdo:perviousItem` | `sdo:ListItem` | A link to the ListItem that preceeds the current one |

!!! note "Editor's Note"
**Note:**
The terminology of ListItem and ItemList; nextItem (which is a ListItem), item (which is not a ListItem) and itemListElement (which is a ListItem, and sometimes also an ItemList) is confusing, but it's what schema.org has given us `¯\_(ツ)_/¯`.

### Example
Expand Down Expand Up @@ -363,8 +361,8 @@ A module comprising a sequence of two topics, the first of which is a sequence o
]
}
```
!!! note "Editor's Note"
**Note:**
Experimenting with ToC as nested objects.

!!! note "Editor's Note"
**Note:**
Hacking the context for sdo: properties to be stricter than schema.org's own and to generate links not values.

0 comments on commit 5a75011

Please sign in to comment.