IMS GLC IWB/CFF Conformance Document
Version 1.0 Final Specification
Date Issued: 1 February 2012
Latest version: http://www.imsglobal.org/iwbcff/
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 © 2012 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/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 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.
Join the discussion and post comments in the IWB/CFF Public Forum: http://www.imsglobal.org/community/forum/categories.cfm?catid=145&entercat=y
Table of Contents
2.1 Requirements for IWB/CFF Conformance
2.2.1 Testing Process for IWB/CFF Files
2.2.2 Scope of IWB/CFF File Tests
2.2.3 Limitations of IWB/CFF Testing
2.2.4 IWB/CFF Conformance Mark
2.3.1 Testing Process for IWB/CFF Readers
1 Introduction
The Interactive WhiteBoard/Common File Format (IWB/CFF) specification contains a file format that can be used to increase interoperability of file exchange between whiteboard applications. The file format will hold content primarily designed to be viewed on a large display. Much of this content will be designed to be interactive, so objects can move around the page.
The primary goal of this format is to establish a format that can be opened, edited, saved and used across many whiteboard applications so that teaching content can be exchanged between establishments. To this goal the format must be simple but extendible in a restricted way to ensure compatibility.
1.1 Scope
The primary purpose of this document is to provide information on how to test and achieve conformance to the IWB/CFF specification.
1.2 Nomenclature
File This is the actual file on a computer.
Document This is the collection of one or more pages available in a file.
Page This is where any elements are placed.
Slide This is the area on a page that should primarily be shown on a whiteboard, it is defined with the viewbox attribute.
Elements These are the objects which appear on a page.
Reader The application that is opening the file to display it.
Writer The application that is saving the file, either the first creation or by resaving an existing file.
SVG Scalar Vector Graphics format.
SVGT SVG Tiny specification.
Paint server This is an SVG term for filling objects with things such as gradients or patterns. The IWB format only allows filling with a solid color.
1.3 References
XML 1.0 http://www.w3.org/TR/REC-xml/
SVG 1.1 http://www.w3.org/TR/SVG11/
SVG 1.2 (draft) http://www.w3.org/TR/2004/WD-SVG12-20041027/
SVG Tiny 1.2 (draft) http://www.w3.org/TR/SVGMobile12/
CSS2 http://www.w3.org/TR/REC-CSS2/cover.html
2 Conformance
IMS Interactive WhiteBoard/Common File Format (IWB/CFF) conformance enables the interoperability of the packaging, delivery and display of interactive whiteboard content.
Conformance can be achieved at the IWB/CFF file level or at the Reader level. The IWB/CFF file refers to the file that contains content to be displayed in a whiteboard. The Reader refers to the hardware playing the IWB/CFF file.
There are different processes to achieve conformance based on whether an IWB/CFF file is being tested or an IWB/CFF Reader is being tested. Details on each are below.
2.1 Requirements for IWB/CFF Conformance
The following functionality, tags, and attributes are required for conformance.
Table 2.1 IWB/CFF Conformance requirement details.
|
Item |
Attribute |
Mandatory |
|
.iwb filename extension |
|
Yes |
|
Content.xml file required |
|
Yes |
|
IWB namespace required |
|
Yes |
|
SVG namespace required |
|
Yes |
|
XLINK namespace required |
|
Yes |
|
Tag |
||
|
element |
background |
Yes |
|
|
flip |
Yes |
|
|
locked |
Yes |
|
group |
|
Yes |
|
iwb |
|
Yes |
|
|
version |
Yes |
|
|
xmlns |
Yes |
|
|
xmlns:svg |
Yes |
|
|
xmlns:xlink |
Yes |
|
|
xmlns:xsi |
Yes |
|
|
xsi:schemaLocation |
Yes |
|
link |
|
Yes |
|
meta |
|
Yes |
|
tspan |
|
Yes |
|
|
Type |
Yes |
|
svg:a |
|
Yes |
|
|
xlink:href |
Yes |
|
|
xlink:href=”*.wav” |
Yes |
|
|
xlink:href=”*.mp3” |
Yes |
|
svg:circle |
|
Yes |
|
|
fill |
Yes |
|
|
fill-opacity |
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:ellipse |
|
Yes |
|
|
fill |
Yes |
|
|
fill-opacity |
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:g |
|
Yes |
|
|
fill |
Yes |
|
|
fill-opacity |
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:image |
|
Yes |
|
|
xlink:href=”*.jpg” |
Yes |
|
|
xlink:href=”*.bmp” |
Yes |
|
|
xlink:href=”*.gif” |
Yes |
|
|
xlink:href=”*.png” |
Yes |
|
|
requiredExtension |
Yes |
|
|
transform |
Yes |
|
svg:line |
|
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:video |
|
Yes |
|
|
xlink:href=”*.mpeg” |
Yes |
|
|
requiredExtension |
Yes |
|
|
transform |
Yes |
|
svg:page |
|
Yes |
|
svg:pageset |
|
Yes |
|
svg:polygon |
|
Yes |
|
|
fill |
Yes |
|
|
fill-opacity |
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:polyline |
|
Yes |
|
|
Stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:rect |
|
Yes |
|
|
fill |
Yes |
|
|
fill-opacity |
Yes |
|
|
stroke |
Yes |
|
|
stroke-width |
Yes |
|
|
transform |
Yes |
|
svg:svg |
|
Yes |
|
|
viewbox |
Yes |
|
svg:switch |
|
Yes |
|
svg:tbreak |
|
Yes |
|
svg:text |
|
Yes |
|
|
fill |
Yes |
|
|
font-family |
Yes |
|
|
font-size |
Yes |
|
|
font-style |
Yes |
|
|
font-weight |
Yes |
|
|
transform |
Yes |
|
svg:textarea |
|
Yes |
|
|
fill |
Yes |
|
|
font-family |
Yes |
|
|
font-size |
Yes |
|
|
font-style |
Yes |
|
|
font-weight |
Yes |
|
|
text-align |
Yes |
|
|
transform |
Yes |
|
svg:tspan |
|
Yes |
|
|
fill |
Yes |
|
|
font-family |
Yes |
|
|
font-size |
Yes |
|
|
font-style |
Yes |
|
|
font-weight |
Yes |
|
|
text-align |
Yes |
2.2 IWB/CFF Files
To be deemed to comply with the IWB/CFF specification, an iwb file must:
- Successfully validate against the IWB/CFF online validator.
- Satisfy all of the additional mandatory constraints.
2.2.1 Testing Process for IWB/CFF Files
- Access the online validator (http://validator.imsglobal.org/iwb/) if you are testing a iwb/cff file. Choose which profile you would like to test against – IWB v1.0.
- Upload your file and the test will run.
- When you have tested your file and are ready to apply for conformance, go to the conformance validator ( http://www.imsglobal.org/developers/iwbcffalliance/conformancevalidator.cfm ) which will gather some data to make applying for conformance very easy.
- You will be taken to the online validator. Upload your file. Choose which profile you would like to test against – IWB v1.0.
- Once the test is complete, click on the link that says Apply for Conformance.
- Your file test results will be posted in the form. Fill out the remaining data and click submit.
- You will be contacted and may then apply the appropriate conformance mark to the product identified.
2.2.2 Scope of IWB/CFF File Tests
IMS provides an online IWB/CFF validation tool. The tool is located at: http://validator.imsglobal.org/iwb /
This test system is made available free-of-charge so that you can perform your own testing of IWB/CFF files for conformance with the IMS IWB/CFF v1.0 specification.
The validator will:
- Test unzipping the file.
- Test correctness and completeness of references in content.xml.
- Do XML validation of all XML files in the cartridge using namespaces for which profiles are defined in the IWB/CFF spec.
- Report XML files in the IWB file which were not checked (either since they did not concern IWB/CFF or the namespace given was incorrect).
- Do Schematron validation of the content.xml file to enforce additional constraints not enforced through XML Schema validation alone.
2.2.3 Limitations of IWB/CFF Testing
- The testing tool will ensure the presence of appropriate media files for a learning application resource (e.g., mpg, jpg), but not verify their internal structure.
- The testing tool will not apply run-time tests to the IWB/CFF file content.
2.2.4 IWB/CFF Conformance Mark
After you have submitted your successful conformance information to conformance@imsglobal.org , you may then apply the appropriate conformance mark. The IWB/CFF Conformance Chart will list your conformance details. If you have any questions, please feel free to contact us at any point.
Membership in the Interactive WhiteBoard/ Common File Format Alliance is the only way to achieve official conformance to the IWB/CFF standard. Products without a Conformance Registration Number are not considered to be compliant by IMS GLC.
2.3 IWB/CFF Readers
To be deemed to comply with the IWB/CFF specification, IWB/CFF Readers must:
- Successfully import and play the valid test data IWB/CFF files.
- Satisfy all of the additional mandatory constraints.
2.3.1 Testing Process for IWB/CFF Readers
- Download the valid test data set of IWB/CFF files.
- Import all of the test IWB/CFF files into your product.
- Ensure that the IWB/CFF files display properly and all functionality is working.
- Upon satisfactory completion of the above test, email conformance@imsglobal.org stating:
— the date that testing was completed,
— the product tested (and version number),
— the conformance established (e.g. IWB/CFF v1.0),
— indicate that you have achieved conformance for a IWB/CFF reader tool.
- You will be contacted and then you may apply the appropriate conformance mark to the product identified.
2.4 Test Data Set
A test data set of IWB/CFF files is available to members of the IWB/CFF Alliance to enable self-testing of platforms for IWB/CFF compliance. The test data set is comprised of a set of valid IWB/CFF files that support all of the required features of IWB/CFF:
- Valid cartridges which exercise the scope of the features supported in IWB/CFF.
Implementers requiring access to the test data set should visit: http://www.imsglobal.org/IWBCFF/alliance.html
About This Document
Title: IMS GLC IWB/CFF Conformance Document
Editor: Lisa Mattson (IMS GLC)
Version: 1.0
Version Date: 1 February 2012
Release: 1.0
Status: Final Release
Summary: This document describes the conformance requirements for the IWB/CFF specification.
Purpose: This document is made available for adoption by the IMS community and general public.
Document Location: Join the discussion and post comments in the IWB/CFF Public Forum: http://www.imsglobal.org/community/forum/categories.cfm?catid=145&entercat=y
List of Contributors
The following individuals contributed to the development of this document:
Name Organization
Dinesh Advani SMART Technologies
Thor Anderson Utah Valley University
Martin Hall Lightbox Education
Lisa Mattson IMS Global Learning Consortium
Jordan Meyerowitz SMART Technologies
Jitu Patel TeamBoard
Colin Smythe IMS Global Learning Consortium
Mary Waller TeamBoard
Revision History
|
Version No. |
Release Date |
Comments |
|
Public Draft v1.0 |
7 December 2011 |
This draft is submitted to the IMS community for public review and comment. |
|
Final Release v1.0 |
1 February 2012 |
This specification is formally approved by IMS GLC for adoption and conformance. |
|
|
|
|
IMS Global
Learning Consortium, Inc. ("IMS GLC") is publishing the
information contained in this IMS GLC IWB/CFF Conformance
Document ("Specification") for purposes of scientific,
experimental, and scholarly collaboration
only.
IMS GLC 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.
IMS GLC
would appreciate receiving your comments and
suggestions.
Please contact IMS GLC through
our website at http://www.imsglobal.org
Please refer to Document Name: IMS GLC CFF/IWB
Conformance Document Revision: 1 February 2012