Summarised Help Template

There are 7 main sections of data as discussed below

Equipment Calibration Values
- This section contains the information that is imported from any equipment items on the screen through the calibration values.
- Create a new section for each equipment item from which something is imported and mention the data (along with any units) that is being imported.
Minimum Data Requirements
- This section contains information on the minimum data that is to be entered for certain calculations to take place.
- Each calculation should have it's own subsection and the information should be presented in grid format.
Related Documents
- This section contains information on the documents from which data is imported to the current screen or vice versa.
- For each test method/screen that is related, the field/data that is being imported/exported also needs to be mentioned, in different sections. Refer example below.
Completion Requirements
- This section contains information on what makes the screen complete.
Reported Results
- This section contains the information that is being reported from this screen.
- Both the standard reporting requirements and any additional data being reported needs to be mentioned.
- Both these information should be presented in a single grid but with different section headings. Refer example below.
Formulae
- All relevant formulae used in obtaining the final reported results (or intermediate results) should be mentioned here.
- Follow formulae notation as show in the example below.
Test Specific Options
- This section will contain information on how a given document level option affects the current screen.
- There will be some options that are obsolete i.e. are not used anymore. These DON'T need to be mentioned here. Only options that are still used should be mentioned.
- As far as possible, avoid using images. This way if the screen is changed then we don't have to update the wiki.

Shown below is an example of a summarised section.
NOTE: Each section (for a given test method) needs to be enclosed in the <div class="qestSummary"> </div> tags as shown below (when you 'Edit').
NOTE: When creating new summarised pages you can just copy the example below and replace data in the necessary sections.

Example:

Equipment Calibration Values

Density Mould

Mould Type
Mould Mass (g/lb)
Mould Volume (cm³\ft³)

Hammer

Description

Minimum Data Requirements

Maximum Dry Density Calculation

Prompt	Value
Number of Samples	>=3
Mass of Mould & Wet Soil (g)	-
Volume of Mould (cm³)	-
Mass of Container & Wet Soil (g)	-
Mass of Container & Dry Soil (g)	< Mass of Container & Wet Soil (g)

Completion Requirements

MDD (t/m³) value exists.

Reported Results

Standard Reporting Requirements
Standard Maximum Dry Density (t/m³)	nearest 0.01
Standard Optimum Moisture Content (%)	nearest 0.5
Oversize Sieve (mm)	nearest 0.1
Oversize Material (%)	nearest 1
Additional Reporting
Mould Type	-
Particle Density (t/m³)	nearest 0.001
Compactive Effort	-

Formulae

Wet Density

D_wet = (M_mould+soil - M_mould) / V_mould
Where,
D_wet = Wet Density (t/m³)
M_mould+soil = Mass of Mould & Wet Soil (g)
M_mould = Mass of Mould (g))
V_mould = Volume of Mould (cm³)

Dry Density

D_dry = 100 * D_wet / (100 + MC)
Where,
D_dry = Dry Density (t/m³)
D_wet = Wet Density (t/m³)
MC = Moisture Content (%)

Air Voids

D_dry = (1 - A_void / 100) / (1 / D_particle + MC/100)
Where,
D_dry = Dry Density (t/m³)
A_void = Air Voids (%)
D_particle = Particle Density (t/m³)
MC = Moisture Content (%)

Test-specific Options

Use Water Added (%) in Calculations

If this option is set to "TRUE", "Water Added (g)" is no longer manually entered but is instead calculated from the "Mass of Sub Sample (g)" and the "Water Added (%)".