Source Viewer
Source Viewer prikaže izvorne datoteke v wikiju, ne da bi jih kopiral: barvanje skladnje, številke vrstic, sidra vrstic in trajne povezave, po izbiri kot blok na strani ali v stranskem predalu. Od kod je datoteka, odloči ponudnik – krajevne datoteke in predstavnostna mapa so vgrajene, Git in Git, ki gostuje v ADO, prideta iz pripadajočih paketov. Vtičnik je namenjen avtorjem, ki kodo pokažejo na strani, in bralcem, ki jo berejo v sobesedilu.
Prvi koraki
Hitri začetek: prikaz izvorne datoteke na strani – najkrajša pot do prvega rezultata, v treh korakih.
Pogosta opravila
| Kaj želite | Za koga | Kje to naredite | Navodilo |
|---|---|---|---|
| prikazati datoteko na strani | avtorji | oznaka {{source>…}} | Obe obliki zapisa |
| prikazati le območje vrstic | avtorji | oznaka z navedbo vrstic | Obe obliki zapisa |
| povezati na posamezno vrstico | avtorji | sidro vrstice | Glava dokumenta |
| prikazati datoteko iz repozitorija Git | avtorji | – | wkdogit |
| prikazati datoteko iz Azure DevOps | avtorji | – | ADO-Git |
| prikazati datoteko Markdown kot dokument | avtorji | – | Markdown kot dokument |
| nastaviti omejitve velikosti in vrste | upravitelji | Splošne nastavitve | Nastavitve |
Namen
Prikaže izvorne datoteke v wikiju, ne da bi jih kopiral: barvanje skladnje, številke vrstic, sidra vrstic in trajne povezave, poleg tega stranski predal za ogled brez menjave strani. Od kod je datoteka, odloči ponudnik – sam vtičnik ne pozna ne gita ne ADO.
Registrirana storitev (glejte Core): source.providers.
Obe obliki zapisa
Enakovredni sta in dasta enak rezultat (glejte Core):
{{source>ado:wk:DokuWiki-Plugins:moj-repo:master:README.md}}
<wk:source ref="ado:wk:DokuWiki-Plugins:moj-repo:master:README.md"
title="README vtičnika"
subtitle="Vstopni dokument · stanje master"
badges="language"
actions="permalink,drawer" />
V obliki DokuWiki se dodatne navedbe pišejo za navpičnicami:
{{source>spec|mode=drawer|numbers=0}}.
| Navedba | Učinek |
|---|---|
mode | inline / block / preview / drawer |
numbers | številke vrstic vklopljene/izklopljene |
lang | vsili jezik za barvanje skladnje |
title | ime v glavi namesto imena, izpeljanega iz datoteke |
subtitle | dodatna vrstica za imenom; nadomesti polno navedbo |
badges | izbor značk: ref, language, status |
actions | izbor dejanj: view, permalink, raw, download, drawer, refresh |
badges in actions ločita tri stanja: navedba manjka = prikaže se vse,
badges=“” = ne prikaže se nič, seznam = natanko ti elementi. Vrstni red ne prihaja s strani –
zaporedje v glavi določa komponenta, da sta dve vdelavi z enakim izborom tudi videti enako.
Območje vrstic: sidro na koncu navedbe omeji prikazani izsek, npr.
…/App.php#L10-L20.
Ponudniki
| Predpona | Vir | Prihaja iz |
|---|---|---|
page: | stran wikija | ta vtičnik |
media: | predstavnostni arhiv | ta vtičnik |
git: | krajevni repozitorij | Git |
ado: | repozitorij Azure DevOps | wkdoadogit |
Vsak ponudnik pred branjem preveri seznam dostopa (ACL) DokuWiki. Pri datoteki brez pravice za branje se prikaže sporočilo ACL, ne vsebina – in tudi noben namig, da datoteka obstaja.
Glava dokumenta
Glave nad vsako vdelavo ne oblikuje ta vtičnik; to je skupna komponenta iz wkfluentui. Vtičnik opiše le, kaj je v njej; razporeditev, krajšanje, barvni odtenek in vrstica, pripeta na vrh, se določajo osrednje – da izvorna datoteka in brskalnik po repozitoriju na isti strani govorita isti jezik.
Brez oblikovnega sistema vtičnik izriše namenoma preprosto nadomestno glavo z enako vsebino.
Markdown kot dokument
Če je render_markdown vklopljen, se datoteke .md prikažejo oblikovano namesto z barvanjem
skladnje – z DokuWikijevim lastnim razčlenjevalnikom, ki podpira Markdown v slogu GitHuba. Glava tedaj
ponudi še prikaži kot izvorno kodo oziroma prikaži kot dokument.
Vklopite le tam, kjer so viri za ponudniki enako zaupanja vredni kot sam wiki. Območja vrstic in način predogleda tudi tedaj ostanejo izvorno besedilo.
Nastavitve
| Nastavitev | Privzeto | Pomen |
|---|---|---|
cache | 1 | predpomni vdelave z barvanjem skladnje (veljavnost poteče z virom) |
max_bytes | 262144 | zgornja meja 256 KB → stanje toolarge |
max_lines | 1000 | zgornja meja vrstic; daljše se skrajša in označi |
preview_lines | 12 | vrstice v načinu predogleda |
highlight | 1 | glavno stikalo za barvanje skladnje |
default_mode | block | način, kadar ga vdelava ne navede |
default_numbers | 1 | številke vrstic, kadar vdelava o tem ne pove ničesar |
render_markdown | 0 | glejte zgoraj |
Zgornje meje so hkrati zavora obremenitve: barvanje skladnje porabi procesorski čas sorazmerno z velikostjo datoteke.
local_roots ne obstaja. Starejše različice te strani so ključ navajale v zgornji tabeli, kot
pridržan za prihodnjega ponudnika local:. Glede zmožnosti je to držalo, glede ključa ne: ključ
ni nikjer deklariran in ga ne prebere nobena vrstica kode. Tabela pove natanko eno (kaj prikažejo
Splošne nastavitve), in tja ključ nikoli ni sodil. Ko pride ponudnik, pride z njim tudi ključ.
Meje
- Stranski predal se naloži prek
?call=wksourceview_view; končna točka na strežniku znova preveri varnostni žeton in ACL. - Na mesto v orodni vrstici lupine se premakne samo prva vdelava na strani. Vrstica na vrhu, ki bi tiho upravljala le enega od petih virov, bi bila slabša od nobene.
Podatki o paketu
Vtičnik: wksourceview
Imenski prostor: lib/plugins/wksourceview/
Avtor: Wolfgang van der Stille Wolfgang.van.der.Stille@gmail.com (The White Knight Labs)
Licenca: GPL 2.0-only