Where’s the Party At? – Installation Guide

Where’s the Party At?

Installation and Technical Guide

Table of Contents

Table of Contents

Background

Terminology

Installation

How do I install the toolbox on my server?

Server requirements

Hardware

Software

File structure

The directory structure

File naming conventions

Disaggregation

How can I deliver activities and/or units individually?

Using a learning management system

Customisation

Discussion tool customisation

Activities customisation

General XML customisation

True and false activities

Choose your path activities

Known issues

Accessing Word files

Old Browsers

Accessibility issues

Navigation

JavaScript

Flash

No mouse input

Screenreaders

Text Browsers

Minimum hardware/software requirements and installation advice for learners.

Hardware

Software

Background

Thislanguage, literacy and numeracy toolboxfor youthprovides online learning resources for the Certificate in General Education for Adults (CGEA). Much of the online material is customisable. The toolbox has been designed and developed to conform to W3C Priority 1 Accessibility Guidelines and makes use ofa HTML navigation system that enables access from the site map or the section menus.

Thislanguage, literacy and numeracytoolbox as released on the CD is a flexible learning resource that can be easily customised to suit individual learning needs and work environments.

The toolbox comes complete with its own internal navigation ready for installation onto a web server. The toolbox has been designed to incorporate online communication (email and Discussion board) tools and you will need to add the necessary links to your choice of communication tools.

The toolbox may also be incorporated into a learning management system such as WebCT, to make use of the system’s tools (eg. communication tools) and features.

It is recommended that you make a backup copy of the CD in case the original becomes lost or is damaged.

Terminology

Sections / e.g. bathroom, bedroom, lounge, kitchen
Sub-sections / e.g. Nick, Emma, Ben, Angie, Leyla
Topics / e.g. “Big butt”, “Friends”, “Rage party”
Activity / e.g. Flash, HTML or word document
Assessment / Are all downloadable word documents

Installation

How do I install the toolbox on my server?

To install the Toolbox on your server, follow these steps:

Insert the Toolbox CD-ROM into your CD-ROM drive.

Open a directory browser on your server computer and navigate to the drive that you inserted the CD into.

Either copy all the files and directories in the root directory of the CD-ROM to a nominated directory on your server, or

If you only wish to copy specific units or activities then refer to the section How can I deliver activities and/or topics individually? next.

There are no server side technologies utilised in this toolbox so it will not be necessary to configure anything extra to use the toolbox. After all the files are copied to the nominated directory on your server, it’s just a matter of opening a web browser and accessing the index.html page in the nominated directory.

If you rename any of the subdirectories, you will have to change the appropriate links in the content. Unless it is absolutely necessary that you do this, we’d recommend keeping the directory structure as is to prevent any errors from occurring.

If you have trouble accessing the Shockwave content in the toolbox, it may be necessary to set the appropriate mime type for Flash (application/x-shockwave-flash). This should not be necessary for most installations.

Server requirements

The necessary requirements to implement this toolbox on your server are as follow:

Hardware

This depends on user concurrency. The minimum would be:

-Pentium 200MHZ or Mac equivalent

-32MB RAM

-25 MB Hard Drive

This requirement scales up according to the number of concurrent users that will be accessing the application.

Software

-Windows, Linux or Mac OS

-No databases or server technologies are necessary

file structure

The directory structure

The folder structure of this toolbox is as follows:

The Root Directory
index.htm / Entry page for entire site.
/site/ / Folder with all the contentof this toolbox
/site/shared/ / All the shared content for the site. This directory should always be copied when disaggregating.
/site/shared/common / Common html pages that are used in many places of the site
/site/shared/flash / Common flash movies that are used in various places
/site/shared/images / All the images of the site are here
/site/shared/scripts / Common JavaScript libraries
/site/shared/styles / Common CSS styles

File naming conventions

The files in the /site/ directory have being named using the following convention:

- Hyphen / The hyphen indicates a sub level. The hierarchy is as follow:
Section-subsection-topic-activity
Example:
In “drugs-alc-01_know_it_all.htm”
-“Drugs” is the section
-“Alc” (Alcohol) is as sub section of Drugs
-“01_know_it_all” is a topic of Alcohol
_ Underscore / The underscore represent a space in the name of a file. For example:
drugs-alc-01_know_it_all.htm
“01_know_it_all” is just one topic “01 Know It All”
## Numbers / The numbers are used to show the correct sequence of the topics within a category (sub-section). For example:
drugs-alc-01_know_it_all.htm
drugs-alc-02_what_would_you_do.htm
-pu
Pop Up / The extension “-pu” in a file name indicates that this is a pop up window For example:
“sex-sex-01_sexfaqs-pu_act_f.htm” is a pop up that is called from “sex-sex-01_sexfaqs.htm”
_f
Flash / “_f” at the end of a file name denotes that this pages has a flash embedded object in it
_nf
Non Flash / “_nf” at the end of a file name indicates that this page is the non flash version of a flash page
~ / The “~” indicates that one file is linked to other. For example:
drugs-alc-02_what_would_you_do-pu_act_f.htm
drugs-alc-02_what_would_you_do-pu_act_f~data.xml
These two files are linked together, the parent file is the first one and the second is a complement to the first.
When copying files you should make sure that all the linked files are copied together. To make sure of this you should look for any file with the same file name and the “~” extension. These files are always together in the explorer window. For example (this is the most difficult example of the site):
When copying:
drugs-smk-01_smoke_haze-pu_int_quiz_f.htm
The following files should be copied as well:
drugs-smk-01_smoke_haze-pu_int_quiz_f~audio.swf
drugs-smk-01_smoke_haze-pu_int_quiz_f~data.xml

