1. Preface

The most up to date version of this documentation can be found in html and PDF form on ReadTheDocs.

1.1. What this guide covers

This guide explains a little about how the HLU Tool source code is structured, what you may need to develop and support it, how to build and distribute it, and how to maintain the associated online guides.

Requirements summarises the applications, websites, tools, skills & experience that a developer may need.

Components outlines the major components of the tool’s source code.

Source Control introduces the basics of the GitHub version control repository where the source code is hosted.

Coding Standards proposes some general guidelines for coding standards, metadata and comments when making code changes.

Windows Installer summarises the features and configuration options that are used for creating an installer for the tool.

New Releases lists the steps to follow when building the tool and distributing a new release.

ArcGIS Registration describes how and why the tool is registered as an ArcGIS extension.

Documentation gives an overview of the associated online guides and how to maintain them.

Issue Logging introduces the online forum and issue log where problems and enhancements can be proposed and discussed.

Appendix contains a copy of the GNU Free Documentation License v1.3 covering this guide.

1.2. Open Source 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.

These licenses are designed to guarantee the user’s freedom to share and change the software and documentation under the terms of the licenses (but note that no additional restrictions may be applied to any new products resulting from changes to the HLU Tool or associated documentation).

Please remember, however, that the 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 ALERC forum.

1.4. Acknowledgements

Many thanks are due to all the LRCs in the south-east of England and their staff who have, and continue to, fund and support the development of the HLU Tool. It takes a small army of developers, testers and users to build a truly useful tool (especially users who care enough to test new releases, report bugs and discuss feature requests).

1.5. 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 developers should pay attention.