Teaching Guide Template
Total Page:16
File Type:pdf, Size:1020Kb
Technical guide
SIR07 Retail Services Training Package Series 12 Flexible Learning Toolbox
Supporting resources for: SIR20207 Certificate II in Retail
27/10/09 Final Version
flexiblelearning.net.au/toolbox © Commonwealth of Australia 2009
The views expressed herein do not necessarily represent the views of the Commonwealth of Australia. This work is copyright. Apart from any use as permitted under the Copyright Act 1968, no part may be reproduced by any process without prior written permission from the Commonwealth. Requests and enquiries concerning reproduction and rights should be addressed to Training Copyright, Department of Education Science and Training, GPO Box 9880 Canberra City ACT 2601 or email [email protected]. Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Contents
Introduction...... 2 System requirements...... 3 Client hardware and software (for learners)...... 3 Server hardware and software (for RTO)...... 3 Developer hardware and software (for customising)...... 4 Toolbox Help Desk and support services...... 4 Customising Toolbox content...... 5 What features can be customised?...... 5 Basic editing...... 12 Customising a Toolbox for single unit delivery...... 13 Keeping to the standards...... 13 Visual design...... 14 Navigation...... 17 File structure...... 17 Accessibility...... 19 Technical support...... 20 Installation on a web server...... 20 Installing into a SCORM compliant LMS...... 20 Producing CD-ROMs for distribution...... 20 Known issues...... 21 Troubleshooting...... 21 Frequently asked questions - FAQs...... 22 The Toolbox Help Desk...... 23 References...... 23
List of tables and figures Table 1: Customsisable elements...... 8 Table 2: CSS style list ...... 12
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright iii Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Introduction The Retailer Toolbox provides a valuable source of training material for delivery of the SIR20207 Certificate II in Retail.
The Toolbox is based around scenarios that provide learning experiences which replicate real life work situations faced by retail operators. The scenarios are supplemented by:
training sessions that provide background theory and practical tasks topics that encourage sharing of ideas and experiences activities to be completed in the workplace.
This Technical guide has been developed to support you in delivering the SIR07 Retail Services Training Package and gives specific details on file structure and naming conventions (to help you find files within the toolbox) and how to edit some of the files. Your understanding of these instructions will depend on your level of knowledge and experience in web development. If you find you do not understand some of the concepts in the guide or you run into trouble when trying to edit or locate files in the Toolbox, you may need the help of a professional web developer. A Teacher’s guide has been developed to assist and advise teachers and trainers as to how to use the Toolbox in their delivery of courses to learners. This Technical guide is divided into three sections: System requirements Customising Toolbox content Technical support (FAQs, troubleshooting, help desk).
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 1 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
System requirements
Client hardware and software (for learners) Hardware To use the learning material in this unit, learners will need a computer with the following features:
IBM® compatible with a 1000 MHz processor running Windows 2000, XP, Vista -- OR -- Apple Macintosh® with a 500 MHz processor running OSX v10.4 with: o 256 Mb of RAM o 1024 x 768 pixel display o CD-ROM drive o Internet access o Sound card.
Software Learners will also need the following software/plug-ins installed on their computer:
Internet Explorer 6.0 or above (http://www.microsoft.com/ ) -- OR -- Firefox 2.0 or above (http://www.mozilla.com/ ) -- OR -- Safari 2.0.4 or above (http://www.apple.com/ ).
Microsoft® Word 97 or a similar word processing program to open and use downloadable forms, checklists and worksheets. Adobe® Flash Player 9. If you haven’t got this plug-in, you can download and install the latest free version from: www.adobe.com. Adobe® PDF Reader 6.0 or above. If you haven’t got this plug-in, you can download and install the latest free version from: www.adobe.com. Incorrect versions of these applications could result in information being shown in an unreadable form or not shown at all.
Server hardware and software (for RTO) IBM compatible computer with a 1000 MHz processor (or Unix equivalent). 256 Mb of RAM. 4 Gb hard disk space free. CD-ROM drive. 2xISDN (128k), T1 preferred. Internet server software.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 2 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Developer hardware and software (for customising) Same as client hardware and software above, with the addition of:
An 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: o Flash CS3 o XML SPY or equivalent XML editing tool – Dreamweaver can also be used to edit XML files o Photoshop/Fireworks (or equivalent) for editing still images o SoundEdit16 (or equivalent) for editing sound content o Premiere (or equivalent) for editing video content.
Toolbox Help Desk and support services The Toolbox website provides support at http://toolboxes.flexiblelearning.net.au/support/patches.htm. This site offers help desk details, frequently asked questions, installation and configuration advice and patches for any products that are found to have minor errors or discrepancies. If you are unable to find what you are looking for on this site, please email the Toolbox Help Desk at [email protected] or phone 1300 736 710.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 3 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Customising 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 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 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 Toolboxes. However, before embarking on any modifications or customisation, we suggest that you: check the licensing details of the Toolboxes to ensure that any customisation does not contravene the conditions of the licence have the required trained personnel 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 Toolboxes can be easily customisable. However, there are other aspects of the Toolboxes that are more difficult. For this complex customisation we recommend that you proceed only if you have the relevant trained technical personnel. The Toolbox has been created using Templates which control the structure of the Toolbox and the most of the links. All links found in any of the global navigation and the menus of the scenarios are controlled in the templates. This makes the Toolbox much easier to update quickly and easily. The Training Rooms are have their structure created by one template and therefore the links need to be set manually inside each individual page rather than by use of a template. There are a number of multimedia applications that have been included in the Toolbox and all, where possible, have been made using easily editable XML files and in a few cases a Flash actionscript file that accompanies the Flash application source file included in the source_files directory of the Toolbox. Other applications that are considered very basic and are absolutely one off will not have this edit ability and the information can only be edited by someone with a basic knowledge of Adobe Flash. In this case the majority of the actionscript used to create the application can be found on the root timeline in a layer called script. An example of this would be the scanner application located in activity two of the Buy now scenario. There is only price information in this application and this information can be found in the place described above.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 4 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
The XML has been written in the hope that it is intuitive to use. Below is an example of an XML file that supplies information to the mid sized sound player found in the intro to the Taking it back scenario:
Inside the sound node you will find the file node use the attribute file_location to describe the location of the sound file in relation to the web page that the application is residing on. The play_on_load node is used to tell the player to play the queued sound as soon as the sound is ready or to wait until the play button is selected. Changing the play_pause attribute to 1 will cause play on load and 0 will disable the sound until play is pressed.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 5 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
It is possible to supply an icon of the person speaking using the icon type_or_location="default" Using default will not load an icon and specifying the path to an image in relation to the page where the application resides will load in that image. The text node is used to supply a transcript of the audio that is currently queued to play. file_type should always be set to mp3. image fileLocation is only available when the full sized sound player is used, the file location is again relative to the .htm page where the application resides. Duplicating the sound node will enable another sound to be placed in the queue and enable the next and previous buttons It is also possible to change the colour of the application if needed by supplying colour values found inside the style node. The colour values should be supplied in hex values without the # symbol. Changing the colour, size or font of the text displayed in the player can be done by changing any of the font values also found in the style node. The home page of the Toolbox, retailer.htm has a map of a shopping centre. This Flash application does not have an xml file to update the information this instead uses an actionscript file called text_and_urls.as that is located in the source_files directory of the Toolbox. Changing the text found inside the actionscript file will change the text that appears in the Flash application when the shockwave file is recreated. If removing Scenarios from the Toolbox the Flash file will need to be opened to delete the characters that have links and text associated with them. A portion of the actionscript file is shown below:
The first part of the actionscript file is used to provide information about the individual stores, using basic html mark up is allowed: var SupermarketMessage = "Welcome to PriceCRASH. We've CRASHED prices on all major brands so you buy more for less. PriceCRASH scenarios:
The next section provides information about the individual characters, using basic html mark up is allowed: var newsagent_boss = "In this scenario Mr Watt is telling his staff about a recent spate of shoplifting in the centre.
Select Mr Watt to begin." var new_stock_arrived = "In this scenario Martin has just received word that new stock has arrived.
Select Martin to begin." (More…)
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 6 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
The URLs specify the location of the individual scenarios in relation to the home page of the toolbox: var newsagent_boss_URL="toolbox12_06/scenarios/bit_sus/01_intro/01 _intro.htm" var new_stock_arrived_URL="toolbox12_06/scenarios/first_in/01_intr o/01_intro.htm" (More…)
Some of the applications in the toolbox use a multipurpose flash file “Learninator”. The Learninator application can build a variety of learning activities (sub apps) and arrange them into a sequence. This application is driven by editable XML files. The XML has been written in a manner that is intuitive and easy to use.
The “Learninator” should not need to be edited as it has been setup to use XML input. Edit the XML first to see what can be accomplished before making changes in the original learninator.fla file. If the original application does need editing, you will need good Actionscript 3 skills and will also need to set the class path in Flash to point to the Classes folder in the source file folder of the Toolbox. These files are needed to republish and test the Flash file. If you are unsure about how to do this, refer to the Help files in Adobe Flash.
The above XML is the header of this ‘Learninator’ application. This also holds the set up of the application and some elements (tags) that can be set for the application. The tags are named appropriately and indicate how they affect the application. For example: The unlimited attempts property can be set to false if you wish to lock the user to only one attempt at any questions in your application. A handy tag is the showDevelopersTools. If this is set to true, when you test your application, you can click and drag within the swf and x, y, height and width properties will be displayed. This can be useful for the placement of images etc. When entering these values back into the XML’s subApp tag properties. Just remember to set it back to false when you have completed your application. The type and taxonomyType tags should not be changed, as they specify what application runs in the subApp. If a typing error appears in here, no app will appear in the swf file.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 7 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
If you look inside the first subApp’s statement tags and image tag you will see the x, y, height and width properties. These properties give you the control in placing text and images within the subApp’s stage. The Learninator application can read basic html tags that are available within Actionscript 3, such as
breaks. These come in handy when formatting the text displayed within the subApps. Below is an example of the XML file that supplies ‘Introduction information’ to the first screen of almost every Learninator application sequence.
In most cases, the Learninator application has been individually customised to perform specific tasks relevant to each topic in the Retail toolbox. If you want to edit more than one question and feedback text or images, it is advisable that you proceed only if you have the relevant trained technical personnel.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 8 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Table 1: Customsisable elements
Element To Customise Description Location Toolbox index Formatted entirely in HTML, edit with index.htm page Dreamweaver. Retailer home Formatted mostly in HTML, edit with retailer.htm page Dreamweaver. Editing of the Flash interaction is explained above. Orientation text Most text in is standard HTML, browse to \content\*.htm the location in the Toolbox, take note of the URL, and use that to find the appropriate file in the toolbox_12_06 directory. Open the file in Dreamweaver (or a text editor) and make the changes.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 9 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Flash interactions Most of these interactions can be \content\*.swf customised by anyone with basic \source\*.fla Macromedia Flash design skills. However some are more complex, and require \content\xml\*.xml actionscript knowledge. \images\*.jpg Some Flash interactions in this Toolbox are self contained, but most pull in external data from an XML file. If there is an associated xml file it can be found inside the media/flash/xml folder and generally matches, or relates in name to the name of the Flash file. To customise the XML open in Dreamweaver or any basic text editor. The XML has been written in the hope that it is intuitive to use although some experimentation may be required. Experimenting with the XML will not damage the application but may make it not work as expected, always keep a back up of the original XML file. To customise open the page in Dreamweaver and select the Flash object that you wish to change. Under the properties of the object, you will see a filename such as flashint.swf. You cannot change this directly, but must rebuild it from the source code. Using Flash CS3 authoring software, browse to the source directory and locate a .fla file with the same name as the .swf. This is the file you need to edit. Open it up inside Flash and look for comments in the actionscript attached to the first frame. These comments will point you in the right direction. There are, in Flash, a few places where scripts will be stored, a script layer, a functions layer and an XML layer. Rarely has script been placed on actual buttons, look for scripts in the timeline first and then the buttons/movieclips.
The Teacher guide includes a ‘high-level’ overview of customisation. That guide refers to this one for further information. It is important that this cross-referencing is consistent. Do not accept what is written below – customise it to suit your product and make sure all references are relevant.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 10 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Basic editing There are numerous ways of editing the content of this 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 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 (i.e. MS FrontPage or Macromedia Dreamweaver) and make appropriate changes. Save each file. Check your edits in a web browser to see if it displays properly.
Text editor (i.e. MS Notepad)
Download complete 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 (i.e. MS Notepad) Make appropriate changes, following the CSS styles, some of which are: o
(Main Headings) larger blue font in caps o (Sub headings) green fonts o
(main content i.e. paragraphs) black text. Save each file. Check your edits in a web browser to see if it displays properly.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 11 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Customising a Toolbox for single unit delivery You may only want to offer one or two units from the Toolbox, or limit access to certain units and/or streams. To disable access to units, open the index.htm file in the root folder in Dreamweaver, and edit the link target for the unit you wish to disable to point to disabled.htm. Now when users click these buttons they will receive a pop-up message saying that this content is not available at this time. You can modify this message by changing disabled.htm. 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 toolbox12_06 directory. If choosing to use only one particular scenario you will need to make sure that the appropriate training sessions are available, or in fact disabled, by pointing the links to disabled.htm. It is also possible to remove the links entirely.
Each scenario is organised in the following folder naming convention: 01_intro 02_review (which is in fact the last item in the scenario menu after the activities) 03_on_the_floor (which sits at the very bottom of the menu after the training sessions activity_01 activity_02 etc. All individual scenarios and training sessions are self contained, meaning that all content is contained within the folder structure of the scenario or training session. If removing scenarios or training sessions from the Toolbox it is best to also take the shared folder as well and keep the scenario eg Taking it back inside the scenarios folder. This will help to make sure that all files such as styles and scripts are available and that the pages will display and function correctly. You may wish to modify the index.htm inside the scenario folder or index.htm inside the training_centre folder to not show these missing units, or you may wish to create an entirely new one using the existing file as a reference.
Keeping to the standards This 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 2 - http://www.w3.org/TR/REC-CSS2/
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 12 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Visual design This Toolbox uses: Cascading Style Sheets (CSS2) for visual layout and site structure only relative font sizes, compatible with the user specified "text size" option have been specified. If your browser or browsing device does not support style sheets at all, the content and menu structure of each page is still readable.
Global formatting with CSS This Toolbox has been created with Cascading Style Sheets (CSS). This will enable you to make global changes to the look and feel of this 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 file is located at styles\global.css there is also a print style this is located at styles\print.css CSS style descriptions
Table 2: CSS style list
Style Name Font Size Description
body Arial 76% Main body font. a Link not underlined. a:hover Link underlined on hover. ul, ol Padding and margins set to standardise display across browsers. #header Style applies to all pages that contain a header. #header Global navigation style, sets the dimension for #headerLinks the global navigation container and background image. #header div.gb_link Sets the style for the individual link containers in the global navigation area. #header div.gb_link Sets the style for the link inside the gb_link a container and importantly the position of the link in relation to it’s parent container gb_link. #header div.gb_link Shows link as red when hovered over. a:hover #logo Positions the Retailer logo in the header. #container Container holds all navigation and content areas but not the header and global navigation. #pageNav Navigation found on all scenario pages located on the left of the screen. #pageNav Link at very top of page navigation - Scenario a.scenarioLink home link.
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 13 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Style Name Font Size Description
#pageNav Menu separator - image - blue lines above and .seperator below on the floor link. #pageNav h3 Menu titles for training centre and the activities part of the menu. #pageNav a General menu link style. #activityLinks Used in conjunction with html tags to create styles that lead to links that are within the current scenario. #trainingLinks Used in conjunction with html tags to create styles that lead to links to training session related to the current scenario. #m_out_there a Style that relates only to the “on the floor” link contained in the page navigation #content_two_col Describes the container for the scenario pages that incorporate an image on the right of the screen, generally this can be found on the scenario intro and the review page. #content_one_col Describes the container for the scenario pages that contain no picture on the right of the screen. This is the majority of the pages that make up the scenarios. #content_no_menu Content for pages with no menus such as text alternative pages. #rightcolumn Positioning of right column that hold the picture for the two column content layout. .star_retailer, Describes the boxes or ‘important’ areas that .safety_checker, contain extra information. These boxes are .the_hub, .training generally found at the bottom scenario or activity pages. .newsagent, Styles used to create the boxes that can be .boutique, found on the Scenario home page and the .supermarket, Training Room home page. .department, .training_selection #footer Describes the dimensions of the footer found on all pages. #flashcontent Used to position Flash applications on the page #retailer_intro Used in conjunction with html tags to create the Toolbox homepage. .clear This is an important style that forces a line break between elements. Particularly handy to use with
Part of the Australian Flexible Learning Framework © Commonwealth of Australia 2009 | Licensed under AEShareNet - S Licence Disclaimer and copyright 14 Technical guide: Retail Services Series 12 Flexible Learning Toolbox
Style Name Font Size Description
#footerlinks Describes the links located inside the footer. These links are only found on the index page and pages linked directly to the index page. #training_room Describes the container that holds the content for the Training sessions (rooms). .training_links, Describes the global navigation style for the links .training_nolink found at the top of each training session these links look like tabs. .training_nolink a, Makes sure that tabs in the training session still .training_nolink look the same even if the tabs are not links. span #training_room_co Position of content in the training room - the ntent large left pad is used to create room for the internal menu located in the content of the page. #training_room_sid Positions the internal training session navigation. e_menu #training_room_sid Style background of the unordered list with a e_menu ul barcode image. #training_room_sid Give the list that houses the internal navigation e_menu li links dimension. #training_room_sid Position and style anchors so that they sit on top e_menu a of the tag images, width and height set the hit area that reveals the 'tag' image padding sets the position of text. #train_nav_top, Provides a background image for the links of the #train_nav_middle, training sessions. #train_nav_bottom #next_previous, Used to position next and back buttons located #tr_next_previous at the top of some pages in scenarios or training sessions. .image_and_text Class is used to create a box that places an image on the left and accompanying text on the right. Other styles have been used, though they relate to the styles that are located above. For example in mentioning the style #container it should be assumed that html tags such as