Disaggregation

How can I deliver sections, sub-sections, topics or select activities individually?

You can choose to install only select sections, sub-sections, topics or select activities from one topic on your server. It is important that you maintain the overall directory structure to make sure that links between pages remain functional.

Please refer to the Terminology section on this document to understand the terms Section, Sub-section and Topic.

To copy an entire section (for example DrugsAlcohol) / -Copy the room files: In this case all the files that start with “lounge”.
-Copy all the files that start with the section identifier: In this case “drugs”.
-Copy the “Shared” folder.
To copy an entire sub-section (for example Smoking) / -Copy all the files that start with: “drugs-smk”.
-Copy the “Shared” folder.
To copy an individual topic (for example “Smashed and Trashed” in Alcohol & Drugs > Alcohol) / -Copy all the files that start with: “drugs-alc-05_smashed_and_trashed”.
-Copy the “Shared” folder.
To copy an individual activity (for example Flash Activity 1 in “Booze in the blood” in Alcohol & Drugs > Alcohol)
This is the minimum level that can be disaggregated. / -Copy all the files that start with: “drugs-alc-09_booze_in_blood-pu_int_01_f.htm”. These files will have the same name and a extension with the character “~”.
-Copy the “Shared” folder.

Note that if you are delivering only select topics discretely, you may need to delete the linkson those pages that point to other parts of the site.

Using a learning management system

While this language and literacy toolbox has been designed as a self contained resource, with its own internal navigation, individual units and activities can be easily transferred to a web-based learning management system. If your learning management system has in-built navigation (such as WebCT) then you will need to disable the internal navigation tools contained within the toolbox.

This can be done using the individual HTML files within each activity directory and incorporating them into the learning management system navigation as appropriate.

Consult the technical documentation that accompanies your learning management system for more details.

WebCT support

WebCT is an online student management system, that is capable of

providing:

* secure student login

* content delivery

* communication tools, such as discussion boards and chat

* assessment tools, such as assignment submissions and computer marked quizzes

* grades management

* collaborative learning environments

* student management and tracking information.

Provided on this CD is a WebCT course archive:

/path_to_webct_archive/archive_name.zip

(please note, that although this file has a .zip extension, it is not browsable with standard zip tools and only functions within WebCT)

This WebCT course contains a number of enhancements to the CD delivered product, including integration with the communication tools of WebCT.

