Inhaltsverzeichnis
WvdS Audit Plugin
Version: 1.0
Author: Wolfgang van der Stille zeljko.petrusic@outlook.de
License: GPL 2
Description
The wvdsaudit plugin enables embedding of audit badges on wiki pages with automatic status calculation based on checkbox syntax.
Features:
- Automatic status calculation (passed/issues/critical)
- Critical sections can be marked
- Manual override possible
- Fluent Design color scheme (Note plugin compatible)
- Multilingual (DE, EN, SL)
Syntax
Variant 1: Explicit Sections
<wvds:audit stack="stack-name" title="Module-Title"> <wvds:audit:result value="passed|issues|critical" /> <!-- Optional: Override --> <wvds:section title="Section-Title" ref="wiki:link" critical="true"> [x] Passed [ ] Failed [-] Not applicable </wvds:section> </wvds:audit>
Variant 2: Include (recommended)
Automatically loads section title from the referenced wiki page:
<wvds:audit stack="vsix" title="FPC Solution Explorer 2"> <!-- With full text --> <wvds:include ref="code:qualitaet" critical="true"> [ ] No TODO comments (22 found) [x] No stub functions </wvds:include> <!-- Template mode: horizontal (compact) --> <wvds:include ref="stacks:vscode-extension">[x][x][ ][x][x]</wvds:include> <!-- Template mode: vertical --> <wvds:include ref="sicherheit:kritis"> [x] [x] [-] </wvds:include> </wvds:audit>
Benefits of Include:
- Section title is automatically loaded from checklist page
- Link to checklist is automatically set
- Shorter syntax, less error-prone
- Multilingual: Title is loaded from language-specific page
- Template mode: Item texts from review pages (only status specified)
Attributes
<wvds:audit>
| Attribute | Required | Description |
|---|---|---|
stack | No | Stack identifier (vsix, doku, fpc, etc.) |
title | Yes | Display title of the audit |
<wvds:audit:result>
| Attribute | Description |
|---|---|
value | Override: passed, issues, critical or auto |
<wvds:section>
| Attribute | Required | Description |
|---|---|---|
title | Yes | Section title |
ref | No | Wiki link to checklist (without language prefix) |
critical | No | If true, [ ] results in CRITICAL instead of ISSUES |
<wvds:include> (NEW)
| Attribute | Required | Description |
|---|---|---|
ref | Yes | Wiki link to checklist (e.g., code:qualitaet, stacks:vscode-extension) |
critical | No | If true, [ ] results in CRITICAL instead of ISSUES |
Note: Section title is automatically loaded from the first headline (====== Title ======) of the referenced page.
Checkbox Syntax
| Syntax | Status | Meaning |
|---|---|---|
[x] | passed | Check point passed |
[ ] | failed | Check point failed |
[-] | na | Not applicable (ignored) |
Status Calculation
| Condition | Status | Color |
|---|---|---|
All [x] | passed | Green (#dff6dd) |
At least one [ ] (non-critical) | issues | Orange (#fff4ce) |
[ ] in critical=„true“ section | critical | Red (#fde7e9) |
Examples
All Passed (Green)
Perfect ModuleAudit bestanden • 2026-03-30▾
Code Quality
- ✓ No TODO comments
- ✓ No FIXME comments
With Issues (Orange)
Module with IssuesAudit: Anmerkungen • 2026-03-30▾
Documentation
- ✓ README present
- ✗ API documented
Critical (Red)
Critical ModuleAudit: Kritisch • 2026-03-30▾
Files
lib/plugins/wvdsaudit/
├── plugin.info.txt # Plugin metadata
├── syntax.php # Syntax parser
├── helper.php # Status calculation & rendering
├── style.css # Fluent Design styling
├── conf/
│ ├── default.php # Default settings
│ └── metadata.php # Admin UI
└── lang/
├── de/lang.php # German
├── en/lang.php # English
└── sl/lang.php # Slovenian
CSS Classes
| Class | Description |
|---|---|
.wvds-audit | Container |
.wvds-audit-passed | Green status |
.wvds-audit-issues | Orange status |
.wvds-audit-critical | Red status |
.wvds-audit-header | Header area |
.wvds-audit-body | Body with sections |
.wvds-audit-section | Individual section |
.wvds-audit-item-passed | Passed item |
.wvds-audit-item-failed | Failed item |
.wvds-audit-item-na | N/A item |
See Also
wvdsaudit PluginAudit bestanden • 2026-03-30▾
Zuletzt geändert: on 2026/01/29 at 07:51 PM