====== WvdS Audit Dodatak ====== **Verzija:** 1.0\\ **Autor:** Wolfgang van der Stille \\ **Licenca:** GPL 2 ---- ===== Opis ===== Dodatak **wvdsaudit** omogućuje ugrađivanje revizijskih oznaka na wiki stranice s automatskim izračunom statusa na temelju sintakse potvrdnih okvira. **Značajke:** * Automatski izračun statusa (passed/issues/critical) * Kritične sekcije mogu se označiti * Moguće ručno nadjačavanje * Fluent Design shema boja (kompatibilno s Note dodatkom) * Višejezično (DE, EN, SL, HR) ---- ===== Sintaksa ===== ==== Varijanta 1: Eksplicitne sekcije ==== [x] Prošlo [ ] Nije prošlo [-] Nije primjenjivo ==== Varijanta 2: Include (preporučeno) ==== Automatski učitava naslov sekcije s referencirane wiki stranice: [ ] Bez TODO komentara (22 pronađeno) [x] Bez stub funkcija [x][x][ ][x][x] [x] [x] [-] **Prednosti Include:** * Naslov sekcije se automatski učitava sa stranice s popisom za provjeru * Poveznica na popis za provjeru se automatski postavlja * Kraća sintaksa, manje sklonost greškama * Višejezično: Naslov se učitava s jezično specifične stranice * **Način predloška:** Tekstovi stavki sa stranica za pregled (naveden je samo status) ===== Atributi ===== ==== ==== ^ Atribut ^ Obavezno ^ Opis ^ | ''stack'' | Ne | Identifikator stacka (vsix, doku, fpc, itd.) | | ''title'' | Da | Prikazni naslov revizije | ==== ==== ^ Atribut ^ Opis ^ | ''value'' | Nadjačavanje: ''passed'', ''issues'', ''critical'' ili ''auto'' | ==== ==== ^ Atribut ^ Obavezno ^ Opis ^ | ''title'' | Da | Naslov sekcije | | ''ref'' | Ne | Wiki poveznica na popis za provjeru (bez jezičnog prefiksa) | | ''critical'' | Ne | Ako ''true'', ''[ ]'' rezultira u CRITICAL umjesto ISSUES | ==== (NOVO) ==== ^ Atribut ^ Obavezno ^ Opis ^ | ''ref'' | Da | Wiki poveznica na popis za provjeru (npr. ''code:qualitaet'', ''stacks:vscode-extension'') | | ''critical'' | Ne | Ako ''true'', ''[ ]'' rezultira u CRITICAL umjesto ISSUES | **Napomena:** Naslov sekcije se automatski učitava iz prvog naslova (''====== Naslov ======'') referencirane stranice. ---- ===== Sintaksa potvrdnih okvira ===== ^ Sintaksa ^ Status ^ Značenje ^ | ''[x]'' | passed | Kontrolna točka prošla | | ''[ ]'' | failed | Kontrolna točka nije prošla | | ''[-]'' | na | Nije primjenjivo (zanemareno) | ---- ===== Izračun statusa ===== ^ Uvjet ^ Status ^ Boja ^ | Sve ''[x]'' | passed | Zelena (#dff6dd) | | Najmanje jedan ''[ ]'' (nekritično) | issues | Narančasta (#fff4ce) | | ''[ ]'' u ''critical="true"'' sekciji | critical | Crvena (#fde7e9) | ---- ===== Primjeri ===== ==== Sve prošlo (Zeleno) ==== [x] Bez TODO komentara [x] Bez FIXME komentara ==== S problemima (Narančasto) ==== [x] README prisutan [ ] API dokumentiran ==== Kritično (Crveno) ==== [ ] Validacija unosa [x] Rukovanje greškama ---- ===== Datoteke ===== lib/plugins/wvdsaudit/ ├── plugin.info.txt # Metapodaci dodatka ├── syntax.php # Parser sintakse ├── helper.php # Izračun statusa i renderiranje ├── style.css # Fluent Design stilizacija ├── conf/ │ ├── default.php # Zadane postavke │ └── metadata.php # Admin UI └── lang/ ├── de/lang.php # Njemački ├── en/lang.php # Engleski └── sl/lang.php # Slovenski ---- ===== CSS klase ===== ^ Klasa ^ Opis ^ | ''.wvds-audit'' | Spremnik | | ''.wvds-audit-passed'' | Zeleni status | | ''.wvds-audit-issues'' | Narančasti status | | ''.wvds-audit-critical'' | Crveni status | | ''.wvds-audit-header'' | Područje zaglavlja | | ''.wvds-audit-body'' | Tijelo sa sekcijama | | ''.wvds-audit-section'' | Pojedinačna sekcija | | ''.wvds-audit-item-passed'' | Prošla stavka | | ''.wvds-audit-item-failed'' | Neuspješna stavka | | ''.wvds-audit-item-na'' | N/A stavka | ---- ===== Vidi također ===== * [[.:hr:review:start|Popisi za pregled]] * [[.:hr:test:wvdsaudit_demo|Demo stranica]] ---- [x][x][x][x] [x][x][x][x][x] [x][x][x][-][-] ~~DISCUSSION:off~~