QC Tutorial Pages

This information refers to the main implementation of the QC tutorial pages in 2008. It is kept for heritage only.

Here is a list of hints and tips on how to transfer your current tutorial pages to the new format using the template page. Examples are available for GIRAFFE (QC1 parameters in table; screen shots for trending) and FORS1 (QC1 parameters in list, pop-up windows for trending).

• replace "Sabine.Moehler" by your name
• replace "smoehler" by your username
• fill <title> and header consistently (instrument name and tutorial type)
• replace GIRAFFE with your instrument name
• navigation bar: *must always be included as #include virtual* with the name as defined in the webNavBar config file (use PARENT/CHILD mechanism for the navbars in the QC section)
• make sure that the QC1 database links go to correct table!

The tool checkTut (to be used from your operational account) checks for comments ChangeName, changeInst and ChangeContent and thereby allows you to see if you did all necessary changes.

• top navigation
  • only if more than one item
  • repeat the ones from the top table
  • use anchors (and "top") for page navigation
• levels
  • level 1 - item
  • level 2 - topic
    possible values: QC1 parameters | trending | history (all optional but at least one entry!)
• style
  • <font size=2> for text, table entries etc.
  • <font size=+2 color=white><b> for item headlines (level 1); these go into a table
  • <font size=+1><b> for level 2 headlines
• images
  • into table (80%)
  • 2 cells: one for image, one for caption
  • smaller images: included
  • larger images: linked
• tables: width 80%

• QC1 Parameters
  • "parameter" as showing up in the Health Check plots
  • "QC1 database: table, name" listing the qc1 db table and column name
  • "procedure" or "description": some description of what is done
• Trending
  • any text describing the plots etc.
  • screen shots or links to plots if necessary
• History: anything which you want to keep remembered
• You could also have some general remarks preceeding the "QC1 parameter" section.