*******
Preface
*******

.. index::
	single: 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 <https://readthedocs.org/projects/hlutool-userguide/>`_.

Recommended User Knowledge
==========================

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).


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 <https://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.


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.

:doc:`../introduction/introduction` \ explains why the HLU Tool is needed, what it does and where it comes from.

:doc:`../concepts/concepts` \ is a brief outline of the key concepts of the HLU Tool.

:doc:`../menus/menus` \ describes all the user interface menu items and buttons on the HLU Tool.

:doc:`../interface/interface` \ describes all the user interface windows and components of the HLU Tool.

:doc:`../functions/functions` \ demonstrates how to perform the common functions of the HLU Tool.

:doc:`FAQ <../faq/faq>` \ has a list of commonly asked questions and their answers.

:doc:`../glossary/glossary` \ contains a brief glossary and description of commonly used terms.

:doc:`../appendix/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.


.. index::
	single: Licensing

Licensing
=========

The code for the HLU Tool is 'open source' and is released under `GNU General Public License (GPL) v3 <http://www.gnu.org/licenses/gpl.html>`_. 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 <http://www.gnu.org/licenses/fdl.html>`_. 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 <https://khub.net/group/association-of-local-environmental-records-centres>`_.


.. index::
	single: Useful Links

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 <https://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 <https://github.com/HabitatFramework/HLUTool/releases>`_

Developers
	For the source code for the HLU Tool see `github.com/HabitatFramework/HLUTool <https://github.com/HabitatFramework/HLUTool>`_

Issues
	For details of any known issues and proposed change requests see `github.com/HabitatFramework/HLUTool/issues <https://github.com/HabitatFramework/HLUTool/issues>`_


.. index::
	single: Acknowledgements

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.


.. raw:: latex

	\newpage

Conventions used in this manual
===============================

The following typographical conventions are used in this manual:

:kbd:`Ctrl-A`
	Indicates a key, or combination of keys, to press.

:guilabel:`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.

:file:`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.