Urejanje police Jezikoslovno označevanje korpusov

Ta stran podaja tehnične postopke in način dela z odprtokodno platformo BookStack, ki gosti CJVT Wiki. Predstavljeni so tudi vsebinski in oblikovni vidiki, ki jih je pri dodajanju nove vsebine treba upoštevati, da se ohranja celovitost in enotnost informacij.
Za lažje urejanje vsebine na spletišču smo pripravili ta kratek vodnik.

Dostop za urejanje strani

Okolje BookStack ne omogoča dodeljevanja pravic samo za posamezen objekt (polico, knjigo) ali posameznega uporabnika. Pravice so določene za skupino uporabnikov, in vsak, ki želi urejati stran, mora v skupini pridobiti ustrezno vlogo. V skupini sta določeni dve vlogi, na kateri je vezan postopek urejanja strani:
some text- Administrator: ima dostop do vsega.
some text- Urejevalec: vloga uporabnika z možnostjo urejanja strani, katerih lastnik je.
Vsak_a, ki želi urejati spletišče, si ustvari uporabniški račun na spletišču in enega od administratorjev prosi, da ga_jo doda v skupino in mu_ji dodeli vlogo urejevalca. Dodeljeno mu bo lastništvo objekta oz. nove police/knjige, ki ga želi urejati.
Pomni! Objekt ima lahko v lasti le en uporabnik naenkrat.
Ko uporabnik konča z urejanjem, se znova oglasi administratorju, da ta znova prevzame lastništvo objekta.

Organizacija police

Osnovna enota spletišča je polica "Shelf", ki jo poimenujemo. Ko je polica ustvarjena, lahko nanjo dodajamo knjige (Books). Knjiga ima lahko strani (Page) in/ali poglavja (Chapters), v katera lahko organiziramo vsebino, ki jo želimo predstaviti. V primeru police Jezikoslvno označevanje korpusov, ki predstavlja označevanje slovenskih korpusov, vsaka knjiga predstavlja en označevalni nivo (npr. Lematizacija, Oblikoskladnja ...). Vsaka knjiga se začne z uvodnim odstavkom, ki oriše označevalno raven. Knjiga ima 3 strani (Pages): Predstavitev oznak, Označevalne smernice in Reference in povezave. Vsaka stran ima uniformno uvodno poved, ki nakazuje na njeno vsebino, npr. V tem poglavju so navedene in strnjeno predstavljene oznake sistema JOS-SYN. Podrobnejšo predstavitev najdete v smernicah v poglavju Označevalne smernice.

Stran Predstavitev oznak vsebuje tabelo z oznakami. Upoštevamo potrebne prilagoditve, recimo če označevalni sistem nima oznak, ker gre za proces, te strani ni ali pa jo nadomesti stran Predstavitev [procesa] z natančenjšim opisom (npr. segmentacija, normalizacija).

Za oblikovanje besedila na platformi se uporablja format markdown. Markdown predvideva preproste znake, s katerimi dosežemo željeni oblikovni učinek, recimo ** na obeh straneh besede/besedila za odebeljen tisk, * za poševni tisk, različno število zaporednih # za različne hierarhije naslovov itd. Besedilo lahko oblikujete tudi v običajnem urejevalniku besedil (npr. MS Word) in ga s pomočjo kakšnega orodja, recimo te spletne aplikacije, pretvorite v format markdown (besedilo iz urejevalnika preprosto kopirate v okno aplikacije in zgenerira se vaše besedilo v markdownu; to kopirate in prilepite v urejevalnik na spletišču ter ročno pregledate). Pretvorba besedilne datoteke XDOC je možna tudi s tem ukazom v vmesniku z ukazno vrstico (CLI):

pandoc -s VHODNA_DATOTEKA.docx  --wrap=none --reference-links -t markdown -o IZHODNA_DATOTEKA.md

Stran Označevalne smernice našteva označevalne smernice sistema, zvrščene od najnovejše različice do najstarejše. Dokument citiramo in priložimo datoteke kot prilogo, na primer:

Različica 2.0 (02-2023)
projekt Razvoj slovenščine v digitalnem okolju
ARHAR HOLDT, Špela, TERČON, Luka, KREK, Simon, LEDINEK, Nina, MOŽE, Sara, SAKSIDA, Amanda, HOLZ, Nanika, 2023: Navodila za skladenjsko označevanje slovenščine po sistemu JOS-SYN. Različica 2.0. Rezultat projekta Razvoj slovenščine v digitalnem okolju. [DOCX] [PDF]

