From 334e5b03a865d6b7810eb6bbddcf7405e247f0ce Mon Sep 17 00:00:00 2001 From: Marc Froehlich Date: Mon, 20 Jul 2026 22:27:53 +0200 Subject: [PATCH] manual refactoring --- .github/workflows/tagged-release.yml | 10 +- github_docs/Home.md | 56 ++------ github_docs/de-Home.md | 123 +++++++++++----- github_docs/en-Home.md | 125 ++++++++++++----- .../kst4contest/controller/BeaconTask.java | 3 +- website/.eleventy.js | 79 ++++++++++- website/src/_layouts/base.njk | 8 +- website/src/features/airscout.md | 4 +- website/src/features/dual-chat.md | 5 +- website/src/features/dx-cluster.md | 5 +- website/src/features/log-sync.md | 4 +- website/src/features/macros.md | 4 +- website/src/features/priority-score.md | 4 +- website/src/features/sked-reminder.md | 4 +- website/src/features/timeline.md | 4 +- website/src/index.njk | 132 ++++++++++++++---- website/src/manual/de/index.njk | 4 +- website/src/manual/en/index.njk | 4 +- 18 files changed, 409 insertions(+), 169 deletions(-) diff --git a/.github/workflows/tagged-release.yml b/.github/workflows/tagged-release.yml index 929d4d2..15c200e 100644 --- a/.github/workflows/tagged-release.yml +++ b/.github/workflows/tagged-release.yml @@ -435,12 +435,14 @@ jobs: FLATPAK_GPG_KEY_ID=$(gpg --list-secret-keys --with-colons | awk -F: '/^fpr/{print $10; exit}') echo "FLATPAK_GPG_KEY_ID=$FLATPAK_GPG_KEY_ID" >> "$GITHUB_ENV" - - name: Determine OSTree branch + - name: Determine OSTree branch and flatpakref filename run: | if [[ "${{ github.ref_name }}" == beta-* ]]; then echo "OSTREE_BRANCH=beta" >> "$GITHUB_ENV" + echo "FLATPAKREF_NAME=de.x08.KST4Contest.beta.flatpakref" >> "$GITHUB_ENV" else echo "OSTREE_BRANCH=stable" >> "$GITHUB_ENV" + echo "FLATPAKREF_NAME=de.x08.KST4Contest.flatpakref" >> "$GITHUB_ENV" fi - name: Build Flatpak repo @@ -454,7 +456,7 @@ jobs: REPO_NAME="${GITHUB_REPOSITORY#*/}" PAGES_URL="https://${GITHUB_REPOSITORY_OWNER}.github.io/${REPO_NAME}/" GPG_KEY_B64=$(gpg --export "$FLATPAK_GPG_KEY_ID" | base64 -w 0) - cat > "dist/de.x08.KST4Contest.${OSTREE_BRANCH}.flatpakref" << EOF + cat > "dist/${FLATPAKREF_NAME}" << EOF [Flatpak Ref] Name=de.x08.KST4Contest Branch=${OSTREE_BRANCH} @@ -469,7 +471,7 @@ jobs: uses: actions/upload-artifact@v4.3.4 with: name: flatpakref - path: dist/de.x08.KST4Contest.*.flatpakref + path: dist/*.flatpakref - name: Upload Flatpak OSTree repo uses: actions/upload-artifact@v4.3.4 @@ -747,7 +749,7 @@ jobs: release-assets/debian/KST4Contest-${{ github.ref_name }}-debian-amd64.deb, release-assets/fedora/KST4Contest-${{ github.ref_name }}-fedora-x86_64.rpm, release-assets/archlinux/KST4Contest-${{ github.ref_name }}-archlinux-*.pkg.tar.zst, - release-assets/flatpakref/de.x08.KST4Contest.flatpakref, + release-assets/flatpakref/*.flatpakref, release-assets/macos/KST4Contest-${{ github.ref_name }}-macos-*.dmg, release-assets/docs/KST4Contest-${{ github.ref_name }}-manual-en.pdf, release-assets/docs/KST4Contest-${{ github.ref_name }}-manual-de.pdf diff --git a/github_docs/Home.md b/github_docs/Home.md index 4352b32..e41f87c 100644 --- a/github_docs/Home.md +++ b/github_docs/Home.md @@ -1,53 +1,25 @@ -# KST4Contest – Wiki +# KST4Contest -**KST4Contest** (auch bekannt als *PraktiKST*) ist ein Java-basierter Chat-Client für den [ON4KST-Chat](http://www.on4kst.info/chat/), speziell entwickelt für den Contest-Betrieb auf den VHF/UHF/SHF-Bändern. +KST4Contest is a desktop client for the [ON4KST Chat](https://www.on4kst.org/chat/login.php), developed for VHF, UHF and SHF contest operation. It combines chat, candidate selection, sked planning, aircraft scatter information and connections to logging and station software. -Entwickelt von **DO5AMF (Marc Fröhlich)**, Operator bei DM5M. +KST4Contest ist ein Desktop-Client für den [ON4KST-Chat](https://www.on4kst.org/chat/login.php), der für den Contest-Betrieb auf den VHF-, UHF- und SHF-Bändern entwickelt wurde. Er verbindet Chat, Stationsauswahl, Sked-Planung, Aircraft-Scatter-Daten sowie die Anbindung an Log- und Stationssoftware. + +Developed by / Entwickelt von **DO5AMF (Marc Fröhlich)**, operator at / Operator bei DM5M. --- -## 🌐 Sprache / Language +## Language / Sprache -| 🇩🇪 Deutsch | 🇬🇧 English | +| Deutsch | English | |---|---| -| [Startseite (Deutsch)](de-Home) | [Home (English)](en-Home) | +| [Deutsches Handbuch](de-Home) | [English manual](en-Home) | --- -## 🇩🇪 Inhalt (Deutsch) +## Project links / Projektlinks -| Seite | Inhalt | -|---|---| -| [Installation](de-Installation) | Download, Java-Voraussetzungen, Update | -| [Konfiguration](de-Konfiguration) | Alle Einstellungen im Detail | -| [Log-Synchronisation](de-Log-Synchronisation) | UCXLog, N1MM+, QARTest, DXLog.net, WinTest | -| [AirScout-Integration](de-AirScout-Integration) | Flugzeug-Scatter-Erkennung | -| [DX-Cluster-Server](de-DX-Cluster-Server) | Integrierter DX-Cluster für das Log-Programm | -| [Funktionen](de-Funktionen) | Alle Features im Überblick | -| [Makros und Variablen](de-Makros-und-Variablen) | Text-Snippets, Shortcuts, Variablen | -| [Benutzeroberfläche](de-Benutzeroberflaeche) | UI-Erklärung und Bedienung | -| [Changelog](de-Changelog) | Versionsgeschichte | - ---- - -## 🇬🇧 Contents (English) - -| Page | Contents | -|---|---| -| [Installation](en-Installation) | Download, Java requirements, updates | -| [Configuration](en-Configuration) | All settings in detail | -| [Log Synchronisation](en-Log-Sync) | UCXLog, N1MM+, QARTest, DXLog.net, WinTest | -| [AirScout Integration](en-AirScout-Integration) | Aircraft scatter detection | -| [DX Cluster Server](en-DX-Cluster-Server) | Built-in DX cluster for your logging software | -| [Features](en-Features) | All features at a glance | -| [Macros and Variables](en-Macros-and-Variables) | Text snippets, shortcuts, variables | -| [User Interface](en-User-Interface) | UI explained and how to operate it | -| [Changelog](en-Changelog) | Version history | - ---- - -## Schnellinfo / Quick Info - -- **Download**: https://github.com/praktimarc/kst4contest/releases -- **GitHub**: https://github.com/praktimarc/kst4contest -- **Kontakt / Contact**: praktimarc+kst4contest@gmail.com +- [Project website / Projektwebseite](https://kst4contest.hamradioonline.de/) +- [Download the current stable release / Aktuelle stabile Version herunterladen](https://github.com/praktimarc/kst4contest/releases/latest) +- [Source code / Quellcode](https://github.com/praktimarc/kst4contest) +- [Bug reports and feature requests / Fehler und Funktionswünsche](https://github.com/praktimarc/kst4contest/issues) +- [Online manual / Online-Handbuch](https://kst4contest.hamradioonline.de/manual/) \ No newline at end of file diff --git a/github_docs/de-Home.md b/github_docs/de-Home.md index d7c6fd0..7edff2f 100644 --- a/github_docs/de-Home.md +++ b/github_docs/de-Home.md @@ -1,10 +1,64 @@ -# KST4Contest – Wiki +# KST4Contest – Handbuch -> 🇬🇧 [English version](en-Home) | 🇩🇪 Du liest gerade die deutsche Version +> [English version](en-Home) | Du liest gerade die deutsche Version -**KST4Contest** (auch bekannt als *PraktiKST*) ist ein Java-basierter Chat-Client für den [ON4KST-Chat](http://www.on4kst.info/chat/), der speziell für den Contest-Betrieb auf den VHF/UHF/SHF-Bändern (144 MHz und aufwärts) entwickelt wurde. +KST4Contest ist ein Desktop-Client für den [ON4KST-Chat](https://www.on4kst.org/chat/login.php), der für den Contest-Betrieb auf den VHF-, UHF- und SHF-Bändern entwickelt wurde. Er verbindet Chat, Stationsauswahl, Sked-Planung, Aircraft-Scatter-Daten und die Anbindung an weitere Programme in einer gemeinsamen Arbeitsoberfläche. -Entwickelt von **DO5AMF (Marc Fröhlich)**, Operator bei DM5M. +Entwickelt wird KST4Contest von **DO5AMF (Marc Fröhlich)**, Operator bei DM5M und (seit Mai 2025) **DN9APW (Philipp Wagner)**. Der Quellcode ist öffentlich auf [GitHub](https://github.com/praktimarc/kst4contest) verfügbar. + +--- + +## Wozu braucht man einen eigenen ON4KST-Client? + +Der ON4KST-Chat liefert während eines Contests eine große Menge an Informationen: aktive Stationen, Locator, Frequenzen, Sked-Anfragen und Hinweise auf aktuelle Aktivität. Das eigentliche Problem besteht nicht darin, diese Daten zu sehen. Man muss daraus rechtzeitig die nächste sinnvolle Verbindung ableiten. + +KST4Contest wertet die verfügbaren Informationen aus, ordnet sie und stellt sie in einem contestgerechten Arbeitsablauf dar. Dabei werden unter anderem Antennenrichtung, Entfernung, bekannte Bänder und Frequenzen, bereits gearbeitete Stationen, Chat-Aktivität und Aircraft-Scatter-Zeiten berücksichtigt. + +Das Programm entscheidet jedoch nicht, welches QSO tatsächlich möglich ist. Der Prioritätsscore, die AP-Timeline und die verschiedenen Hervorhebungen sind Entscheidungshilfen. Die endgültige Beurteilung bleibt beim Operator – schon deshalb, weil auch ein recht überzeugender Computerbildschirm noch keine Funkverbindung herstellt. + +--- + +## Was KST4Contest im Contest unterstützt + +- **Chat beobachten und einordnen:** KST4Contest kann zwei ON4KST-Chat-Kategorien gleichzeitig darstellen. Nachrichten, Frequenzangaben und bekannte Bandaktivitäten werden den jeweiligen Stationen zugeordnet. + +- **Relevante Stationen herausfiltern:** Richtungs-, Entfernungs-, Worked- und NOT-QRV-Filter reduzieren die Benutzerliste auf die Stationen, die für den aktuellen Betriebszustand tatsächlich interessant sind. + +- **Kandidaten priorisieren:** Das Score-System bewertet aktive Chatmember anhand mehrerer bekannter Kriterien. Die derzeit relevantesten Kandidaten erscheinen zusätzlich in einer eigenen Prioritätsliste. + +- **Skeds vorbereiten und im Blick behalten:** Sked-Erinnerungen, automatische Vorwarnungen und die AP-Timeline helfen dabei, vereinbarte Verbindungen nicht zwischen Chat, Log und laufendem CQ-Betrieb zu verlieren. + +- **Aircraft Scatter einbeziehen:** Über die AirScout-Schnittstelle werden geeignete Flugzeuge und erwartete Reflexionszeiten in die Stationsbewertung und Zeitplanung übernommen. + +- **Log und Funkstation anbinden:** KST4Contest synchronisiert gearbeitete Stationen und Frequenzinformationen mit unterstützten Logprogrammen. Zusätzlich stehen Schnittstellen zu Win-Test, PSTRotator und ein integrierter DX-Cluster-Server zur Verfügung. + +- **Stationen und Funkwege darstellen:** Die Stationskarte zeigt aktive Chatmember, Locator-Felder, Antennenrichtungen und den Weg zur ausgewählten Station. Für ausgewählte Verbindungen kann außerdem ein Geländeprofil berechnet werden. + +Die Funktionen greifen ineinander. Eine erkannte Frequenz kann beispielsweise einem aktiven Band zugeordnet werden, der Worked-Status stammt aus dem Log, Aircraft-Scatter-Daten ergänzen die zeitliche Bewertung und der daraus berechnete Score beeinflusst die Prioritätsliste. Fehlende oder veraltete Eingangsdaten können deshalb auch das Ergebnis beeinflussen. + +--- + +## Voraussetzungen + +Für die Anmeldung ist ein registrierter ON4KST-Account erforderlich. Registrierung und Login sind über die [offizielle ON4KST-Anmeldeseite](https://www.on4kst.org/chat/login.php) erreichbar. + +Die offizielle Sprache im ON4KST-Chat ist Englisch. Das gilt auch für Nachrichten an Stationen aus dem eigenen Land. Übliche Amateurfunk-Abkürzungen wie `pse`, `agn`, `qrg`, `dir`, `rrr`, `tnx` oder `73` sind dabei normal und meistens erheblich schneller als ausformulierte Prosa. + +Download, unterstützte Betriebssysteme und Installationswege sind im Kapitel [Installation](de-Installation) beschrieben. + +--- + +## Versionsstand dieses Handbuchs + +Dieses Handbuch beschreibt die stabile Version **v1.41.1**. + +Funktionen oder Änderungen, die nur im aktuellen Entwicklungsstand enthalten sind, werden ausdrücklich als **Nightly / v1.42** gekennzeichnet. Fehlt eine solche Kennzeichnung, bezieht sich die Beschreibung auf die stabile Version. + +- [Aktuelle stabile Version herunterladen](https://github.com/praktimarc/kst4contest/releases/latest) +- [Nightly-Builds und automatisierte Builds](https://github.com/praktimarc/kst4contest/actions) +- [Versionsgeschichte](de-Changelog) + +Für einen Contest ist grundsätzlich die stabile Version zu empfehlen. Nightly-Builds enthalten neuere Korrekturen und Funktionen, können sich aber zwischen zwei Builds verändern. Sie sind sinnvoll, wenn eine bestimmte Änderung getestet werden soll – weniger sinnvoll ist der erste Versuch zehn Minuten vor Contestbeginn. --- @@ -12,51 +66,52 @@ Entwickelt von **DO5AMF (Marc Fröhlich)**, Operator bei DM5M. | Seite | Inhalt | |---|---| -| [Installation](de-Installation) | Download, Java-Voraussetzungen, Update | -| [Konfiguration](de-Konfiguration) | Alle Einstellungen im Detail | -| [Log-Synchronisation](de-Log-Synchronisation) | UCXLog, N1MM+, QARTest, DXLog.net, WinTest | -| [AirScout-Integration](de-AirScout-Integration) | Flugzeug-Scatter-Erkennung | -| [DX-Cluster-Server](de-DX-Cluster-Server) | Integrierter DX-Cluster für das Log-Programm | -| [Funktionen](de-Funktionen) | Alle Features im Überblick | -| [Makros und Variablen](de-Makros-und-Variablen) | Text-Snippets, Shortcuts, Variablen | -| [Benutzeroberfläche](de-Benutzeroberflaeche) | UI-Erklärung und Bedienung | -| [Changelog](de-Changelog) | Versionsgeschichte | +| [Installation](de-Installation) | ON4KST-Account, Download, Installation und Updates | +| [Konfiguration](de-Konfiguration) | Login, Station, Bänder, Benutzeroberfläche und externe Schnittstellen | +| [Log-Synchronisation](de-Log-Synchronisation) | Simplelogfile, UCXLog, N1MM+, QARTest, DXLog.net und Win-Test | +| [AirScout-Integration](de-AirScout-Integration) | Verbindung zu AirScout und Auswertung von Aircraft-Scatter-Zeiten | +| [DX-Cluster-Server](de-DX-Cluster-Server) | Übergabe erkannter Möglichkeiten an das Logprogramm | +| [Funktionen](de-Funktionen) | Arbeitsweise, Herleitung und Grenzen der einzelnen Funktionen | +| [Makros und Variablen](de-Makros-und-Variablen) | Wiederverwendbare Texte, Shortcuts und automatisch ersetzte Werte | +| [Benutzeroberfläche](de-Benutzeroberflaeche) | Aufbau der Oberfläche und Bedienung im Contest | +| [Changelog](de-Changelog) | Releases, Nightly-Änderungen und behobene Fehler | --- -## Was ist KST4Contest? +## Kontakt und Support -Der ON4KST-Chat ist der De-facto-Standard für Skeds auf den 144-MHz-und-höher-Bändern. KST4Contest erweitert die Chat-Nutzung um contest-spezifische Funktionen: +- **Download:** [Aktuelle stabile Version](https://github.com/praktimarc/kst4contest/releases/latest) +- **Quellcode:** [praktimarc/kst4contest](https://github.com/praktimarc/kst4contest) +- **Fehler und Funktionswünsche:** [GitHub Issues](https://github.com/praktimarc/kst4contest/issues) +- **E-Mail:** praktimarc+kst4contest@gmail.com + Bitte nur für Themen verwenden, die KST4Contest betreffen. -- **Worked-Markierung**: Bereits gearbeitete Stationen werden farblich markiert, direkt aus dem Logprogramm via UDP synchronisiert. -- **Sked-Richtungs-Erkennung**: Wenn eine Station eine andere aus deiner Richtung anruft, wird sie grün und fett hervorgehoben. -- **QRG-Erkennung**: KST4Contest liest Frequenzen automatisch aus dem Chat-Verkehr und zeigt sie in der Benutzerliste an. -- **AirScout-Interface**: Anzeige reflektierbarer Flugzeuge direkt in der Benutzerliste. -- **Integrierter DX-Cluster-Server**: Spots werden direkt an das Logprogramm gesendet. -- **Dark Mode** (ab v1.26): Schont die Augen in der Nacht. -- **Multi-Channel-Login** (ab v1.26): Gleichzeitig in zwei Chat-Kategorien einloggen. +### Einen Fehler melden ---- +Ein Fehler lässt sich wesentlich schneller nachvollziehen, wenn die Meldung mindestens folgende Angaben enthält: -## Kontakt & Support +1. verwendete KST4Contest-Version, +2. Betriebssystem und Installationsart, +3. genaue Schritte bis zum Fehler, +4. erwartetes und tatsächlich beobachtetes Verhalten, +5. gegebenenfalls einen Screenshot, +6. die Fehler-Logdatei. -- **E-Mail**: praktimarc+kst4contest@gmail.com *(nur für kst4contest-Themen)* -- **GitHub**: https://github.com/praktimarc/kst4contest -- **Download**: https://github.com/praktimarc/kst4contest/releases/latest +Die Fehler-Logdatei wird hier gespeichert: -### Fehler melden (Issue erstellen) - -Beim Melden eines Fehlers bitte **immer die Logdatei anhängen**. KST4Contest schreibt automatisch eine Fehler-Logdatei (nur Fehlermeldungen, keine persönlichen Daten): - -| Betriebssystem | Pfad zur Logdatei | +| Betriebssystem | Pfad | |---|---| | Linux / macOS | `~/.praktiKST/kst4contest-errors.log` | | Windows | `C:\Users\\.praktiKST\kst4contest-errors.log` | -Beim Erstellen eines Issues auf GitHub steht eine Vorlage bereit, die alle wichtigen Felder abfragt. +Vor dem Hochladen sollte die Datei kurz geprüft werden. Ein Fehlerprotokoll enthält überwiegend technische Informationen, kann abhängig vom Fehler aber beispielsweise lokale Dateipfade oder weitere Kontextdaten enthalten. + +In Datei- und Verzeichnisnamen wird teilweise noch der technische Name `praktiKST` verwendet. Gemeint ist dasselbe Programm. --- ## Danksagungen -Besonderer Dank gilt: Gianluca Costantino (IU3OAR), Alessandro Murador (IZ3VTH), Reczetár István (HA1FV), OM0AAO (Viliam Petrik, DX-Cluster-Idee), DC9DJ (Konrad Neitzel, Projektstruktur), DO5ALF (Andreas, Webmaster funkerportal.de), PE0WGA (Franz van Velzen, Tester) sowie allen weiteren Testern und Ideengebern. +KST4Contest wurde durch Rückmeldungen aus dem praktischen Contest-Betrieb wesentlich verbessert. + +Besonderer Dank gilt Gianluca Costantino (IU3OAR), Alessandro Murador (IZ3VTH), Reczetár István (HA1FV), Viliam Petrik (OM0AAO, Idee zum DX-Cluster), Konrad Neitzel (DC9DJ, Projektstruktur), Andreas (DO5ALF, Webmaster von funkerportal.de), Franz van Velzen (PE0WGA, Tester), DN9APW als neuem Entwickler im Team und Master über die CI/CD pipelines sowie allen weiteren Testern und Ideengebern. \ No newline at end of file diff --git a/github_docs/en-Home.md b/github_docs/en-Home.md index f264797..d363e7b 100644 --- a/github_docs/en-Home.md +++ b/github_docs/en-Home.md @@ -1,62 +1,117 @@ -# KST4Contest – Wiki +# KST4Contest – User Manual -> 🇬🇧 You are reading the English version | 🇩🇪 [Deutsche Version](de-Home) +> You are reading the English version | [Deutsche Version](de-Home) -**KST4Contest** (also known as *PraktiKST*) is a Java-based chat client for the [ON4KST Chat](http://www.on4kst.info/chat/), specifically designed for contest operation on the VHF/UHF/SHF bands (144 MHz and above). +KST4Contest is a desktop client for the [ON4KST Chat](https://www.on4kst.org/chat/login.php), developed for VHF, UHF and SHF contest operation. It brings chat, candidate selection, sked planning, aircraft scatter data and external station software together in a single operating interface. -Developed by **DO5AMF (Marc Fröhlich)**, operator at DM5M. +KST4Contest is developed by **DO5AMF (Marc Fröhlich)**, operator at DM5M and (since May 2025) **DN9APW (Philipp Wagner)**. The source code is publicly available on [GitHub](https://github.com/praktimarc/kst4contest). --- -## Quick Navigation +## Why use a dedicated ON4KST client? + +During a contest, the ON4KST Chat provides a considerable amount of information: active stations, locators, frequencies, sked requests and indications of current activity. The actual problem is not seeing this data. It is turning it into the next useful contact in time. + +KST4Contest evaluates the available information, puts it into context and presents it as part of a contest-oriented workflow. This includes antenna direction, distance, known bands and frequencies, worked status, chat activity and aircraft scatter timing. + +The program does not decide which QSO is actually possible. Priority scores, the AP timeline and visual highlights are decision aids. The final judgement remains with the operator – not least because even a very convincing computer screen cannot complete a radio contact. + +--- + +## How KST4Contest supports contest operation + +- **Observe and organise chat activity:** KST4Contest can display two ON4KST chat categories at the same time. Messages, frequency information and known band activity are assigned to the corresponding stations. + +- **Reduce the station list:** Direction, distance, worked and NOT-QRV filters help limit the user list to stations that are relevant to the current operating situation. + +- **Prioritise candidates:** The score system evaluates active chat members using several known criteria. The currently most relevant candidates are also shown in a separate priority list. + +- **Prepare skeds and keep them visible:** Sked reminders, automatic advance messages and the AP timeline help prevent scheduled contacts from disappearing somewhere between chat, logging and ongoing CQ operation. + +- **Include aircraft scatter information:** The AirScout interface brings suitable aircraft and expected reflection times into candidate evaluation and sked planning. + +- **Connect the logger and station equipment:** KST4Contest synchronises worked stations and frequency information with supported logging software. It also provides interfaces for Win-Test, PSTRotator and a built-in DX Cluster server. + +- **Display stations and radio paths:** The station map shows active chat members, locator squares, antenna directions and the path to the selected station. A terrain profile can also be calculated for selected paths. + +These functions share information. A detected frequency can indicate an active band, worked status comes from the logger, aircraft scatter data adds timing information and the resulting score affects the priority list. Missing or outdated input data can therefore affect the result as well. + +--- + +## Requirements + +A registered ON4KST account is required. Registration and login are available from the [official ON4KST login page](https://www.on4kst.org/chat/login.php). + +English is the official language of the ON4KST Chat. This also applies when communicating with stations from your own country. Common amateur radio abbreviations such as `pse`, `agn`, `qrg`, `dir`, `rrr`, `tnx` and `73` are normal and usually considerably faster than carefully written prose. + +Downloads, supported operating systems and installation methods are described in [Installation](en-Installation). + +--- + +## Manual version + +This manual describes the stable release **v1.41.1**. + +Features or changes that are only available in the current development version are explicitly marked as **Nightly / v1.42**. If no such label is present, the description refers to the stable release. + +- [Download the current stable release](https://github.com/praktimarc/kst4contest/releases/latest) +- [Nightly and automated builds](https://github.com/praktimarc/kst4contest/actions) +- [Version history](en-Changelog) + +For contest operation, the stable release is generally the appropriate choice. Nightly builds contain newer fixes and features, but may change between builds. They are useful when a particular change needs testing. Trying one for the first time ten minutes before a contest is less useful. + +--- + +## Quick navigation | Page | Contents | |---|---| -| [Installation](en-Installation) | Download, Java requirements, update | -| [Configuration](en-Configuration) | All settings in detail | -| [Log Synchronisation](en-Log-Sync) | UCXLog, N1MM+, QARTest, DXLog.net, WinTest | -| [AirScout Integration](en-AirScout-Integration) | Aircraft scatter detection | -| [DX Cluster Server](en-DX-Cluster-Server) | Built-in DX cluster for your logging software | -| [Features](en-Features) | All features at a glance | -| [Macros and Variables](en-Macros-and-Variables) | Text snippets, shortcuts, variables | -| [User Interface](en-User-Interface) | UI explanation and operation | -| [Changelog](en-Changelog) | Version history | +| [Installation](en-Installation) | ON4KST account, downloads, installation and updates | +| [Configuration](en-Configuration) | Login, station, bands, user interface and external connections | +| [Log Synchronisation](en-Log-Sync) | Simplelogfile, UCXLog, N1MM+, QARTest, DXLog.net and Win-Test | +| [AirScout Integration](en-AirScout-Integration) | Connecting AirScout and evaluating aircraft scatter timing | +| [DX Cluster Server](en-DX-Cluster-Server) | Passing detected opportunities to logging software | +| [Features](en-Features) | Operation, reasoning and limitations of individual functions | +| [Macros and Variables](en-Macros-and-Variables) | Reusable messages, shortcuts and automatically substituted values | +| [User Interface](en-User-Interface) | Interface layout and operation during a contest | +| [Changelog](en-Changelog) | Releases, Nightly changes and resolved issues | --- -## What is KST4Contest? +## Contact and support -The ON4KST Chat is the de-facto standard for skeds on the 144 MHz and higher bands. KST4Contest enhances the chat experience with contest-specific features: +- **Download:** [Current stable release](https://github.com/praktimarc/kst4contest/releases/latest) +- **Source code:** [praktimarc/kst4contest](https://github.com/praktimarc/kst4contest) +- **Bug reports and feature requests:** [GitHub Issues](https://github.com/praktimarc/kst4contest/issues) +- **Email:** praktimarc+kst4contest@gmail.com + Please use this address only for KST4Contest-related topics. -- **Worked marking**: Stations already worked are highlighted visually, synchronised directly from your logging software via UDP. -- **Sked direction detection**: When a station calls another one from your direction, it is highlighted green and bold. -- **QRG detection**: KST4Contest automatically reads frequencies from the chat traffic and shows them in the user list. -- **AirScout interface**: Reflectable aircraft are shown directly in the user list. -- **Built-in DX cluster server**: Spots are sent directly to your logging software. -- **Dark mode** (from v1.26): Easy on the eyes during night-time operation. -- **Multi-channel login** (from v1.26): Simultaneously logged into two chat categories. +### Reporting a bug ---- +A problem is considerably easier to reproduce when the report contains at least: -## Contact & Support +1. the KST4Contest version, +2. the operating system and installation method, +3. the exact steps leading to the problem, +4. the expected and observed behaviour, +5. a screenshot where appropriate, +6. the error log file. -- **Email**: praktimarc+kst4contest@gmail.com *(for kst4contest topics only)* -- **GitHub**: https://github.com/praktimarc/kst4contest -- **Download**: https://github.com/praktimarc/kst4contest/releases/latest +The error log is stored at: -### Reporting a bug (creating an issue) - -When reporting a bug, please **always attach the log file**. KST4Contest automatically writes an error log (error messages only, no personal data): - -| Operating system | Log file location | +| Operating system | Path | |---|---| | Linux / macOS | `~/.praktiKST/kst4contest-errors.log` | | Windows | `C:\Users\\.praktiKST\kst4contest-errors.log` | -When opening an issue on GitHub, a template is provided that guides you through all relevant fields. +Please inspect the file briefly before uploading it. An error log mainly contains technical information, but depending on the problem it may also include local file paths or other contextual data. + +Some file and directory names still use the technical name `praktiKST`. They refer to the same program. --- ## Acknowledgements -Special thanks to: Gianluca Costantino (IU3OAR), Alessandro Murador (IZ3VTH), Reczetár István (HA1FV), OM0AAO (Viliam Petrik, DX cluster idea), DC9DJ (Konrad Neitzel, project structure), DO5ALF (Andreas, webmaster funkerportal.de), PE0WGA (Franz van Velzen, tester) and all other testers and contributors. +KST4Contest has benefited considerably from feedback gathered during actual contest operation. + +Special thanks go to Gianluca Costantino (IU3OAR), Alessandro Murador (IZ3VTH), Reczetár István (HA1FV), Viliam Petrik (OM0AAO, DX Cluster idea), Konrad Neitzel (DC9DJ, project structure), Andreas (DO5ALF, webmaster of funkerportal.de), Franz van Velzen (PE0WGA, testing), and all other testers and contributors. \ No newline at end of file diff --git a/src/main/java/kst4contest/controller/BeaconTask.java b/src/main/java/kst4contest/controller/BeaconTask.java index 8086226..5dd0e74 100644 --- a/src/main/java/kst4contest/controller/BeaconTask.java +++ b/src/main/java/kst4contest/controller/BeaconTask.java @@ -48,7 +48,8 @@ public class BeaconTask extends TimerTask { replaceVariables = replaceVariables.replaceAll("MYCALL", this.chatController.getChatPreferences().getStn_loginCallSign()); replaceVariables = replaceVariables.replaceAll("MYLOCATOR", this.chatController.getChatPreferences().getStn_loginLocatorMainCat()); replaceVariables = replaceVariables.replaceAll("MYQTF", this.chatController.getChatPreferences().getActualQTF().getValue() + ""); - replaceVariables = replaceVariables.replaceAll("SECONDQRG", this.chatController.getChatPreferences().getActualQTF().getValue() + ""); + replaceVariables = replaceVariables.replaceAll("SECONDQRG", this.chatController.getChatPreferences().getMYQRGSecondCat().getValue() + ""); + beaconMSG.setMessageText( diff --git a/website/.eleventy.js b/website/.eleventy.js index faa74fb..88839ad 100644 --- a/website/.eleventy.js +++ b/website/.eleventy.js @@ -3,6 +3,74 @@ const path = require("path"); const markdownIt = require("markdown-it"); const markdownItAnchor = require("markdown-it-anchor"); +const MANUAL_PAGE_ORDER = { + de: [ + "home", + "installation", + "konfiguration", + "log-synchronisation", + "airscout-integration", + "dx-cluster-server", + "funktionen", + "makros-und-variablen", + "benutzeroberflaeche", + "changelog" + ], + en: [ + "home", + "installation", + "configuration", + "log-sync", + "airscout-integration", + "dx-cluster-server", + "features", + "macros-and-variables", + "user-interface", + "changelog" + ] +}; + +function markdownToPlainText(value) { + return (value || "") + .replace(/!\[([^\]]*)\]\([^)]+\)/g, "$1") + .replace(/\[([^\]]+)\]\([^)]+\)/g, "$1") + .replace(/<[^>]+>/g, "") + .replace(/[*_~`]/g, "") + .replace(/\s+/g, " ") + .trim(); +} + +function extractManualTitle(raw, fallbackTitle) { + const heading = (raw || "").match(/^#\s+(.+)$/m); + return heading ? markdownToPlainText(heading[1]) : fallbackTitle; +} + +function extractManualSummary(raw) { + const blocks = (raw || "").split(/\r?\n\s*\r?\n/); + + for (const block of blocks) { + const trimmed = block.trim(); + + if (!trimmed + || /^(#|>|\||---|```|!\[)/.test(trimmed) + || /^[-*+]\s/.test(trimmed) + || /^\d+[.)]\s/.test(trimmed)) { + continue; + } + + return markdownToPlainText(trimmed); + } + + return ""; +} + +function getManualPageOrder(lang, slug) { + const configuredOrder = MANUAL_PAGE_ORDER[lang] || []; + const index = configuredOrder.indexOf(slug); + + return index >= 0 ? index : 999; +} + function rewriteManualLinks(content, lang) { return (content || "") // GitHub-Wiki-Links im Stil [[de-Installation]] oder [[en-Installation]] @@ -96,19 +164,28 @@ module.exports = function (eleventyConfig) { .replace(/\.md$/, "") .toLowerCase(); - const title = file + const fallbackTitle = file .replace(/^en-/, "") .replace(/^de-/, "") .replace(/\.md$/, "") .replace(/-/g, " "); + const title = extractManualTitle(raw, fallbackTitle); + return { file, lang, slug, title, + summary: extractManualSummary(raw), + order: getManualPageOrder(lang, slug), content: rewriteManualLinks(raw, lang) }; + }) + .sort((a, b) => { + return a.lang.localeCompare(b.lang) + || a.order - b.order + || a.title.localeCompare(b.title); }); }); diff --git a/website/src/_layouts/base.njk b/website/src/_layouts/base.njk index 57c7e65..998f111 100644 --- a/website/src/_layouts/base.njk +++ b/website/src/_layouts/base.njk @@ -5,12 +5,12 @@ {{ title or "KST4Contest" }} - + - + @@ -20,7 +20,7 @@ - + @@ -53,7 +53,7 @@
KST4Contest -

Contest-optimized ON4KST workflow for VHF/UHF/SHF operators.

+

ON4KST chat, candidate selection and sked planning for VHF, UHF and SHF contest operation.

Project diff --git a/website/src/features/airscout.md b/website/src/features/airscout.md index a46130d..bb65373 100644 --- a/website/src/features/airscout.md +++ b/website/src/features/airscout.md @@ -3,8 +3,8 @@ title: AirScout Integration icon: ✈️ category: Aircraft Scatter since: "1.26" -summary: Use aircraft scatter awareness directly inside your ON4KST contest workflow. -description: AirScout information helps operators evaluate AP windows, aircraft scatter timing and candidate stations during VHF/UHF/SHF contests. +summary: Use AirScout AP predictions in candidate evaluation, the timeline and sked planning. +description: KST4Contest receives aircraft scatter information from AirScout and relates AP timing to active ON4KST stations. tagsList: - AirScout - airplane scatter diff --git a/website/src/features/dual-chat.md b/website/src/features/dual-chat.md index 3f4df1b..a1c2616 100644 --- a/website/src/features/dual-chat.md +++ b/website/src/features/dual-chat.md @@ -3,8 +3,9 @@ title: Dual Chat Categories icon: 💬 category: ON4KST Chat since: "1.26" -summary: Operate in two ON4KST categories at once, for example VHF/UHF and microwave. -description: Dual category support gives contest operators better overview when working across multiple ON4KST chat rooms. +since: "1.26" +summary: Log in to two ON4KST categories and handle both message streams in one station list and interface. +description: KST4Contest combines two ON4KST chat categories while retaining the category required for messages and station context. tagsList: - ON4KST - dual chat diff --git a/website/src/features/dx-cluster.md b/website/src/features/dx-cluster.md index 11d8986..8d39952 100644 --- a/website/src/features/dx-cluster.md +++ b/website/src/features/dx-cluster.md @@ -3,8 +3,8 @@ title: DXCluster Server icon: 📡 category: Radio Workflow since: "1.23" -summary: Use DXCluster information as part of the wider contest operating workflow. -description: KST4Contest includes DXCluster functionality to support situational awareness during contest operation. +summary: Send direction warnings as DX Cluster spots to compatible logging software when a usable QRG is known. +description: The built-in DX Cluster server forwards KST4Contest direction warnings and known frequency information to compatible contest loggers. tagsList: - DXCluster - ham radio @@ -14,6 +14,7 @@ related: - priority-score --- + ## More situational awareness DXCluster information can support contest operators by adding another source of activity information. diff --git a/website/src/features/log-sync.md b/website/src/features/log-sync.md index 795f0b0..7a53515 100644 --- a/website/src/features/log-sync.md +++ b/website/src/features/log-sync.md @@ -3,8 +3,8 @@ title: Log Synchronization icon: 🔄 category: Logger Integration since: "1.31" -summary: Connect ON4KST chat workflow with Win-Test, UCXLog and contest logging state. -description: Log synchronization helps KST4Contest understand worked stations, active bands and contest context. +summary: Import worked stations and current frequencies from supported contest loggers so filters and band information follow the log. +description: KST4Contest receives worked-station and, where supported, frequency data from UCXLog, N1MM+, QARTest, DXLog.net and Win-Test through file and UDP interfaces. tagsList: - Win-Test - UCXLog diff --git a/website/src/features/macros.md b/website/src/features/macros.md index 376bc01..479ed3c 100644 --- a/website/src/features/macros.md +++ b/website/src/features/macros.md @@ -3,8 +3,8 @@ title: Macros and Variables icon: ⚡ category: Operator Speed since: "1.0" -summary: Send recurring contest messages faster with configurable macros and variables. -description: Macros reduce repetitive typing and help operators respond quickly during active ON4KST contest sessions. +summary: Build recurring chat messages from configurable text blocks and variables such as the current QRG or locator. +description: KST4Contest macros combine reusable message text with values taken from the current station, frequency and operating context. tagsList: - macros - ON4KST diff --git a/website/src/features/priority-score.md b/website/src/features/priority-score.md index c3e130b..e07da62 100644 --- a/website/src/features/priority-score.md +++ b/website/src/features/priority-score.md @@ -3,8 +3,8 @@ title: Priority Score System icon: 🎯 category: Contest Workflow since: "1.40" -summary: Find the most promising stations faster using contest-aware candidate scoring. -description: KST4Contest ranks stations by activity, direction, sked context, band information, QRG hints and operator workflow signals. +summary: Rank active stations from known context such as direction, activity, band, QRG, AP and sked information. +description: The Priority Score System combines available contest information to populate a separate list of currently relevant candidates. tagsList: - ON4KST - VHF diff --git a/website/src/features/sked-reminder.md b/website/src/features/sked-reminder.md index 111753f..a32dac3 100644 --- a/website/src/features/sked-reminder.md +++ b/website/src/features/sked-reminder.md @@ -3,8 +3,8 @@ title: Sked Reminder icon: 🔔 category: Sked Management since: "1.40" -summary: Keep scheduled contacts visible and avoid missing time-critical skeds. -description: KST4Contest keeps skeds in focus while the operator handles chat traffic, logging, bands and aircraft scatter timing. +summary: Store planned contacts and issue configurable chat messages plus local alerts before the agreed time. +description: Sked Reminder keeps scheduled contacts visible and provides automatic advance messages together with acoustic and visual operator alerts. tagsList: - sked - ON4KST diff --git a/website/src/features/timeline.md b/website/src/features/timeline.md index d7281a0..1444714 100644 --- a/website/src/features/timeline.md +++ b/website/src/features/timeline.md @@ -3,8 +3,8 @@ title: Timeline View icon: ⏱️ category: Contest Awareness since: "1.40" -summary: See upcoming AP windows and candidate timing in a compact contest timeline. -description: The timeline view helps operators understand short propagation windows and candidate timing during active contest operation. +summary: Show AP-based priority candidates and scheduled contacts on a shared timeline. +description: The Timeline View places upcoming aircraft scatter candidates and planned skeds into a common time-based overview. tagsList: - timeline - AP windows diff --git a/website/src/index.njk b/website/src/index.njk index acf6f94..fb98fd0 100644 --- a/website/src/index.njk +++ b/website/src/index.njk @@ -1,7 +1,7 @@ --- layout: base.njk -title: KST4Contest – Contest-Optimized ON4KST Chat Client -description: KST4Contest is a modern ON4KST chat client built for VHF, UHF and SHF contest operation. +title: KST4Contest – ON4KST Contest Client for VHF, UHF and SHF +description: KST4Contest combines ON4KST chat, candidate prioritisation, sked planning, AirScout data and logger integration in one desktop client. heroFx: true --- @@ -10,25 +10,32 @@ heroFx: true
-

The contest-optimized ON4KST client

+

ON4KST contest workflow for 144 MHz and above

KST4Contest

+

- Work smarter. Make more QSOs. KST4Contest brings priority candidates, - AirScout workflow, sked reminders, dual chat categories and log synchronization - into one contest-focused ON4KST client. + ON4KST shows you the traffic. KST4Contest helps turn it into an operating + decision by combining chat, candidate prioritisation, sked planning, + AirScout data and logger integration in one desktop client. +

+ +

+ The available information is filtered, related to active stations and + presented in a contest-oriented workflow. The final decision still + belongs to the operator.

Download KST4Contest - View on GitHub - Read manual + Read the manual + View source code
- KST4Contest workflow + Functions sharing the same station context
@@ -46,21 +53,63 @@ heroFx: true
-

Powerful features

-

Everything you need for contest success

+

The operating problem

+

The useful station is rarely the only station in the chat

- Every feature is designed to reduce operator workload and improve decision speed during real contest operation. + During an active contest, messages, sked requests, frequency information + and band changes arrive continuously. The task is to identify which part + of that traffic matters now, which candidate should be monitored and + which contact is better scheduled for later.

- {% for feature in collections.features %} +
+

Observe

+

+ Messages, locators, detected frequencies and known band activity are + assigned to stations across as many as two ON4KST chat categories. +

+
+ +
+

Evaluate

+

+ Direction, distance, worked status, NOT-QRV information, chat activity, + sked context and aircraft scatter data feed filters and candidate scores. +

+
+ +
+

Act

+

+ Candidates can be contacted, scheduled or monitored. Skeds remain + visible, while supported loggers and station interfaces receive the + information required for the next operating step. +

+
+
+
+ +
+
+

Functions

+

One workflow, shared context

+

+ The individual functions are not isolated tools. They use the same + station, message, band and timing information, so that a change in one + part of the workflow can also affect filters, priorities and reminders. +

+
+ +
+ {% for feature in collections.sortedFeatures %} {% endfor %}
@@ -68,29 +117,52 @@ heroFx: true
-

Open Source

-

Built by contesters for contesters.

+

Limits

+

A priority score is not a propagation forecast

- KST4Contest is developed around real VHF/UHF/SHF contest workflows: - ON4KST chat, aircraft scatter, skeds, logging and fast operator decisions. + KST4Contest can only evaluate the information it knows. Scores, AP + windows, filters and path profiles support the operator's decision; they + do not guarantee a contact. If the input data is incomplete or outdated, + the result can be incomplete or outdated as well.

+
- Download KST4Contest - Explore features - ❤️ Support development + Explore the functions + Read the technical details +
+
+
+ +
+
+

Project status

+

Stable for operation, Nightly for testing

+

+ KST4Contest is open-source software. The current stable release is the + normal choice for contest operation. Nightly builds follow ongoing + development and are useful when a particular fix or feature needs + testing. A few minutes before a contest is not the ideal time to discover + what changed. +

+ +
+ Download the stable release + Development status + Support development
+ \ No newline at end of file diff --git a/website/src/manual/de/index.njk b/website/src/manual/de/index.njk index 5225a2a..2bbadfc 100644 --- a/website/src/manual/de/index.njk +++ b/website/src/manual/de/index.njk @@ -15,7 +15,9 @@ description: Deutsches Benutzerhandbuch für KST4Contest. {% if manual.lang == "de" %}

{{ manual.title }}

-

Handbuchseite „{{ manual.title }}“ öffnen.

+ {% if manual.summary %} +

{{ manual.summary }}

+ {% endif %}
{% endif %} {% endfor %} diff --git a/website/src/manual/en/index.njk b/website/src/manual/en/index.njk index de23f8d..8a68e2d 100644 --- a/website/src/manual/en/index.njk +++ b/website/src/manual/en/index.njk @@ -15,7 +15,9 @@ description: English user manual for KST4Contest. {% if manual.lang == "en" %}

{{ manual.title }}

-

Open the {{ manual.title }} manual page.

+ {% if manual.summary %} +

{{ manual.summary }}

+ {% endif %}
{% endif %} {% endfor %}