Tudásbázis

Áttekintés

Tartalom áttekintése

A Tudástáron belüli információtárolás működése egy átlagos könyvkupachoz hasonló. A normál könyvekhez hasonlóan a Tudástár könyvek is tartalmazhatnak fejezeteket és oldalakat. Kezdje azzal, hogy létrehoz egy könyvet, amely a kategorizálás legmagasabb szintjeként működik. Ideális esetben külön könyvek kellenek külön témákhoz.

Egy könyvön belül közvetlenül létrehozhat oldalakat, vagy először létrehozhat fejezeteket is. A fejezetek további oldalcsoportosítási szintet biztosítanak az oldalak rendszerezéséhez, de nem kötelezőek. Az összes írt információ oldalakon belül található. Bár a könyvek és fejezetek nem tartalmaznak információkat, rövid leírást kaphatnak a keresés és a láthatóság elősegítése érdekében.

Miután elkezdte a könyvek halmozását, elkezdheti a Könyvespolcok használatát a Könyvek rendszerezésére. A könyvespolcok több könyvet is tartalmazhatnak, és egyetlen könyv több könyvespolcra is elhelyezhető.

 

Alapértelmezett színkódolás

A könyvespolcok, könyvek, fejezetek és oldalak színkódolást kaptak a Tudástárban, hogy könnyen azonosíthatók legyenek. Az alábbi példák az alapértelmezett színsémát mutatják be. (Vegye figyelembe, hogy ezt a rendszergazda felülírhatja.)

 Könyvek Fejezetek Oldalak Piszkozatok  Könyvespolcok

 

Kezdetek

Amikor elkezdi használni a Tudástár-modult, kétféleképpen rendezheti a dolgokat; Megtervezheti könyvének/fejezetének/oldalának szerkezetét, vagy hagyhatja, hogy a dolgok idővel természetesen fejlődjenek. Ha ismeri a tartalom felépítését, amely a Tudástárba kerül, akkor valószínűleg a legjobb, ha a kezdetekkor megtervezi, ellenkező esetben, ha a nulláról kezdi, akkor hagyja, hogy minden megtalálja a maga helyét.

Ha úgy dönt, hogy természetes módon növekszik, akkor valószínűleg minden főbb kategóriához egy könyvet fog kezdeni, és közvetlenül ezekhez a könyvekhez ad hozzá oldalakat. Amint elkezd sok oldalt kapni minden könyvben, elkezdi használni a fejezeteket az oldalak csoportosítására. Ha egy fejezet túl nagy lesz, jobb lehet, ha saját könyvbe kerül. A Tudástárban könnyedén mozgathatja a fejezeteket és oldalakat a könyvek és fejezetek között, így nem kell aggódnia amiatt, hogy a jövőben át kell helyeznie a dolgokat.

Tartalom rendezése

Amint a Tudástárban szereplő tartalom növekedésnek indul, rá fog jönni, hogy érdemes újrarendezni a tartalmat. A Tudástárban két lehetőség van a tartalom mozgatására; Egyenként mozgathatja az oldalakat és fejezeteket, vagy rendezheti a teljes könyveket.

Vegye figyelembe, hogy a tartalom áthelyezéséhez „szerkesztési” jogosultsággal kell rendelkeznie mind az áthelyezett tartalomhoz, mind a szülőhöz, amelybe áthelyezik.

 

Egyes oldalak és fejezetek mozgatása

Az oldalak és fejezetek közvetlenül áthelyezhetők új fejezetbe vagy könyvbe. Fejezet vagy oldal ilyen módon történő áthelyezéséhez lépjen egy oldalra vagy fejezetre, és válassza az „Áthelyezés” lehetőséget a műveletlistában:

Oldalmozgatás művelet
Az „Áthelyezés” műveletre kattintva egy képernyőre jut, ahol kiválaszthatja a fejezet vagy az oldal új helyét. Itt kereshet egy adott könyvet vagy fejezetet a kiválasztó képernyő tetején található keresősáv segítségével. Ha új szülőt választott a fejezetéhez vagy oldalához, nyomja meg az „Oldal áthelyezése” vagy a „Fejezet áthelyezése” gombot, és a fejezet vagy az oldal átkerül az új fejezetbe vagy könyvbe. Ha áthelyez egy fejezetet, az összes alárendelt oldal abban a fejezetben marad, és minden kapcsolódó tevékenység megjelenik az új szülőkönyv alatt.

 

