====== WvdS Audit Plugin ====== **Verzija:** 1.0\\ **Avtor:** Wolfgang van der Stille \\ **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 ==== [x] Uspešno [ ] Neuspešno [-] Ni uporabno ==== Varianta 2: Include (priporočeno) ==== Avtomatsko naloži naslov sekcije iz referenčne wiki strani: [ ] Brez TODO komentarjev (22 najdenih) [x] Brez stub funkcij [x][x][ ][x][x] [x] [x] [-] **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 ===== ==== ==== ^ Atribut ^ Obvezno ^ Opis ^ | ''stack'' | Ne | Identifikator sklada (vsix, doku, fpc, itd.) | | ''title'' | Da | Prikazni naslov revizije | ==== ==== ^ Atribut ^ Opis ^ | ''value'' | Preglasitev: ''passed'', ''issues'', ''critical'' ali ''auto'' | ==== ==== ^ 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 | ==== (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) ==== [x] Brez TODO komentarjev [x] Brez FIXME komentarjev ==== Z opombami (Oranžna) ==== [x] README prisoten [ ] API dokumentiran ==== Kritično (Rdeča) ==== [ ] Validacija vnosov [x] Obravnava napak ---- ===== 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 ^ | ''.wvds-audit'' | Vsebnik | | ''.wvds-audit-passed'' | Zelen status | | ''.wvds-audit-issues'' | Oranžen status | | ''.wvds-audit-critical'' | Rdeč status | | ''.wvds-audit-header'' | Območje glave | | ''.wvds-audit-body'' | Telo s sekcijami | | ''.wvds-audit-section'' | Posamezna sekcija | | ''.wvds-audit-item-passed'' | Uspešna postavka | | ''.wvds-audit-item-failed'' | Neuspešna postavka | | ''.wvds-audit-item-na'' | N/A postavka | ---- ===== Glej tudi ===== * [[.:sl:review:start|Kontrolni seznami za pregled]] * [[.:sl:test:wvdsaudit_demo|Demo stran]] ---- [x][x][x][x] [x][x][x][x][x] [x][x][x][-][-] ~~DISCUSSION:off~~