Updated documentation following the addition of new features.

pull/61/head
Christian T. Jacobs 2017-04-10 23:32:25 +01:00
rodzic 93e76b9b84
commit db80fac9fe
4 zmienionych plików z 41 dodań i 21 usunięć

Wyświetl plik

@ -13,9 +13,9 @@ include:
- Customisable interface (e.g. only show callsign and frequency
information).
- Import and export logs in ADIF format.
- Import logs in `ADIF <http://www.adif.org/>`_ format, and export logs in ADIF or `Cabrillo <http://wwrof.org/cabrillo/>`_ format.
- Perform callsign lookups and auto-fill data fields using the qrz.com and hamqth.com online databases.
- Perform callsign lookups and auto-fill data fields using the `qrz.com <http://www.qrz.com/>`_ and `hamqth.com <http://www.hamqth.com/>`_ online databases.
- Sort the logs by individual fields.
@ -23,7 +23,7 @@ include:
- Connect to Telnet-based DX clusters.
- Progress tracker for the DXCC award.
- Progress tracker for the `DXCC <http://www.arrl.org/dxcc/>`_ award.
- Grey line plotter.
@ -32,7 +32,7 @@ include:
- Remove duplicate QSOs.
- Basic support for the Hamlib library.
- Basic support for the `Hamlib <http://hamlib.sourceforge.net/>`_ library.
The source code for PyQSO, written in Python (version 3.x), is available for download from the `GitHub repository <https://github.com/ctjacobs/pyqso>`_.
@ -67,5 +67,5 @@ If you have any comments or questions about PyQSO, please send them via email to
Structure of this documentation
-------------------------------
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. A `keyboard shortcuts list <shortcuts.html>`_ is also available for reference.
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/exporting logs, 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. A `keyboard shortcuts list <shortcuts.html>`_ is also available for reference.

Wyświetl plik

@ -19,7 +19,7 @@ logbook). Furthermore, it can only be composed of alphanumeric
characters and the underscore character, and the first character in the
name must not be a number.
Note: When logs are stored in the database file, field/column names from
**Note:** When logs are stored in the database file, field/column names from
the ADIF standard are used. However, please note that only the following
subset of all the ADIF fields is considered: CALL, QSO\_DATE, TIME\_ON,
FREQ, BAND, MODE, SUBMODE, TX\_PWR, RST\_SENT, RST\_RCVD, QSL\_SENT, QSL\_RCVD,
@ -43,8 +43,8 @@ Importing and exporting a log
-----------------------------
While PyQSO stores logbooks in SQL format, it is possible to export
individual logs in the well-known `ADIF <http://www.adif.org/>`_ format. Select the log to export,
and click ``Export Log`` in the ``Logbook`` menu.
individual logs in the well-known `ADIF <http://www.adif.org/>`_ and `Cabrillo <http://wwrof.org/cabrillo/>`_ formats. Select the log to export,
and click ``Export Log as ADIF`` or ``Export Log as Cabrillo`` in the ``Logbook`` menu.
Similarly, records can be imported from an ADIF file. Upon importing,
users can choose to store the records in a new log, or append them to an

Wyświetl plik

@ -13,21 +13,25 @@ Under the ``General`` tab, the user can choose to:
- display yearly logbook statistics on the Summary page when a logbook is opened (see figure:summary_)
- open a default logbook file
- keep the ``Add Record`` dialog window open after a new QSO is added, in preparation for the next QSO
- pin-point the user's QTH on the grey line map
.. _figure:summary:
.. figure:: images/summary.png
:align: center
The Summary page which appears after a logbook is opened. This presents some basic logbook statistics.
View
----
Not all the available fields have to be displayed in the logbook. The user can choose to hide a subset of them by unchecking them in the ``View`` tab. PyQSO must be restarted in order for any changes to take effect.
ADIF
----
Import/Export
-------------
PyQSO currently supports the ``NOTES`` field in the ADIF specification, but not the ``COMMENTS`` field. When a user imports a log in ADIF format, they can choose to merge any existing text in the ``COMMENTS`` field with the ``NOTES`` field by checking the 'merge' checkbox. This way, no information in the ``COMMENTS`` field is discarded during the import process.
@ -50,5 +54,5 @@ PyQSO features rudimentary support for the Hamlib library. The name and
path of the radio device connected to the user's computer can be
specified in the ``Hamlib`` tab of the preferences dialog. Upon adding a
new record to the log, PyQSO will use Hamlib to retrieve the current
frequency that the radio device is set to and automatically fill in the
Frequency field.
frequency and mode that the radio device is set to and automatically fill in the
Frequency and Mode fields.

Wyświetl plik

@ -28,6 +28,30 @@ pyqso.awards module
:undoc-members:
:show-inheritance:
pyqso.cabrillo module
---------------------
.. automodule:: pyqso.cabrillo
:members:
:undoc-members:
:show-inheritance:
pyqso.cabrillo_export_dialog module
-----------------------------------
.. automodule:: pyqso.cabrillo_export_dialog
:members:
:undoc-members:
:show-inheritance:
pyqso.calendar_dialog module
----------------------------
.. automodule:: pyqso.calendar_dialog
:members:
:undoc-members:
:show-inheritance:
pyqso.callsign_lookup module
----------------------------
@ -100,14 +124,6 @@ pyqso.record_dialog module
:undoc-members:
:show-inheritance:
pyqso.telnet_connection_dialog module
-------------------------------------
.. automodule:: pyqso.telnet_connection_dialog
:members:
:undoc-members:
:show-inheritance:
pyqso.toolbar module
--------------------