Könyvek válogatása

A „Könyvrendezés” felület lehetővé teszi több oldal és fejezet könnyű mozgatását egy egyszerű fogd és vidd felületen. Egy könyv tartalmának rendezéséhez nyissa meg a Könyvet, és keresse meg a „Rendezés” lehetőséget a műveletek listájában.

Kezdetben csak a könyv jelenik meg a bal oldalon. A jobb oldali kijelölésükkel további könyveket is hozzáadhat a rendezési felülethez. Itt egyszerűen áthúzhatja a fejezeteket és oldalakat a különböző könyvek között és között is. Miután rendezte a tartalmat, nyomja meg a „Mentés” gombot, és az összes mellékelt könyvet újraszervezi.

 

Könyvek és polcok

Egy könyvespolc több könyvet is tartalmazhat, egy könyv pedig több polcon is. Meglévő könyv polchoz való hozzáadásához nyissa meg azt a polcot, amelyre át szeretné helyezni a könyvet, majd nyomja meg a „Szerkesztés” gombot. A „Könyvek hozzáadása ehhez a polchoz” részben keresse meg és válassza ki azt a könyvet, amelyet át szeretne helyezni az éppen szerkesztett polcra, majd válassza a „Polc mentése” lehetőséget. Ugyanezen a felületen belül húzhat könyveket a két lista között, vagy a bal oldali listában, hogy beállítsa a könyvek alapértelmezett sorrendjét az adott polcon.

Ne feledje, hogy egy könyv több polcon is elhelyezhető, így ha egy könyvet egy új polcra ad hozzá, az nem törli azt a többi polcról. Ha el szeretne távolítani egy könyvet a polcról, a fenti módon kell bemennie mindegyik polcba, de mentés előtt válassza ki vagy húzza ki őket a „Könyvek ezen a polcon” listából.

Keresés

Tartalom keresése

A dokumentációban való keresés lehetősége elengedhetetlen a mindennapi használathoz. A Tudástárban több felület is van, ahol tartalmakat kereshet. 

Fejléc keresősáv – A minden oldal fejlécében található keresősáv/link lehetővé teszi, hogy bárhonnan keressen. Ez a keresés egy globális keresés, amely a rendszer összes könyvére, fejezetére és oldalára keres. Miután végrehajtott keresést ebben a mezőben, egy olyan keresőoldalra kerül, amely olyan lehetőségeket és funkciókat tartalmaz, amelyek segíthetnek egy fejlettebb keresés felépítésében.
Könyv/fejezet keresősáv – Könyv vagy fejezet megtekintésekor a bal oldalsáv tetején található egy keresősáv. Ezek a keresések az összes alárendelt elemre kiterjednek.
Áthelyezés és hivatkozás kijelölése – Ha egy oldal/fejezet áthelyezését választja, vagy amikor kiválaszt egy oldalt/fejezetet/könyvet, amelyre hivatkozni kíván a szerkesztőben, megjelennek a legnépszerűbb elemek, de lehetősége van keresni is.

 

Speciális keresés

A Tudástár összes fenti keresési helyén működik egy speciális keresési szintaxis. Ennek a szintaxisnak egy egyszerű alkalmazása az, ha egy globális keresést indítunk, majd keresési szűrőket használunk, amelyek frissítik a keresett kifejezést az alábbi szintaxissal. Az alábbiakban ismertetjük a használható szintaxis különböző típusainak részleteit:

Keresés típus szintaxis példa leírás
Normál keresés <KIFEJEZÉS1> <KIFEJEZÉS2> londoni megbeszélés Normál szókeresés a tartalom nevében és leírásában vagy törzsében. Ha több kifejezést keres, csak egy kifejezésnek kell egyeznie a tartalommal, de a mindkét kifejezést tartalmazó tartalom magasabban jelenik meg a találatok között.
Pontos egyezés keresés "<KIFEJEZÉS1>" "londoni megbeszélés" A pontos egyezések megkövetelik, hogy az idézőjelekben lévő teljes karakterlánc pontosan ugyanabban a formátumban szerepeljen a tartalomban. Használja ezt, ha pontos kifejezést keres, vagy ha szóközt tartalmazó kifejezést szeretne keresni.
Tag keresés [<név>]
[<operator><érték>]
[<név><operator><érték>]		 [helyszín]
[=london]
[helyszín=london]
[létszám>5]		 A címkekeresés lehetővé teszi, hogy olyan oldalakat keressen, amelyeken meghatározott címkék vannak alkalmazva. Kereshet címkenév, címkeérték vagy név és érték alapján egyaránt. Ha címkeérték alapján keresünk, operátort kell használni az egyezés típusának meghatározásához. Operátorként használhatja az =, !=, <, >,<=, >= vagy hasonlókat. Ha a like operátort használja, használhat % szimbólumokat a helyettesítő karakterek megjelenítésére a keresésben.
Szűrő keresés {<szűró_név>}
{<szűró_név>:<szűró_érték>}		 Lásd lejjebb A szűrők további speciális funkciókat hajtanak végre a keresések még hatékonyabbá tétele érdekében. Egyes szűrők értékeket vesznek fel, de vannak, amelyekre nincs szükség. Az elérhető szűrők teljes listáját lásd alább.

 

Elérhető szűrők

A szűrők olyan speciális keresési funkciók, amelyek a keresési kifejezésben használhatók. Az alábbi táblázat az elérhető összes szűrőt és azok használatát mutatja be.

Dátumszűrők
{updated_after:<dátum>} {updated_after:2016-12-30} Hozzáadja azt a feltételt, hogy a tartalomnak a megadott dátum után kellett utoljára frissülnie. A dátumnak ÉÉÉÉ-HH-NN formátumban kell lennie
{updated_before:<date>} {updated_before:2016-12-30} Hozzáadja azt a feltételt, hogy a tartalomnak a megadott dátum előtt utoljára frissülnie kell. A dátumnak ÉÉÉÉ-HH-NN formátumban kell lennie
{created_after:<dátum>} {created_after:2016-12-30} Hozzáadja azt a feltételt, hogy a tartalomnak a megadott dátum után kell létrejönnie. A dátumnak ÉÉÉÉ-HH-NN formátumban kell lennie
{created_before:<dátum>} {created_before:2016-12-30} Hozzáadja azt a feltételt, hogy a tartalomnak a megadott dátum előtt létre kell hoznia. A dátumnak ÉÉÉÉ-HH-NN formátumban kell lennie

Felhasználói szűrők
{updated_by:<user_slug|me>} {updated_by:barry} {updated_by:me} Hozzáadja azt a feltételt, hogy a tartalmat az adott slug felhasználója frissítette utoljára. Ha az „én” szót használjuk a slug helyett, akkor megkeresi az aktuális bejelentkezett felhasználó által utoljára frissített tartalmat.
{created_by:<user_slug|me>} {created_by:barry} {létrehozta:én} Hozzáadja azt a feltételt, hogy a tartalmat az adott slug felhasználójának kell létrehoznia. Ha az „én” szót használjuk a slug helyett, akkor az aktuális bejelentkezett felhasználó által létrehozott tartalmat fogja megtalálni.
{tulajdonos:<felhasználói_slug|én>} {tulajdonos:barry} {tulajdonos:én} Hozzáadja azt a feltételt, hogy a tartalomnak aktívan az adott slug felhasználójának kell lennie. Ha az „én” szót használjuk a slug helyett, akkor az aktuális bejelentkezett felhasználó tulajdonában lévő tartalmat fogja találni.

Tartalomszűrők
{in_name:<keresés>} {in_name:London Meetings} {in_name:Meetings} Megköveteli, hogy a tartalom nevében a megadott <kereső> kifejezés szerepeljen a név vagy a tartalomtörzs helyett.
{in_body:<keresés>} {in_body:London Meetings} {in_body:Meetings} Megköveteli, hogy a tartalom törzsében a megadott <kereső> kifejezés szerepeljen a név vagy a tartalom törzse helyett.

