edit docu

docu/docs/config.md

@@ -7,7 +7,6 @@ zwingend in die Konfiguration eingetragen werden.
 ---
 ## Client
 
-
 ### `client:`
 |Feld|Beschreibung|Default|
 |----|------------|-------|
@@ -25,7 +24,7 @@ Ansonsten wird versucht die Verbindungsdaten per Broadcast Paket direkt vom Serv
 |ip|IP Adresse des Servers|127.0.0.1|
 |port|Port des Sever|8080|
 
-Bsp:
+**Beispiel:**
 ```yaml
 server:
   ip: 10.10.10.2
@@ -44,7 +43,7 @@ Aktuell gibt es nur `sdr:` als Input Quelle
 |squelch|Einstellung der Rauschsperre|0|
 |gain|Verstärkung des Eingangssignals|100|
 
-Bsp:
+**Beispiel:**
 ```yaml
 inputSource:
   sdr:
@@ -80,7 +79,7 @@ Nachfolgend alle Paramater der Server Konfiguration
 ### `alarmRouter:`
 Enthält eine Liste der Router Namen, welche bei einem Alarm direkt gestartet werden sollen.
 
-Bsp:
+**Beispiel:**
 ```yaml
 alarmRouter:
   - Name des Routers
@@ -106,7 +105,7 @@ Jeder Router kann eine beliebige Anzahl einzelner Routenpunkte enthalten. Diese
 |name|Zu ladende Resource (Siehe weiter unten)||
 |config|Konfigurationseinstellungen des Routenpunktes (Siehe weiter unten)||
 
-Bsp:
+**Beispiel:**
 ```yaml
 router:
   - name: Router 1
@@ -119,24 +118,6 @@ router:
 ```
 
 ---
-## Module
-Nachfolgend alle Paramater der Modul Konfigurationen
-
-### `filter.modeFilter`
-
-|Feld|Beschreibung|Default|
-|----|------------|-------|
-|allowed|Liste der erlaubten Paket Typen `fms` `zvei` `pocsag`||
-
-Bsp:
-```yaml
-config:
-  allowed:
-    - fms
-    - zvei
-```
-
----
-## Plugins
-Nachfolgend alle Paramater der Plugin Konfigurationen
+## Module/Plugins
 
+Für die Konfiguration der Module und Plugins ist in den entsprechenden Kategorien eine ausführliche Beschreibung zu finden.

docu/docs/modul/mode_filter.md

@@ -1,3 +1,24 @@
 # <center>Mode Filter</center> 
 
+## Beschreibung
 Mit diesem Modul ist es Möglich, die Pakete auf bestimmte Modes (FMS, POCSAG, ZVEI) zu Filtern. Je nach Konfiguration werden Pakete eines bestimmten Modes im aktuellen Router weitergeleitet oder verworfen.
+
+---
+## Resource
+`filter.modeFilter`
+
+## Konfiguration
+
+|Feld|Beschreibung|Default|
+|----|------------|-------|
+|allowed|Liste der erlaubten Paket Typen `fms` `zvei` `pocsag` `msg`||
+
+**Beispiel:**
+```yaml
+- type: module
+  name: filter.modeFilter
+  config:
+    allowed:
+      - fms
+      - pocsag
+```

docu/mkdocs.yml

@@ -6,24 +6,25 @@ edit_uri: edit/develop/docu/docs/
 
 nav:
   # - BW3: index.md
-  - Quick Start Guide:
+  - Quick Start:
 #      - Installation: tbd.md
       - Konfiguration: config.md
 #      - BOSWatch nutzen: tbd.md
 #      - BOSWatch als Service: tbd.md
-#  - Informationen:
+  - Informationen:
 #      - Server/Cient Prinzip: tbd.md
 #      - Broadcast Funktion: tbd.md
 #      - Modul/Plugin Konzept: tbd.md
 #      - Routing Mechanismus: tbd.md
+       - Changelog: changelog.md
   - Module:
       - Mode Filter: modul/mode_filter.md
-#  - Plugins: tbd.md
+  - Plugins: tbd.md
   - Entwickler:
-    - Eigenes Modul/Plugin: develop/ModulPlugin.md
-    - BOSWatch Packet Format: develop/packet.md
-    - BW3 Source Docu: api/html/index.html
-  - Changelog: changelog.md
+    - Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md
+    - BOSWatch Alarmpaket Format: develop/packet.md
+    - BW3 Quellcode Dokumentation: api/html/index.html
+
 
 use_directory_urls: false
 

module/filter/modeFilter.py

@@ -36,7 +36,7 @@ class BoswatchModule(Module):
         pass
 
     def doWork(self, bwPacket):
-        """!start an rund of the module.
+        """!start an run of the module.
 
         @param bwPacket: A BOSWatch packet instance
         @return bwPacket or False"""

module/template_module.py

@@ -36,7 +36,7 @@ class BoswatchModule(Module):
         pass
 
     def doWork(self, bwPacket):
-        """!start an rund of the module.
+        """!start an run of the module.
 
         @param bwPacket: A BOSWatch packet instance
         @return bwPacket or False"""