Manual content mostly written now. Still need to update the figures.

pull/17/head
Christian Jacobs 2013-10-01 23:56:13 +01:00
rodzic 8aa8cbcc20
commit 78f2cfd3d2
1 zmienionych plików z 8 dodań i 13 usunięć

Wyświetl plik

@ -20,7 +20,6 @@
\documentclass[11pt, a4paper]{report}
\usepackage[margin=1.2in]{geometry}
\usepackage{graphicx}
\usepackage{float}
\usepackage{hyperref}
\hypersetup{
colorlinks=false,
@ -116,10 +115,11 @@ Logbooks are SQL databases, and as such they are accessed with a database connec
\item Create a new database by entering a (non-existing) file name and clicking \texttt{Open}. The logbook database file (and a connection to it) will then be created automatically.
\end{itemize}
Once the database connection has been established, the database file name will appear in the status bar. All logs in the logbook will be opened automatically, and the interface will look something like the one shown in Figure \ref{fig:log_view_with_awards}.
\begin{figure}
\centering
\includegraphics[width=1\columnwidth]{images/log_with_awards.png}
\caption{Log view.}
\caption{PyQSO main window, showing the records in a log called \texttt{repeater\_contacts}, and the awards tool in the toolbox below it.}
\label{fig:log_view_with_awards}
\end{figure}
@ -134,7 +134,9 @@ A logbook can be closed (along with its corresponding database connection) by cl
\section{Creating a new log}
To create a new log, click \texttt{New Log} in the \texttt{Logbook} menu and enter the desired name of the log (e.g. repeater\_contacts, dx, mobile\_log). Alternatively, use the shortcut key combination \texttt{Ctrl + N}.
Note that the log name must be unique (i.e. it cannot already exist in the 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.
The log name must be unique (i.e. it cannot already exist in the 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 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, TX\_PWR, RST\_SENT, RST\_RCVD, QSL\_SENT, QSL\_RCVD, NOTES, NAME, ADDRESS, STATE, COUNTRY, DXCC, CQZ, ITUZ, IOTA.
\section{Renaming a log}
To rename the currently selected log, click \texttt{Rename Selected Log} in the \texttt{Logbook} menu. Remember that the log's new name cannot be the same as another log in the logbook.
@ -174,12 +176,12 @@ A dialog window will appear where details of the QSO can be entered (see Figure
\begin{figure}
\centering
\includegraphics[width=1\columnwidth]{images/edit_record.png}
\caption{Record dialog.}
\caption{Record dialog used to add new records and edit existing ones.}
\label{fig:edit_record}
\end{figure}
\subsection{Callsign lookup}
PyQSO can also resolve callsign-related information (e.g. the operator's name, address, and ITU Zone) by querying the qrz.com database. Note that the user must first supply their qrz.com account information in the preferences dialog window.
PyQSO can also resolve callsign-related information (e.g. the operator's name, address, and ITU Zone) by clicking the \texttt{Lookup on qrz.com} button adjacent to the Callsign data entry box. Note that the user must first supply their qrz.com account information in the preferences dialog window.
\section{Editing a record}
An existing record can be edited by:
@ -244,14 +246,7 @@ The user can also enter their login details to access the qrz.com database. Note
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 \texttt{View} tab. PyQSO must be restarted in order for any changes to take effect.
\section{Hamlib support}\label{sect:hamlib}
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 \texttt{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.
\begin{figure}
\centering
\includegraphics[width=0.75\columnwidth]{images/preferences_hamlib.png}
\caption{The Hamlib options in the Preferences dialog.}
\label{fig:preferences_hamlib}
\end{figure}
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 \texttt{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.
\bibliographystyle{plainnat}
\end{document}