Broadly speaking the scaffold refers to the structure (or layout ) of the site. Some effort has gone into reducing the scaffolding restrictions.
Here is an images of the site layout for this manual as it appears in WindowsXP. (The .svn folders as well as the special icons overlaying the folders are artifacts of the subversion control system we use for all software development projects.)
Although the layout has designed to be quite flexible there are some basics
which authors must respect. Fundamentally, the site is designed as a tree.
The root node can be any directory on your web site but the rest of the tree
must branch down from that node. There are three webWriter subdirectories under
the root—webWriter
, style
and content
.
The Templates
folder contains Dreamweaver templates and has been
left in as a convenience for Dreamweaver authors that use templates. Others
may delete it. The TMSetup
contains instructions for setting up
FireFox or InternetExplorer for use with WebWriter++ and the Teaching Machine.
It is not part of the site, per se, but again has been included for
convenience (although it is not likely to age gracefully). The help
folder
contains the (very limited) help files for the TM itself.
default.htm
navBar.htm
tocGenerator.htm
tm.jar
buttonClass.js
header.js
‹head›
section
for content pages. inputForm.htm
navBarheader.js
‹head›
section
for the navigation bar which tops most pages. parser.js
insertCode
snippet used to insert code into webWriter++ code containers.printForm.htm
printHeader.js
‹head›
section for printed pages. slider.htm
tocNavigator.js
standardButtons.js
wait_for_applets.htm
web_writer.js
ww_one_time.js
web_writer.js
. lectureScreen.css
notesScreen.css
notesPrint.css
navBar.css
slider.css
toc.css
configurations folder
insertCode
command.
TM configuration files control such things as the overall size and layout
of TM windows, as well as which ones will appear, the font sizes and the
title of the windows. dictionary.htm
nav-map.js
noteConstants.js
constants.js
file). It is used to allow the very large video files to be grouped
together making them easier to manage. This much of the layout should be respected. A WebWriter++ skeleton in the form of a zip file is contained in the root of this site.
The schema was suggested by Theo Norvell and is designed to isolate content, style and tools from each other.
This is the head for this page and should be used as a template for each content page:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html401/sgml/dtd.html"><head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>The Site Scaffold</title>
<script language="JavaScript">
nestingDepth = "../../";
</script>
<script language="JavaScript" src="../noteConstants.js"></script>
<script language="JavaScript" src="../../webWriter/header.js"></script> <script language="JavaScript" src="../../webWriter/buttonClass.js"></script>
<script language="JavaScript" src="../../webWriter/parser.js"></script>
<script language="JavaScript" src="../../webWriter/web_writer.js"></script>
</head>
The header.js
javaScript writes most of the standard head information
including generator
, author(s)
and copyright
meta tags,
using variables set in contants.js
(in
the content
folder root). It also automatically links in the stylesheets
(whose names must be preserved but which may be otherwise edited).
The crucial issue is the nestingDepth
which defines the path
of the page relative to the root as well as the the leading part of the three
javaScript references. This must be correct. Those to web_writer.js
and header.js
use
the same string as the
nestingDepth
because the webWriter
folder is located
in the root. The noteConstants.js
,
however, backs up one less because the noteConstants.js
javascript,
which is designed to be author-editable, is located in the root of the content
folder.
The title
tag should always be present as it will be used to
generate the title that appears in the tool bar.
Pages at different depths from the root will have to change all relative references in this head including nestingDepth
Authors using Dreamweaver may use a Dreamweaver template as an alternative to propagating the above head to every page in the site by hand. All references in the Dreamweaver template are relative to the template. Dreamweaver will automatically adjust them when creating template based pages. However, nestingDepth
is a JavaScript variable and will not be altered by Dreamweaver so must be adjusted by hand. Thus it has been included with title in an editable section of the template.
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html401/sgml/dtd.html"><head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<!-- TemplateBeginEditable name="doctitle" -->
<title>Unnamed Page</title>
<script language="JavaScript">
nestingDepth = "../../";
</script>
<!-- TemplateEndEditable -->
<!-- these are relative to template -->
<script language="JavaScript" src="../content/noteConstants.js"></script>
<script language="JavaScript" src="../webWriter/header.js"></script> <script language="JavaScript" src="../webWriter/buttonClass.js"></script>
<script language="JavaScript" src="../webWriter/parser.js"></script>
<script language="JavaScript" src="../webWriter/web_writer.js"></script>
</head>
<body id="bodyRef">
<div id="content">
<!-- TemplateBeginEditable name="contents" -->
<!-- TemplateEndEditable -->
<div id="allExamples">
<!-- TemplateBeginEditable name="allExamples" -->
<h1>Examples Shown in Full </h1>
<!-- TemplateEndEditable --></div>
<p>
<script language="JavaScript">
bottomStamp(true, true);
</script>
</p>
</div>
</body>
</html>