From efb1f38e9a5531e3003ccc73c8ee8d11a7a8a869 Mon Sep 17 00:00:00 2001 From: "Christian T. Jacobs" Date: Tue, 16 May 2017 23:24:06 +0100 Subject: [PATCH] Updates to documentation. --- docs/source/preferences.rst | 26 ++++++++++++++++++-------- docs/source/pyqso.rst | 8 ++++++++ docs/source/record_management.rst | 2 +- docs/source/toolbox.rst | 6 +++--- 4 files changed, 30 insertions(+), 12 deletions(-) diff --git a/docs/source/preferences.rst b/docs/source/preferences.rst index 8738f3a..fe5f8de 100644 --- a/docs/source/preferences.rst +++ b/docs/source/preferences.rst @@ -17,7 +17,7 @@ Under the ``General`` tab, the user can choose to: - 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 +- pin-point the user's QTH on the grey line map by specifying the latitude-longitude coordinates (or looking them up based on the QTH's name, e.g. city name) .. _figure:summary: .. figure:: images/summary.png @@ -30,22 +30,32 @@ 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. -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. - Records ------- -The records tab allows users to choose if the UTC timezone is used when autocompleting the date and time fields, and whether the band should be automatically determined from the frequency field. Default values for the Power, Mode, and Submode fields can also be specified here. +The records tab comprises options concerning the Add/Edit Record dialog window. It allows users to: + +- use the UTC timezone when autocompleting the date and time fields + +- choose whether the band should be automatically determined from the frequency field + +- specify default values for the Power, Mode, and Submode fields + +- enter the QSO's frequency in a unit other than MHz (note that the frequency will always be presented in MHz in the main window, regardless of this preference) + +- specify the callsign lookup settings Callsign lookup ~~~~~~~~~~~~~~~ The user can enter their login details to access the `qrz.com `_ or `hamqth.com `_ database and perform callsign lookups. Note that these details are currently stored in plain text (unencrypted) format. -If the ``Ignore callsign prefixes and/or suffixes`` box is checked, then PyQSO will perform the callsign lookup whilst ignoring all prefixes (i.e. anything before a preceding "/" in the callsign) and the suffixes "P", "M", "A", "PM", "MM", "AM", and "QRP". For example, if the callsign to be looked up is EA3/MYCALL/P, only MYCALL will be looked up. If you get 'Callsign not found' errors, try enabling this option. +If the ``Ignore callsign prefixes and/or suffixes`` box is checked, then PyQSO will perform the callsign lookup whilst ignoring all prefixes (i.e. anything before a preceding "/" in the callsign) and the suffixes "P", "M", "A", "PM", "MM", "AM", and "QRP". For example, if the callsign to be looked up is EA3/MYCALL/QRP, only MYCALL will be looked up. If you get 'Callsign not found' errors, try enabling this option. + +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. Hamlib support -------------- diff --git a/docs/source/pyqso.rst b/docs/source/pyqso.rst index ea603dd..ee2986b 100644 --- a/docs/source/pyqso.rst +++ b/docs/source/pyqso.rst @@ -156,6 +156,14 @@ pyqso.summary module :undoc-members: :show-inheritance: +pyqso.telnet_connection_dialog module +------------------------------------- + +.. automodule:: pyqso.telnet_connection_dialog + :members: + :undoc-members: + :show-inheritance: + pyqso.toolbar module -------------------- diff --git a/docs/source/record_management.rst b/docs/source/record_management.rst index 12f40d7..6ad7a15 100644 --- a/docs/source/record_management.rst +++ b/docs/source/record_management.rst @@ -17,7 +17,7 @@ A new QSO can be added by either: A dialog window will appear where details of the QSO can be entered (see figure:edit_record_). Note that the current date and time -are filled in automatically. When ready, click ``OK`` to save the +are filled in automatically. When ready, click ``OK`` or press the Enter key to save the changes. .. _figure:edit_record: diff --git a/docs/source/toolbox.rst b/docs/source/toolbox.rst index 29fcb84..256f41e 100644 --- a/docs/source/toolbox.rst +++ b/docs/source/toolbox.rst @@ -22,8 +22,8 @@ supplied. Frequently used servers can be bookmarked for next time; bookmarked se Once connected, the server output will appear in the DX cluster frame (see figure:dx_cluster_). A command can also -be sent to the server by typing it into the entry box beneath the server output, and clicking the -adjacent ``Send Command`` button. +be sent to the server by typing it into the entry box beneath the server output and clicking the +adjacent ``Send Command`` button (or pressing the Enter key). .. _figure:dx_cluster: .. figure:: images/dx_cluster.png @@ -36,7 +36,7 @@ Grey line The grey line tool (see figure:grey_line_) can be used to check which parts of the world are in darkness. The position of the grey -line is automatically updated every 30 minutes. +line is automatically updated every 30 minutes. The user's QTH can be pin-pointed on the map by specifying the latitude-longitude coordinates in the preferences. .. _figure:grey_line: .. figure:: images/grey_line.png