Fixed up the Introduction.

pull/32/head
Christian Jacobs 2015-02-08 14:20:56 +00:00
rodzic f49ac8738e
commit b5b56cf04b
1 zmienionych plików z 6 dodań i 23 usunięć

Wyświetl plik

@ -35,9 +35,7 @@ include:
- Basic support for the Hamlib library.
The source code for PyQSO is available for download at:
``https://github.com/ctjacobs/pyqso``
The source code for PyQSO is available for download from the `GitHub repository <https://github.com/ctjacobs/pyqso>`_.
Data storage model
------------------
@ -46,7 +44,7 @@ Many amateur radio operators choose to store all the contacts they ever
make in a single *logbook*, whereas others keep a separate logbook for
each year, for example. Each logbook may be divided up to form multiple
distinct *logs*, perhaps one for casual repeater contacts and another
for DXing. Finally, each log can contain multiple *records*. PyQSO is
for DX'ing. Finally, each log can contain multiple *records*. PyQSO is
based around this three-tier model for data storage, going from logbooks
at the top to individual records at the bottom.
@ -60,25 +58,10 @@ log.
Licensing
---------
PyQSO is free software, released under the GNU General Public License.
Please see the file called COPYING for more information.
PyQSO is free software, released under the GNU General Public License. Please see the file called ``COPYING`` for more information.
Structure of this manual
------------------------
Structure of this documentation
-------------------------------
The structure of this manual is as follows. Chapter
[chap:getting:sub:`s`\ tarted] is all about getting started with PyQSO –
from the installation process through to creating a new logbook (or
opening an existing one). Chapter [chap:log:sub:`m`\ anagement] explains
how to create a log in the logbook, as well as the basic operations that
users can perform with existing logs, such as printing, importing
from/exporting to ADIF format, and sorting. Chapter
[chap:record:sub:`m`\ anagement] deals with the bottom layer of the
three-tier model – the creation, deletion, and modification of QSO
records in a log. Chapter [chap:toolbox] introduces the PyQSO toolbox
which contains three tools that are useful to amateur radio operators: a
DX cluster, a grey line plotter, and an awards progress tracker.
Finally, Chapter [chap:preferences] explains how users can set up Hamlib
support and show/hide various fields in a log, along with several other
user preferences that can be set via the Preferences dialog window.
The structure of this documentation is as follows. The section on `Getting Started <getting_started.html>`_ provides information on the PyQSO installation process through to creating a new logbook (or opening an existing one). The `Log Management <log_management.html>`_ section explains how to create a log in the logbook, as well as the basic operations that users can perform with existing logs, such as printing, importing from/exporting to ADIF format, and sorting. The `Record Management <record_management.html>`_ section deals with the bottom layer of the three-tier model - the creation, deletion, and modification of QSO records in a log. The `Toolbox <toolbox.html>`_ section introduces the PyQSO toolbox which contains three tools that are useful to amateur radio operators: a DX cluster, a grey line plotter, and an awards progress tracker. Finally, the `Preferences <preferences.html>`_ section explains how users can set up Hamlib support and show/hide various fields in a log, along with several other user preferences that can be set via the Preferences dialog window.