Skip to content

Commit

Permalink
Fixes to formatting issues from when we moved from mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
philbarker committed Jun 12, 2024
2 parents ee0c13d + 57af9a3 commit 7af9e1c
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 23 deletions.
2 changes: 1 addition & 1 deletion inpage/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ See also examples for Assessment.

From https://pilot.unbounded.org/math/grade-4/module-1/topic-a/lesson-1

!!! note "Editor's note:"
**Note:**
DRAFT EXAMPLE, needs checking & validating.

``` json
Expand Down
4 changes: 2 additions & 2 deletions inpage/auxiliary-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Defined as "the context of a LearningComponent". Treat as equivalent to a subcla

## oer:LearningObjective

!!! note "Editor's Note"
I am not sure if we use these, or whether we should use these. They are a little under-defined, but they do fill a hole currently in schema.org.
**Note**
It is not clear whether we should use these. They are a little under-defined, but they do fill a hole currently in schema.org.

Treat as equivalent to a subclass of [schema.org/Intangible](https://schema.org/Intangible).

Expand Down
8 changes: 4 additions & 4 deletions inpage/course.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parent: In page markup
- parentOf: `oer:Module`
- childOf: `oer:Resource`

!!! Note
**Note:**
We treat the OER Schema course to be equivalent to [schema.org/Course](https://schema.org/Course) so that properties for scheme.org/Course may be used with it. (This exploits the flexibility of schema.org/domainIncludes used in defining schema.org properties.)

This represents the entire course. A Course includes one or more modules.
Expand All @@ -41,7 +41,7 @@ If properties with similar meaning are available from both schema.org and OER sc

The table below selectively lists those properties that are most relevant to OCX.

!!! Note
**Note**
Descriptions of some properties have been tweaked to make them more appropriate for describing courses.

{% include props.md schematype="course" %}
Expand All @@ -59,10 +59,10 @@ Markup for [https://pilot.unbounded.org/math/grade-4](https://pilot.unbounded.or

The following would be placed in a `<script type="application/ld+json">` element in the HTML sectioning element that contained information about the course.

!!! Note
**Note**
The URIs used for the `@id`s are based on the URLs of the page that represent the course being described and its modules with the addition of the #A fragment identifiers treating them as aggregate resources as described in the section on [manifest structuring]({{ site.baseurl }}{% link manifest/structure.md %}). This conforms with the requirement that different identifiers are used for CCM entities and the web pages that represent them, as described in the [content model]({{ site.baseurl }}{% link contentmodel.md %}).

!!! Note
**Note**
In the case where the content of a course is split over many HTML files, there is no requirement for the `hasPart` array shown in this example as this information would be provided by the manifest.

```json
Expand Down
12 changes: 6 additions & 6 deletions inpage/lesson.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ In many cases, the curriculum will describe a specific order that the Activities

oer:Lesson meets the definition of schema.org/Course, i.e. it is "a sequence of one or more educational events and/or creative works which aims to build knowledge, competence or ability of learners". This means that resources that are lessons should be typed as oer:lesson and schema.org/Course. The schema.org learningResourceType property with a value of "lesson" should be used to indicate the type of course to systems that understand schema.org but not the OER Schema terms used by OCX.

!!! Note "Editor's Note"
I know that lesson as a Course seems odd. If we find we don't need scheme.org's courseCode or coursePrerequisites properties we can just call a lesson a creative work.
**Note**
Lesson as a Course seems odd. If we find we don't need scheme.org's courseCode or coursePrerequisites properties we can just call a lesson a creative work.

Examples:

