A few updates to the user manual.

pull/17/head
Christian Jacobs 2013-08-22 18:33:24 +01:00
rodzic 9511c40e21
commit b4f5aa10a6
1 zmienionych plików z 39 dodań i 0 usunięć

Wyświetl plik

@ -85,21 +85,57 @@ Running PyQSO with the \texttt{-d} or \texttt{--debug} flag enables the debuggin
\noindent All debugging-related messages are written to a file called pyqso.debug, located in the current working directory.
\section{Creating a new logbook}
Logbooks are SQL databases, and as such they must be accessed with a database connection.
To create a connection, click \texttt{Connect to Logbook...} in the \texttt{Logbook} menu, and either:
\begin{itemize}
\item Find and select an existing logbook database file (with the \texttt{.db} file extension), and click \texttt{Open} to create the database connection; or
\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.
\section{Log management}
\subsection{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). This name must be unique. Alternatively, use the shortcut key combination \texttt{Ctrl + N}.
\subsection{Renaming a log}
\subsection{Deleting a log}
\subsection{Importing and exporting a log}
While PyQSO stores logbooks in SQL format, it is possible to export individual logs in the well-known ADIF format. View the log you wish to export, and click \texttt{Export Log} in the \texttt{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 existing log in the logbook. To import, click \texttt{Import Log} in the \texttt{Logbook} menu.
Note that all data must conform to the ADIF standard, otherwise it will be ignored.
\subsection{Printing a log}
Due to restrictions on the page width, only a selection of field names will be printed: callsign, date, time, frequency, and mode.
\subsection{Filtering by callsign}
Entering an expression such as \texttt{xyz} into the ``Filter by callsign'' box will instantly filter out any callsigns beginning with that expression.
\subsection{Sorting by field}
To sort a log by a particular field name, left-click the column header that contains that field name. By default, it is the \texttt{Index} field that is sorted in ascending order.
\section{Record management}
\subsection{New record (QSO)}
A new QSO can be added by either:
\begin{itemize}
\item Clicking the `+' button in the toolbar.
\item Pressing \texttt{Ctrl + R}.
\item Clicking \texttt{Add Record...} in the \texttt{Records} menu.
\end{itemize}
A dialog window will appear where you can enter the details of the QSO. Note that the current date and time are filled in automatically.
\subsubsection{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 users must first supply their qrz.com account information in the preferences dialog window.
\chapter{Toolbox}
\section{DX cluster}
@ -108,10 +144,13 @@ A DX cluster is essentially a server through which radio operators can report an
PyQSO is able to connect to a DX cluster that operates using the Telnet protocol to provide a text-based alert service. As a result of the many different Telnet-based software products that DX clusters run, PyQSO currently outputs the raw data received from the DX cluster rather than trying to parse it in some way.
\section{Grey line}
The grey line tool can be used to check which parts of the world are in darkness. The grey line window is updated every 30 minutes.
\section{Awards}
\chapter{Preferences}
PyQSO user preferences are stored in a configuration file located at \texttt{\textasciitilde/.pyqso.cfg}, where \texttt{\textasciitilde} denotes the user's home directory.
\section{View}
Not all the available fields have to be displayed in the logbook. Users can choose to hide a subset of them by unchecking them in the View tab.