A dokumentumsablon meghatározza a jelentés szerkezetét,
elrendezését és tartalmát. A sablon sikeres létrehozása a sablon
megtervezését, fejlesztését, tesztelését és tárolását igényli.
1: Igények összegyűjtése
A különböző
igényekhez különböző tervek kellenek. A sablon(ok) tervezésének megkezdése
előtt állapítsa meg, hogy a dokumentumnak milyen üzleti igényeket és
gyakorlati követelményeket kell kielégítenie.
- Adatelemek
- Különféle sablonelemek vannak, amelyek különféle típusú információkat
jelenítenek meg. Milyen információkra van szüksége a dokumentumot
megjelenítő személy(ek)nek? Ha ezt tudja, akkor elkezdheti meghatározni az
adatelemeket:
- Mely sablonelemek jelenítik meg ezeket az adatokat? Hogyan fog ez
kinézni a végső dokumentumban?
- Van több módja az információk megjelenítésének? Ha igen, akkor melyik
illeszkedik leginkább a kontextushoz, amelyben a dokumentum megjelenítésre
kerül?
- Mennyi adat szükséges? Lehet, hogy ki tudja szűrni a szükségtelen
adatokat, amivel időt takaríthat meg a jelentéskimenet előállításakor.
- Kimeneti típus
- Gondolja át, hogy milyen típusú kimenet szolgálja leginkább azok
igényeit, akik majd megjelenítik a dokumentumot. A megtervezett sablon eltérően nézhet ki a
különféle kimeneti típusokhoz. Bizonyos elemek bizonyos formátumokhoz
vannak optimalizálva, illetve bizonyos elemek nem támogatottak bizonyos
formátumokban. Ismerje meg, hogy a sablonelemek hogyan jelennek meg a
különféle kimeneti formátumokban. Így kiválaszthatja azokat az elemeket és
azt a kimeneti típust, ami legjobban működik együtt.
- Egy sablon vagy több sablon
- Ez egy egyszeri használatra való sablon, vagy bizonyos részeit más
sablonokban is fel tud használni?
- Egy sablon: Egyetlen sablon, amely tartalmazza a dokumentumterv összes
különböző részét. Ez azt jelenti, hogy minden egy helyen van és nem
szükséges összevonás.
- Több sablon: Használhat moduláris megközelítést, több sablont
létrehozva, amelyek összevonásával áll elő a teljes dokumentum.
Például lehet egy tartalomjegyzék
sablon, egy előlap sablon, egy adatsablon, egy indexsablon és egy hátlap
sablon. Ezek a sablonok újrafelhasználhatók a különféle dokumentumok
előállításakor.
Az igények tükrében határozza meg, hogy hány sablonra lesz szükség.
A
metaadat-attribútumokban elnevezheti és leírhatja az egyes
sablonblokkokat.
A név tartalma látható lesz a sablonban, a leírás
tartalma pedig a sablonelem tipp mezőjében.
- Megjelenítési kontextus
- Hogyan fogja valaki megjeleníteni ezt a dokumentumot?
- Kinyomtatja? A képernyőn nézi meg? Mindkettő?
- Integrált termékben futtatja majd?
2: Sablon tervezése
Sablon
tervezésekor az alábbi taktikát követve használhatja hatékonyan az
idejét.
- Felülről lefelé építkező megközelítés használatával valósítsa meg a
sablon átfogó szerkezetét. Kezdje a legáltalánosabb elemekkel, majd
fokozatosan szűkítse a részletekre.
- Ellenőrizze az adatok előállítását, mielőtt a formázás részleteire
fókuszálna.
Ha nem kevés időt tölt a formázással, majd rájön, hogy az adatok
előállítása hibás, akkor újraformázásra lehet szükség. Részleteket a
3.
Sablon tesztelése című szakaszban talál.
- Ezután pontosítsa a részleteket és egyesével
építse be a specifikusabb igényeket.
A kevésbé fontos vagy nehezebben
kielégíthető igények megvalósítását hagyja későbbre.
Gondolja át a nehezen
kivitelezhető igények jelentőségét, ahogyan egy költség-előny elemzés
esetén tenné.
- Fontolja meg parancsfájlok használatát ahhoz, hogy a
Rational Publishing Engine
által hatékonyan felhasználható formátumban nyerje ki az információkat.
- Tervezhet sablont a specifikus oldalelrendezési tulajdonságok -
például az oldalméret, tájolás, margók, oszlopok száma, bekezdésstílusok -
biztosításához, amelyek a dokumentumokban legvalószínűbben felhasználásra
kerülnek.
- A sablon az alábbiakat tartalmazhatja:
- A dokumentum szerkezeti elemei, például bekezdések, táblázatok,
listák, tartalomjegyzékek.
- Dokumentumelrendezési blokkok, például mesteroldalak, stíluslapok,
fejlécek és láblécek.
- A felhasználó által meghatározott belső és külső stílusok, például
szöveg- vagy bekezdésformátumok. Szövegformátum például a félkövér, dőlt,
aláhúzás, betűméret és betűszín. Bekezdésformátum például a margó,
szegély, behúzás beállításai és a JavaScript formátumú
parancsfájl-paraméterek.
- Beágyazott sablontartalom, például képek, statikus szöveg, valamint
statikus fájlokra és stíluslapokra mutató hivatkozások.
- Adatelemek, például attribútumok, feltételek és dinamikus adatelemek.
- Adatkinyerés lekérdezések és szűrők formájában.
- Külső változók, amelyek a futás során kapnak értéket, valamint belső
változók, amelyek a számításokhoz használatosak. A külső
változók létrehozása előnyösebb, mint az adatforrás URL címek közvetlen
bírása a sablonba. Ha beírja az URL címeket és megváltozik a kiszolgáló
neve, akkor utána az összes sablonban frissítenie kell az URL címet. Külső
változók használata esetén a futás során felülbírálhatja az URL címeket. Más termékekbe beágyazott sablonok esetén az adott termékek által
felismert speciális változókat használni.
- Indítsa el a Document Studio alkalmazást.
- Hozzon
létre új sablont a nulláról vagy egy meglévő sablon alapján.
- Vegye
fel az adatforrássémát.
- Vegyen
fel elemeket.
- Vegyen
fel formázást az elemekhez.
- Határozzon
meg dinamikus tartalmat.
- Nem kötelező:
Finomítsa
az adatokat szűrőkkel, rendezésekkel vagy feltételekkel.
3. Sablon tesztelése
- A tesztelésre növekményesen kerül sor a fejlesztés során. Gyakran
végezzen mentést, egyedi nevek használatával. Rendszeresen ellenőrizze a
kimenetet a tesztadatok kis készletének használatával. Ne vegyen fel
további elemeket, amíg a meglévő rész nem működik.
- A dokumentum legnagyobb részének kifejlesztése után végezzen betöltési
tesztelést a teljesítményproblémák észlelése érdekében. Az Előkép
eszközben korlátozhatja a használt adatok méretét. Az előállított jelentés
továbbra is pontos, ám gyorsabban fut, mert a
Rational Publishing Engine
által egy-egy lekérdezésben beolvasott rekordok maximális száma
alapértelmezésben 10 rekord. A feltételek tesztelésekor lehetséges, hogy
az első 10 közül egyetlen rekord sem felel meg a feltételnek. Ilyen
esetben a Futtatás eszközt használja az Előkép eszköz helyett, vagy pedig
a Beállítások között módosítsa a lekérdezésenkénti rekordok maximális
számát.
- Tesztelje a sablont különböző kimeneti formátumokkal. Lehet, hogy
valamelyik kimeneti típus nem jeleníti meg olyan jól a sablont, mint egy
másik.
- Futtassa az ellenőrző eszközt.
- Állítson elő előképet.
4: Sablon tárolása
- Központi fájlkiszolgálóra mentse a kifejlesztett és tesztelt
sablonokat.
A Központi felügyelet összetevőt tárolóhelyként használhatja.
- Mindenképpen adjon meg bizonyos információkat a sablon metaadataiban,
hogy mások is tudják, hogy hogyan lehet újrafelhasználni a sablont. Ha
megad néhány minta adatot és minta dokumentummeghatározás információt a
projekt adatainál, azzal segíti a sablon hatékony újrafelhasználását.
Következő lépések
A sablon(ok)
létrehozása és tesztelése után: