Canadian Heritage
Symbol of the Government of Canada
Skip to content | Skip to institutional links

Common menu bar links

CHIN Home > Get Investment > Virtual Exhibits Investment Program > Manage Investment > Technical Requirements > Archive > Annex I - 1.3

Institutional links

chin.gc.ca

Virtual Museum of Canada (VMC) Virtual Exhibits Investment Program

Call 11 - Annex 1 - Technical Requirements for the Development of VMC Exhibits and Games, 1.3 (November 2005)

Note: For additional details on and explanations of the following technical requirements, as well as other recommendations and best practices, see the document, Technical Requirements and Recommendations for the Development of Virtual Museum of Canada (VMC) Exhibits and Games, 1.3[PDF].

Contents

1.0 Markup Languages and Scripts
Markup Languages
Client-Side Scripting
Character Encoding and Special Characters
2.0 Browsers and Plug-Ins
Browsers
Plug-In and Media Playing Software
Secure Sockets Layer (SSL)
3.0 Content Types and Format Standards
Text
Still Images
Video/Moving Images
Audio/Sound
Animations
Databases
4.0 File Directory Names and Structure
File and Directory Structure
File and Directory Names
5.0 Navigation and Layout
VMC Logo
Language Version Navigation
Pop-Up Window Navigation
Copyright
Credits
Feedback Mechanism
Site Map
Navigational Headers and Footers
Frames
6.0 Accessibility
W3C Web Content Accessibility Guidelines
7.0 Search Engine Optimization (SEO)
<Title> Element
<Meta> "Keywords" and "Description" Elements
8.0 Metadata (Dublin Core)
Creating Metadata Content
Implementing Metadata
9.0 Technical Requirements for CHIN-Hosted Content
CHIN Web Server Environment

1.0 Markup Languages and Scripts

Markup Languages

  1. The product must be developed for delivery to a Web browser in either the "Strict" or "Transitional" variant of either HyperText Markup Language (HTML) or Extensible HyperText Markup Language (XHTML) as recommended by the World Wide Web Consortium (W3C). Currently, these are HTML 4.01 and XHTML 1.0.

    Note: Use of the "Frameset" variant of either markup language is not permitted. Also, if using XHTML 1.0, it is important to understand the issues involved in serving XHTML as XML (MIME type "application/xhtml+xml") as opposed to HTML (MIME type "text/html"). For more on these issues, see the W3C's document, XHTML Media Types, as well as the W3C tutorial, Character sets & encodings in XHTML, HTML and CSS.

  2. The product and all of its pages must validate against a W3C-published Document Type Definition (DTD) for either the "Strict" or "Transitional" variant of either HTML 4.01 or XHTML 1.0, whichever markup language is used. The W3C Markup Validation Service will check both HTML and XHTML files for conformance to W3C recommendations and standards based on a specified DTD.

    Note: Validating against approved grammars as defined by formal DTDs also addresses checkpoint 3.2 of the W3C's Web Content Accessibility Guidelines 1.0, a checkpoint to which the product must conform. See 6.0 Accessibility.

  3. Cascading Style Sheets (CSS) used by the product must not be embedded or inline, but must be referenced as external files using the following code format:

    <link rel="stylesheet" type="text/css" href="Css/styles.css">

    Note: Replace "Css/styles.css" in the above example with the actual name and location of your CSS file. If using XHTML, make sure to properly close the <link> element, which is an empty element, by adding a space and trailing forward slash (/) before the closing angle bracket (>) in the <link> element, i.e.,

    <link rel="stylesheet" type="text/css" href="Css/styles.css" />

Client-Side Scripting

  1. Client-side scripts used by the product must be compliant with ECMAScript, version 3, also known as ECMA-262.

  2. Client-side scripts used by the product must be tested and functional using the Web browsers listed under 2.0 Browsers and Plug-Ins.

    Note: The key features of the product should function even when scripting is disabled in a browser. See 6.0 Accessibility, especially checkpoint 6.3.

  3. Client-side scripts used by the product must not be embedded within any page or object from which they are invoked. They must be placed in one or more external files that are referenced in the <head> section of the page, using the following code format:

    <script language="javascript" type="text/javascript" src="Scripts/script.js"></script>

    Note: Replace "Scripts/script.js" in the above example with the correct file name and path.


Character Encoding and Special Characters

  1. The product must use either UTF-8 or ISO-8859-1 character encoding. The encoding used must be declared within each of the product's Web pages.

    For HTML documents, and XHTML documents served as HTML (MIME type "text/html"), the encoding must be established through a <meta> element "charset" declaration placed as near as possible to the top of the <head> section of the Web page, for example,

    <meta http-equiv="Content-Type" content="text/html;charset=utf-8">

    For XHTML documents served as XML (MIME type "application/xhtml+xml"), the <meta> "charset" declaration should not be used. Instead, declare the character encoding in the XML declaration that must appear as the first line of every Web page served as XML:

    <?xml version="1.0" encoding="utf-8"?>

    Note: For a discussion of the issues with character encoding and serving (X)HTML documents, see the W3C tutorial, Character sets & encodings in XHTML, HTML and CSS.

  2. Use character entity references (e.g., "&lt;" for "<") or numerical character references (e.g., "&#60;" for "<") to express all special characters.


2.0 Browsers and Plug-Ins

Browsers

  1. The product must be viewable and fully functional in the following browsers for the Windows and Macintosh platforms:

    Windows
    • Microsoft Internet Explorer 5.01 and above;
    • Netscape Navigator 7.0 and above; and,
    • Firefox 1.0 and above.


    Macintosh
    • Microsoft Internet Explorer 5.1.7 and above;
    • Netscape Navigator 7.0 and above;
    • Firefox 1.0 and above; and,
    • Safari 1.0 and above.

    Note: The above list of browsers is current as of July 2005, but continually evolving and updated. Also please note that, in accordance with the requirements under 6.0 Accessibility, the product must be accessible over slow or dial-up Internet connections using browsers that do not display graphics or images, and thus should be tested and validated with a text-only browser or emulator.

  2. The use of browser-specific elements and/or technologies (e.g., Internet Explorer's <marquee> or Netscape Navigator's <blink> elements) is not permitted.


Plug-In and Media Playing Software

  1. Plug-in technologies must be platform-independent and supported by the Web browsers listed above under Browsers.

  2. If, in order to be viewed, the product requires a plug-in or special media playing software such as Apple's QuickTime Player, Microsoft's Windows Media Player, Macromedia's Flash Player, or Real's RealPlayer, a link to the source of the plug-in or software must be provided and be accessible from each of the product's unilingual main pages and/or from the page(s) on which the plug-in or software is needed to access the content.


Secure Sockets Layer (SSL)

  1. The product must use the Secure Sockets Layer (SSL) protocol when any personal information (including, but not limited to, name, address, age, email address, telephone number, and credit card number) is solicited from a user.

    Note: It is not necessary to use SSL when soliciting a user's nickname only, for example, to store a high score in an online game.



3.0 Content Types and Format Standards

Text

  1. Text-based content must be developed for delivery to a Web browser in either the "Strict" or "Transitional" variant of either HyperText Markup Language (HTML) or Extensible HyperText Markup Language (XHTML) as recommended by the World Wide Web Consortium (W3C). Currently, these are HTML 4.01 and XHTML 1.0.

    While all text-based content must be displayed as (X)HTML, such content can additionally be developed in a proprietary format for viewing or printing with the use of plug-in software freely available over the Internet. An example of this type of format is Adobe's PDF, which requires the use of the Adobe PDF viewer, Adobe Reader.

    Text-based content can also be delivered in formats such as RTF or ASCII, or as a delimited text file. Content produced in such formats is acceptable if the files are intended for download, storage or manipulation by users outside of the browser environment, and if they are not meant to be a substitute to content created in (X)HTML.

    Note: This requirement does not apply to text found within still images, moving images, video or animation files.


Still Images

  1. All graphics must be optimized and enhanced for the Web to reduce file size and download time:

    • In the case of line-drawn graphics, the use of GIF or PNG formats is required.
    • In the case of photographs, high resolution, and continuous tone images, the use of the JPEG (24-bit) format is required.
    • All links to large image files (i.e., files greater than 50 Kb) must carry a label that identifies the file size in order to alert users.


  2. Exemptions to the above requirements may be granted by CHIN in certain situations where the use of proprietary solutions is needed to meet project objectives. These solutions must allow the relevant content to be viewed or experienced at no charge, e.g., through the use of a freely-available plug-in or media player. A justification must be provided for the use of such technologies in the context of the project's objectives. This could be the case, for example, where geographic maps are being digitized. In such cases, specialized solutions could be chosen to provide users with greater flexibility in viewing the digitized objects.


Video/Moving Images

  1. Video and moving image files must be prepared in a format that can be played by a freely-available player such as Apple's QuickTime Player, Microsoft's Windows Media Player, Macromedia's Flash Player, or Real's RealPlayer. This includes the following commonly accepted formats:

    • AVI (.avi)
    • Flash (.swf, .flv)
    • MPEG (.mpg, .mpeg)
    • QuickTime (.mov)
    • RealVideo (.ram, .rm)
    • Shockwave/Director (.dcr)
    • Windows Media Video (.wmv)

    Please consult CHIN for approval if you intend to use another format.

  2. Video can be streamed or delivered as a file to be downloaded prior to viewing. If a video file is prepared for delivery in a high-bandwidth environment, an alternate low-bandwidth version must also be prepared and provided to users.

    Some streaming systems allow producers to prepare a single video file that can be played at various streaming speeds corresponding to multiple Internet access speeds. In cases where such systems are used, a single version of a video file is sufficient.

    Note: CHIN regularly contracts video streaming services from Akamai. If the product is to use streaming video, it may be possible for it to use this service. For more information, contact CHIN.

  3. Streamed video files that are loaded into a browser-embedded player must not start automatically, and the player must include controls for starting and stopping the video. This is to prevent large video files from being automatically streamed without the express permission or control of the user, especially in the case of slow or dial-up Internet connections.

  4. All links to large video files (i.e., files greater than 50 Kb) must be accompanied by a label indicating the file's size and duration.

  5. Where a codec is used to compress video file content, the codec must be included in a standard platform (such as the Apple, Real or Microsoft platforms) or be freely-available for installation by users. A link to the codec must be provided for users who need to download and install it.


Audio/Sound

  1. Sound or audio files must be prepared in a format that can be played by a freely-available player such as Apple's QuickTime Player, Microsoft's Windows Media Player, Macromedia's Flash Player, or Real's RealPlayer. This includes the following commonly accepted formats:

    • Flash (.swf)
    • MP3 (.mp3)
    • RealAudio (.ram, .rm)
    • WAV (.wav)
    • Windows Media Audio (.wma)

    Please consult CHIN for approval if you intend to use another format.

  2. Audio can be streamed or delivered as a file to download prior to listening. If an audio file is prepared for delivery in a high-bandwidth environment, an alternate low-bandwidth version must also be prepared and provided to users.

    Some streaming systems allow producers to prepare a single audio file than can be played at various streaming speeds corresponding to multiple Internet access speeds. In cases where such systems are used, a single version of an audio file is sufficient.

  3. Streamed audio files that are loaded into a browser-embedded player must not start automatically, and the player must include controls for starting and stopping the audio. This is to prevent large audio files from being automatically streamed without the express permission or control of the user, especially in the case of slow or dial-up Internet connections.

  4. All links to large audio files (i.e., files greater than 50 Kb) must be accompanied by a label indicating the file's size and duration.

  5. Where a codec is used to compress audio file content, it must be included in a standard platform (such as the Apple, Real or Microsoft platforms) or freely-available for installation by users. A link to the codec must be provided for users who need to download and install it.



Animations

  1. Animation files must be prepared in a format that can be played by all browsers listed under 2.0 Browsers and Plug-Ins or with the use of freely-available plug-in software. This includes the following commonly accepted formats:

    • Animated GIF (.gif)
    • Flash (.swf)
    • Shockwave/Director (.dcr)


    Please consult CHIN for approval if you intend to use another format.


Databases

  1. If the product employs a database and is to be hosted on CHIN's server, the database must use the MySQL Database Server database management system (DBMS).

    Note: See 9.0 Technical Requirements for CHIN-Hosted Content, for the latest version of MySQL in use on CHIN's server.

  2. If the product employs a database and is to be hosted on CHIN's server, the database must be documented in a data dictionary that includes a list of all database files, and the name, type, and description of each field. The documentation must also include a graphical schema of the database, as well as explanations of the major decisions behind the database's design and structure, normalization, etc. This documentation will serve several purposes, including the facilitation of possible migrations, data recovery and preservation, and allow others to better understand the database in the case of future maintenance and software updates.

  3. If the product employs a database and is to be hosted on CHIN's server, any information that is stored in the database and that indicates product usage must have an associated timestamp value for tracking and verification purposes.


4.0 File Directory Names and Structure

File and Directory Structure

  1. The product's top or root level directory, as well as all directories containing one or more Web page, must include a default page (e.g., index.html, default.html, index.php) that acts as the main page for that directory. See 5.0 Navigation and Layout for the navigational structure that these pages must incorporate.

  2. The product must include, within its top or root level directory, separate directories for each language version of the product. See 5.0 Navigation and Layout for the navigational structure that these pages must incorporate.

  3. Product files containing important content that is common to all language versions of the product (e.g., images, CSS, JavaScript) must be placed in unique directories located in the product's top or root level directory, and not be duplicated.

  4. Product files specific to a particular language version of the product must be located within that language version's directory.


File and Directory Names

  1. The product's file and directory name rules and conventions must be documented.

  2. All product directory and file names must use, to the greatest degree possible, recognized words, separated by hyphens (-) where necessary. The words should be meaningful, descriptive, intuitive to the institution and intended users, and use the language of the product version under consideration.

    For example, a directory name such as " ManitobaHistory " is not recognized as a word or phrase, but can be made so by separating the individual words with a hyphen, i.e., "Manitoba-History."

    Note: For products that are hosted on CHIN's server, the individual words in directory names must each begin with an upper-case letter, while file names must all be in lower-case. For example, "Manitoba-History" is a valid directory name, while "manitoba-history.html" is a valid file name.

  3. All of the product's (X)HTML files must use the ".html" extension, and not the ".htm" extension.



5.0 Navigation and Layout

VMC Logo

  1. The VMC logo, which will be provided by CHIN, must be present at the top right-hand corner of each product page, including pop-up windows. The VMC logo must be displayed without any image border. The following JavaScript references and (X)HTML code must be incorporated in the product.

    First, the product file needs to contain the following references to a JavaScript source file:

    English
    <script type="text/javascript" language="javascript" src="http://www.virtualmuseum.ca/Logo_Script/english.js"></script>

    French
    <script type="text/javascript" language="javascript" src="http://www.museevirtuel.ca/Logo_Script/francais.js"></script>

    Second, the following (X)HTML code must be used to load the logo with the proper target:

    English
    <a href="http://www.virtualmuseum.ca" onclick="javascript:gotoVirtualMuseumofCanada(); return false;"><img src="Images/vmc_animated.gif" width="147" height="42" alt="Virtual Museum of Canada " title="See more of the Virtual Museum of Canada" /></a>

    French
    <a href="http://www.museevirtuel.ca" onclick="javascript:gotoVirtualMuseumofCanada(); return false;"><img src="Images/vmc_animated.gif" width="147" height="42" alt="Musée virtuel du Canada" title="Pour voir davantage du Musée virtuel du Canada" /></a>

    Note:Replace "Images/vmc_animated.gif," as well as the "width" and "height" attributes, in the above code with the proper name, location, and dimensions of the logo image file.


Language Version Navigation

  1. The default page (e.g., index.html, default.html, index.php) within the product's top or root level directory must act as the product's language selection "splash" or entrance page and include a link to each language version of the product.

  2. The main page for each language version of the product must have a link to the other language version(s). This link must be visible without scrolling the page.

  3. The default page (e.g., index.html, default.html, index.php) within the main directory for each language version of the product must act as the main entrance page for that language version, and include a link to each particular format of the product, e.g., Flash or (X)HTML, should they exist.


Pop-Up Window Navigation

  1. All pop-up windows must include a banner that:

    • identifies the pop-up window content as part of the product; and,
    • provides a link to the home or entrance page of the product's relevant language version.


Copyright

  1. The product must include, in the form of a separate Web page, a full copyright statement that identifies all rights holders.

  2. The copyright symbol, ©, the copyright holder and the year in which the product was launched, must appear on each product page and link to the full copyright statement (see F above), for example:

    © Museum of History 2005. All Rights Reserved.

    Note: If the institution holding the copyright is officially bilingual, use the institution's English name in the English version of the product, and the French institution name in the French version. If the institution is unilingual, use the same unilingual institution name in each language version.


Credits

  1. The product must have a "Credits" section that is linked to from the both the language selection "splash" page and each unilingual entrance page, and that acknowledges the financial participation of the Government of Canada as follows:

    English
    The [Name of Institution] gratefully acknowledges the financial investment by the Department of Canadian Heritage in the creation of this online presentation for the Virtual Museum of Canada.

    French
    Le [Nom de l'établissement] exprime sa reconnaissance au ministère du Patrimoine canadien pour son investissement financier dans la création de cette présentation en ligne dans le cadre du Musée virtuel du Canada.

  2. The "Credits" section must name and link to all institutional partners involved with the product.


Feedback Mechanism

  1. Each product page must include a link that allows for audience feedback. The feedback mechanism must be configured to also send an email to CHIN (vmccc@virtualmuseum.ca or mvccc@museevirtuel.ca) with a clear identification of the product in the subject line.

    CHIN will provide, upon request, a PERL script that can be used to create the required email feedback mechanism.

    Note: This does not alter the institution's responsibility for feedback as specified in clause 3.11 of the Agreement.

  2. Users must be advised that their feedback messages are also being forwarded to CHIN, and be provided with a link to the CHIN Privacy Policy statement pop-up window (see the example below). Alternatively, information that identifies the user could be stripped from the feedback.

    English Message Example
    Your comments will also be forwarded to the Canadian Heritage Information Network (CHIN), which has overall responsibility for the Virtual Museum of Canada, to be used as part of its audience research. Please see the CHIN Privacy Policy for more information.

    French Message Example
    Vos commentaires seront également acheminés au Réseau canadien d'information sur le patrimoine (RCIP), qui a la responsabilité globale du Musée virtuel du Canada. Ils seront utilisés à des fins de recherche sur le public. Veuillez consulter la Politique du RCIP sur la protection des renseignements personnels pour de plus amples renseignements.

    The following JavaScript references and (X)HTML code must be present to use the CHIN Privacy Policy statement pop-up window:

    English JavaScript Reference
    <script type="text/javascript" language="javascript" src="http://www.virtualmuseum.ca/Logo_Script/english.js"></script>

    English (X)HTML
    <a href="http://www.virtualmuseum.ca/English/Common/copyright.html#privacy" onclick="privPolicy(this.href,this.target,'...'); return false;">Link Goes Here</a>

    French JavaScript Reference
    <script type="text/javascript" language="javascript" src="http://www.museevirtuel.ca/Logo_Script/francais.js"></script>

    French (X)HTML
    <a href="http://www.museevirtuel.ca/Francais/Common/copyright.html#privacy" onclick="privPolicy(this.href,this.target,'...'); return false;">Link Goes Here</a>


Site Map

  1. Each language version of the product must include a Web page with a site map that uses text links, as opposed to graphical links or buttons.

  2. Each page of the product must include a text link to the site map in the appropriate language to help ensure that human users and search engines can find every page of the product.


Navigational Headers and Footers

  1. The use of corporate Web site navigation, such as headers or footers, is not permitted without CHIN's express approval.


Frames

  1. The use of frames is not permitted.


6.0 Accessibility

W3C Web Content Accessibility Guidelines

  1. The product must conform to Priority 1 and Priority 2 checkpoints (conformance level "Double-A") of the W3C's Web Content Accessibility Guidelines 1.0. If, for whatever reasons, compliance with the required checkpoints is not possible, a proposal for an alternate version of the product shall be submitted to CHIN for approval at its sole discretion.


7.0 Search Engine Optimization (SEO)

<Title> Element

  1. Each page of the product must include in its <head> section a <title> element containing a meaningful and keyword-rich title for that page's content. Each page must therefore have a <title> element unique to that page.


<Meta> "Keywords" and "Description" Elements

  1. Each product page must include in the <head> section a <meta> "keywords" element containing a list of keywords and keyphrases for that page's content. Each page must therefore have a <meta> "keywords" element unique to that page. Separating the keywords and keyphrases with commas is optional.

  2. Each product page must include in the <head> section a <meta> "description" element containing a meaningful and keyword-rich description of that page's content. Each page must therefore have a <meta> "description" element unique to that page.


8.0 Metadata (Dublin Core)

Creating Metadata Content

  1. Metadata content describing the product as a whole must be prepared for each of the product's language-specific entrance pages and include the following seven metadata elements from the Dublin Core Metadata Element Set, Version 1.1:

    • Title
    • Creator
    • Subject
    • Description
    • Date
    • Identifier
    • Language (where applicable)


Implementing Metadata

  1. All product metadata must be expressed in a standardized way that can be read, searched, and exchanged by computer systems.

    Metadata can be expressed in (X)HTML or RDF/XML (Resource Description Framework/Extensible Markup Language). Simple metadata, such as unqualified Dublin Core elements, can easily be expressed in (X)HTML. More complex metadata, such as qualified Dublin Core elements, can be expressed in (X)HTML, but with limitations. RDF/XML has been used more successfully for highly-structured, complex metadata.

    See the following documents for help with expressing metadata:



9.0 Technical Requirements for CHIN-Hosted Content

CHIN Web Server Environment

  1. Products to be hosted on CHIN's server must be developed for and in accordance with the following environment specifications:

    Server
    • UNIX - Sun Solaris 2.8
    • Apache 1.3.28
    • HTML pages require the ".html" suffix or extension.

    CGI and PERL
    • CGI scripts require the ".cgi" extension, and can be located anywhere in a project's directory structure of the project.
    • PERL 5.8 is enabled.
    • PERL and CGI scripts require the following "shebang" notation:

      #!/usr/local/bin/perl
      use strict;

    • Most standard PERL modules are available, for example, CGI, DBI.

    PHP
    • PHP 4.0.4 is enabled.
    • PHP scripts must use the ".php" extension.
    • PHP scripts can be located anywhere in the project's directory structure.
    • PHP access to MySQL is enabled.
    • PHP support for XML is enabled.
    • The addition of PHP extensions will be decided by CHIN on a case by case basis. If you are interested in using a particular PHP extension, enquire with CHIN.

    Server-Side Includes (SSI)
    Any HTML page with the ".html" suffix or extension and the execute bit set will be parsed for SSI.

    Database
    • MySQL 4.1
    • Access to the MySQL database management system (DBMS) is available upon request

    Note: Any information that is stored in a database and that indicates product usage must have an associated timestamp value for tracking and verification purposes.

Footer Links

Find out more about our member institutions

Subscription to E-Newsletter(s)

  • VMC Friends
  • VMC Teachers' Centre
  • CHIN
Subscribe

Date Modified: 2009-11-07

Top of Page

Important Notices

© CHIN 2009. All Rights Reserved. | v2.0