Spectrum markers: updated documentation

sdrgui/spectrummarkers.md

@@ -12,13 +12,15 @@ The complete dialog is split into tabs:
 
   - **Hist** for histogram (spectrum line) markers
   - **Wat** for waterfall markers
+  - **Anno** for annotation markers
 
 <h3>2. Markers set selection</h3>
 
 This lets you selects which markers are displayed
 
   - **None**: no markers are displayed
-  - **Spec**: spectrum markers are displayed
+  - **Spec**: spectrum markers (histogram and waterfall) are displayed
+  - **Anno**: spectrum annotations are displayed
 
 <h2>Histogram markers tab</h2>
 
@@ -30,7 +32,7 @@ Use this frequency dial to set the marker frequency in Hz
 
 <h3>2. Center marker frequency</h3>
 
-Push this button to move the marker at the center of the spectrum
+Push this button to move the marker at the center of the current spectrum
 
 <h3>3. Marker color</h3>
 
@@ -44,7 +46,7 @@ Toggles marker display on the spectrum
 
 Turn the dial button to select the marker being set up. The index of the marker appears at left.
 
-<h3>6. Swap marker with reference marker (index 0)<h3>
+<h3>6. Swap marker with reference marker (index 0)</h3>
 
 Push this button to swap the current marker with marker at index 0. The marker at index 0 is the reference marker. Note that the colors are not swapped so that the marker color is associated to its index and not the marker itself.
 
@@ -93,7 +95,7 @@ Toggles marker display on the spectrum
 
 Turn the dial button to select the marker being set up. The index of the marker appears at left.
 
-<h3>6. Swap marker with reference marker (index 0)<h3>
+<h3>6. Swap marker with reference marker (index 0)</h3>
 
 Push this button to swap the current marker with marker at index 0. The marker at index 0 is the reference marker. Note that the colors are not swapped so that the marker color is associated to its index and not the marker itself.
 
@@ -109,3 +111,94 @@ The time mark of the marker is given in seconds by mantissa M and exponent E so
 <h3>9. Time exponent</h3>
 
 This slider lets you control the exponent part E of the time mark so that t(s) = M &times; 10<sup>E</sup>. The value in exponential notation appears on the left.
+
+<h2>Annotation markers tab</h2>
+
+![Spectrum Markers annotation dialog](../doc/img/Spectrum_Markers_dialog_anno.png)
+
+<h3>1. Marker selection</h3>
+
+Turn the dial button to select the marker being set up. The index of the marker appears at left.
+
+<h3>2. Add/Remove marker</h3>
+
+  - Press the "+" button to add a new marker.
+  - Press the "-" button to remove the current marker.
+
+<h3>3. Marker color</h3>
+
+The marker color is displayed here. You can click on the square to open a standard color selection dialog to select the marker color. Note that it selects the color of the text display of the marker the crosshairs remain in white color.
+
+<h3>4. Marker text</h3>
+
+Type in the text of the marker to be displayed when it is selected (see "Annotations on spectrum display" next). You can enter up to 36 characters.
+
+<h3>5. Export markers to .csv file</h3>
+
+Export the markers to a .csv file. Colums are
+  - **Start**: start frequency in Hz
+  - **Width**: width in Hz
+  - **Text**: marker text when selected
+  - **Show**: marker show state (see 15)
+    - **0**: hidden
+    - **1**: top area or line
+    - **2**: full display
+  - **Red**: red component (0..255) of marker color
+  - **Green**: green component (0..255) of marker color
+  - **Blue**: blue component (0..255) of marker color
+
+The column names appear in the first line (header) of the file
+
+<h3>6. Import markers from .csv file</h3>
+
+Import the markers from a .csv file in the format described above.
+
+<h3>7. Select start or Center input frequency</h3>
+
+Use this button to select whether the input frequency next (9) should apply to marker start or center frequency
+
+<h3>8. Input marker frequency</h3>
+
+Enter either start or center marker frequency in Hz depending on the Start/Center button selection (8)
+
+<h3>9. Select central frequency display</h3>
+
+Click on this button to set the input frequency (9) to the center frequency of the spectrum
+
+<h3>10. Duplicate marker</h3>
+
+Duplicate the current marker in a new marker
+
+<h3>11. Sort markers</h3>
+
+Sort markers  by increasing starting frequency
+
+<h3>12. Show start/center frequency</h3>
+
+The start of center frequency in Hz is displayed when the center or start inpu frequency (8) is selected respectively.
+
+<h3>13. Show stop frequency</h3>
+
+Displays the stop frequency of the marker in Hz
+
+<h3>14. Marker bandwidth</h3>
+
+Sets the bandwidth of the marker in Hz
+
+<h3>15. Marker show state</h3>
+
+Select how the marker is displayed
+
+  - **Hidden**: marker is hidden
+  - **Top**: only the top area or line is displayed
+  - **Full**: marker is displayed in full with line limits and text
+
+<h3>16: Apply show state to all</h3>
+
+Click on this button to apply the current marker show state (15) to all markers
+
+<h3>Annotations on spectrum display</h3>
+
+![Spectrum Markers annotation spectrum](../doc/img/Spectrum_Markers_dialog_anno_spectrum.png)
+
+In "top" state the markers are displayed as short lines or thin areas on the top of the spectrum. Click in the marker area to toggle between "full" and "top" states. For line markers (bandwidth 0 Hz) click close to the right of line marker.