Audit Plugin

Verzija: 1.0
Avtor: Wolfgang van der Stille Wolfgang.van.der.Stille@gmail.com (The White Knight Labs)
Licenca: GPL 2

Opis

Vtičnik wvdsaudit omogoča vključitev revizijskih značk na wiki strani z avtomatskim izračunom statusa na podlagi sintakse potrditvenih polj.

Funkcije:

Avtomatski izračun statusa (passed/issues/critical)
Kritične sekcije so lahko označene
Možno ročno preglasitev
Fluent Design barvna shema (združljivo z Note vtičnikom)
Večjezično (DE, EN, SL)

Sintaksa

Varianta 1: Eksplicitne sekcije

<wk:audit stack="stack-name" title="Naslov-modula">
  <wk:audit:result value="passed|issues|critical" />  <!-- Opcijsko: Preglasitev -->
 
  <wk:section title="Naslov-sekcije" ref="wiki:povezava" critical="true">
    [x] Uspešno
    [ ] Neuspešno
    [-] Ni uporabno
  </wk:section>
</wk:audit>

Varianta 2: Include (priporočeno)

Avtomatsko naloži naslov sekcije iz referenčne wiki strani:

<wk:audit stack="vsix" title="FPC Solution Explorer 2">
  <!-- S polnim besedilom -->
  <wk:include ref="code:qualitaet" critical="true">
    [ ] Brez TODO komentarjev (22 najdenih)
    [x] Brez stub funkcij
  </wk:include>
 
  <!-- Način predloge: horizontalno (kompaktno) -->
  <wk:include ref="stacks:vscode-extension">[x][x][ ][x][x]</wk:include>
 
  <!-- Način predloge: vertikalno -->
  <wk:include ref="sicherheit:kritis">
[x]
[x]
[-]
  </wk:include>
</wk:audit>

Prednosti Include:

Naslov sekcije se avtomatsko naloži iz strani s kontrolnim seznamom
Povezava do kontrolnega seznama se avtomatsko nastavi
Krajša sintaksa, manj napak
Večjezično: Naslov se naloži iz jezikovne različice strani
Način predloge: Besedila postavk iz strani za pregled (samo status je naveden)

Atributi

<wk:audit>

Atribut	Obvezno	Opis
`stack`	Ne	Identifikator sklada (vsix, doku, fpc, itd.)
`title`	Da	Prikazni naslov revizije

<wk:audit:result>

Atribut	Opis
`value`	Preglasitev: `passed`, `issues`, `critical` ali `auto`

<wk:section>

Atribut	Obvezno	Opis
`title`	Da	Naslov sekcije
`ref`	Ne	Wiki povezava do kontrolnega seznama (brez jezikovne predpone)
`critical`	Ne	Če `true`, `[ ]` povzroči CRITICAL namesto ISSUES

<wk:include> (NOVO)

Atribut	Obvezno	Opis
`ref`	Da	Wiki povezava do kontrolnega seznama (npr. `code:qualitaet`, `stacks:vscode-extension`)
`critical`	Ne	Če `true`, `[ ]` povzroči CRITICAL namesto ISSUES

Opomba: Naslov sekcije se avtomatsko naloži iz prvega naslova (====== Naslov ======) referenčne strani.

Sintaksa potrditvenih polj

Sintaksa	Status	Pomen
`[x]`	passed	Kontrolna točka uspešna
`[ ]`	failed	Kontrolna točka neuspešna
`[-]`	na	Ni uporabno (prezrto)

Izračun statusa

Pogoj	Status	Barva
Vse `[x]`	passed	Zelena (#dff6dd)
Vsaj en `[ ]` (nekritično)	issues	Oranžna (#fff4ce)
`[ ]` v `critical=„true“` sekciji	critical	Rdeča (#fde7e9)

Primeri

Vse uspešno (Zelena)

<wk:audit stack=„demo“ title=„Popoln modul“>

<wk:section title="Kakovost kode" ref="code:qualitaet">
  [x] Brez TODO komentarjev
  [x] Brez FIXME komentarjev
</wk:section>

</wk:audit>

Z opombami (Oranžna)

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

<wk:section title="Dokumentacija" ref="infrastruktur:dokumentation">
  [x] README prisoten
  [ ] API dokumentiran
</wk:section>

</wk:audit>

Kritično (Rdeča)

<wk:audit stack=„demo“ title=„Kritičen modul“>

<wk:section title="Varnost" ref="sicherheit:kritis" critical="true">
  [ ] Validacija vnosov
  [x] Obravnava napak
</wk:section>

</wk:audit>

Datoteke

lib/plugins/wvdsaudit/
├── plugin.info.txt     # Metapodatki vtičnika
├── syntax.php          # Parser sintakse
├── helper.php          # Izračun statusa in izris
├── style.css           # Fluent Design oblikovanje
├── conf/
│   ├── default.php     # Privzete nastavitve
│   └── metadata.php    # Admin-UI
└── lang/
    ├── de/lang.php     # Nemščina
    ├── en/lang.php     # Angleščina
    └── sl/lang.php     # Slovenščina

CSS razredi

Razred	Opis
`.wk-audit`	Vsebnik
`.wk-audit-passed`	Zelen status
`.wk-audit-issues`	Oranžen status
`.wk-audit-critical`	Rdeč status
`.wk-audit-header`	Območje glave
`.wk-audit-body`	Telo s sekcijami
`.wk-audit-section`	Posamezna sekcija
`.wk-audit-item-passed`	Uspešna postavka
`.wk-audit-item-failed`	Neuspešna postavka
`.wk-audit-item-na`	N/A postavka

Glej tudi

Kontrolni seznami za pregled
Demo stran je del vtičnika; na tej namestitvi ni nameščen wvdsaudit, zato je tu ni.

<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~~