ATLAS     Level 1     Calorimeter Trigger     Software    

L1Calo Software About this website

 

Overview

The source files for this website are kept in our CVS repository (package l1calo/sweb). The main reason for this is to allow controlled access by widely scattered developers rather than to keep the history.

The input HTML files can (in principle) be created by any web authoring tool, or by hand.

The entire CVS package is unpacked periodically and processed by a perl script (cobble.pl) which adds the title and navigation bars. The script adds a link to a common style sheet. It will also add an <address> section if the original file doesnt contain one. The date and author are obtained from the CVS Id string.

This script is kept in the repository, but for security reasons a manual copy of the script is actually used.

Notes for Developers

  • Checkout the l1calo/sweb package from our CVS repository.
  • Since this package refers to our documentation package l1calo/doc you might need to checkout that one too.
  • Create/modify web pages with your favourite tool.
  • Im not sure what happens if your tool adds its own style sheet (it might conflict with ours).
  • Dont include an <h1> tag as the automatically created title bar effectively provides one.
  • Do, if possible, include an HTML comment with a CVS Id tag
    <!-- $Id: $ -->
    as this is expanded by CVS and can be used to automatically create the last update <address> section.
  • Dont use a tool which removes comments from existing files!
  • You can add yourself as a known author to the top level .cobble options file. This allows the script to convert your username to a fullname and a URL (eg mailto or home page).
  • Try out your changes locally:
    • Create a suitable output directory within your webspace:
      mkdir ~/pubwww/l1calo
    • Set the L1CALO_ROOT environment variable to point to it:
      export L1CALO_ROOT=~/pubwww/l1calo     or
      setenv L1CALO_ROOT ~/pubwww/l1calo
    • Run make to build the website locally and check it looks OK.
  • Commit your changes to CVS and check the default website has been correctly updated (in next day or so hopefully).


Last updated on 18-Apr-2005 by Murrough Landon