IMS Global Logo

The PARCCv1p0 Profile of the IMS Accessible Portable Item Protocol (APIP) 1.0 Data Model (XSD) Checklist

Author

Colin Smythe (IMS Global, UK)

Date

5th June 2015

Release

Final (1.0)

Schema Version

IMS AFAPNP APIP EXT V1.0 PARCC V1.0

Namespace

http://www.imsglobal.org/xsd/apip/apipv1p0/imsapip_pnpv1p0

Summary

This document provides a checklist of the PARCCv1p0 Profile for the data model defined in the IMS Accessible Portable Item Protocol (APIP) 1.0 Specification.

IPR and Distribution Notices

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.

IMS 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 IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Copyright © 2013 IMS Global Learning Consortium. All Rights Reserved.

Use of this specification to develop products or services is governed by the license with IMS found on the IMS website: http://www.imsglobal.org/license.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 IMS 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.

key | toc | top

Table of Contents

  1. Key and Color Coding
  2. Profile Summary
  3. Root Attributes Summary Checklist
  4. Root Class Checklists
    1. "APIPContent" Root Class Checklist
    2. "APIPControl" Root Class Checklist
    3. "APIPDisplay" Root Class Checklist
    4. "APIPScreenEnhancement" Root Class Checklist
    5. "ActivateByDefault" Root Class Checklist
    6. "AssignedSupport" Root Class Checklist
  5. Common Class Checklists
    1. "AdditionalTestingTime" Class Checklist
    2. "AlternativeRepresentations" Class Checklist
    3. "AuditoryBackground" Class Checklist
    4. "BackgroundColour" Class Checklist
    5. "Breaks" Class Checklist
    6. "Chunking" Class Checklist
    7. "CognitiveGuidance" Class Checklist
    8. "ColourOverlay" Class Checklist
    9. "Encouragement" Class Checklist
    10. "ForegroundColour" Class Checklist
    11. "IncreasedWhiteSpacing" Class Checklist
    12. "IncreasedWhiteSpacingType" Class Checklist
    13. "InvertColourChoice" Class Checklist
    14. "ItemTranslationDisplay" Class Checklist
    15. "KeywordEmphasis" Class Checklist
    16. "KeywordTranslations" Class Checklist
    17. "LanguageLearner" Class Checklist
    18. "LineReader" Class Checklist
    19. "Magnification" Class Checklist
    20. "Masking" Class Checklist
    21. "NegativesRemoved" Class Checklist
    22. "ReducedAnswers" Class Checklist
    23. "Scaffolding" Class Checklist
    24. "Signing" Class Checklist
    25. "SimplifiedLanguage" Class Checklist
    26. "Spoken" Class Checklist
  6. Abstract Class Checklists
    1. "EncouragementSelection" Abstract Class Checklist
  7. Derived Data-Type Checklists
    1. "Decimal" Derived Class Checklist
  8. Primitive Data-Type Definitions
  9. Schematron Rules Definitions
    1. Unordered Schematron Rules

key | toc | top

Key and Color Coding

In the following tables, three colours are used to denote standard classifications of the rows:

The key to the columns used in the following profile comparison details is:

The key to the colours used in the following profile comparison details is:

key | toc | top

Profile Summary

This is the "PARCCv1p0". THIS IS A PROFILE OF THE BASE SPECIFICATION. The changes to the base specification are:

key | toc | top

Root Attributes Summary Checklist

The set of root attributes defined in the data model.

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
1 apipContent [1] APIPContent (Unordered) - -
2 apipControl [1] APIPControl (Unordered) - -
3 apipDisplay [1] APIPDisplay (Unordered) - -
4 apipScreenEnhancement [1] APIPScreenEnhancement (Unordered) - -
5 assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
6 activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

Root Class Checklists

The set of root classes (the classes for the set of root attributes) defined in the data model.