Expand All @@ -49,16 +49,16 @@ Markup for [https://pilot.unbounded.org/ela/grade-6/module-1/unit-2/lesson-8](ht

The following would be placed in a `<script type="application/ld+json">` element in the HTML sectioning element that contained information about the lesson.

!!! note
**Note**
The URIs used for the `@id`s are based on the URLs of the page that represent the module being described and its units with the addition of the #A fragment identifiers treating them as aggregate resources as described in the section on [manifest structuring]({{ site.baseurl }}{% link manifest/structure.md %}). This conforms with the requirement that different identifiers are used for CCM entities and the web pages that represent them, as described in the [content model]({{ site.baseurl }}{% link contentmodel.md %}).

!!!note
**Note**
In the case where the content of a unit is split over many HTML files, there is no requirement for the `hasPart` array shown in this example as this information would be provided by the manifest.

!!! note "Editor's Note"
**Note**
Several parts of the original are omitted in the example in order to avoid repetition.

!!! note
**Note**
Some of the parts are documents in a choice of digital format (encoding). If the HTML page for the Lesson is the only HTML page containing information about these documents then it is necessary to provide a full description of those documents in this page and their encodings. An example of such as description is provided under [Properties of SupportingMaterial]({{ site.baseurl }}{% link inpage/supportingmaterial.md %}).

```json
Expand Down
6 changes: 3 additions & 3 deletions inpage/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If properties with similar meaning are available from both schema.org and OER sc

The table below selectively lists those properties that are most relevant to OCX.

!!! note
**Note**
Descriptions of some properties have been tweaked to make them more appropriate for describing modules.

{% include props.md schematype="module" %}
Expand All @@ -53,10 +53,10 @@ Markup for [https://pilot.unbounded.org/math/grade-4/module-1](https://pilot.unb

The following would be placed in a `<script type="application/ld+json">` element in the HTML sectioning element that contained information about the module.

!!! note
**Note**
The URIs used for the `@id`s are based on the URLs of the page that represent the module being described and its units with the addition of the #A fragment identifiers treating them as aggregate resources as described in the section on [manifest structuring]({{ site.baseurl }}{% link manifest/structure.md %}). This conforms with the requirement that different identifiers are used for CCM entities and the web pages that represent them, as described in the [content model]({{ site.baseurl }}{% link contentmodel.md %}).

!!! note
**Note**
In the case where the content of a module is split over many HTML files, there is no requirement for the `hasPart` array shown in this example as this information would be provided by the manifest.


Expand Down
7 changes: 5 additions & 2 deletions inpage/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ The nature of the CCM or significant subdivision should be denoted with types dr

Metadata about a subdivision should be placed within the HTML sectioning element that contains that subdivision. This ensures that if this section is extracted from the document the metadata travels with it.

##Relevant schema.org types
## Relevant schema.org types

Useful schema.org types can be found under [schema.org/CreativeWork](http://schema.org/CreativeWork) which provides normative definitions, and include:

* Book, Course, AudioBook, WebSite
Expand All @@ -78,6 +79,7 @@ Useful schema.org types can be found under [schema.org/CreativeWork](http://sche
schema.org must be used as the main vocabulary for the document. schema.org types may be identified with cURIs with no namespace, e.g. `CreativeWork`.

## Relevant OER Schema types

* Course
* Module
* Unit
Expand All @@ -96,7 +98,8 @@ As defined by [OER Schema](http://oerschema.org/docs/schema.html).

OER Schema types should be identified with cURIs using the RDF namespace prefix `oer:` for the `http://oerschema.org/` namespace URI, for example oer:Lesson.

##Custom OCX types
## Custom OCX types

OCX types may be added as this specification matures.

OCX types should be identified with cURIs using the RDF namespace prefix `ocx:` for the ocx namespace URI and , e.g. ocx:NewType.
Expand Down
8 changes: 4 additions & 4 deletions inpage/unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ Markup for [https://pilot.unbounded.org/ela/grade-2/module-1/unit-6](https://pil

The following would be placed in a `<script type="application/ld+json">` element in the HTML sectioning element that contained information about the unit.

!!! note
**Note**
The URIs used for the `@id`s are based on the URLs of the page that represent the module being described and its units with the addition of the #A fragment identifiers treating them as aggregate resources as described in the section on [manifest structuring]({{ site.baseurl }}{% link manifest/structure.md %}). This conforms with the requirement that different identifiers are used for CCM entities and the web pages that represent them, as described in the [content model]({{ site.baseurl }}{% link contentmodel.md %}).

!!! note
**Note**
In the case where the content of a unit is split over many HTML files, there is no requirement for the `hasPart` array shown in this example as this information would be provided by the manifest.

!!! note "Editor's Note"
**Note**
Several parts of the original are omitted in the example in order to avoid repetition.

!!! note
**Note**
Some of the parts are pdf documents (one is included in the example). If the HTML page for the Unit is the only HTML page containing information about these documents then it is necessary to provide a full description of those documents in this page. An example of such as description is provided under [Properties of SupportingMaterial]({{ site.baseurl }}{% link inpage/supportingmaterial.md %}).

```json
Expand Down
2 changes: 1 addition & 1 deletion manifest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ For clarity and ease of use, we propose Sitemap extended vocabulary that points

A similar approach has already been adopted by Google via Sitemap extensions for [Video](https://support.google.com/webmasters/answer/80471), [Images](https://support.google.com/webmasters/answer/178636?hl=en) and [News](https://www.google.co.uk/schemas/sitemap-news/0.9/). In addition, Google [recommends](https://developers.google.com/webmasters/videosearch/schema) using the schema.org compliant on-page markup, just as we do.

!!! Note "open issue"
**Open issue:**
Where does the manifest go? How can it be discovered. Is it one file or two? [See github issue](https://github.com/K12OCX/k12ocx-specs/issues/33)
2 changes: 2 additions & 0 deletions manifest/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ A module comprises two topics, one of the topics comprises three lessons
We provide information about the default logical and pedagogically appropriate sequence for displaying or presenting the components of complex curriculum materials using a JSON array of URIs, each URI representing a component. This approach is based on the [default reading order](https://www.w3.org/TR/wpub/#default-reading-order) of the (draft) W3C [Web Publications](https://www.w3.org/TR/wpub/) spec.

### Recommended Vocabulary Identifiers

| Vocabulary | Namespace : Context URI |
| ---------- | ----------------------- |
| OCX extensions | `ocx` |
Expand All @@ -131,6 +132,7 @@ We provide information about the default logical and pedagogically appropriate s
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

| Property | Expected Type | Defintion |
| ------------- | -------------- | --------- |
| `ocx:defaultOrder` | a list of URIs | The default order in which to present the resources in the aggregation to the user. |
Expand Down

0 comments on commit 7af9e1c

Please sign in to comment.