CLASS™ Directory Structure
NET CLASS PROCEDURE DATE: August 5, 1998 BY: Technical Design Task Force APPROVAL: _____________________________
CATEGORY: Production Purpose or Definition: To define the directory structure for the CLASS™ courses. Responsibilities: Read and understand the directory structure, use it in a CLASS™ course without alteration. Procedure: When creating a CLASS™ course, the directory structure in this document will be copied into the course directory. Folder and file naming conventions will be followed as laid out in this document. Please refer to Attachment 1 for a visual of the structure. o All folder and files names must adhere to these naming conventions. o Folder and file names will be lower case for the CLASS™ Web Server functionality. o File extensions will be in lower case o File extensions included in the File Naming Conventions document will be used. o Only working files will be placed in the Source Folders section of the file structure. o Only final content files will be placed in the Final Folders section of the file structure. o In absolutely no case will a source file (.psd .a4p .a3w, etc.) be placed in a final folder on the CLASS server. o Place a Read-me document that contains style information for the specific folder (audio, graphics, video, etc) in the root of that section. Final Folders [c000coursename] Folder Procedure o When drive space is assigned for your course the main folder will be named from the list on Attachment 2. NET and DCS created this list. Do not change this number. You will work with a software engineer to develop a shortened version of the title of the course. o When the course is transferred to the CLASS™ web server, the main folder on the CLASS™ web server will be named the same as this one. cache Folder Procedure
1
o When the cache file for your course is created, it is saved here. This folder is not transferred to the CLASS™ Web server o Refer to the Caching Procedures document for instructions on how to create a cache file. courseroot(final) Folder Procedure o The index.html file will be placed here. o This folder will be renamed once uploaded to the Web server to the three digit course number with course name [000coursename] (i.e. 055oceans). 00common Folder Procedure o Content included in this folder will be items that are designed to be used more than once in a course. Examples are background tiles, navigation graphics, course logo. o Naming these files will follow the File Naming Conventions document. 0000splash folder Procedure o This folder contains the files needed for the initial entry to the course. o Documents contained here are: o Blank.htm – opens in menu frame while tracking applet is loading. o Loading.htm – wait screen while tracking applet is loading. o Splash.htm o Splashmenu.htm – standard options for entry into the course. See the Frameset Procedure document for further information. o This folder also contain a media folder that will contain any audio, video, graphic, or animation files needed for the opening splash screen. 0001frameset Folder Procedure o This folder contains the files needed to create your course specific frameset. See the Frameset Procedure document for frame names, example frameset code, and location of template. o Document contained here is: 1. frameset.htm 002tracking Folder Procedure o This folder will contain any elements needed from the software engineers for tracking purposes. 003exam Folder Procedure o This folder will contain exam generator applet files.
2
o There will be graphics folder here for the standard buttons for all exams (i.e., the correct and why buttons). o Graphics for the specific exams will be stored in the appropriate section media folders. 004glossary Folder Procedure o This folder will contain glossary files. See Glossary Notes section. 01[unitname] Folder Procedure o The Unit Name will be a 01 (zero-one) followed by up to eight alpha characters. (i.e. 01latoya for Unit on LaToya for the Health Course, 02brandy for Unit Two on Brandy for the Health Course). o No html files will be placed in thif folder. o The file structure that can be copied from the NIM server has structure built for one unit. Please add additional units and sections as needed following the structure for all units. 0100intro Folder Procedure o Any html files that are used as an opening page for the unit will be placed here. o This folder contains a media folder that will hold any media items used on the opening page of the unit. (i.e., graphics, audio, animations, movies) See the File Naming Conventions document for naming procedures. Media Folder Procedure o All media elements will be numbered sequentially as they appear on the html page. If an element is deleted, then the number for that element will be deleted. If an element is added, then a new number for that element gets added at the end of the sequence no matter where the element appears on the page. See the File Naming Conventions document for naming procedures. o Any media element that consists of more than one file (i.e., a movie that opens a new window with an html page for text) will be placed in its own folder under media. o The folder will be named the same as the files contained within, minus the file extensions. 0101[sectionname] Folder Procedure o The section name will be a 0101 (zero-one-zero-one) followed by up to eight alpha characters (i.e., 0101mkchoice for the Unit One Section One Make Choices, 0203drugs for Unit Two Section Three Drugs). o There will not be a specific html folder under the sectionname folder. The html files will be in the sectionname folder.
3
o There should not be any html files placed any deeper in the directory structure than the sectionname filder level. When Cascading Style Sheets are implemented, the html documents must all be in the same relative position to the CSS. o Under the sectionname folder will be a media folder. The procedure for the media folder will follow the same guidelines as those written for the media folder under the 0100html folder procedure. 96weblinks Folder Procedure o This folder will contain html files with the list of all the web links for the course. 97webcache Folder Procedure o Any websites that are cached for the course will be placed here. Each site will reside in it’s own folder. Remember that you will need the graphics from the page as well as the html code. 98toolbar Folder Procedure o All files and graphics needed for the CLASS Toolbar will be stored in this location. The files and graphics for the toolbar structure are common across ALL courses so not alteration to files names is needed. o There will be a central location to get these files. Check the Toolbar Procedure document for location and instructions. o Under the toolbar folder there will be individual folders that correspond to each button on the toolbar. o 9901 contents o 9902 notebook o 9903 communications o 9904 search o 9905 grade report o 9906 help o 9907 more o Html pages contained within these folders will be numbered sequentially. (i.e. 9901_01.htm through 9901_03.htm if needed). o Any media elements needed for these sections of the toolbar will be placed in a media folder for that section and naming will follow previously laid out guidelines. o Most of the toolbar items are single pages that will link to other areas or items within the course. Notebooks Folder Procedure o When notebook pages are created for the course, the student template files are stored in the templates folder. These are the pages (i.e.,
4
personal journal page, essay assignments, reading log) the software engineers will upload for each student enrolled. o These copies will begin appearing under the notebooks folder with the users name. Do not delete or alter these newly created user folders. Source Folders Procedure source Folder Procedure o This folder does not need to be altered o In absolutely no case will a source file (.psd, a4p, .a3w, etc.) be placed in a final folder on the CLASS server. audio Folder Procedure o Within the audio folder is a working and a check folder. o The working folder is divided into common and a units folder o Source files will always be kept in the working directory. If an audio file is used throughout the course, place the source file in the common folder. If an audio file is used in a specific unit, place the source file in the unit folder. o When the audio files are ready for the project manager to check a final, formatted version will be put into the check folder o If the audio file is approved by the project manager, it will then be moved into the appropriate folder in the final section and incorporated into the course. Documents File Procedure o Within this folder is a htmltemplates and an original folder o The htmltemplates folder will contain template files that are being used for the course. (i.e., page layout examples, multiple choice tests, T/F tests) o Within the htmltemplates folder is a notebooks folder. This folder will mirror the notebooks folder on the CLASS™ Web Server. Within this folder is a templates (templates for each student) folder that will contain all the notebook templates for the cousre pages (i.e., personal journal page, essay assignments, reading log). Graphics for the notebooks pages go directly into the templates folder. o The original folder will contain all original files that are received from DCS. This folder contains a units folder that breaks the course down into its unit segments. o As the html files are created, make a copy and place the copy in the appropriate final folder of the final folder section. o The websites folder will contain any websites that are cached for the course. Each site will reside in it’s own folder. Glossary Folder Procedure o Within this folder is a database, graphics, and text folder.
5
o The original text for the glossary that is received from DCS should be placed in the text folder. o The database that is created in MSAccess with the html markup will be stored in the database folder. o Any final graphics that are to be used in the glossary will be stored in the graphics folder o All source graphic files for the glossary will be in the graphics folder inside the source folder. Graphics Folder Procedure o Within this folder is a working and a check folder. o The working folder will contain all source files for the course. o Within the working folder is a common folder that contains all graphics common and repeated in the course. o Also within the working folder is a units folder where source graphics for each unit are stored. o When graphics are sized and formatted, place them in the check folder. Once they are approved they should be cut and pasted into the appropriate final unit/section. o If there are graphics needed for the glossary then a graphics source folder will be created. Video Folder Procedure o Within this folder is a units folder. o Captured video should be stored in the units folder. o Once a video has been compressed and approved it should be stored in the appropriate final unit folder under the final video folder. o Source Capture files should not be saved once the compressed version has been approved. o A Readme file should be kept with the specifications for the captured video (time code, bit rate for audio, etc.) in the video folder.
6