Skip to content

Commit

Permalink
Fixed docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
hmatuschek committed Jul 20, 2024
1 parent c30a819 commit b9f9c98
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 22 deletions.
Binary file added doc/manual/gui/fig/qdmr-settings-datasources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/gui/fig/qdmr-settings-programming.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 52 additions & 22 deletions doc/manual/gui/settingsdialog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,45 @@
</info>

<para>
The application settings dialog controls some of the behavior of <application>qdmr</application>.
The dialog is divided into 4 sections: <guilabel>Location</guilabel>, <guilabel>Radio
Programming</guilabel>, <guilabel>Call-Sign DB</guilabel> and <guilabel>Extended Features</guilabel>.
The application settings dialog controls the behavior of <application>qdmr</application>.
The dialog is divided into 3 sections, accessible via the tabs on the top.
</para>

<screenshot>
<mediaobject>
<imageobject><imagedata fileref="fig/qdmr-settings-dialog.png" width="5cm" align="center"/></imageobject>
<textobject>Screen shot of the application settings dialog.</textobject>
</mediaobject>
<title>The settings dialog</title>
</screenshot>


<section>
<info>
<title>Location settings</title>
<title>Data Sources</title>
</info>

<para>
The <guilabel>Data Sources</guilabel> tab collects the settings for the location service and
repeater database.
</para>

<screenshot>
<mediaobject>
<imageobject><imagedata fileref="fig/qdmr-settings-datasources.png" width="5cm" align="center"/></imageobject>
<textobject>Screen shot of the application settings dialog for the data sources.</textobject>
</mediaobject>
<title>The settings dialog: Data sources</title>
</screenshot>

<para>
The first section concerns the location of the user. You may enter your <glossterm>Maidenhead
Locator</glossterm> here or you may enable <guilabel>System location</guilabel>. The latter tries
to obtain the current location from the operating system. This information is then used in the
channel editors (see <xref linkend="guiChannels"/>) to provide auto-completion for repeaters
nearby.
</para>

<para>
The second section allows to set the source for the repeater database. This enables
<application>qdmr</application> to automatically complete some information for a repeater if its
callsign is entered as the name, when creating a new channel. For some weird reason, the single
data source <ulink url="https://www.repeaterbook.com/">Repeater Book</ulink> provides two identical
APIs for North America and the rest of the World. You must select your source accordingly.
</para>
</section>


Expand All @@ -45,8 +58,21 @@
</info>

<para>
The second section controls the programming of the radio and how codeplugs are assembled. The
first option <guilabel>Update codeplug</guilabel> specifies whether a codeplug is generated from
The second tab controls, how the radios are programmed. That is, how the codeplug is assembled and
also, how the callsign database gets curated.
</para>

<screenshot>
<mediaobject>
<imageobject><imagedata fileref="fig/qdmr-settings-programming.png" width="5cm" align="center"/></imageobject>
<textobject>Screen shot of the application settings dialog for programming the radios.</textobject>
</mediaobject>
<title>The settings dialog: Programming</title>
</screenshot>

<para>
The first section specifies how codeplugs are assembled. The first option
<guilabel>Update codeplug</guilabel> specifies whether a codeplug is generated from
scratch or whether the codeplug currently programmed on the radio gets updated.
<application>qdmr</application> does not implement all settings possible for all radios,
consequently <guilabel>Update codeplug</guilabel> should be choses to maintain all settings
Expand Down Expand Up @@ -77,13 +103,6 @@
manufacturer. But be aware, that transmitting outside the declared frequency range may destroy
the radio!
</para>
</section>


<section>
<info>
<title>Call-sign DB settings</title>
</info>

<para>
The <guilabel>Call-Sign DB</guilabel> section collects options that control the automatic
Expand Down Expand Up @@ -124,12 +143,23 @@
</para>
</section>


<section>
<info>
<title>Extended feature settings</title>
<title>Extension settings</title>
</info>

<para>
The last tab collects settings, controlling several extended settings for the devices.
</para>

<screenshot>
<mediaobject>
<imageobject><imagedata fileref="fig/qdmr-settings-extensions.png" width="5cm" align="center"/></imageobject>
<textobject>Screen shot of the application settings dialog for extensions.</textobject>
</mediaobject>
<title>The settings dialog: Extensions</title>
</screenshot>

<para>
DMR originated as a standard for commercial radios. Consequently, there are many features that
are not relevant or even illegal for ham-radio use (e.g., encryption). However, some operators
Expand Down

0 comments on commit b9f9c98

Please sign in to comment.