Skip to content

Commit bd9dccf

Browse files
committed
Update docs
1 parent c97f1b1 commit bd9dccf

2 files changed

Lines changed: 42 additions & 17 deletions

File tree

docs/assets/main_window.webp

128 KB
Loading

docs/basic_operations.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#
1+
# Basic Operations
22

33
![sw_current](assets/main_window.webp)
44

@@ -10,11 +10,11 @@
1010

1111
Create a new database.
1212

13-
* **Load Database**
13+
* **Load Database**
1414

1515
Open the Database Manager windows in order to open, rename, or delete a database.
1616

17-
* **Import Database**
17+
* **Import Database**
1818

1919
Import an Artemis database with a standard .tar format.
2020
!!! tip "Offline Importing of SigID Database"
@@ -23,11 +23,11 @@
2323
1. Download the .tar database [:material-download: HERE](https://github.com/AresValley/Artemis-DB/releases) from a PC with an internet access
2424
2. Import the downloaded .tar on the target PC (without internet access) using the **Import Database** function
2525

26-
* **Export Database**
26+
* **Export Database**
2727

2828
Export the loaded database with a standard .tar format.
2929

30-
* **Edit Tags**
30+
* **Edit Tags**
3131

3232
Open the tags editor window. From here, you can add, rename, or delete tags. The tags can be added to a signal from the [tags menu](#4-tags)
3333

@@ -43,31 +43,45 @@
4343

4444
This will close the application.
4545

46-
### Signal
47-
* **New**
46+
### Edit
47+
48+
* **New Signal**
4849

4950
Add a new signal to the database.
5051

51-
* **Edit**
52+
* **Edit name/description**
5253

5354
Edit the current/selected signal from the loaded database.
5455

56+
* **Add ...**
57+
58+
Add new signal parameters such as Frequency, Bandwidth, Modulation, ACF, ...
59+
60+
### Filter
61+
62+
This menu contains
63+
64+
* **Reset All Filters**
65+
66+
Add new signal parameters such as Frequency, Bandwidth, Modulation, ACF, ...
67+
5568
### Space Weather
5669

5770
* **Check Report**
5871

5972
Open the main [Space Weather window](space_weather/current.md) and retrieve all the live data from Poseidon Crawler.
6073

6174
## 2. Signal List
75+
6276
This is the signal list where all the database entries are shown. When a signal is selected, it will load on the right panel.
6377

6478
### Filter by Name/Description
79+
6580
On top of the list, there is a field for filtering signals by name or any keyword inside the description of the signal: this filter has the highest priority among all the filters.
6681

67-
## 3. Signal Menu
68-
Here you can swithc between the main **signal** window and the **filter** page.
82+
## 3. Signal Categories
6983

70-
## 4. Tags
84+
The category (also known as tags) are listed here.
7185

7286
* **Associate Tag**
7387

@@ -81,29 +95,40 @@ Here you can swithc between the main **signal** window and the **filter** page.
8195

8296
To add a new tag open the [Tags Editor](#1-main-menu) in the main menu.
8397

84-
## 5. Add Parameter
98+
## 4. Since DB
99+
100+
This badge shows from which version of the SigID DB the selected signal has been introduced.
101+
102+
## 5. Signal Parameters
103+
85104
Click on the labels to add the corresponding parameter to the signal (e.g. click on **Frequency** to add a new frequency).
86105

87-
## 6. Edit Parameter
106+
### edit Parameters
107+
88108
Click on the parameter badge to open the Signal Editor windows. From here, you can edit or delete the corresponding parameter.
89109

90110
!!! tip "Parameter Description"
91111
All the parameters have a description field: if some text is added, it will appear when the corresponding parameter badge is hovered with the mouse pointer.
92112

93-
## 7. Description :simple-markdown:{ title="Markdown Supported" }
113+
### description :simple-markdown:{ title="Markdown Supported" }
114+
94115
This is the description of the signal and can be edited from the [Main Menu](#1-main-menu) (`Signal/Edit...`)
95116

96117
!!! tip "Markdown Supported"
97118
The Description field can render **Markdown**, a simple markup language for creating rich text using plain text. Headers, emphasis, lists, links, code blocks, and many more features for advanced text formatting. [Markdown Basic Syntax :simple-markdown:](https://www.markdownguide.org/basic-syntax/)
98119

99-
## 8. Audio Sample
120+
## 6. Audio Sample
121+
100122
This is a player where an audio sample of the signal can be played. To associate an audio file to be shown as the **main** audio sample, check in the [extra menu](#10-extra) below the signal spectrum.
101123

102-
## 9. Image Sample
124+
## 7. Image Sample
125+
103126
This is an image box that commonly contains the signal spectrum/waterfall. To associate an image file to be shown as the **main** image sample, check in the [extra menu](#10-extra) below the signal spectrum.
104127

105-
## 10. Extra
128+
## 8. Open SigID wiki
106129

107130
:material-earth: This button is only available for the standard SigID wiki database and connects the local signal to its counterpart on the [sigidwiki website](https://www.sigidwiki.com/).
108131

132+
## 9. Open Document Manager
133+
109134
:material-file-document-multiple: This will open the **Documents Manager**. From here you can add any file (audio, image, pdf, etc.) to the signal entry. It is also possible to mark only one image and one audio to be shown on the main signal window.

0 commit comments

Comments
 (0)