Audit Plugin

Version: 1.0
Autor: Wolfgang van der Stille Wolfgang.van.der.Stille@gmail.com (The White Knight Labs)
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

<wk:audit stack="stack-name" title="Modul-Titel">
  <wk:audit:result value="passed|issues|critical" />  <!-- Optional: Override -->
 
  <wk:section title="Section-Titel" ref="wiki:link" critical="true">
    [x] Bestanden
    [ ] Nicht bestanden
    [-] Nicht anwendbar
  </wk:section>
</wk:audit>

Variante 2: Include (empfohlen)

Lädt Section-Titel automatisch aus der referenzierten Wiki-Seite:

<wk:audit stack="vsix" title="FPC Solution Explorer 2">
  <!-- Mit vollem Text -->
  <wk:include ref="code:qualitaet" critical="true">
    [ ] Keine TODO-Kommentare (22 gefunden)
    [x] Keine Stub-Funktionen
  </wk:include>
 
  <!-- Template-Modus: horizontal (kompakt) -->
  <wk:include ref="stacks:vscode-extension">[x][x][ ][x][x]</wk:include>
 
  <!-- Template-Modus: vertikal -->
  <wk:include ref="sicherheit:kritis">
[x]
[x]
[-]
  </wk:include>
</wk:audit>

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

<wk:audit>

Attribut	Pflicht	Beschreibung
`stack`	Nein	Stack-Identifikator (vsix, doku, fpc, etc.)
`title`	Ja	Anzeige-Titel des Audits

<wk:audit:result>

Attribut	Beschreibung
`value`	Override: `passed`, `issues`, `critical` oder `auto`

<wk:section>

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

<wk:include> (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)

<wk:audit stack=„demo“ title=„Perfektes Modul“>

<wk:section title="Code-Qualität" ref="code:qualitaet">
  [x] Keine TODO-Kommentare
  [x] Keine FIXME-Kommentare
</wk:section>

</wk:audit>

Mit Anmerkungen (Orange)

<wk:audit stack=„demo“ title=„Modul mit Anmerkungen“>

<wk:section title="Dokumentation" ref="infrastruktur:dokumentation">
  [x] README vorhanden
  [ ] API dokumentiert
</wk:section>

</wk:audit>

Kritisch (Rot)

<wk:audit stack=„demo“ title=„Kritisches Modul“>

<wk:section title="Sicherheit" ref="sicherheit:kritis" critical="true">
  [ ] Input-Validierung
  [x] Fehlerbehandlung
</wk:section>

</wk:audit>

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
`.wk-audit`	Container
`.wk-audit-passed`	Grüner Status
`.wk-audit-issues`	Oranger Status
`.wk-audit-critical`	Roter Status
`.wk-audit-header`	Header-Bereich
`.wk-audit-body`	Body mit Sections
`.wk-audit-section`	Einzelne Section
`.wk-audit-item-passed`	Bestandenes Item
`.wk-audit-item-failed`	Fehlgeschlagenes Item
`.wk-audit-item-na`	N/A Item

Siehe auch

Review-Checklisten
Eine Demo-Seite gehört zum Lieferumfang des Plugins; auf dieser Installation ist wvdsaudit nicht eingerichtet, deshalb gibt es sie hier nicht.

<wk:audit stack=„doku“ title=„wvdsaudit Plugin“>

<wk:include ref="code:qualitaet" critical="true">[x][x][x][x]</wk:include>
<wk:include ref="stacks:dokuwiki-php">[x][x][x][x][x]</wk:include>
<wk:include ref="sicherheit:kritis" critical="true">[x][x][x][-][-]</wk:include>

</wk:audit>

~~DISCUSSION:off~~