Nalaganje datotek: Datoteke najprej naložimo s svojega računalnika na strežnik. To storimo tako, da na navpičnem traku skrajno desno kliknemo na sponko (Attachments). Potem kliknemo na Upload file, izberemo datoteko s svojega računalnika in jo naložimo; ali pa primemo datoteko na svojem računalniku in jo odložimo kamorkoli v vzdolžnem delu menija. Naložena datoteka se pokaže na seznamu že naloženih datotek. Ko želimo pripeti povezavo do datoteke v besedilu, se s kurzorjem postavimo na mesto, kjer želimo povezavo. Izberemo pravo datoteko na seznamu in kliknemo na ikono verige desno ob njej. Ob ikoni verige sta še ikona svinčnika, ki odpre meni za urejanje (besedila) datoteke in ikona križca, ki omogoča brisanje datoteke.
Prikaz datoteke smernic, ki je trenutno v rabi, je tak: prilogo dodamo na željeno mesto v besedilu - pojavita se dva para oklepajev: v oglatih okepajih je najprej izvorno ime datoteke, ki bo prikazano in ki ga lahko poljubno spremenimo (kar v besedilu ali v desnem vzdolžnem meniju s klikom na ikono svinčnika ob datoteki na seznamu), v okroglih oklepajih pa je povezava do naložene datoteke - tega ne spreminjamo.
Po podobnem postopku lahko dodajamo tudi spletne strani. Polinkamo recimo projekte, v okviru katerih so smernice nastale.

Če želimo dodati novo različico smernic, na strani Označevalne smernice na vrhu seznama samo citiramo nove smernice, na stranskem desnem meniju naložimo datoteko novih smernic in jo dodamo v besedilo (gl. Nalaganje datoteke zgoraj). Poskrbite tudi za dodajanje nove vsebine na angleški polici (gl. Dodajanje angleške različice spodaj.)

Stran Reference in povezave vsebuje čim več relevantnih virov, povezanih z obravnavanim označevalnim nivojem. Priporočene sekcije na tej strani so:
Projekti, na katerih se je označevalni sistem razvijal oz. uporabljal (navedeno ime projekta in spletna povezava do njega);
(Učni) korpus(i) z ročno pregledanimi oznakami [sistema] (navedena referenca in povezava do vseh relevantnih korpusov);
Reference (navedena referenca in povezava do vseh relevantnih korpusov);
Orodje [ime orodja] za označevanje ..., če je relevantno za označevalni sistem (navedena referenca in povezava do orodja)

Svetujemo, da si ogledate primer oblikovanja te strani, recimo Reference in povezave v knjigi Skladnja JOS-SYN.

Priporoča se, da so datoteke referenc naložene na strežnik (in polinkane v besedilu) in da se navede tudi spletno povezavo do reference (če je objavljena). Enako velja za smernice, orodja ...

Dodajanje angleške različice

Polica Jezikoslovno označevanje korpusov ima tudi angleško vzporedno verzijo - polico Linguistic Annotation of Slovene Corpora.
Toplo se priporoča, da se novo vsebino, dodano na slovensko polico, prevede v angleščino in doda tudi na angleško polico - tako bodo informacije, ki so na voljo v slovenščini, na voljo tudi mednarodni javnosti. Naložite datoteke smernic, četudi so v slovenščini (dodajte opombo '- only in Slovene', kot npr. tukaj); če obstajajo smernice v angleščini, pa naložite samo te.
Dostop do urejanja na angleški polici pridobite pri administratorju.

Konec urejanja strani

Ko uporabnik zaključi urejanje strani, se oglasi administratorju, ki uporabniku odvzame vlogo urejevalca in s tem možnost urejanja. Administrator tako znova prevzame lastništvo objekta, . Ko je pisanje smernic končano oz. je na podlagi njih pripravljen tudi korpus, se vsem (razen administratorju) odstrani dostop do urejanje strani s smernicami.

Urejene strani lahko tudi izvozite v formatu PDF (priporočeno), TXT ali HTML (Export v vzdolžnem meniju desno).

Koristni nasveti

Ne dodajajte le povezav/slik/gradiv/... iz zunanjih virov. Ohranjati želimo dostopnost smernic in ostalih datotek neodvisno od zunanjih vplivov, tako da jih odlagamo lokalno na strežnik (gl. Nalaganje datotek zgoraj).
Med pisanjem vsebine na spletišču redno shranjujte vmesne rezultate. Izguba povezave z internetom ali osvežitev strani bo pomenila izgubo vseh neshranjenih podatkov.
Na wiki-ju je več različnih projektov. Pravice in vloge pa so generalne za celotno spletišče. To pomeni, da je treba paziti, da ne prihaja do problemov, kot je na primer, da nekdo iz drugega "projekta" spreminja ali izbriše vsebino.