"APIPContent" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root APIPContent.Type - N/A - -[[ Unordered ]]- - - N/A -
1
->languageLearner [0..1] LanguageLearner (Sequence) - -
2
->cognitiveGuidance [0..1] CognitiveGuidance (Sequence) - -
3
->scaffolding [0..1] Scaffolding (Sequence) - -
4
->chunking [0..1] Chunking (Sequence) - -
5
->keywordEmphasis [0..1] KeywordEmphasis (Sequence) - -
6
->reducedAnswers [0..1] ReducedAnswers (Sequence) - -
7
->negativesRemoved [0..1] NegativesRemoved (Sequence) - -
8
->alternativeRepresentations [0..1] AlternativeRepresentations (Sequence) - -
9
->keywordTranslations [0..1] KeywordTranslations (Sequence) - -
10
->itemTranslationDisplay [0..1] ItemTranslationDisplay (Sequence) - -
11
->signing [0..1] Signing (Sequence) - -
12
->spoken [0..1] Spoken (Sequence) - -
13
->simplifiedLanguage [0..1] SimplifiedLanguage (Sequence) - -

key | toc | top

"APIPControl" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root APIPControl.Type - N/A - -[[ Unordered ]]- - - N/A -
1
->breaks [0..1] Breaks (Sequence) - -
2
->additionalTestingTime [0..1] AdditionalTestingTime (Sequence) - -
3
->lineReader [0..1] LineReader (Sequence) - -

key | toc | top

"APIPDisplay" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root APIPDisplay.Type - N/A - -[[ Unordered ]]- - - N/A -
1
->masking [0..1] Masking (Sequence) - -
2
->encouragement [0..1] Encouragement (Sequence) - -
3
->auditoryBackground [0..1] AuditoryBackground (Sequence) - -

key | toc | top

"APIPScreenEnhancement" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root APIPScreenEnhancement.Type - N/A - -[[ Unordered ]]- - - N/A -
1
->increasedWhiteSpacing [0..1] IncreasedWhiteSpacing (Sequence) - -
2
->colourOverlay [0..1] ColourOverlay (Sequence) - -
3
->foregroundColour [0..1] ForegroundColour (Sequence) - -
4
->backgroundColour [0..1] BackgroundColour (Sequence) - -
5
->invertColourChoice [0..1] InvertColourChoice (Sequence) - -
6
->magnification [0..1] Magnification (Sequence) - -

key | toc | top

"ActivateByDefault" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root ActivateByDefault.Type - N/A - PT:Boolean - - N/A -

key | toc | top

"AssignedSupport" Root Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Root AssignedSupport.Type - N/A - PT:Boolean - - N/A -

key | toc | top

Common Class Checklists

The set of classes (excluding the root classes) defined in the data model.

"AdditionalTestingTime" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class AdditionalTestingTime.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->timeMultiplier [1] [ Union (TimeMultiplier) ] - The value is one of the following data-type(s): {PT:Decimal | Enumeration (Unlimited) }.
The enumeration for the Unlimited is { unlimited }
Default value = "unlimited".

key | toc | top

"AlternativeRepresentations" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class AlternativeRepresentations.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->alternativeRepresentationType [1..*] Enumeration (AlternativeRepresentationType) - Permitted values are: { Audio | Video | Graphic | Text | Interactive }.

key | toc | top

"AuditoryBackground" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class AuditoryBackground.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "false".

key | toc | top

"BackgroundColour" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class BackgroundColour.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->colour [0..1] PT:HexBinary - -

key | toc | top

"Breaks" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Breaks.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".

key | toc | top

"Chunking" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Chunking.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"CognitiveGuidance" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class CognitiveGuidance.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"ColourOverlay" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class ColourOverlay.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "false".
3
->colour [0..1] PT:HexBinary - -

key | toc | top

"Encouragement" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Encouragement.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->actvateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
-[[ Abstract ]]- [1..*] -[[ Selection ]]- - In the model this abstract class is named: EncouragementSelection
3.1
->textMessageString XOR [1..*] PT:NormalizedString - -
3.2
->soundFileHref XOR [1..*] PT:AnyURI - -

key | toc | top

"ForegroundColour" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class ForegroundColour.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->colour [0..1] PT:HexBinary - -

key | toc | top

"IncreasedWhiteSpacing" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class IncreasedWhiteSpacing.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->increasedWhiteSpacingType [0..1] IncreasedWhiteSpacingType (Sequence) - -

key | toc | top

