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

The most up to date version of this documentation can be found in **HTML** and **PDF** form on `ReadTheDocs <https://readthedocs.org/projects/databuffer-userguide/>`_.

.. index::
	single: Recommended user knowledge

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

Users
-----

This user guide assumes that users of the Data Buffer tool have:

* General IT experience including the use of Microsoft Windows.
* Experience in the use of a relevant GIS application supported by the tool (currently MapInfo and ArcGIS), including selecting and querying features and attributes.
* An understanding of the datasets that are used by the Data Buffer tool.


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.
* Have certified training or equivalent experience in advanced features of the relevant GIS software.
* Become familiar with how the Data Buffer tool has been configured within the organisation.
* Have a good understanding of XML.

.. raw:: latex

   \newpage

.. index::
	single: Reading guide

Reading Guide
=============

This Preface explains a little about the Data Buffer tool, the community of people who develop and use it, and the licensing conditions for using and distributing it. It also explains how to read this user guide.

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

:doc:`Setting up the tool <../setup/setup>` \ describes how to install and set up the Data Buffer tool.

:doc:`Running the tool <../execute/execute>` \ describes how to run the Data Buffer tool.

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

:doc:`../appendix/appendix` \ contains examples of the XML configuration file for MapInfo, 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 Data Buffer tool is 'open source' and is released under the `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 the `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 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 email to either `Hester <mailto:Hester@HesterLyonsConsulting.co.uk>`_ or `Andy <mailto:Andy@AndyFoyConsulting.co.uk>`_.


.. index::
	single: Useful links

Useful links
============

Related community links:

* Administrators: (`MapInfo Installation <https://github.com/LERCAutomation/DataBuffer-MapInfo/releases/>`_) - Release notes and installers for MapInfo.
* Developers (`MapInfo Source Code <https://github.com/LERCAutomation/DataBuffer-MapInfo>`_) - Source code for the Data Buffer tool.
* Issues (`Known issues <https://github.com/LERCAutomation/DataBuffer-MapInfo/issues>`_) - Details of known issues and existing change requests.


.. index::
	single: Acknowledgements

Acknowledgements
================

Many thanks to Thames Valley Environmental Records Centre (TVERC) who have funded the development of the Data Buffer tool.


.. raw:: latex

	\newpage

.. index::
	single: Conventions used in this user guide

Conventions used in this user guide
===================================

The following typographical conventions are used in this manual:

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

:file:`C:\\Program Files (x86)\\MapInfo\\Professional`
	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.