Document Structure

This HTML document template is built with two components: the content and the style definitions. The content is in HTML4.01 and use is made of some simple container elements to define the regions for the different forms of content. The directory struture of the document follows the structure of each main page with a sub-directory for each major heading.

• Directory Structure
  Common element directories
  • css
  • Images
  Content element directories
  • Section1
  • Section2
  • Section3
  • Resources
• Page structure
  Each page in the manual consists of several main container elements, plus the required HTML header. The header is where all the appropriate format code, specified using cascading style sheets, is imported. The main element containers, specified as HTML <div id="name"> elements where the names are
  • Header
  • TopNav
  • content
  • LeftNav
  • Banner
  • copyright
  The highlighted items are the containers that a developer needs to edit to add content for a page. In general, TopNav items are links to the index page for that major topic, the one exception being the Resources, this page being part of that set of content that is only accessible from the main Index (which is contained in the Header div).
• Formatting Buttons
  Buttons are formed by placing anchor elements in the appropriate TopNav or LeftNav <div> containers. Class specifiers can be used to give a button the appearance of being pressed - this is useful to indicate visually that a particular page is currently being viewed. This is achieved thus: <a class="sel" href="...some url"> ButtonName </a>
  For buttons in the LeftNav <div>, there are two extra containers used to give the appearance of a list and sublist of buttons. These additional <div> elements are of the form <div id=links"> and <div id="sublinks">. The same formatting of an anchor element is used to create the button and a class="sel" specifier to give the appearance of a selected button. The Example Source button in the left menu of this page has the source code for these effects, as well as showing the other container elements in each page.
• Relative Links
  Just to note that most of the navigation functions to get to different pages of the document use relative links. Care must be taken to ensure the links are correct relative to where the actual page is in the directory tree. Do not use full path names for the links, these will only be correct for your own localisation of the document. Always use relative names.

More Navigation