"IncreasedWhiteSpacingType" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class IncreasedWhiteSpacingType.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->Line [1] PT:Boolean - -
2
->Word [1] PT:Boolean - -
3
->Character [1] PT:Boolean - -

key | toc | top

"InvertColourChoice" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class InvertColourChoice.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"ItemTranslationDisplay" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class ItemTranslationDisplay.Type - N/A - -[[ Sequence ]]- - - N/A -
a
->@language [1] PT:Language - -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"KeywordEmphasis" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class KeywordEmphasis.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"KeywordTranslations" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class KeywordTranslations.Type - N/A - -[[ Sequence ]]- - - N/A -
a
->@language [1] PT:Language - -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"LanguageLearner" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class LanguageLearner.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"LineReader" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class LineReader.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "false".
3
->colour [0..1] PT:HexBinary - -

key | toc | top

"Magnification" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Magnification.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"Masking" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Masking.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "false".
3
->maskingType [ 1 .. 2 ] Enumeration (MaskingType) - Permitted values are: { CustomMask | AnswerMask }.

key | toc | top

"NegativesRemoved" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class NegativesRemoved.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"ReducedAnswers" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class ReducedAnswers.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"Scaffolding" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Scaffolding.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"Signing" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Signing.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->signingType [1] Enumeration (SigningType) - Permitted values are: { ASL | SignedEnglish }.

key | toc | top

"SimplifiedLanguage" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class SimplifiedLanguage.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".

key | toc | top

"Spoken" Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Spoken.Type - N/A - -[[ Sequence ]]- - - N/A -
1
->assignedSupport [1] AssignedSupport (DerivedType) - Default value = "true".
2
->activateByDefault [1] ActivateByDefault (DerivedType) - Default value = "true".
3
->spokenSourcePreference [1] Enumeration (SpokenSourceType) - Permitted values are: { Human | Synthetic }.
Default value = "Human".
4
->readAtStartPreference [1] PT:Boolean - Default value = "true".
5
->userSpokenPreference [0..1] Enumeration (SpokenPreference) - Permitted values are: { TextOnly | GraphicsOnly | TextGraphics | NonVisual }.
Default value = "TextOnly".
6
->directionsOnly [0..1] PT:Boolean - Default value = "false".

key | toc | top

Abstract Class Checklists

The set of abstract classes defined in the data model.

"EncouragementSelection" Abstract Class Checklist

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class EncouragementSelection - N/A - -[[ Selection ]]- - - N/A -
1
->textMessageString XOR [1..*] PT:NormalizedString - -
2
->soundFileHref XOR [1..*] PT:AnyURI - -

key | toc | top

Derived Data-Type Checklists

This is the definition of the set of derived data-types used in this specification and its associated profiles. In the cases where the named child elements are "pattern", "whiteSpace", "minLength", "minInclusive", "maxInclusive" or "maxLength" then these are used to constrain the value of the parent and will not occur as child elements in an instance.

"Decimal" Derived Class Checklists

Identifier Element/Attribute Name Multiplicity Data Type Profile Notes
Class Decimal.Type - N/A - PT:Decimal - - N/A -
1
->minInclusive [1] PT:Decimal - Default value = "0.0".
2
->maxInclusive [1] PT:Decimal - Default value = "10.0".

key | toc | top

Primitive Data-Type Definitions

This is the definition of the set of primitive data-types used in this specification and its associated profiles.

Data-type Name Description
AnyURI This is mapped to the XML "xs:anyURI" data-type.
Boolean This is mapped to the XML "xs:boolean" data-type.
Decimal This is mapped to the XML "xs:decimal" data-type.
HexBinary This is mapped to the XML "xs:hexBinary" data-type.
Language This is mapped to the "xml:language" structure. This is used to indicate the associated language.
NormalizedString This is mapped to the XML "xs:normalizedString" data-type.
String This is mapped to the XML "xs:string" data-type.

key | toc | top

Schematron Rules Definitions

This is the set of schematron rules used to improve validation of the XSD.

Unordered Schematron Rules

This is the set of schematron rules used to enforce the uniqueness features of the "unordered" stereotype.

Class Name (Unordered Stereotype) Profile
APIPContent.Type -
APIPControl.Type -
APIPDisplay.Type -
APIPScreenEnhancement.Type -

key | toc | top