Technical guide
Upcoming SlideShare
Loading in...5
×
 

Technical guide

on

  • 526 views

 

Statistics

Views

Total Views
526
Views on SlideShare
525
Embed Views
1

Actions

Likes
0
Downloads
0
Comments
0

1 Embed 1

http://www.webct.ulg.ac.be 1

Accessibility

Categories

Upload Details

Uploaded via as Microsoft Word

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Technical guide Technical guide Document Transcript

    • Technical guide Employment Consultant Skills Series 9 Flexible Learning Toolbox Supports Certificate IV in Business (Employment and Services) competencies from the Community Services and Health Training Package: • CHCES403A Develop and monitor employment plans • CHCES404A Promote clients to employers • BSBCMN403A Establish business networks • BSBCMN409A Promote products and services • BSBMKG406 Build client relationships 25 October 2006: Version 1.0 flexiblelearning.net.au/toolbox
    • © Commonwealth of Australia 2006 The views expressed herein do not necessarily represent the views of the Commonwealth of Australia. This work is copyright. It may be reproduced in whole or in part for study or training purposes, subject to the inclusion of an acknowledgement of the source and it is not used for commercial use or sale. Reproduction for purposes other than those indicated above requires the prior written permission from the Commonwealth. Requests and enquiries concerning reproduction and copyright should be addressed to the Branch Manager, Technology and Information Services Branch, Industry Skills Development Group, Department of Education, Science and Training, GPO Box 9880 Canberra City, ACT, 2601. Part of the Australian Flexible Learning Framework
    • Technical Guide – Employment Consultant Skills Table of Contents Introduction......................................................................................................1 System requirements......................................................................................2 To play.................................................................................................................2 To customise.......................................................................................................2 To serve..............................................................................................................3 Local machine (Offline delivery)..........................................................................3 Customising Employment Consultant Skills Toolbox content..................4 What features can be customised?.....................................................................4 Basic editing........................................................................................................6 Advanced editing (with Dreamweaver)................................................................6 Customising a Toolbox for single unit delivery....................................................7 Keeping to the standards....................................................................................7 Visual design.......................................................................................................7 Navigation...........................................................................................................8 File structure........................................................................................................8 Accessibility.........................................................................................................9 Technical support..........................................................................................11 Installation on a web server...............................................................................11 Installing into a SCORM compliant LMS...........................................................11 Producing CD-ROMs for distribution.................................................................11 Known issues....................................................................................................12 Troubleshooting.................................................................................................12 The Toolbox Help Desk.....................................................................................12 List of tables and figures Table 1: Toolbox structure (High level)........................................................1 Table 2: Customisable elements...................................................................5 Table 3: Folder/file structure..........................................................................9 Part of the Australian Flexible Learning Framework iii
    • Technical Guide – Employment Consultant Skills Introduction Welcome to the Technical Guide for the Employment Consultant Skills Series 9 Flexible Learning Toolbox. This guide explains the technical features and file structure of the Toolbox to assist technical staff in the installation and customisation of the Toolbox. (For information on how to use the Toolbox to deliver training in the Employment Services industry, please see the accompanying Trainer Guide.) This Technical Guide is divided into three sections: • System requirements • Customising Employment Consultant Skills Toolbox content • Technical support (FAQs, troubleshooting, Help Desk). The Toolbox offers resources and activities to cover the underpinning knowledge for the following units of competency from the Community Services Training Package. The design of the Employment Consultant Skills Toolbox and its file structure simulates the way employment consultants work. Table 1: Toolbox structure (High level) (For more information about the learning design of the Employment Consultant Skills Toolbox and its features, please see the accompanying Trainer Guide.) Part of the Australian Flexible Learning Framework 1
    • Technical Guide – Employment Consultant Skills System requirements To play  IBM® compatible with a 1000 MHz processor running Windows 2000, XP or above OR  Apple Macintosh® with a 500 MHz processor running OSX 10.2.0 or above WITH  128 MB of RAM  800 x 600 pixel display  CD-ROM drive  Internet access  sound card. Learners will also need the following software/plug-ins installed on their computer:  Internet Explorer® 6.0 or higher, or Mozilla Firefox® 1.0 or higher.  Microsoft® Word 97 or a similar word processing program to open and use downloadable forms, checklists and worksheets.  Macromedia® Flash 7 Player. If you haven’t got this plug-in, you can download and install the latest free version from Adobe’s website at <www.adobe.com>.  Adobe® PDF Reader 6.0 or above. Download at <www.adobe.com>. Read the terms and conditions for distributing Adobe Reader on your CD from <http://www.adobe.com/products/acrobat/distribute.html?readstep>. Incorrect versions of these applications could result in information being shown in an unreadable form or not shown at all. To customise For customisation, users will need the same client hardware and software as listed above, with the addition of: • a HTML text editor such as Homesite®, BBEdit® or Macromedia® Dreamweaver • a word processor such as Microsoft® Word to edit documents. If customisation of multimedia interactions is required, then the following applications may be necessary: • Flash 8. Part of the Australian Flexible Learning Framework 2
    • Technical Guide – Employment Consultant Skills To serve There are no special server requirements to serve the Employment Consultant Skills Toolbox. The Employment Consultant Skills Toolbox is best delivered through a web service. A server will require the following specifications: • IBM compatible computer with a 1000 MHz processor (OR Unix equivalent) • 128 MB of RAM • 4 GB hard disk space free • CD-ROM drive • 2 x ISDN (128k), T1 preferred • Internet server software. To make the materials available for delivery to learners, you need to copy the entire contents of the CD into a directory on your Internet server and make a link available that will point to the Employment Consultant Skills Toolbox’s index.htm page. This will provide a direct link to the site. The index.htm page provides an entry point for teachers and administrators and briefly describes the resource. This page also provides links to: • a System Requirements page • the Trainer Guide • the Technical Guide • an Acknowledgements page which includes disclaimer and copyright information • a ‘First Time User’ section which describes the various sections and features of the Employment Consultant Skills Toolbox. Local machine (Offline delivery) If you are planning to use the Employment Consultant Skills Toolbox offline, simply load the Employment Consultant Skills Toolbox CD-ROM into your computer’s CD-ROM drive. The Employment Consultant Skills Toolbox CD-ROM includes an auto-run (Windows) function. For systems that cannot utilise the auto-run function, simply navigate to the index.htm file in the root of the CD and open it in your preferred browser. If you have been directed to use the Employment Consultant Skills Toolbox through the Internet or an intranet, simply open your preferred browser and enter the address (URL) that you have been provided. Part of the Australian Flexible Learning Framework 3
    • Technical Guide – Employment Consultant Skills Customising Employment Consultant Skills Toolbox content In most cases Toolboxes are able to be modified and redistributed with minimal licensing or copyright encumbrance. However, before commencing any modifications we recommend that you check the license details of the Employment Consultant Skills Toolbox, to ensure that any customisation undertaken does not contravene the conditions of that license. For licensing conditions visit: <http://www.flexiblelearning.net.au/toolbox/license.htm>. Remember to retain the original files in their CD-ROM format so that you always have an original copy of the Employment Consultant Skills Toolbox as a backup. What features can be customised? Toolboxes can be customised by users under the flexible licensing arrangements, as long as they are not on-sold. You are therefore encouraged to customise the Employment Consultant Skills Toolbox. However, before embarking on any modifications or customisation, we suggest that you: • check the licensing details of the Employment Consultant Skills Toolbox to ensure that any customisation does not contravene the conditions of the licence. • have the required trained personnel. • remember to retain the original files in the CD-ROM format as a backup (should you require them at a later stage). Some design aspects of the Employment Consultant Skills Toolbox can be easily customisable. However, there are other aspects of the Employment Consultant Skills Toolbox that are more difficult. For this complex customisation we recommend that you proceed only if you have the relevant trained technical personnel. Part of the Australian Flexible Learning Framework 4
    • Technical Guide – Employment Consultant Skills Element To customise Name Description Location Acknowledgements page Formatted entirely in XHTML, edit with acknowledgements.htm Dreamweaver. Main entry screen Formatted in XHTML, edit with index.htm Dreamweaver. HTML pages Introductory text to the various tasks and Example: (eg introductory text) activities is contained in standard XHTML. content03_wed Browse to the location in the Employment task_101_plan Consultant Skills Toolbox, take note of the page001.htm URL and use that to find the appropriate file in the Employment Consultant Skills Toolbox’s directory/file structure. Open the file in Dreamweaver (or a text editor) and make the changes. Changes to styles should be made via the CSS style sheets. Flash text Flash interactions in this Employment Example: Consultant Skills Toolbox often pull in page001.htm external data (eg text) from an XML file. page001.xml Text located within Flash can be customised by locating the corresponding .xml file in the ‘xml’ directory and editing the appropriate content. This can be achieved using a simple editing tool such as MS Notepad. Flash interactions Flash interactions can be customised by Example: anyone with the required Macromedia Flash page_001.swf skills. Some interactions are more complex and require Flash ActionScript knowledge. and To customise, open the page in source…page_1 Dreamweaver and select the Flash object task_01part1part1.fla that you wish to change. Under the source...01_plan properties of the object, you will see a page_001 filename such as page_001.swf. You page_001.fla cannot change this directly, but must rebuild it from the source code. Using Flash MX 2004 authoring software, browse to the location of the source_files folder and locate the corresponding folder. Within this folder you will find the .fla source file(s) for the .swf. This is the file you will need to edit. Table 2: Customisable elements Part of the Australian Flexible Learning Framework 5
    • Technical Guide – Employment Consultant Skills Basic editing There are numerous ways of editing the content of this Employment Consultant Skills Toolbox. The approach is similar to editing pages that might be found on any website. The two simplest ways are: 1. Using a web development package (MS FrontPage or Macromedia Dreamweaver). 2. Using a straight text editor (MS Notepad or your favourite text editor). A basic understanding of HTML and the software package is useful. Web development software package • Download the complete Employment Consultant Skills Toolbox contents onto your machine. • Identify the pages you would like to edit (these are displayed in the address bar at the top of the browser page when viewing). • Locate these files in the downloaded files, following the paths displayed in the browser. • Open each file in your web editing software package (ie MS FrontPage or Macromedia Dreamweaver) and make the appropriate changes. • Save each file. • Check your edits in a web browser to see if it displays properly. Text editor (eg MS Notepad) • Download the complete Employment Consultant Skills Toolbox contents onto your machine. • Locate the file you wish to edit, following the paths displayed in the browser. • Open the file using a text editor (eg MS Notepad) • Make the appropriate changes, following the CSS styles, some of which are: - <h1> (Main headings) larger blue font in caps - <h2> (Sub-headings) green fonts - <p> (main content, ie, paragraphs) black text. • Save each file. • Check your edits in a web browser to see if it displays properly. Advanced editing (with Dreamweaver) If you need to alter the templates and certain major structural elements (eg headings, link and button text, etc) within the Employment Consultant Skills Toolbox, you will need to access the ‘Templates’ and ‘Library’ folders located in the source files. Part of the Australian Flexible Learning Framework 6
    • Technical Guide – Employment Consultant Skills Before you mount a Dreamweaver site to alter any of the files in the Employment Consultant Skills Toolbox, you will need to copy the ‘Templates’ and ‘Library’ folders over to the root of the Employment Consultant Skills Toolbox folder. Customising a Toolbox for single unit delivery You may only want to offer one or two units from the Employment Consultant Skills Toolbox, or limit access to certain units and/or streams. To disable access to units, open the content/diary.htm file in Dreamweaver, and edit the link target for the unit you wish to disable by typing ‘javascript:alert (‘This unit is not available.’)’. Now when users click these buttons they will receive a popup message saying that this content is not available at this time. If you want to distribute a smaller version by pruning the unnecessary content, you will need to follow the above process, and in addition delete the appropriate folders in the content directory. For example to remove ‘Monday’ (Develop and monitor employment plans) delete the content/01_mon folder and edit the content/diary.htm file as described above for the link that refers to the 01_mon folder. Keeping to the standards This Employment Consultant Skills Toolbox has been developed in accordance with a number of internal conventions and international standards. These standards may be related to accessibility, cross-browser compatibility, or just to enable the easy location and customisation of content. Keep this in mind when you are customising, as whatever you produce will need to be accessible, cross-browser compatible, and able to be further customised. Try to ensure that any changes you make are conformant with the following standards: • W3C Priority One – Web Accessibility Initiative – <http://www.w3.org/WAI/> • XHTML 1.0 Transitional – <http://www.w3.org/TR/xhtml1/> • CSS 1 – <http://www.w3.org/TR/1999/REC-CSS1-19990111>. Visual design This Employment Consultant Skills Toolbox uses: • Cascading Style Sheets (CSS2) for visual layout and site structure • only relative font sizes compatible with the user specified ‘text size’ option. If your browser or browsing device does not support style sheets at all, the content and menu structure of each page is still readable. Part of the Australian Flexible Learning Framework 7
    • Technical Guide – Employment Consultant Skills Global formatting with CSS This Employment Consultant Skills Toolbox has been created with Cascading Style Sheets (CSS). This will enable you to make global changes to the look and feel of this Employment Consultant Skills Toolbox. If you don’t have a good understanding of HTML and at least a beginner’s level understanding of CSS you should get somebody with this knowledge to help you. The main CSS files are located in the contentcss folder. You can find out more about CSS at: <http://www.htmlhelp.com/reference/css/>. Navigation Navigation in the Employment Consultant Skills Toolbox is achieved through hyperlinks, Flash navigation and the occasional use of JavaScript. Please ensure that you maintain all accessibility features of the Employment Consultant Skills Toolbox when customising. Where JavaScript may be turned off or in browsers that do not support JavaScript, the JavaScript used allows graceful transformation of navigation so that content remains accessible. JavaScript has also been separated out into an include file which is located at contentscripts. To modify any Flash navigation across activities, you will need to locate the Flash source files, make the necessary modifications and replace the Flash activity with your new one. Customisation of Flash elements will require expertise in Flash development. File structure The files and directories have been organised in a logical directory structure to make it easier to extract, modify and deliver individual components of this Employment Consultant Skills Toolbox. File naming conventions used are as follows: • A two digit prefix such as ‘01’ is used to designate a content page’s order in a content sequence, eg, 01_workout.htm. Part of the Australian Flexible Learning Framework 8
    • Technical Guide – Employment Consultant Skills The following table outlines the directory structure and explains the main folders and files. Root directory Description index.htm Entry page for the entire Employment Consultant Skills Toolbox. This page includes links to the acknowledgements page, the system requirements page, the Trainer Guide, the Technical Guide and the First Time User section. content The ‘content’ folder contains all the learning content. contentresources The ‘learning resources’, containing the folders for each of the resources. content01_mon The folder ‘01_mon’ contains sub-folders for the tasks for Monday (each day of the week represents a competency and each task represents an appointment) and a folder for the express pathway. There are also folders for the other days of the week that follow the same structure. content01_montask_1 Each task folder has plan/do/debrief folders that contain the activities. contentintranet This folder contains all of the files for the intranet. images This folder contains all of the graphical content. contentcss This folder contains sub-folders containing CSS files. contentscripts This folder contains sub-folders containing JavaScript files. Library The ‘Templates’ and ‘Library’ folders contain Dreamweaver templates and library items used in customisation. These items do not need to Templates be deployed. Contentftu This folder contains the files for the First Time User section, which provides a guide to the Employment Consultant Skills Toolbox for first time users. Table 3: Folder/file structure Accessibility The Employment Consultant Skills Toolbox has been designed to meet the requirements of the W3C Web Content Accessibility Priority 1 Guidelines. Measures employed to facilitate equitable use include the following: • relevant images have the appropriate ALT arguments, meaning they have an equivalent when read by speech synthesisers such as JAWS • navigation elements have been included as text without ALT arguments to facilitate faster reading in speech synthesisers • where JavaScripted popups appear, an alternative mechanism has been provided. This may mean that a popup will appear as a new window if JavaScript is turned off • rich media assets such as Flash elements are supported by text equivalents (in RTF format) for use by magnification or speech synthesis software • text and paragraph elements within HTML pages have been deployed in a way that supports both text size change within the supported browser and local cascading style sheets (CSS). Part of the Australian Flexible Learning Framework 9
    • Technical Guide – Employment Consultant Skills If you modify any Flash content, remember to modify the content in the text alternative version as well. The alternative version name follows the name of the Flash file. For example, if the Flash file is called page_001.swf then the text alternative (ta) is titled page_001_ta.rtf. Text equivalents of rich elements All content images used in this site include descriptive ALT attributes. Purely decorative graphics include null ALT attributes. Media rich content in Flash movies is provided in Rich Text Format as text alternatives. If you replace any Flash movie or image with another, it is important that you update the ALT tag or text alternatives appropriately. Links Title attributes have been used on links to describe the link in greater detail. Links have been written so users with screen-readers can make sense of them when taken out of context. Part of the Australian Flexible Learning Framework 10
    • Technical Guide – Employment Consultant Skills Technical support Technical support is available from the Toolbox Help Desk, which is detailed at the end of this section. However, before calling or emailing, please make sure that the answer you seek is not located elsewhere in this guide. Installation on a web server Copy the entire contents (except for Autorun.inf, Autorun.exe) from the CD-ROM to the appropriate directory on your web server. If you are only copying selected units to your server or CD-ROM, you must make sure any shared files and the associated structure(s) are also copied. As there are no server side technologies utilised by this Employment Consultant Skills Toolbox, no server configuration will be necessary. Installing into a SCORM compliant LMS If you wish to make content from this Employment Consultant Skills Toolbox available through your LMS, and your LMS is SCORM compliant, then you can install the relevant learning objects (LOs) by using the following process: 1. Browse to the Toolbox Repository at <http://toolboxes.flexiblelearning.net.au/repository/index.htm>. 2. Search on the name of this Toolbox. You will find a number of learning objects, each relating to a section of the Employment Consultant Skills Toolbox CD-ROM. 3. Download each object that you wish to place on your LMS. They will be delivered as IMS content packages, which look exactly like .zip files. 4. Follow your LMS’s specific instructions for uploading these IMS content packages. Be aware that not all LMSs are SCORM compliant, and that some claiming to be compliant cannot process IMS content packages so probably aren’t. Please refer issues with the uploading of content to your LMS administrator, not the Toolbox Help Desk. The administrator or LMS vendor will contact us if necessary. Producing CD-ROMs for distribution Whether producing one-off copies of CD-ROMs or class sets, use the following procedure: 1. Start up your favourite CD-ROM burning software. 2. Select the data option (don’t simply copy the whole CD-ROM). 3. Drag and drop all files (except the source directory). 4. You may wish to delete the Trainer Guide and Technical Guide. 5. Burn the CD. Part of the Australian Flexible Learning Framework 11
    • Technical Guide – Employment Consultant Skills Before you burn a class set, it might be wise to test that the first one works as expected. Known issues The following are known technical issues that users may experience when using this Employment Consultant Skills Toolbox: • IIS 6.0 will not serve content of unknown MIME type • Flash detection issues in WebCT (Version x.x) • Lotus Notes based training environments don’t allow popups • issues with popup blocking by Windows XP SP2, and others (eg Google) • browser printing (right hand edge of page may be cut off) • issues trying to use Dreamweaver templates inside FrontPage. Troubleshooting The following checks may be of use if you are experiencing technical difficulties with your Employment Consultant Skills Toolbox product. • If text, images and page layout appear out of alignment check that you have the required browser versions and operating system requirements. See the ‘To play’ section for information on the required browser and OS versions. • If Flash elements do not appear or behaviour is erratic, check that you have the required Flash player plug-in. See the ‘System requirements’ section for information on the required software versions. • If you are experiencing broken links or misplaced image files, check to ensure that you have kept the necessary folder/file structure intact when moving, deleting or modifying any files. The Toolbox Help Desk If you need technical assistance with a Toolbox, a single Help Desk call is all that is needed. The Help Desk’s contact details are: Email: Toolboxhelp@flexiblelearning.net.au Telephone: 1300 736 710 Part of the Australian Flexible Learning Framework 12
    • Technical Guide – Employment Consultant Skills Before contacting the Toolbox Help Desk The Toolbox Help Desk is here to help you with installing Toolboxes and solving technical issues. Before contacting the Help Desk please assist us by following these steps: • Check if your question has already been answered in the Frequently Asked Questions (FAQs) section of the Toolbox website at <http://toolboxes.flexiblelearning.net.au/support/index.htm>. • Check the section relating to patches and fixes on the Toolbox website at <http://toolboxes.flexiblelearning.net.au/support/patches.htm>. • Please provide: - the Toolbox name and series number, eg 903 Employment Consultant Skills - your name, phone number and email address - the problem you need help with. The Flexible Learning Toolbox Help Desk will contact you as soon as possible. Part of the Australian Flexible Learning Framework 13
    • Technical Guide – Employment Consultant Skills Toolbox contact details: Flexible Learning Toolbox Help Desk Phone: 1300 736 710 Email: toolboxhelp@flexiblelearning.net.au Website: flexiblelearning.net.au/toolbox 2006 Australian Flexible Learning Framework National Communication Phone: +61 7 3307 4700 Fax: +61 7 3259 4371 Email: enquiries@flexiblelearning.net.au Website: flexiblelearning.net.au GPO Box 1326 Brisbane, Queensland 4001 Australia Part of the Australian Flexible Learning Framework 14