1. Preface

The most up to date version of this documentation can be found in HTML and PDF form on ReadTheDocs at readthedocs.org/projects/hlutool-userguide.

1.1. Recommended User Knowledge

1.1.1. Users

This user guide assumes that users of the HLU Tool have:

• General IT experience including use of Microsoft Windows.

• Experience in the use of a relevant GIS software (currently ArcGIS or MapInfo), including selecting, querying and editing features and attributes.

• An understanding of habitat survey methodologies, especially the Integrated Habitat System (IHS).

1.1.2. Administrators

It is recommended that a person within each organisation is designated as the tool and database administrator. This person should:

• Have an understanding and experience of IT systems management.

• Understand relational database structures.

• Be an expert user of the chosen database system.

• Have qualifications, certified training or equivalent experience in managing databases using that system.

• Have certified training or equivalent experience in advanced features of the relevant GIS software, including defining, joining and exporting layers and creating spatial and attribute indexes.

A technical guide is also available on ReadTheDocs at readthedocs.org/projects/hlutool-technicalguide for those of a more ‘techie’ nature with details on how to install, configure, maintain and upgrade the HLU Tool and associated relational database.

1.2. Reading Guide

This Preface explains a little about the HLU Tool, the community of people who develop and use it, and the licensing conditions for using and distributing it.

Introduction explains why the HLU Tool is needed, what it does and where it comes from.

Concepts is a brief outline of the key concepts of the HLU Tool.

Menus describes all the user interface menu items and buttons on the HLU Tool.

Interfaces describes all the user interface windows and components of the HLU Tool.

Functions demonstrates how to perform the common functions of the HLU Tool.

FAQ has a list of commonly asked questions and their answers.

Glossary contains a brief glossary and description of commonly used terms.

Appendix introduces tips for optimising performance, lists known issues with the tool and contains a copy of the GNU Free Documentation License v1.3 covering this guide.

1.3. Licensing

The code for the HLU Tool is ‘open source’ and is released under GNU General Public License (GPL) v3. Users are free to install it on as many computers as they like, and to redistribute it according to the GPLv3 license.

This guide is released under GNU Free Documentation License (FDL) v1.3. Permission is granted to copy, distribute and/or modify this document under the terms of the license.

Please remember, however, that the HLU Tool cost a lot of money to develop and still requires further development and ongoing support. Hence any contributions towards costs would be gratefully received. Enquiries can be made via the Knowledge Hub at khub.net/group/association-of-local-environmental-records-centres.

1.4. Useful links

Related community links:

Users

For announcements, bug reports, user Q&A and feature discussions see khub.net/group/association-of-local-environmental-records-centres/group-forum

Administrators

For release notes and installers for ArcGIS and MapInfo systems see github.com/HabitatFramework/HLUTool/releases

Developers

For the source code for the HLU Tool see github.com/HabitatFramework/HLUTool

Issues

For details of any known issues and proposed change requests see github.com/HabitatFramework/HLUTool/issues

1.5. Acknowledgements

Many thanks are due to all the LERCs in the south-east of England and their staff who have, and continue to, fund and contribute to the HLU Tool. It takes a small army of developers, testers and users to build a truly useful tool.

1.6. Conventions used in this manual

The following typographical conventions are used in this manual:

Ctrl-A

Indicates a key, or combination of keys, to press.

Commit

Indicates a label, button or anything that appears in user interfaces.

Tools… –> About

Indicates a menu choice, or a combination of menu choices, tab selections or GUI buttons.

C:\Program Files\HLU Tool

Indicates a filename or directory name.

Tip

Tips can help save time or provide shortcuts.

Note

Notes explain things in more detail or highlight important points.

Caution

Warnings where users should pay attention.