The Setup Directory
- To create the SetupDirectory directory.
Setup Files
The SetupDirectory directory should contains the following files:
- ReadMe.html
- Any supplemental setup files (e.g, a database script or a build file)
Course Descriptor
There should be one course descriptor for each class that can be created from these class files. For example, if there could be an introductory class, intermediate class, and advanced class, then there should be three course descriptors. A course descriptor is an HTML file that follows a very specific structure. The demo below shows how it is formatted.
Code Sample: TheSetupDirectory/Demos/ReadMe.html
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Read Me</title>
</head>
<body>
<h1>HTML Setup Instructions</h1>
<p>This document contains setup instructions for Webucator's HTML courses.</p>
<section id="allCourses">
<ol>
<li>If you haven't already, download the class files listed at the bottom of this page.</li>
<li>Create a folder in the root of your C drive called "Webucator" and extract the class files zip file to that folder.</li>
<li>Make sure that you have installed the editor you plan to use in class.<ol>
<li>See the course outline for your class to determine which editors you can use.</li>
<li>If this is for a private onsite class make sure that each computer has the editor installed.</li>
<li>If you are using a trial version of the editor, be aware that some products require a unique trial key on each computer.</li>
</ol>
</li>
</ol>
</section>
<section id="HTM101">
<p class="ClassOutline">Outline available at <a href="http://www.webucator.com/WebDesign/HTM101.cfm">http://www.webucator.com/WebDesign/HTM101.cfm</a>
</p>
<p class="ClassFiles">Class files available at <a href="http://www.webucator.com/ClassFiles/HTM101.zip">http://www.webucator.com/ClassFiles/HTM101.zip</a>
</p>
<p class="TechReqs">Technical requirements listed at <a href="http://www.webucator.com/WebDesign/HTM101.cfm#TechReqs">http://www.webucator.com/WebDesign/HTM101.cfm#TechReqs</a>.</p>
</section>
<section id="HTM201">
<p class="ClassOutline">Outline available at <a href="http://www.webucator.com/WebDesign/HTM201.cfm">http://www.webucator.com/WebDesign/HTM101.cfm</a>
</p>
<p class="ClassFiles">Class files available at <a href="http://www.webucator.com/ClassFiles/HTM201.zip">http://www.webucator.com/ClassFiles/HTM101.zip</a>
</p>
<p class="TechReqs">Technical requirements listed at <a href="http://www.webucator.com/WebDesign/HTM201.cfm#TechReqs">http://www.webucator.com/WebDesign/HTM101.cfm#TechReqs</a>.</p>
</section>
</body>
</html>
Read Me
The ReadMe.html file has instructions for how to get started with setup. This is where people setting up for class will go after they have properly installed all the software needed for class. It should tell people where to put the class files and how to set them up and how to run tests to make sure setup has been done correctly.
If the class can be broken up into different classes, the ReadMe.html file should explain what needs to get done for each class.
This file should be valid XHTML Strict. It must be broken into HTML5 <section> tags as follows:
- One <section> block that applies to all courses (<section id="allCourses">)
- One <section> block for each course (e.g, intro, intermediate, advanced)
The Setup Directory Conclusion
In this lesson of the WCWC tutorial, you have learned to create the SetupDirectory directory.