Falhsználói dokumentáció
utoljára frissítve: 2007-08-06, fgcms verzió 0.4.4
Bevezetés
Az fgcms 0.4.x a php alapú szakkör-honlap-motor java servlet/jsp alapú újraírása. Az alapvető koncepció hasonló, de néhány dolog változott:
- a dokumentumok nyelve felokosított xhtml, néhány kiterjesztéssel
- az írási és olvasási jogok minden dokumentumra egyedi módon beállíthatóak
- a könyvtárhiererchia szerepét is a dokumentumok vették át, vagyis a dokumentumok megkapták a könyvtárak képességeit
Dokumentum-hierarchia
Felhasználói megközelítésben az történt, hogy egyes könyvtárakhoz főoldal készült, ami olyan mint egy dokumentum, csak elfedi a könyvtárlistát. Ezeknél a könyvtáraknál a Lista fülre kattintva tekinthető meg a tartalom. Pl.: 2006/2007
Mindez a valóságban azt jelenti, hogy a könyvtárak üres dokumentumokká lettek konvertálva. Az üres dokumentumok hasonlóan jelennek meg, mint régebben a könyvtárak, tehát egy listaként. Ebben az új rendszerben a címkék tehát maguk is dokumentumok. Ez azért is hasznos, mert leírható közvetlenül bennük, hogy mit is jelentenek.
- Dokumentum
- html alapú szöveget tartalmaz, a portálhierarchia alapeleme
- Szülő
- Minden dokumentumnak pontosan egy szülődokumentuma van
- Aldokumentum
- A szülő reláció ellentéte
- Címke
- X dokumentumra egy másik Y dokumentumot rá lehet akasztani címkeként, így Y neve megjelenik X fejlécében, X pedig megjelenik Y listázásában
- Egy dokumentum listázása
- A lista fülre megjelenő lista, az aldokumentumok és a dokumentum által megcímkézett dokumentumok összessége
Összefoglalva, az adattárolás formája most egy dokumentumierarchia, ami egy címkézésekkel kiegészített fa struktúra. A dokumentumok alapból fa-struktúrában szerveződnek, mint a fájlrendszer könyvtárai, a címkék pedig hasonlóan viselkednek, mint szimbolikus linkek: a címkéző dokumentum aldokumentum-listájában megjelenik a címkézett dokumentum, és úgy viselkedik, mintha a könyvtárhierarchiában is ott lenne.
Dokumentumok elhelyezése
Szerkesztés -> Elhelyezés -> Itt a könyvtárstruktúrában keresd ki az új könyvtár helyét és kattints a sárga ikonra. Ekkor megjelenik az új hely a táblázatban. A táblázatban a kiválasztott hely melletti Legyen ez szülő linkre kattintva a dokumentum az adott hely aldokumentumává válik.
Speciális dokumentumok (csatolt fájlok)
A dokumentumok speciális alosztályát képezik a csatolt fájlok. Ezek hasonlóan címkézhetők a dokumentumokhoz, viszont
- nem válhatnak címkévé más dokumentumon és nem lehetnek aldokumentumaik
- tartalmuk tetszőleges lehet
- szöveges fájlok
- A rendszer UNIX típusúra konvertálja a sorvégeket, és UTF-8-ra a karakterkódolást és így tárolja őket az adatbázisban. Letöltéskor meg lehet választani a formájukat.
- forráskódok
- a szöveges fájlokról elmondottak itt is érvényesek, de ha a fájlkiterjesztés alapján a fájl forráskódot tartalmaz, akkor megtekintéskor szintaksziskiemeléssel látható a fájl
- ZIP fájlok
- A bennük lévő szöveges fájlok feltöltéskor szintén UTF-8/UNIX-ra konvertálódnak, a bináris fájlok változatlanul maradnak. Letöltéskor szintén lehet választani formátumot, de csak a zipfájl összes szöveges fájljára közösen.
Leírónyelv
A leírónyelv XHTML alapú, bizonyos kibővítésekkel. Fontos, hogy a dokumentumoknak
mindig szabályos XML dokumentumoknak kell lenniük, tehát a < > &
karaktereket helyettesíteni kell, így: < > &
Megkötések, korlátozások
- Mivel ez XHTML, ne felejtsük el lezárni az üres tag-eket, pl. <img src="blabla.png" />
- A portál egységek kinézete érdekében css-ben csak a legegyszerűbb dolgok megvalósítását javaslom, bármit ami újrahasznosíthatónak tűnik azt tag szinten vagy osztályok szintjén kell csinálni. Ezt egyelőre sajnos nem tehetik meg a felhasználók, de bármit szivesen és gyorsan beépítek. :)
A hivatkozásokat tartalmazó html tagek közül csak a <a>,
<img>, <applet> használhatóak, illetve kompatibilitási okokból megtartottam a <code src="..."> alakot, de ez az <a>-val azonos. Ezen szintén lehet bővíteni, de belső linkekre csak ezek működnek.
Linkek
Az előbb felsorolt 3+1 tag esetén a hivatkozások háromfélék lehetnek: külső, belső abszolút és belső relatív. Belső címzéseknél a régebbi verziókkal szemben itt már nem kell : (kettőspont) karaktert az elérési út részeinek az elválasztására használni, hanem a / (perjel) használandó mindig.
- külső
- egy szabályos protokollal ellátott web-url-t kell megadni, pl.: http://www.example.com
- belső abszolút
- Egy a portálban létező dokumentum egy abszoltút elérési útját kell megadni. Az útban szerepelhetnek címkék is, de egyértelműnek kell lennie, mert ha nem akkor a rendszer nem tudja feloldani a linket, például jó: <a href="article:/szakkor/bdg/0405/06ora">6. óra</a>: 6. óra, de nem jó <a href="article:/tipus/ora/06ora">6. óra</a>: 6. óra, ez utóbbi módon viszont egy link a 27. órára működne, mert abból csak egy szerepel a tipus/ora listázásban.
- belső relatív
-
A relatív címzés kiindulása mindig a szülődokumentum, a címkeként szereplő más dokumentumokon nem indul el a kersés.
Példa: <a href="../fgcms">P.L.</a>: P.L.
Csak az <a> tagre vonatkozó újdonság, hogy a belső linkek címe elhagyható, így: <a href="article:/szakkor/bdg/0405/06ora" />: 6. óra
További speciális tag-ek
- <p>
- Jelentése a HTML-ből megszokotthoz hasonló, tehát egy paragrafust jelöl, de a HTML-el szemben itt a paragrafus tartalmazhat blokk-szintű elemeket, azaz például listákat, forráskód dobozokat, stb. A HTML-ben megjelenő kód: <div class="paragraph">...</div>, természetesen ne ezt használjuk!
- <c>
- Szövegbe ágyazott forráskód, fix szélességű betűkkel, hasonlóan mint régebben az [IC] volt. Természetesen ezen belül is helyettesíteni kell a HTML karaktereket.
- <code type="ext">
- Egy forráskódot tartalmazó doboz, ahol ext a fájltípusra utaló kiterjesztés, ami szerint a szintakszis ki lesz emelve. Adjunk meg txt-t ha nem akarunk kiemelést.
- <math>
- Egy LaTeX matematika formulát tartalmaz, sajnos több megkötés is van: egyelőre a html karaktereket sem helyettesítéssel, sem a anélkül nem fogadja el. A LaTeXMathML weboldalán olvashatók további részletek. Az eltérés annyi, hogy itt nem $-jeleket kell használni, hanem ezt a tag-et.