1EdTech Content Packaging Summary of Changes Version 1.1.4 Final Specification |
Copyright © 2004 1EdTech Consortium, Inc. All Rights Reserved.
The 1EdTech Logo is a registered trademark of 1EdTech Consortium, Inc.
Document Name: 1EdTech Content Packaging Summary of Changes
Revision: 04 October 2004
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.
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.
Copyright © 2004 1EdTech Consortium. All Rights Reserved.
Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.
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/license.html.
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.
Table of Contents
1. Introduction
1.1 Content Packaging Overview
1.2 Scope and Context
1.3 Structure of this Document
1.4 Nomenclature
1.5 References
2. Amendments and Errata Instructions
2.1 Namespacing of 'xml:lang'
2.1.1 Reference to CP Issues List
2.1.2 Information Model Changes
2.1.3 XML Binding Changes
2.1.4 Best Practice Changes
2.2 Conflicting Information on <organizations>
2.2.1 Reference to CP Issues List
2.2.2 Information Model Changes
2.2.3 XML Binding Changes
2.2.4 Best Practice Changes
2.3 Clarification on the Order of Elements in a Manifest
2.3.1 Reference to CP Issues List
2.3.2 Information Model Changes
2.3.3 XML Binding Changes
2.3.4 Best Practice Changes
2.4 Typographic Correction in Best Practice Guide
2.4.1 Reference to CP Issues List
2.4.2 Information Model Changes
2.4.3 XML Binding Changes
2.4.4 Best Practice Changes
2.5 Remove Reference to the <variation> Element
2.5.1 Reference to CP Issues List
2.5.2 Information Model Changes
2.5.3 XML Binding Changes
2.5.4 Best Practice Changes
2.6 Correction for Online Validation of the Examples
2.6.1 Reference to CP Issues List
2.6.2 Information Model Changes
2.6.3 XML Binding Changes
2.6.4 Best Practice Changes
2.7 Clarification on the Length of the 'href' Attribute String
2.7.1 Reference to CP Issues List
2.7.2 Information Model Changes
2.7.3 XML Binding Changes
2.7.4 Best Practice Changes
2.8 Clarification on the Usage of External Meta-data
2.8.1 Reference to CP Issues List
2.8.2 Information Model Changes
2.8.3 XML Binding Changes
2.8.4 Best Practice Changes
2.9 Scoping of Meta-data in a Content Package
2.9.1 Reference to CP Issues List
2.9.2 Information Model Changes
2.9.3 XML Binding Changes
2.9.4 Best Practice Changes
2.10 Correction of the Parameter Construction Algorithm
2.10.1 Reference to CP Issues List
2.10.2 Information Model Changes
2.10.3 XML Binding Changes
2.10.4 Best Practice Changes
2.11 Usage of Local and Remote XSDs for Instance Validation
2.11.1 Reference to CP Issues List
2.11.2 Information Model Changes
2.11.3 XML Binding Changes
2.11.4 Best Practice Changes
2.12 The Usage of 'xml:base' in Sub-manifests
2.12.1 Reference to CP Issues List
2.12.2 Information Model Changes
2.12.3 XML Binding Changes
2.12.4 Best Practice Changes
2.13 Improved Guidance on Merging Sub-manifests
2.13.1 Reference to CP Issues List
2.13.2 Information Model Changes
2.13.3 XML Binding Changes
2.13.4 Best Practice Changes
2.14 Clarification on the Default Attribute of the <organizations>
Element
2.14.1 Reference to CP Issues List
2.14.2 Information Model Changes
2.14.3 XML Binding Changes
2.14.4 Best Practice Changes
2.15 Sub-manifest Referencing Using the <dependency> Element
2.15.1 Reference to CP Issues List
2.15.2 Information Model Changes
2.15.3 XML Binding Changes
2.15.4 Best Practice Changes
2.16 Correction of the Item Element Multiplicity
2.16.1 Reference to CP Issues List
2.16.2 Information Model Changes
2.16.3 XML Binding Changes
2.16.4 Best Practice Changes
2.17 Declaring All Files in a Package's Manifest
2.17.1 Reference to CP Issues List
2.17.2 Information Model Changes
2.17.3 XML Binding Changes
2.17.4 Best Practice Changes
2.18 Removing References to Physical Files
2.18.1 Reference to CP Issues List
2.18.2 Information Model Changes
2.18.3 XML Binding Changes
2.18.4 Best Practice Changes
2.19 Miscellaneous Changes
2.19.1 Information Model
2.19.2 XML Binding
2.19.3 Best Practice Guide
3. Deliverables
Appendix A - The Initial Issues
About This Document
List of Contributors
Revision History
Index
1. Introduction
1.1 Content Packaging Overview
The 1EdTech Content Packaging specification describes data structures, XML binding and accompanying best practices that are used to provide interoperability for Internet based content with content creation tools, learning management systems (LMS), and run time environments. The scope of the 1EdTech Content Packaging specification is focused on defining interoperability between systems that wish to import, export, aggregate, and disaggregate Packages of content.
At the current time it is version 1.1.3 of the Content Packaging specification that is available in the Final Release form to the public. This was released in June 2003. In March 2004 a further maintenance review cycle for Content Packaging was started. This document describes the editorial amendments and errata corrections for the creation of the v1.1.4 maintenance release.
1.2 Scope and Context
This document describes amendments that should be made by adopters of the 1EdTech Content Packaging specification v1.1.3, thereby creating the 1EdTech Content Packaging v1.1.4 specification. Many typographical and elaborative changes were made to clarify and correct the supporting documents. The substantive differences between the v1.1.3 and the v1.1.4 specifications are limited to:
- Name-spacing of 'xml:lang' - ensure that the 'xml:lang' attribute is used instead of the 'x:lang' attribute and that the associated namespacing and schema location is correctly identified in the XSD;
- Conflicting information on <organizations> - confirm that the <organizations> element must occur once in a manifest;
- Clarification on the order of elements in a manifest - state that the XML Binding imposes the implied order described in the Information Model;
- Typographic corrections in the best practice document - editorial correction for one of the examples demonstrating the usage of the 'isvisible' attribute;
- Removal of reference to the <variation> element - ensure that there are no reference to the <variation> element;
- Correction for online validation of the examples - amend the examples to ensure that the online validation works correctly;
- Clarification on the length for the string contained in the 'href' attribute - clarify the interaction of the 'href' and 'xml:base' attributes and the consequence on the maximum length of the HRef created;
- Clarification on the usage of external meta-data in Best Practice Guide - state that the support for external meta-data requires the usage of an extension;
- Placing and scope of meta-data with a content package - state that the aggregation etc. of the different sets of meta-data within a content package is an implementation independent feature;
- The normative parameter construction algorithm is not complete - correction of the algorithm that uses parameters to create an HRef;
- Clarification on the usage of local and remote XSDs for instance validation - explain which XML control files need to be placed in the root of the content package;
- Explain how 'xml:base' should be used in sub-manifests - clarify the usage of the 'xml:base' attribute with sub-mainfests;
- More guidance or requirements are needed to explain sub-manifest merging process - provide guidance on how sub-manifests can be merged;
- Clarification on the use of the default attribute on the <organizations> element - state that the default attribute must point to a direct child <organization> in the manifest;
- Sub-manifest referencing using the <dependency> element - state that this element cannot point to something in a sub-manifest;
- Item element multiplicity is not the same in the Information Model and Binding documents - ensure that the <item> element multiplicity is consistently defined in the Information Model and the XML Binding and XSD.
- Correcting the diagrams in the Information Model and Best Practice that reference "physical files".
1.3 Structure of this Document
The structure of this document is:
1.4 Nomenclature
1.5 References
2. Amendments and Errata Instructions
2.1 Namespacing of 'xml:lang'
2.1.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-24 | Inconsistent name-spacing using xml:lang and x:lang. |
2.1.2 Information Model Changes
2.1.3 XML Binding Changes
2.1.4 Best Practice Changes
2.2 Conflicting Information on <organizations>
2.2.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-41 | Conflicting information describing the <organizations> element. |
2.2.2 Information Model Changes
2.2.3 XML Binding Changes
2.2.4 Best Practice Changes
2.3 Clarification on the Order of Elements in a Manifest
2.3.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-47 | Clarification on the Order of Elements in a Manifest. |
2.3.2 Information Model Changes
2.3.3 XML Binding Changes
2.3.4 Best Practice Changes
2.4 Typographic Correction in Best Practice Guide
2.4.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-50 | Typographic correction in Best Practice Guide (Section 4.10). |
2.4.2 Information Model Changes
2.4.3 XML Binding Changes
2.4.4 Best Practice Changes
Note: All the examples need to change "isVIsible" to "isvisible" and "True" and "False" to "true" and "false".
Amendment Instructions: | Best Practice Document. Change the last example in Section 4.10 |
2.5 Remove Reference to the <variation> Element
2.5.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-52 | Remove remaining references to the <variation> element. |
2.5.2 Information Model Changes
2.5.3 XML Binding Changes
Amendment Instructions: |
2.5.4 Best Practice Changes
Amendment Instructions: |
2.6 Correction for Online Validation of the Examples
2.6.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-54 | Online validation of examples doesn't work because the 'xsi:schemaLocation' recommendation in the Best Practice document has not been followed. |
2.6.2 Information Model Changes
2.6.3 XML Binding Changes
2.6.4 Best Practice Changes
2.7 Clarification on the Length of the 'href' Attribute String
2.7.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-69 | Clarification on the length for the string contained in the 'href' attribute. |
2.7.2 Information Model Changes
2.7.3 XML Binding Changes
2.7.4 Best Practice Changes
2.8 Clarification on the Usage of External Meta-data
2.8.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-48 | Clarification on the usage of external meta-data in Best Practice Guide. |
2.8.2 Information Model Changes
2.8.3 XML Binding Changes
2.8.4 Best Practice Changes
2.9 Scoping of Meta-data in a Content Package
2.9.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-89 | Placing and scope of meta-data with a content package. |
Note: There are dozens of places in all the documents where meta-data is referenced. These have been updated in accordance with the below statements.
2.9.2 Information Model Changes
2.9.3 XML Binding Changes
2.9.4 Best Practice Changes
2.10 Correction of the Parameter Construction Algorithm
2.10.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-53 | The normative parameter construction algorithm is not complete. |
2.10.2 Information Model Changes
2.10.3 XML Binding Changes
2.10.4 Best Practice Changes
2.11 Usage of Local and Remote XSDs for Instance Validation
2.11.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-57 | Clarification on the usage of local and remote XSDs for instance validation. |
2.11.2 Information Model Changes
2.11.3 XML Binding Changes
2.11.4 Best Practice Changes
2.12 The Usage of 'xml:base' in Sub-manifests
2.12.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-58 | How should 'xml:base' be used in sub-manifests? |
2.12.2 Information Model Changes
2.12.3 XML Binding Changes
2.12.4 Best Practice Changes
2.13 Improved Guidance on Merging Sub-manifests
2.13.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-59 | More guidance or requirements are needed to explain sub-manifest merging process. |
2.13.2 Information Model Changes
2.13.3 XML Binding Changes
2.13.4 Best Practice Changes
2.14 Clarification on the Default Attribute of the <organizations> Element
2.14.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-60 | Clarification on the use of the default attribute on the <organizations> element. |
2.14.2 Information Model Changes
2.14.3 XML Binding Changes
2.14.4 Best Practice Changes
2.15 Sub-manifest Referencing Using the <dependency> Element
2.15.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-70 | Sub-manifest referencing using the <dependency> element. |
2.15.2 Information Model Changes
2.15.3 XML Binding Changes
2.15.4 Best Practice Changes
2.16 Correction of the Item Element Multiplicity
2.16.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-158 | Item element multiplicity is not the same in the Info Model and Binding documents. |
2.16.2 Information Model Changes
2.16.3 XML Binding Changes
Amendment Instructions: |
XML Binding Document. Change the XSD so that the <item> multiplicity in an <organization> is one or more times. |
2.16.4 Best Practice Changes
2.17 Declaring All Files in a Package's Manifest
2.17.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-161 | 'Extra files' in a Manifest. |
2.17.2 Information Model Changes
2.17.3 XML Binding Changes
2.17.4 Best Practice Changes
2.18 Removing References to Physical Files
2.18.1 Reference to CP Issues List
Identifier | Issue |
---|---|
CP113-301 | Fix the Info Model basic diagram. |
2.18.2 Information Model Changes
Amendment Instructions: | Information Model Document Figure 3.1 |
2.18.3 XML Binding Changes
2.18.4 Best Practice Changes
Amendment Instructions: | Best Practice Document Figure 3.1 |
Figure 3.2 |
|
Figure 4.1 |
2.19 Miscellaneous Changes
2.19.1 Information Model
The following changes were also made to the Information Model document:
- Update the 'Front Page';
- Update the 'Table of Contents';
- Update the 'Introduction';
- Update the 'About This Document';
- Update the 'List of Contributors';
- Update the 'Revision History';
- Update the 'Index'.
2.19.2 XML Binding
The following changes were also made to the XML Binding document:
- Update the 'Front Page';
- Update the 'Table of Contents';
- Update the 'Introduction';
- Update the 'About This Document';
- Update the 'List of Contributors';
- Update the 'Revision History';
- Update the 'Index'.
2.19.3 Best Practice Guide
The following changes were also made to the Best Practice Guide document:
- Update the 'Front Page';
- Update the 'Table of Contents';
- Update the 'Introduction';
- Update the 'About This Document';
- Update the 'List of Contributors';
- Update the 'Revision History';
- Update the 'Index';
- Remove Appendix D;
- Add a new Appendix D that list the set of outstanding issues to be addressed in later versions.
3. Deliverables
The set of deliverables to be issued as the 1EdTech Content Packaging v1.1.4 specification and documentation set is:
- 1EdTech Content Packaging: Summary of Changes, Version 1.1.4 (this document);
- 1EdTech Content Packaging Information Model, Version 1.1.4;
- 1EdTech Content Packaging XML Binding, Version 1.1.4;
- 1EdTech Content Packaging Best Practice and Implementation Guide, Version 1.1.4;
- 1EdTech Content Packaging v1.1.4 XSD;
- 1EdTech Content Packaging v1.1.4 Examples set.
Appendix A - The Initial Issues
In Table A1 is the list of original issues that were reviewed as part of the maintenance process. There are four possible states for the issue:
- Resolve - the resolution of this issue has been addressed in this document;
- Reject - the issue has been considered and rejected due to various reasons e.g. a wrongly identified fault;
- Duplicate - this issue is a duplicate of another in the list. An associated note identifies the other entry;
- Defer - this issue can only be resolved by the addition of new functionality or making changes that will cause problems with backwards compatibility. These issues will be considered as a part of a CP v1.2 development.
Issue Identifier | Review Status | Comment |
---|---|---|
CP113-24 | Resolved | Inconsistent namespacing using 'xml:lang' and 'x:lang'. Action: See sub-section 2.1 of this document. |
CP113-25 | Reject | Incorrect numbering of elements in the Information Model tabular description. Action: Resolved as part of the CP v1.1.3 maintenance. |
CP113-41 | Resolved | Conflicting information describing the <organizations> element. Action: See sub-section 2.2 of this document. |
CP113-47 | Resolved | Clarification on the Order of Elements in a Manifest. Action: See sub-section 2.3 of this document. |
CP113-48 | Resolved | Clarification on the usage of external meta-data in Best Practice Guide. Action: See sub-section 2.8 of this document. |
CP113-49 | Defer | Using URNs as identifiers or use PLIDs instead of xs:ID. Action: Resolve as part of CP v1.2. |
CP113-50 | Resolved | Typographic correction in Best Practice Guide (Section 4.10). Action: See sub-section 2.4 of this document. |
CP113-51 | Defer | Clarification on the usage of the 'isvisible' attribute. Action: Resolve as part of CP v1.2. |
CP113-52 | Resolved | Remove remaining references to the <variation> element. Action: See sub-section 2.5 of this document. |
CP113-53 | Resolved | Encoding parameters in URLs and the normative parameter construction algorithm is not complete. Action: See sub-section 2.10 of this document. |
CP113-54 | Resolved | Online validation of examples doesn't work because the 'xsi:schemaLocation' recommendation in the Best Practice document has not been followed. Action: See sub-section 2.6 of this document. |
CP113-57 | Resolved | Clarification on the usage of local and remote XSDs for instance validation. Action: See sub-section 2.11 of this document. |
CP113-58 | Resolved | How should 'xml:base' be used in sub-manifests? Action: See sub-section 2.12 of this document. |
CP113-59 | Resolved | More guidance or requirements are needed to explain sub-manifest merging process. Action: See sub-section 2.13 of this document. |
CP113-60 | Resolved | Clarification on the use of the default attribute on the <organizations> element. Action: See sub-section 2.14 of this document. |
CP113-69 | Resolved | Clarification on the length for the string contained in the 'href' attribute. Action: See sub-section 2.7 of this document. |
CP113-70 | Resolved | Sub-manifest referencing using the <dependency> element. Action: See sub-section 2.15 of this document. |
CP113-71 | Duplicate | Action: This is a duplicate of CP113-53 (see CP113-53 for the detailed resolution. |
CP113-89 | Resolved | Placing and scope of meta-data with a content package. Action: See sub-section 2.9 of this document. |
CP113-158 | Resolved | Item element multiplicity is not the same in the Info Model and Binding documents. Action: See sub-section 2.16 of this document. |
About This Document
Title | 1EdTech Content Packaging Summary of Changes |
Editors | Colin Smythe (1EdTech), Alex Jackl (1EdTech), Wilbert Kraan (JISC) |
Version | 1.1.4 |
Version Date | 04 October 2004 |
Status | Final Specification |
Summary | This document presents the amendments and errata corrections that are to be made to the 1EdTech Content Packaging v1.1.3 specifications to create the v1.1.4 release. The scope of these corrections is limited to editorial changes and errata corrections. This document should be used in conjunction with the 1EdTech Content Packaging v1.1.4 specification documents. |
Revision Information | 04 October 2004 |
Purpose | This document has been approved by the 1EdTech Technical Board and is made available for adoption. |
Document Location | http://www.imsglobal.org/content/packaging/cpv1p1p4/imscp_sumcv1p1p4.html |
To register any comments or questions about this specification please visit: http://www.imsglobal.org/developers/ims/imsforum/categories.cfm?catid=5 |
List of Contributors
The following individuals contributed to the development of this document:
Revision History
Index
B
Best Practice Guide 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
Binding 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24
C
Catalog 1
Content Package 1, 2, 3, 4, 5
I
IEEE 1
1EdTech Specifications
Content Packaging 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25
Meta-Data 1
imsmanifest 1, 2
Information Model 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
Interoperability 1
isvisible 1, 2, 3
L
Learning 1
LMS 1, 2, 3
LOM 1
M
Manifest 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
Meta-data 1, 2, 3, 4, 5, 6
Language 1
Version 1
N
Namespace 1, 2
Namespacing 1
Normative 1, 2, 3
P
Package Interchange File 1
Profile 1
R
Resource 1, 2, 3
Resources 1, 2
RFC 1
run time environment 1
S
Schema 1, 2, 3
SCORM 1
Structure 1
sub-Manifest 1
X
XML 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
XSD 1, 2, 3, 4, 5, 6
XML Schema
DTD 1
1EdTech Consortium, Inc. ("1EdTech") is publishing the information contained in this 1EdTech Content Packaging Summary of Changes ("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: 1EdTech Content Packaging Summary of Changes Revision: 04 October 2004