Kako prikazati izvorno kodo na strani wikija

Okoliščina

Repozitorij je priklopljen in zdaj naj se pokaže na strani wikija – bodisi celotno drevo za brskanje bodisi ena sama datoteka ali odsek vrstic ob razlagi.

Pregled rešitve

Na voljo sta dve oznaki. Zamenjava ene z drugo je najpogostejša napaka pri vgradnji.

Oznaka	Kaj prikaže	Kdo jo izriše	Kje deluje
`{{wk:adogit>…}}`	drevo map in datotek celotnega repozitorija	vtičnik `wkdoadogit`	samo na strani pod korenom projektov, na primer `sl:projects:dwplugins:repos`
`{{source>ado:…}}`	vsebino ene datoteke	vtičnik `wksourceview` s shemo `ado`	na strani pod korenom projektov ali na strani znotraj imenskega prostora priklopa

Obe gresta skozi iste pravice: o dostopu odloča imenski prostor priklopa, nikoli stran, na kateri oznaka stoji.

Izvedba

Drevo repozitorija

{{wk:adogit>wvds:DokuWiki-Plugins:wkdoadogit}}

Zapis je {{wk:adogit>povezava:projekt:repozitorij[:veja[:pot]]}}. Izpuščena veja pomeni privzeto vejo repozitorija, izpuščena pot pa koren. Neobvezni pripis region=<ime> na koncu ponudi brskalnik stranskemu območju lupine:

{{wk:adogit>wvds:DokuWiki-Plugins:wkdoadogit:main:/Domain region=toc}}

Ena datoteka

{{source>ado:wvds:DokuWiki-Plugins:wkdoadogit:main:/Domain/MountAclGate.php}}

Zapis je {{source>ado:povezava:projekt:repozitorij:veja:pot}}. Pri tej oznaki je vseh pet delov obveznih, zato vejo vedno navedite. Prazen del pomeni zavrnitev, ne privzete veje.

Odsek vrstic

{{source>ado:wvds:DokuWiki-Plugins:wkdoadogit:main:/Domain/MountAclGate.php#L141-L146}}

Dovoljeni zapisi območja so #L25, #L10-L40 in odprti #L10-. Štetje se začne pri 1 in se prireže na dolžino datoteke. Območje je zgolj prikazno, saj se pri Azure DevOpsu vedno prenese cela datoteka.

Nastavitve izrisa

Nastavitve zapišete za presledkom. Veljajo za vtičnik wksourceview, ne za shemo ado.

{{source>ado:wvds:DokuWiki-Plugins:wkdoadogit:main:/README.md#L1-L20 mode=block numbers=1 lang=markdown}}

Nastavitev	Vrednosti	Privzeto
`mode`	`inline`, `block`, `preview` ali `drawer`	vrednost nastavitve `default_mode` vtičnika `wksourceview`
`numbers`	`0` ali `1`	vrednost nastavitve `default_numbers`
`lang`	ime jezika za barvno označevanje	zazna se iz končnice datoteke

Opombe

Prvi del je ključ povezave, ne njena številka. Povezava se poišče po ključu znotraj projekta DWDO, ki mu pripada stran; številčni zapis ne deluje.
Vsaka vgradnja je klic prek omrežja. Stran z ducatom vgradenj plača ducat klicev, omejenih s časovnimi mejami in mejo bajtov v vtičniku wkdoado.
Vgradnja, pripeta na vejo, se tiho premakne. Besedilo, ki razlaga vrstico 40, se izrisuje naprej, ko se koda premakne na vrstico 90. Za razlage zato raje pripnite commit (40-mestni SHA) kot vejo.
Stran z vgradnjo se ne predpomni. Obe oznaki izklopita predpomnilnik strani, da vsebina, varovana s pravicami, ne pride do napačnega bralca.
Prevelike in dvojiške datoteke se ne izrišejo. Namesto vsebine se prikaže kartica s stanjem; meji nastavljata max_bytes in max_lines vtičnika wksourceview.
Zavrnitev ne pove vzroka. Nepriklopljen repozitorij, neznana povezava in manjkajoča pravica dajo namenoma podobne odgovore.

Sorodne teme

Vodnik: stran z brskalnikom – prva stran z brskalnikom, s celotnim primerom
Kako urediti datoteko in narediti commit iz wikija – urejanje datoteke in commit iz brskalnika
Tehnična referenca: raven vidnosti – kdo sme vgrajeno vsebino videti
Diagnostika – kaj pomeni katera kartica s stanjem