General notes on Conventions used

  • The page is valid XHTML 1.0 Strict. This is essential. Checking is best done using ‘Tools..Validate Local HTML’ in Firefox’s Web Developer Toolbar.
  • All the html is strictly nested and indented using two spaces (not tabs). This is so any nesting issues can quickly be spotted, and it shows the same in all text editors and browser source. Any script is also indented in the same way.
  • All script and style is included in the head of the document. It is OK to put JavaScript and CSS within <script> and <style> tags in the head, as it makes it easier to develop this way. Often the script and style are moved into separate .js and .css files once development and testing is complete.
  • The contents of any inline script is embedded in between
    /* <![CDATA[ */      and      /* ]]> */
    This is so it validates correctly (the validator would otherwise complain about characters like < and > used in the script).
  • To make it easier to see which files are is included at a glance we put the src or href of any include files first, and put two space between ‘link’ and ‘href’ so the file names all line up.
    
        <script src="../Include/Core.js" type="text/javascript"></script>
        <link  href="../Include/Style.css" type="text/css" rel="stylesheet"/>
                
  • All our pages have the following basic structure
    
        <html>
    
          <head>
    
          </head>
    
          <body>
    
            <div id="topnav">
    
            </div>
    
            <div id="wrapper">
              <div id="content">
                <div id="main">
    
                </div>
              </div>
            </div>
    
            <div id="sidebar">
    
            </div>
    
            <div id="footer">
    
            </div>
    
          </body>
    
        </html>