====== WvdS Audit Plugin ====== **Version:** 1.0\\ **Autor:** Wolfgang van der Stille \\ **Lizenz:** GPL 2 ---- ===== Beschreibung ===== Das **wvdsaudit** Plugin ermöglicht die Einbettung von Audit-Badges auf Wiki-Seiten mit automatischer Status-Berechnung basierend auf Checkbox-Syntax. **Features:** * Automatische Status-Berechnung (passed/issues/critical) * Kritische Sections markierbar * Manuelles Override möglich * Fluent Design Farbschema (Note-Plugin-kompatibel) * Mehrsprachig (DE, EN, SL) ---- ===== Syntax ===== ==== Variante 1: Explizite Sections ==== [x] Bestanden [ ] Nicht bestanden [-] Nicht anwendbar ==== Variante 2: Include (empfohlen) ==== Lädt Section-Titel automatisch aus der referenzierten Wiki-Seite: [ ] Keine TODO-Kommentare (22 gefunden) [x] Keine Stub-Funktionen [x][x][ ][x][x] [x] [x] [-] **Vorteile von Include:** * Section-Titel wird automatisch aus der Checklist-Seite geladen * Link zur Checklist wird automatisch gesetzt * Kürzere Syntax, weniger Fehleranfällig * Mehrsprachig: Titel wird aus der sprachspezifischen Seite geladen * **Template-Modus:** Item-Texte aus Review-Seiten (nur Status angeben) ===== Attribute ===== ==== ==== ^ Attribut ^ Pflicht ^ Beschreibung ^ | ''stack'' | Nein | Stack-Identifikator (vsix, doku, fpc, etc.) | | ''title'' | Ja | Anzeige-Titel des Audits | ==== ==== ^ Attribut ^ Beschreibung ^ | ''value'' | Override: ''passed'', ''issues'', ''critical'' oder ''auto'' | ==== ==== ^ Attribut ^ Pflicht ^ Beschreibung ^ | ''title'' | Ja | Section-Titel | | ''ref'' | Nein | Wiki-Link zur Checklist (ohne Sprach-Prefix) | | ''critical'' | Nein | Wenn ''true'', führt ''[ ]'' zu CRITICAL statt ISSUES | ==== (NEU) ==== ^ Attribut ^ Pflicht ^ Beschreibung ^ | ''ref'' | Ja | Wiki-Link zur Checklist (z.B. ''code:qualitaet'', ''stacks:vscode-extension'') | | ''critical'' | Nein | Wenn ''true'', führt ''[ ]'' zu CRITICAL statt ISSUES | **Hinweis:** Der Section-Titel wird automatisch aus der ersten Headline (''====== Titel ======'') der referenzierten Seite geladen. ---- ===== Checkbox-Syntax ===== ^ Syntax ^ Status ^ Bedeutung ^ | ''[x]'' | passed | Prüfpunkt bestanden | | ''[ ]'' | failed | Prüfpunkt nicht bestanden | | ''[-]'' | na | Nicht anwendbar (wird ignoriert) | ---- ===== Status-Berechnung ===== ^ Bedingung ^ Status ^ Farbe ^ | Alle ''[x]'' | passed | Grün (#dff6dd) | | Mindestens ein ''[ ]'' (nicht kritisch) | issues | Orange (#fff4ce) | | ''[ ]'' in ''critical="true"'' Section | critical | Rot (#fde7e9) | ---- ===== Beispiele ===== ==== Alles bestanden (Grün) ==== [x] Keine TODO-Kommentare [x] Keine FIXME-Kommentare ==== Mit Anmerkungen (Orange) ==== [x] README vorhanden [ ] API dokumentiert ==== Kritisch (Rot) ==== [ ] Input-Validierung [x] Fehlerbehandlung ---- ===== Dateien ===== lib/plugins/wvdsaudit/ ├── plugin.info.txt # Plugin-Metadaten ├── syntax.php # Syntax-Parser ├── helper.php # Status-Berechnung & Rendering ├── style.css # Fluent Design Styling ├── conf/ │ ├── default.php # Standard-Einstellungen │ └── metadata.php # Admin-UI └── lang/ ├── de/lang.php # Deutsch ├── en/lang.php # Englisch └── sl/lang.php # Slowenisch ---- ===== CSS-Klassen ===== ^ Klasse ^ Beschreibung ^ | ''.wvds-audit'' | Container | | ''.wvds-audit-passed'' | Grüner Status | | ''.wvds-audit-issues'' | Oranger Status | | ''.wvds-audit-critical'' | Roter Status | | ''.wvds-audit-header'' | Header-Bereich | | ''.wvds-audit-body'' | Body mit Sections | | ''.wvds-audit-section'' | Einzelne Section | | ''.wvds-audit-item-passed'' | Bestandenes Item | | ''.wvds-audit-item-failed'' | Fehlgeschlagenes Item | | ''.wvds-audit-item-na'' | N/A Item | ---- ===== Siehe auch ===== * [[.:de:review:start|Review Checklists]] * [[.:de:test:wvdsaudit_demo|Demo-Seite]] ---- [x][x][x][x] [x][x][x][x][x] [x][x][x][-][-] ~~DISCUSSION:off~~