Opció szűrők
{is_restricted} {is_restricted} A tartalomnak aktív tartalomszintű engedélyekkel kell rendelkeznie. Nem ad vissza olyan elemeket, amelyek csak örökölt eszközjogosultságokkal rendelkeznek.
{viewed_by_me} {viewed_by_me} A jelenlegi felhasználónak legalább egyszer meg kell néznie a tartalmat.
{not_viewed_by_me} {not_viewed_by_me} Nem ad vissza semmilyen tartalmat, amelyet az aktuális felhasználó megtekintett.
{típus:<tartalomtípusok>} {típus:oldal|fejezet|könyv} {type:oldal|fejezet} {type:book} Korlátozza a keresési eredményekben megjelenő tartalom típusait. Ennek használata a keresés típusától függ. Például egy fejezetkeresésben csak az oldalak jelennek meg, így ennek nincs hatása.


Példák keresésre

Az alábbiakban néhány példa található a fenti szintaxis és szűrők használatára leírásokkal együtt:

"macskám" {megtekintve_én} {updated_after:2017-01-24}
„macskám” – olyan tartalom keresése, amely pontosan tartalmazza a „macskám” kifejezést
{viewed_by_me} – ezt én tekintettem meg
{updated_after:2017-01-24} – és utoljára 2017. január 24-e után frissült.

tankönyvbeszélgetés [találkozó] {type:page} {created_by:me}

tankönyvi vita – Keressen a tartalomban a tankönyv vagy vita szavakra
[találkozó] – csak olyan tartalmat jelenítsen meg, amelyhez találkozócímkét alkalmaztak
{type:page} – csak oldalak megjelenítése, fejezetek és könyvek elrejtése
{created_by:me} – én hoztam létre.

{type:book|fejezet} {created_by:me} {created_after:2016-08-12} {created_fore:2017-02-18}

{type:book|chapter} – Keresés az összes könyvben és fejezetben
{created_by:me} – amelyeket én hoztam létre
{created_after:2016-08-12} - 2016. augusztus 12. után
{created_before:2017-02-18} – de 2017. február 18. előtt

Rajzok és diagramok

A Tudástár képes rajzok létrehozására és szerkesztésére a diagrams.net-tel való integráció révén. Ez az integráció nagyon hatékony rajz/diagram szerkesztési lehetőségeket biztosít számos felhasználási esethez. A rendszer alapértelmezés szerint a diagrams.net online verzióját használja, de ezt a rendszergazda konfigurálhatja.

Rajzok beszúrása, szerkesztése és kezelése

WYSIWYG szerkesztő
A WYSIWYG szerkesztő használatakor rajzok hozhatók létre és illeszthetők be az oldalra a szerkesztő eszköztárának gombjával. A gomb egy túlcsordulási menüben található, amely ugyanabban a részben található, mint a táblázatok és hivatkozások:

Meglévő rajz megnyitásához szerkesztésre egyszerűen kattintson duplán a rajzra a szerkesztőben. Alternatív megoldásként megnyomhatja az eszköztár rajz gombját, miközben a rajz ki van jelölve. Meglévő rajz szerkesztésekor és mentésekor a BookStack külön képfájlként menti az új verziót a meglévő rajzok felülírása helyett. Ez lehetővé teszi a megfelelő revíziós előzményeket a régi rajzok érintetlensége mellett.

A meglévő rajzfájlok újra felhasználhatók vagy törölhetők a rajzkezelőn keresztül. Ez a szerkesztő rajz eszköztár gombja mellett található legördülő menüből érhető el:

Markdown szerkesztő
A markdown szerkesztőben a tartalom felett található műveletre kattintva rajzot szúrhat be.

Meglévő rajz szerkesztésre való megnyitásához kattintson duplán a képre az előnézeti ablakban, és a meglévő rajzot meg kell nyitni szerkesztésre. Meglévő rajz szerkesztésekor és mentésekor külön képfájlként menti az új verziót a meglévő rajzok felülírása helyett. Ez lehetővé teszi a megfelelő revíziós előzményeket a régi rajzok érintetlensége mellett.

 

Rajz képfájl tárolása és formátuma

A diagrams.net integrációval létrehozott rajzfájlokat a rendszer a saját adatbázisába menti, ugyanazt a tárolási mechanizmust használja, mint ami a normál képekhez került konfigurálásra.

