Skip to content

Latest commit

 

History

History
133 lines (107 loc) · 14.8 KB

report-properties.md

File metadata and controls

133 lines (107 loc) · 14.8 KB
Raw

Report Properties

The report is a JSON object containing data that can be processed, e.g. for displaying information in a client.

Property Type Description Required
client Object Information relevant for the client Required
messages Array of Objects Messages with information Required
contentTree Object Tree structure of H5P content and its subcontents Required
raw Object Raw data for individual analysis Required

Client

The client object holds information that may be relevant for the client display.

Property Type Description Required
categories Object Info about all categories and types that are potentially available Required
translations Object Translations information for the client or other receiving entity Required

Categories

The categories object holds information about all categories that the library handles. This can be useful for a client to know if not all categories are covered in the messages, but all categories should have a separate section or similar.

Property Type Description Required
accessibility Array of Strings Accessibility types. Possible values are: libreText, missingAltText. Required
efficiency Array of Strings Efficiency types. Possible values are: imageSize, imageResolution. Required
features Array of Strings Feature types. Possible values are: resume, xAPI, questionTypeContract. Required
license Array of Strings License types. Possible values are: missingLicense, missingLicenceVersion, missingAuthor, missingTitle, missingLink, missingChanges, missingLicenseExtras, missingLicenseRemix, invalidLicenseAdaptation, discouragedLicenseAdaptation. Required
reuse Array of Strings Reuse types. Possible values are: notCultutalWork, noAuthorComments, hasLicenseExtras. Required
statistics Array of Strings Statistics types. Possible values are: contentTypeCount. Required

Translations

The translations object holds the key value pairs for translatable strings in the language that was set when initializing. The following list only holds examples.

Property Type Description Required
accessibility String Translation/no space text of the accessibility category, e.g. "Barrieregfreiheit" in German Required
missingAltText String Translation/no space text of the missinAltText type, e.g. "fehlender Alternativtext" in German Required
questionTypeContract String Translation/no space text of the questionTypeContract type, e.g. "question type contract" in English Required

Messages

The messages array holds one object for each message. Strings will be translated into the language that was configured during initialization.

Property Type Description Required
category String The category of the issue. Possible values are: accessibility, efficiency, feature, license, reuse or statistics. Required
type String Type of issue within the category. Possible values are: libreText, missignAltText, missingLicense and others. Required
level String Level of message. Possible values are error when user must change things, warning when user may need to change things and info otherwise. Required
summary String Textual summary of the issue that was found. Required
description String Textual description of the issue that was found. Required
subContentId String Subcontent id of H5P subcontent or 'root' for main content Required
recommendation String Textual hint to the user what he/she should do. Recommended
details Object Extendable list of detail information Recommended

Details

The details section that does not have a fixed list of properties. While there are some common ones that are likely to be set, it can be amended when useful for the specific reporting case.

Property Type Description Required
semanticsPath String Path to to respective parameter within semantics.json. Recommended
title String Title of the H5P content type set in the metadata. Recommended
path String Path to file within H5P content file, e.g. media. Optional
reference String URL to ressource that provided more information for the user. Optional
description String E.g. used for LibreText accessibility report content. Optional
licenseNote String E.g. used for Libretext accessibility report license note. Optional
status String E.g. used for Libretext accessibility report usability status. Optional
type String E.g. used for Libretext accessibility report type field. Optional

ContentTree

The content tree object represents the tree structure that the H5P content has with its subcontents.

Property Type Description Required
label String Suggested label as content type {title} ({machineName}). Required
subContentId String Subcontent id of H5P subcontent or 'root' for main content. May begin with fake- if it is not a real subcontent buy content using one of H5P core's internal editor widgets for media. Required
title String Title of the H5P content type set in the metadata. Required
versionedMachineName String Versioned machine name of the content type, e.g. H5P.CoursePresentation 1.26. Not set for internal editor widget contents. Optional
children Array of ContentTree Objects List of all subcontents as ContentTree objects as well. Optional

Raw

The raw object holds raw information that was extracted from the h5p.json file, etc.

Property Type Description Required
contentJson Object JSON object holding the parameters that were configured by the H5P content author. Required
h5pJson Object JSON object holding the contents of the h5p.json file (see https://h5p.org/documentation/developers/json-file-definitions). Required
libraries Object Content type library specific information. Required
media Object Media information. Required

Libraries

The libraries object holds content type specific information indexed by machine name, e.g. H5P.AdvancedText.

Property Type Description Required
$machineName Object Content type specific information Required

Library item

A library item holds content type specific information.

Property Type Description Required
languages Object Available translation files indexed by ISO 639 Set 1 code. Required
libraryJson Object JSON contents of the library.json file (see https://h5p.org/library-definition). Required
machineName String Machine name of the content type library, e.g. H5P.AdvancedText. Required
majorVersion String Major version of the content type library. Required
minorVersion String Minor version of the content type library. Required
semanticsJson Array of Objects JSON contents of the semantics.json file (see https://h5p.org/semantics). Required

Media

The media object holds information about media used in the content type (except videos).

Property Type Description Required
audios Object Audio file information. Optional
files Object General file information. Optional
images Object Image file information Optional

Media item

A media item object holds information index by the content file names.

Property Type Description Required
$contentFileName Object Media content information Required
Media content item

A media content item object holds information about the medium depending on the type.

Property Type Description Required
size Number Size of the file in bytes. Required
base64 String Base64 encoded representation of images. Optional
height Number Height of an image in px. Optional
width Number Width of an image in px. Optional