- Revamped the README to provide comprehensive documentation for the Mindnet Causal Assistant plugin, including user, administrator, developer, and architect guides. - Added specialized documentation sections for installation, deployment, and troubleshooting. - Enhanced the chain inspection logic to determine effective required links based on template definitions, profiles, and defaults, improving the accuracy of findings related to link completeness.
12 KiB
Mindnet Causal Assistant - Benutzerhandbuch
Version: 1.0.0
Stand: 2025-01-XX
Zielgruppe: Endnutzer des Mindnet Obsidian Plugins
Inhaltsverzeichnis
Einführung
Das Mindnet Causal Assistant Plugin ist ein Authoring-Tool für Obsidian, das Sie dabei unterstützt:
- Strukturierte Notes anzulegen mit Frontmatter, IDs und Typen
- Inhalte über konfigurierbare Interviews zu erfassen
- Semantische Kanten (Edges) zu pflegen und zu validieren
- Links und Edge-Zuordnungen section-basiert zu gruppieren (Semantic Mapping)
- Kausale Ketten zu analysieren und zu validieren
Hauptkonzepte
- Profile: Auswahl eines "Erstell-Profils" (kann mehrere Interviews pro Note-Typ geben)
- Interview Config (YAML): Definiert Steps, Loops, Defaults, Frontmatter-Whitelist
- ID-first: Mindnet-Graph arbeitet über Frontmatter
idals Schlüssel - Semantic Mapping: Links in einer Section werden Edge-Typen zugeordnet und als Callouts strukturiert
- Chain Templates: Vordefinierte Muster für kausale Ketten (z.B.
trigger → transformation → outcome)
Schnellstart
1. Plugin aktivieren
- Öffnen Sie Settings → Community Plugins
- Stellen Sie sicher, dass "Restricted mode" ausgeschaltet ist
- Aktivieren Sie das Plugin "Mindnet Causal Assistant"
2. Erste Konfiguration
Das Plugin benötigt Konfigurationsdateien im Vault. Diese sollten bereits vorhanden sein (siehe Administratorhandbuch). Standardpfade:
_system/dictionary/edge_vocabulary.md- Edge-Typen-Vokabular_system/dictionary/graph_schema.md- Graph-Schema_system/dictionary/interview_config.yaml- Interview-Konfiguration_system/dictionary/chain_roles.yaml- Chain-Rollen-Mapping_system/dictionary/chain_templates.yaml- Chain-Templates
3. Erste Note erstellen
- Öffnen Sie den Command Palette (
Ctrl+P/Cmd+P) - Wählen Sie "Mindnet: Create note from profile"
- Wählen Sie ein Profil aus
- Geben Sie einen Titel ein
- Wählen Sie einen Ordner (optional)
- Die Note wird erstellt und geöffnet
- Optional: Wizard startet automatisch (wenn konfiguriert)
Hauptfunktionen
1. Note-Erstellung mit Profilen
Zweck: Erstellen strukturierter Mindnet-Notes mit korrektem Frontmatter.
Verwendung:
- Command: "Mindnet: Create note from profile"
- Profil wählen (z.B. "experience", "insight", "decision")
- Titel und Ordner festlegen
- Note wird mit Frontmatter erstellt (ID, Typ, Profil)
Frontmatter-Beispiel:
---
id: note_1234567890_abc123
title: "Meine Erfahrung"
type: experience
interview_profile: experience_basic
---
2. Interview-Wizard
Zweck: Strukturierte Erfassung von Inhalten über konfigurierbare Interviews.
Verwendung:
- Startet automatisch nach Note-Erstellung (wenn aktiviert)
- Oder manuell über Command (geplant)
- Steps ausfüllen (Loops/Nested Loops möglich)
- Review → Apply & Finish
- Output wird in die Note geschrieben
Features:
- Verschachtelte Loops
- Section-basierte Ausgabe
- Frontmatter-Whitelist-Unterstützung
3. Semantic Mapping (Edger)
Zweck: Automatische Gruppierung von Links nach Edge-Typen in Mapping-Blöcken.
Verwendung:
- Manuell: Command "Mindnet: Build semantic mapping blocks (by section)"
- Automatisch: Nach Interview Finish (falls im Profil aktiviert)
Output:
- Pro Section ein Mapping-Block am Ende der Section:
- Wrapper Callout (Default:
abstract) - Gruppiert nach Edge-Typ
- Gruppen getrennt durch Leerzeile
- Wrapper Callout (Default:
Beispiel:
## Meine Section
Inhalt mit Links: [[Note1]] und [[Note2]]
> [!abstract] 🕸️ Semantic Mapping
>
> > [!edge] causes
> > [[Note1]]
> >
> > [!edge] influences
> > [[Note2]]
4. Chain Inspector
Zweck: Analyse kausaler Ketten um die aktuelle Section.
Verwendung:
- Command: "Mindnet: Inspect Chains (Current Section)"
- Analysiert lokale Nachbarschaft + Pfade im Graphen
- Template Matching gegen vordefinierte Kettenmuster
- Findings (Gap-Heuristiken) werden generiert
Report enthält:
- Context (aktuelle Datei/Section)
- Neighbors (incoming/outgoing)
- Paths (vorwärts/rückwärts)
- Template Matches
- Findings (fehlende Slots, Links, etc.)
Findings-Beispiele:
missing_slot_*- Wichtige Slots fehlendangling_target- Edge verweist auf nicht-existierende Dateidangling_target_heading- Edge verweist auf nicht-existierendes Headingmissing_link_constraints- Erwartete Links fehlenno_causal_roles- Keine kausalen Rollen gefunden
5. Fix Findings
Zweck: Automatische Behebung von Findings.
Verwendung:
- Command: "Mindnet: Fix Findings (Current Section)"
- Zeigt verfügbare Fix-Actions für Findings
- Wählt Action aus → wird ausgeführt
Verfügbare Actions:
- Create Missing Note - Erstellt fehlende Note (skeleton oder mit Wizard)
- Retarget Link - Ersetzt Link zu existierender Note
- Create Missing Heading - Erstellt Heading in Target-Datei
- Retarget to Existing Heading - Ersetzt Link zu existierendem Heading
- Promote Candidate Edge - Befördert Candidate-Edge zu explizitem Edge
6. Unresolved Link Handling
Zweck: Automatische Note-Erstellung beim Klick auf nicht-existierende Links.
Verwendung:
- Klick auf
[[Neue Note]]in Reading View oder Editor - Plugin übernimmt Flow (wenn aktiviert)
- Profil-Auswahl → Note wird erstellt
- Optional: Wizard startet automatisch
Modifier-Keys:
- Reading View: Bypass-Modifier (Standard:
Alt) - umgeht Plugin-Intercept - Editor: Follow-Modifier (Standard:
Ctrl) - aktiviert Plugin-Intercept
7. Edge-Type-Änderung
Zweck: Ändern des Edge-Typs für Links.
Verwendung:
- Command: "Mindnet: Edge-Type ändern"
- Kontext wird automatisch erkannt:
- Cursor in Link → ändert diesen Link
- Auswahl mit Links → ändert alle Links in Auswahl
- Keine Auswahl → zeigt Edge-Type-Selector für neue Links
Features:
- Graph-Schema-basierte Empfehlungen
- Inline Micro-Suggester (wenn aktiviert)
- Typische/Prohibited Edge-Types
8. Note Adoption
Zweck: Automatische Konvertierung neu erstellter Notes zu Mindnet-Format.
Verwendung:
- Automatisch aktiviert (wenn konfiguriert)
- Erkennt neu erstellte Notes (klein, ohne ID)
- Zeigt Adoption-Modal (abhängig von Confidence)
- Profil-Auswahl → Frontmatter wird hinzugefügt
- Optional: Wizard startet
Confidence-Levels:
- High: Innerhalb Zeitfenster nach Link-Klick
- Low: Andere Fälle
Workflows
Workflow 1: Neue Note erstellen und ausfüllen
-
Note erstellen:
- Command: "Mindnet: Create note from profile"
- Profil wählen (z.B. "experience")
- Titel: "Meine Erfahrung"
- Ordner wählen
-
Wizard ausfüllen:
- Wizard startet automatisch (wenn aktiviert)
- Steps durchgehen
- Review → Apply & Finish
-
Semantic Mapping:
- Edger läuft automatisch (falls im Profil aktiviert)
- Oder manuell: "Mindnet: Build semantic mapping blocks"
-
Validierung:
- Command: "Mindnet: Validate current note"
- Prüft Lint-Regeln
- Zeigt Findings in Console
Workflow 2: Kausale Kette analysieren
-
Section öffnen:
- Cursor in relevante Section positionieren
-
Chain Inspector ausführen:
- Command: "Mindnet: Inspect Chains (Current Section)"
- Report wird in Console ausgegeben
-
Findings prüfen:
- Console öffnen (F12)
- Findings analysieren
- Template Matches prüfen
-
Findings beheben:
- Command: "Mindnet: Fix Findings (Current Section)"
- Verfügbare Actions auswählen
- Automatische Behebung
Workflow 3: Unresolved Link → Note erstellen
-
Link erstellen:
[[Neue Note]]in Note schreiben
-
Link anklicken:
- Reading View: Normaler Klick
- Editor:
Ctrl+ Klick (wenn Follow-Modifier aktiviert)
-
Profil wählen:
- Profile-Selection-Modal öffnet sich
- Profil auswählen
-
Note wird erstellt:
- Frontmatter wird hinzugefügt
- Wizard startet (wenn aktiviert)
Workflow 4: Edge-Type ändern
-
Link markieren:
- Cursor in Link positionieren
- Oder mehrere Links auswählen
-
Command ausführen:
- "Mindnet: Edge-Type ändern"
-
Edge-Type wählen:
- Modal zeigt verfügbare Types
- Empfehlungen basierend auf Graph-Schema
- Type auswählen
-
Änderung wird angewendet:
- Link wird aktualisiert
- Semantic Mapping wird aktualisiert (falls vorhanden)
Commands im Detail
Note-Erstellung & Interview
| Command | Beschreibung | Wann verwenden |
|---|---|---|
| Mindnet: Create note from profile | Erstellt neue Note mit Profil | Neue Note von Grund auf erstellen |
| (Geplant) Mindnet: Start interview wizard | Startet Wizard für aktuelle Note | Interview manuell starten |
Mapping & Edges
| Command | Beschreibung | Wann verwenden |
|---|---|---|
| Mindnet: Build semantic mapping blocks (by section) | Baut Semantic Mapping Blöcke | Links nach Edge-Typen gruppieren |
| Mindnet: Edge-Type ändern | Ändert Edge-Type für Links | Edge-Typ korrigieren/zuordnen |
| Mindnet: Reload edge vocabulary | Lädt Edge-Vokabular neu | Nach Änderung an edge_vocabulary.md |
Analyse & Validierung
| Command | Beschreibung | Wann verwenden |
|---|---|---|
| Mindnet: Inspect Chains (Current Section) | Analysiert kausale Ketten | Chain-Analyse durchführen |
| Mindnet: Fix Findings (Current Section) | Behebt Findings automatisch | Findings automatisch beheben |
| Mindnet: Validate current note | Validiert aktuelle Note (Lint) | Note auf Fehler prüfen |
Export & Debug
| Command | Beschreibung | Wann verwenden |
|---|---|---|
| Mindnet: Export graph | Exportiert Graph als JSON | Graph exportieren |
| Mindnet: Show chains from current note | Zeigt Ketten von aktueller Note | Ketten-Exploration |
| Mindnet: Debug Chain Roles (Loaded) | Debug-Info für Chain Roles | Debugging |
| Mindnet: Debug Chain Templates (Loaded) | Debug-Info für Chain Templates | Debugging |
Detaillierte Referenz: Siehe 07_Event_Handler_Commands.md für vollständige Beschreibung aller Commands, Event Handler und Settings.
Troubleshooting
Wizard startet nicht
Symptom: Wizard startet nicht nach Note-Erstellung.
Lösung:
- Prüfen Sie Settings:
autoStartInterviewOnCreate - Prüfen Sie DevTools Console (F12) auf Fehler
- Prüfen Sie Interview-Config-Pfad in Settings
Edger schreibt Blöcke an falscher Stelle
Symptom: Semantic Mapping Blöcke erscheinen an falscher Position.
Lösung:
- Prüfen Sie Heading-Parsing (Section-Erkennung)
- Prüfen Sie, ob Wrapper-Block korrekt erkannt/ersetzt wird
- Prüfen Sie Console-Logs für Details
Schema-Empfehlungen fehlen
Symptom: Keine Empfehlungen beim Edge-Type-Ändern.
Lösung:
- Prüfen Sie
graph_schema_pathin Settings - Prüfen Sie Schema-Loader Stats/Logging in Console
- Prüfen Sie, ob Schema-Datei existiert und gültig ist
Chain Inspector findet keine Matches
Symptom: Template Matches sind leer.
Lösung:
- Prüfen Sie Chain-Templates-Pfad in Settings
- Prüfen Sie Console-Logs für Template-Loading
- Prüfen Sie, ob Note-Types korrekt im Frontmatter sind
- Prüfen Sie, ob Edges korrekt gemappt sind (chain_roles.yaml)
Unresolved Link wird nicht abgefangen
Symptom: Klick auf [[Neue Note]] öffnet Obsidian-Dialog statt Plugin-Flow.
Lösung:
- Prüfen Sie Settings:
interceptUnresolvedLinkClicks - Reading View: Bypass-Modifier nicht drücken
- Editor: Follow-Modifier (
Ctrl) drücken beim Klick - Prüfen Sie Console-Logs für Details
Note Adoption funktioniert nicht
Symptom: Neu erstellte Notes werden nicht adoptiert.
Lösung:
- Prüfen Sie Settings:
adoptNewNotesInEditor - Prüfen Sie, ob Note klein genug ist (
adoptMaxChars) - Prüfen Sie, ob Note bereits Frontmatter-ID hat (wird nicht adoptiert)
- Prüfen Sie Console-Logs für Adoption-Confidence
Weitere Ressourcen
- Administratorhandbuch: Konfiguration und Wartung
- Entwicklerhandbuch: Code-Struktur und Erweiterungen
- Architektur-Dokumentation: System-Übersicht
- Installation & Deployment: Setup-Anleitung
Ende des Benutzerhandbuchs