A hordozhatóság és kompatibilitás érdekében a rajzokat PNG fájlformátumban menti a rendszer, az eredeti diagrams.net rajzadatokkal együtt. Mivel a rajzadatok be vannak ágyazva a PNG képfájlba, folytathatja az ilyen rajzok szerkesztését bármely diagrams.net példányban a képfájl behúzásával vagy importálásával.

Szerepkörök és jogosultságok

A Tudástáron belül a felhasználók lehetőségeit a hozzájuk rendelt szerepkörök és a szerepkörökhöz biztosított jogosultságok szabályozzák. Egy felhasználóhoz több szerep is hozzárendelhető, ebben az esetben az engedélyek halmozódnak, és a felhasználó bármilyen képességet megkap, ha valamelyik szerepkör rendelkezik ezzel a képességgel.

 

Irányító szerepek

A szerepköröket az adminisztrátor felhasználó hozhatja létre és szerkesztheti, ha a Tudástár felületén a „Beállítások > Szerepkörök” menüpontra lép. Egy új példányban alapértelmezett szerepkörök állnak rendelkezésre a gyakori használati esetekhez. Egy szerep megváltoztatásakor módosíthatja a jogosultságokat, amelyek bizonyos rendszerszintű képességeket biztosítanak. Ezenkívül látni fog egy sor „Eszközengedélyt”, amelyek az adott szerepkör tagjai számára biztosított alapértelmezett képességek a rendszeren belüli tartalomhoz. Ezeket a tartalomszintű engedélyek felülbírálhatják. Számos eszközengedély rendelkezik „Saját” opcióval. Ez csak akkor biztosítja a szerepkör tagjainak a képességet, ha egy elem tulajdonosa a rendszerben.

 

Szerepek kiosztása

Szerepkörök rendelhetők a felhasználókhoz, egy adminisztrátorhoz, aki a felhasználói profilt szerkeszti a felület „Beállítások > Felhasználók” területén. Itt több szerepkör is hozzárendelhető egy felhasználóhoz, ebben az esetben az engedélyek halmozódnak, és a felhasználó bármilyen képességet megkap, ha valamelyik szerepkör rendelkezik ezzel a képességgel.

Ne feledje, hogy a Tudástár bizonyos mechanizmusai képesek megváltoztatni a felhasználó szerepkörét. Ezek tartalmazzák:

 

Tartalomszintű engedélyek

Az engedélyek szükség szerint felülbírálhatók polc, könyv, fejezet vagy oldal szinten. Ezt megteheti az „Engedélyek” művelettel, amikor ilyen tartalmat tekint meg, bármely olyan felhasználó által, aki rendelkezik „Összes/saját engedélyek kezelése” szerepköri engedéllyel.

Az engedélyek nézetében a „Szerepkör engedélyeinek felülbírálása” legördülő menü segítségével kiválaszthatja a szerepkört, amelyhez engedélyeket kíván beállítani. Mentéskor ezek az egyéni engedélyek felülírják a szerepkörök által a konfigurált tartalomelemhez biztosított alapértelmezett engedélyeket.

A „Mindenki más” opció elérhető, amely lehetővé teszi az engedélyek felülbírálását/vezérlését minden olyan szerepkör számára, amely nincs kifejezetten felülírva. Alapértelmezés szerint az „Alapértelmezett értékek öröklése” lesz kiválasztva ennél az elemnél, ami azt jelenti, hogy a rendszer normál szerepkör-engedélyeket használ, kivéve, ha felülbírálják. A jelölőnégyzet kijelölésének törlése helyett az ugyanabban a sorban konfigurált engedélyeket fogja használni.

A BookStack tartalomszintű engedélyei a következőképpen viselkednek:

Ha az egyéni tartalomszintű engedélyek aktívak, és az aktuálisan megtekintett elemet érintik, egy jelző jelenik meg a részletek oldalsávjában. Ha jogosultsága van az aktív tartalomszintű engedélyek szerkesztésére, akkor ez egy hivatkozásként működik, amely a megfelelő engedélyek nézetéhez vezet, még akkor is, ha egy szülő fejezetre vagy könyvre vonatkozik.