To utilise this resource, you will need to have access to a WebCT installation, either locally within your organisation or through a state based provider, such as the Victorian TAFE Virtual Campus (

This archive file was prepared in WebCT CE 4.1. Contact your WebCT Administator for further information.

Customisation

Discussion tool customisation

To link the toolbox to your choice of communication tools (the

Discussion board) you will need to do the following:

-Open the page: “/site/shared/common/discussion.htm”

-Find the html code that start with: “<meta http-equiv="refresh" content="0;URL=”

-After “URL=” replace the current url with the url of your discussion tool. It should look like this: “<meta http-equiv="refresh" content="0;URL=

Activities customisation

The following customisation of activities is possible in this toolbox:

The non flash version of any activity is a simple html file that can be edited with any html editor like Dreamweaver. E.g. “sex-sex-01_sexfaqs-pu_act_nf.htm” is a non flash version because the extension “_nf” is present in the file name.

The flash activities use a linked XML file with the extension “~data.xml”. For example

The flash activity in:

“sex-sex-01_sexfaqs-pu_act_f.htm” uses the linked file

“sex-sex-01_sexfaqs-pu_act_f~data.xml”

To edit the activity open the XML file in a text application like notepad and follow the steps described below.

General XML customisation

Tags:

Inside each XML you will see words wrapped between the characters “<” and “>”. These words are called “tags”. E.g. <question> is a tag.

Elements:

When two tags wrap a sentence like this: <question>What is your name?</question> this is called an element. Note that the end tag always has a “/” at the beginning.

Elements could also be groups of other elements. For example:

<question>

<text>Where is Paris?</text>

<answer>In France</answer>

</question>

<question> is one element with other elements inside (<text> and <answer>). For clarity we will call these elements inside “sub elements”.

Editing elements

To edit the content of an element change the text between the tags. i.e. <question>Change text here</question>

Be careful:

-Not to change the word in the tag

-Not to add spaces in the tag

-Not to add spaces between the tag and the content. E.g. <question> Change…

True and false activities

These activities are located in:

-drugs-alc-01_know_it_all.htm

-drugs-alc-09_booze_in_blood

-drugs-smk-01_smoke_haze

-health-men-01_know_your_mind

-sex-sex-01_sexfaqs

In the xml file you will see the following elements:

<title>

<character>

<instructions>

<audio>

<feedback>

<question>

The <title> element

This is the title for the quiz. There should be only one of these elements.

Example: <title>Exploring the choices</title>

The <character> element

This is the character that is going to appear in the quiz. This element should have a reference to a SWF file and the file name should include the extension “.swf”

Example: <character>characters-ben01.swf</character>

There should be only one of these elements.

The following characters are available:

-characters-ange01.swf

-characters-ben01.swf

-characters-dj01.swf

-characters-emma01.swf

-characters-juanita01.swf

-characters-leyla01.swf

-characters-nemo01.swf

-characters-nick01.swf

The <instructions> element

These are the instructions that appear at the beginning of the test.

Example: <instructions>Ok, dudes, so what do you REALLY know about mental health? Give this quiz a spin and let's find out.</instructions>

There should be only one of these elements.

The <audio> element

This element holds a reference to the audio file for the instructions. This audio should be a SWF file. The file name has to include the “.swf” extension.

Example: <audio>health-men-01_know_your_mind-pu_int_quiz_f~audio.swf</audio>

Note that the SWF file has some special scripting inside, examine the FLA source file for more information.

There should be only one of these elements.

The <feedback> element

This element indicates the feedback that the user will receive at the end of the quiz.

This elementhas two sub elements: <min> and <swf>.

The <swf> element indicates the graphic that will be shown when the user reaches the score in the <min> element.

There can be many <feedback> elements in the xml. The <feedback> element with the lowest <min> sub element should appear first and ordered accordingly.

The <min> element uses the format: <min>Number/min>

Example: <min>8</min>

The <swf> element uses the format: <swf>file name/swf>. The file name should be a SWF file containing a graphic or animation. The file name has to include the “.swf” extension.

Example: <swf>int-end-021good.swf</swf>

The <question> element

There is one of these elements for each question of the quiz. There could be as many elements as you want. The quiz will ask all the questions.

This element is formed by a group of three sub elements: <text>, <answer> and <feedback

Example of an entire question element:

<question>

<text>Mental health means psychiatric illnesses.</text>

<answer>F</answer>

<feedback>'Mental health' is having …… challenges and difficulties.</feedback>

</question>

The <text> sub element holds the actual question.

The <answer> sub element can be either “F” or “T” to indicate False or True

The <feedback> sub element has the feedback text that will appear when the user clicks on an answer.

Choose your path activities

These activities are located in:

-drugs-alc-02_what_would_you_do.htm

-drugs-dgs-01_rage_party

-drugs-dgs-04_spiked_drinks

-sex-rel-01_getting_along

In the xml file you will see the following elements:

<title>

<character>

<instructions>

screen

For <title>, <character> and <instructions> elements please refer to the explanation in “True and false activities”

The <screen> element

There is one <screen> element for each step of the quiz. There could be as many of these elements as you want.

Each screen element has an attribute identified by “id”. Example: <screen id="1">. This attribute is a unique identifier for each screen and is used to go to that screen when the user selects an option.

Sub elements of <screen>:

This element is composed of the following sub elements:

-<text>

-<option>

The <text> sub element contains the descriptionof what is happening in this step. It is not necessary to insert the previous action here that led to this step; this is inserted automatically by the application. To have an empty space between paragraphs insert a carriage return in the xml file.

The <option> sub element represents the options that the user has. There should always be two <option> sub elements in each <screen> element.

Sub elements of <option>:

The <option> sub element is sub divided in two sub elements: <text> and <goto>

The <text> sub element contains the description of the option.

The <goto> sub element contains the screen number to go to for this option. This number is a reference to the “id” attribute in the <screen> element.

Known issues

Accessing Word files

Some problems maybe encountered when accessing Word files on the Macintosh system. These files will appear in a window behind the current window and the user might have to manually find this new window.

Old Browsers

When using old browsers including Netscape 4.7 the following can happen:

-Some content could look out of place because of the lack of support ofthese browsers for the CSS standard version 1.0. However all the content will be present an accessible.

-Some JavaScript may not work correctly because of the lack of support for these browsers of the standard document object model DOM. However all links provide a standard html alternative.

Accessibility issues

The toolbox has been designed with accessibility in mind and meets the W3C Priority 1 Accessibility Guidelines.

Navigation

All the navigation of this toolbox has been implemented using a system where we always provide an alternative for the users if the first method is not available.

JavaScript

To comply with W3C P1 guidelines, the toolbox also works without JavaScript. This has been achieved through the use of standard html code and capturing the clicks with JavaScriptwhen more control is required for a specific link. In this way if JavaScript is not available the standard link will always work.