Open Badges Extra Description Extension 1.0 1EdTech Base Document

Open Badges Extra Description Extension

1EdTech Candidate Final Public
Version 1.0
1EdTech Candidate Final Public
Date Issued: October 7th, 2020
Status: This document is for review and adoption by the 1EdTech membership.
This version: https://www.imsglobal.org/spec/ob-exdesc/v1p0/
Latest version: https://www.imsglobal.org/spec/ob-exdesc/latest/
Errata: https://www.imsglobal.org/spec/ob-exdesc/v1p0/errata/

IPR and Distribution Notice

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

1EdTech takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: http://www.imsglobal.org/speclicense.html.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by 1EdTech or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

Public contributions, comments and questions can be posted here: http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources.

© 2020 1EdTech Consortium, Inc. All Rights Reserved.

Trademark information: http://www.imsglobal.org/copyright.html

1. Abstract

An extension to Open Badges that allows issuers to add additional titled sections of descriptive content to their badges and profiles.

2. Overview

2.1 Introduction

This section is non-normative.

This extension provides extra descriptive metadata about a BadgeClass or Issuer Profile. Usage is primarily intended to serve human-readable display contexts. One or more implementations of this extension may appear within a BadgeClass, for instance, offering additional space to explain information that should travel with the badge in the rich text Markdown format.

2.2 Use cases

This section is non-normative.

  • Present to would-be earners a list of links to educational resources that may aid in learning the content or skills necessary to meet the badge's criteria.
  • Add a section describing job categories related to a badge.
  • Include information about research done on the badge's design or assessment methodology that could signal enhanced market value.
  • Describe an Issuer Profile more fully, in terms of its focus or links to previous projects.

2.3 Extendable Badge Objects

BadgeClass, Profile

2.4 Conformance Statements

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words "MAY", "MUST", "MUST NOT", "OPTIONAL", "RECOMMENDED", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", and "SHOULD NOT" in this document are to be interpreted as described in [RFC2119].

An implementation of this specification that fails to implement a MUST/REQUIRED/SHALL requirement or fails to abide by a MUST NOT/SHALL NOT prohibition is considered nonconformant. SHOULD/SHOULD NOT/RECOMMENDED statements constitute a best practice. Ignoring a best practice does not violate conformance but a decision to disregard such guidance should be carefully considered. MAY/OPTIONAL statements indicate that implementers are entirely free to choose whether or not to implement the option.

2.5 Document Set

2.5.1 Normative Documents

JSON Schema
The JSON Schema defines the syntactical restrictions of this extension [OB-EXDESC-10-SCHEMA].
JSON-LD Context
The JSON-LD context defines mappings for the terms used in this specification to their canonical IRIs [OB-EXDESC-10-CONTEXT].
Errata
The errata details any erratum registered for this version of this specification since its publication [OB-EXDESC-10-ERRATA].

3. Properties

The extension offers a paired name and narrative field so that implementers can describe one or more sections of extra description, where each section has both a name to identify its purpose as well as a markdown-formatted text narrative. The name and narrative fields already defined in the Open Badges V2 context are reused in this new structure.

ExtraDescription Extension Properties

PropertyTypeValue Description
@contextIRI https://purl.imsglobal.org/spec/ob-exdesc/v1p0/context/ (required)
typeJSON-LD Type Array ["Extension", "extensions:ExtraDescriptionExtension"] (required)
namestringA short name for the section. (required)
narrativestring (Markdown allowed) Descriptive data about the extended badge object that falls under the subject identified by the name field. Basic rich text content such as emphasis, lists, and links allowed in Markdown format. Inline images should not be used and may not be supported by implementing platforms. (required)

A. Examples

A.1 A Simple Single Extra Description


{
  "extensions:extraDescription": {
    "@context":"https://purl.imsglobal.org/spec/ob-exdesc/v1p0/context/",
    "type": ["Extension", "extensions:ExtraDescriptionExtension"],
    "name": "Related Roller Coasters",
    "narrative": "Here are two roller coasters that will give you a similar experience to undergoing assessment for this badge.\n\n* [Tempesto](https://www.youtube.com/watch?v=ZCKhkRPq8rI), Busch Gardens, Williamsburg\n* [Fantasia Mini Special Kiddie Roller Coaster](https://www.youtube.com/watch?v=bisz3CJZDpA), Tongdo Fantasia, South Korea"
  }
}
Figure 1 Example of an extraDescription extension property where Markdown is used for the narrative.

A.2 Two Extra Descriptions

When you add multiple sections, they each have a name and a narrative, and you add them as an array within the extensions:extraDescription property of the BadgeClass (or Issuer Profile)


{
  "extensions:extraDescription": [{
    "@context":"https://purl.imsglobal.org/spec/ob-exdesc/v1p0/context/",
    "type": ["Extension", "extensions:ExtraDescriptionExtension"],
    "name": "Related Roller Coasters",
    "narrative": "Here are two roller coasters that will give you a similar experience to undergoing assessment for this badge.\n\n* [Tempesto](https://www.youtube.com/watch?v=ZCKhkRPq8rI), Busch Gardens, Williamsburg\n* [Fantasia Mini Special Kiddie Roller Coaster](https://www.youtube.com/watch?v=bisz3CJZDpA), Tongdo Fantasia, South Korea"
  },{
    "@context":"https://purl.imsglobal.org/spec/ob-exdesc/v1p0/context/",
    "type": ["Extension", "extensions:ExtraDescriptionExtension"],
    "name": "Related Poem",
    "narrative": "Badges may be round, \nmore commonly hexes, \nThey've got great illustrations, \nSometimes of T-Rexes.\n\nSee this [example badge image](http://hexb.in/hexagons/offline-trex.png)."
  }]
}
Figure 2 Example of an extraDescription extension property with multiple descriptions in an array.

B. Revision History

This section is non-normative.

B.1 Version History

Version No.Release DateComments
Candidate Final Public October 7, 2020 Release as public document.
Base Document 1.0 April 12th, 2018 Initial release.

C. References

C.1 Normative references

[OB-EXDESC-10-CONTEXT]
Open Badges Extra Description Extension v1.0 JSON-LD Context. 1EdTech Consortium. April 2018. 1EdTech Final Release. URL: http://purl.imsglobal.org/spec/ob-exdesc/v1p0/context/
[OB-EXDESC-10-ERRATA]
Open Badges Extra Description Extension v1.0 Errata. 1EdTech Consortium. April 2018. 1EdTech Final Release. URL: https://www.imsglobal.org/spec/ob-exdesc/v1p0/errata/
[OB-EXDESC-10-SCHEMA]
Open Badges Extra Description Extension v1.0 JSON Schema. 1EdTech Consortium. April 2018. 1EdTech Final Release. URL: http://purl.imsglobal.org/spec/ob-exdesc/v1p0/schema/
[RFC2119]
Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

D. List of Contributors

The following individuals contributed to the development of this document:

Name Organization Role
Nate OttoConcentric Sky (USA)editor

1EdTech Consortium, Inc. ("1EdTech") is publishing the information contained in this document ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

1EdTech makes no warranty or representation regarding the accuracy or completeness of the Specification.

This material is provided on an "As Is" and "As Available" basis.

The Specification is at all times subject to change and revision without notice.

It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.

1EdTech would appreciate receiving your comments and suggestions.

Please contact 1EdTech through our website at http://www.imsglobal.org.

Please refer to Document Name: Open Badges Extra Description Extension 1.0

Date: October 7th, 2020