theothermy

HLCP requires that a suitable graphical help file be provided.

The Help file is a combination of still screenshots with text boxes, and short animated screen captures, for each "How To" for HLCP, basically to focus on how to get things done, rather than explain everything. Information needs to be presented in a logical manner so that the work flow is clear.



Since it is presumed that the user is familiar with HVAC Load calculations, there is no link to any "Reference" as such, but brief introductionary details shall be provide in text boxes on static screens to explain certain features such as "Project Masters", Schedule Masters", etc. which may be new to the HVAC engineer experienced only in manual Heat Loads .

To meet this end, an sectionalised HTML Help file, each section being a mix of static screenshots with dialogue boxes giving explanations, and short animated swf flash screen captures, which show an animated mouse cursor actually performing a certain task

The final file shall be a set of swf files, linked to HTML files, which can be accessed through the menubar of HLCP or even ported to a website.

"Wink" shall be used to create the animations, and "Shalom Help Maker v 0.6.1" shall be used for the compiled help file.

Download links here:


Wink

http://www.debugmode.com/wink/download.php


Shalom Help Maker

http://www.danish-shareware.dk/soft/shelpm/

You will need the compiler files for turning your project (the shp file and images) into a help file.


Help Compiler

http://www.danish-shareware.dk/soft/shelpmbeta/helpcompiler.zip


A preliminary broad index for the various Sections of the Help file is given below. (Note that within these sections, there would be sub-sections, i.e., that for each section, we may need subdivided sections to cover all aspects.

The proposed sections (index) of the HLCP Help.

Index for HCLP Help file.

Introduction to HLCP
What is HLCP?


Starting HLCP
Accessing the Getting Started pdf file
Accessing the FAQ pdf file


Defining a Building

The HLCP Environment
The Menubar
The tab bar
Getting Help

The user files
eplusout.csv
PostProcess.csv

projectname_input.csv
projectname_postprocess.csv
projectname.pdf

What is a Project
Starting a new Project
Opening an existing Project
Filling in Project Details
Saving a Project
Deleting a Project
Deleting a Project Master
Deleting a Schedule Master

Projects Tab

Selecting the units
Location / Weather Tab
Selecting the location
Selecting the Weather Data source
Selecting the City
Selecting the Range

Project Master tab

Project Masters Tab
What is a Project Master
Creating a new Project Master
Loading an existing Project Master
Saving a Project Master

Select the Project Master tab
Selecting a U value for the Project Master
Adding / deleting a value in the Project Master
Changing default safeties

U value calculator

Opaque U value calculator
What is the opaque U value calculator
Film coefficients
Maximum number of layers
Order of layers
Units

How to create a new opaque Construction...
How to select and transfer an opaque Construction...
How to delete an opaque Construction
How to add a U value directly
Exiting the U value Calculator

How to create a new window Construction...
How to select and transfer a window Construction...
How to delete a window Construction
How to add a U value directly*
Exiting the U value Calculator


Shedule Master tab

What is a Schedule Master
Creating a new Schedule Master
Loading an existing schedule Master
Saving a Schedule Master

System Details tab

What are System Details
Adding a new System
Deleting a System
Duplicating a system
Inside Design Conditions
Bypass factor
System multiplier

Zone Details tab

Defining a new Zone
Entering basic Zone details
Drawing a Zone
Saving a Zone

Entering Wall/ Partition details
Entering Window details
Entering shade (external to window) details
Entering Blinds / Drapes details
Entering Door details
Entering Floor details
Entering Flat Roof/Ceiling details
Entering Skylight details
Entering Gable Roof details

Internal Loads tab

Entering Occupancy details
Entering Infiltration details
Entering Heat Recovery details
Entering Ventilation Air details
Entering Equipment details
Entering lighting details

Input Summary tab

Reports tab

What are seasonal loads
What are monthly loads
What are hourly loads

Selecting the output type required.
Adding a monthly time period
Adding a hourly time period

The Run tab

Save and Simulate
Save and Simulate Later

The Outputs Tab

The Seasonal load output
Accessing the output csv files

The Error window