Šablona dokumentu definuje strukturu, rozvržení a obsah sestavy. Vytvoření úspěšné šablony vyžaduje plánování, vývoj, testování a uložení šablony.
1: Shromážděte požadavky
Různé potřeby vyžadují různé návrhy. Před tím, než začnete svou šablonu či šablony navrhovat, určete obchodní potřeby a praktické požadavky na dokument.
- Datové prvky
- Existuje celá řada prvků šablony, které zobrazují různé typy informací. Jaké informace požaduje osoba, která si dokument zobrazí? Až to budete vědět, můžete začít určovat datové prvky:
- Které prvky šablony zobrazí tato data? Jak budou vypadat v konečném dokumentu?
- Existuje více možností zobrazení informací? Pokud ano, které zobrazení je nejvhodnější pro kontext, v němž se bude dokument zobrazovat?
- Kolik dat je zapotřebí? Možná se vám podaří odfiltrovat zbytečná data, což může vést k časové úspoře při generování výstupu sestavy.
- Typ výstupu
- Zvažte, jaký typ výstupu bude nejlépe vyhovovat potřebám osob, které si budou dokument prohlížet. Šablona, kterou navrhujete, může vypadat jinak, když je vygenerována v jiných typech výstupu. Některé prvky
jsou optimalizovány pro zobrazení v určitém formátu a jiné nejsou v určitých formátech podporovány. Seznamte se se způsobem zobrazení prvků šablony v různých výstupních formátech. Díky tomu budete moci
vybrat prvky a typ výstupu, které spolu nejlépe spolupracují.
- Jedna šablona nebo více šablon
- Jedná se o šablonu pro jednorázové použití, nebo byste mohli některé úseky použít znovu v jiných šablonách?
- Jedna šablona: Můžete použít jednu šablonu, která bude obsahovat všechny různé části návrhu dokumentu. To znamená, že vše je na jednom místě a není zapotřebí žádné slučování.
- Více šablon: Můžete využít modulární přístup a vytvořit několik šablon, jejichž následným spojením vytvoříte úplný dokument.
Můžete mít například šablonu obsahu tabulky, šablonu titulní stránky, šablonu dat, šablonu rejstříku a šablonu zadní strany obálky. Tyto šablony je možné při generování dokumentů používat opakovaně.
Na základě těchto požadavků určete počet potřebných šablon.
Název a popis jednotlivých bloků šablony je možné určit v atributech metadat.
Obsah názvu se zobrazuje v šabloně a obsah popisu se zobrazuj v poli pokynu k danému prvku šablony.
- Kontext zobrazení
- Jakým způsobem se bude tento dokument zobrazovat?
- Bude se tisknout? Zobrazovat na obrazovce? Nebo obojí?
- Bude se spouštět na integrovaném produktu?
2: Navrhněte šablonu
Tato taktika vám pomůže efektivně využít čas při navrhování šablony.
- Celkovou strukturu šablony implementujte pomocí přístupu shoda-dolů. Začněte od nejobecnějších prvků a poté se postupně zaměřujte na užší podrobnosti.
- Před tím, než se zaměříte na podrobnosti formátování, ověřte platnost generování dat.
Strávíte-li mnoho času formátováním a poté zjistíte, že se vám správně negenerují data, možná budete muset formátování provést znovu. Podrobnosti viz téma 3. Testování šablony.
- Podrobnosti rozpracujte a podrobnější požadavky přidávejte jeden po druhém.
Implementaci méně důležitých nebo obtížných podrobností nechte na později.
Zvažte relevantnost požadavků, jejichž realizace je obtížná, jako při analýze nákladů a výnosů.
- Zvažte použití skriptů k extrahování informací do formátu, který může produkt Rational Publishing Engine efektivně využít.
- Šablonu je možné navrhnout tak, aby nabízela specifické vlastnosti rozvržení stránky, jako velikost stránky, její orientaci, okraje, počet sloupců a styly pro typy odstavců, které budou v dokumentu používány nejpravděpodobněji.
- Šablona může obsahovat:
- Prvky struktury dokumentů, jako odstavce, tabulky, seznamy a obsah.
- Bloky rozvržení dokumentu, jako stránky předlohy, šablony stylů, záhlaví a zápatí.
- Interní a externí styly definované uživatelem, jako je formátování textu nebo odstavců. Formátování textu zahrnuje tučné písmo, kurzívu, podtržení, velikost písma a barvu písma. Formátování odstavců zahrnuje okraje, ohraničení, odsazení a parametry vytváření skriptů ve formě jazyka JavaScript.
- Vložený obsah šablon, jako obrázky, statický text a odkazy na statická pole a šablony stylů.
- Datové prvky, jako atributy, podmínky a dynamické datové prvky.
- Extrakce dat ve formě dotazů a filtrů.
- Externí proměnné, které přijímají hodnoty za běhu, a interní proměnné, které se používají pro výpočty. Je lepší vytvářet externí proměnné, než v šabloně adresy URL zdrojů dat stanovit napevno. Pokud adresy URL stanovíte napevno a název serveru se změní, musíte aktualizovat adresy URL ve všech šablonách. S externími proměnnými je možné adresy URL za běhu přepsat. Pro šablony, které jsou vestavěné do jiných produktů, použijte speciální proměnné, které tyto produkty při odkazování na data rozeznávají.
- Spusťte produkt Document Studio.
- Vytvořte novou šablonu, od začátku nebo na základě existující šablony.
- Přidejte schéma zdroje dat.
- Přidejte prvky.
- Přidejte formátování prvků.
- Definujte dynamický obsah.
- Volitelné: Upřesněte data pomocí filtrů, řazení nebo podmínek.
3: Otestujte šablonu
- Testování se provádí inkrementálně během vývoje. Ukládejte často a pod jedinečnými názvy. Výstup často ověřujte s použitím malé sady testovacích dat. Nepřidávejte další prvky, dokud nefunguje to, co již máte.
- Až bude hotová většina dokumentu, proveďte zátěžové testování, abyste zjistili případné výkonnostní problémy. Chcete-li omezit objem používaných dat, použijte nástroj Náhled. Vygenerovaná sestava bude i nadále přesná, ale generuje se rychleji, protože má produkt Rational Publishing Engine stanoven výchozí maximální počet záznamů načítaných pro jeden dotaz na 10 záznamů. Při testování podmínek je možné, že podmínce neodpovídá žádný záznam z prvních 10. V takovém případě použijte místo nástroje Náhled nástroj Spustit, nebo v Předvolbách změňte hodnotu maximálního počtu záznamů pro jeden dotaz.
- Otestujte šablonu v různých výstupních formátech. Možná zjistíte, že jeden typ výstupu nezobrazuje vaši šablonu tak dobře jako jiný.
- Spusťte nástroj pro ověřování.
- Vygenerujte náhled.
4: Uložte šablonu
- Uložte vyvinuté a otestované šablony na centrálním souborovém serveru.
Jako umístění úložiště můžete použít komponentu Central Management.
- Nezapomeňte v metadatech šablony uvést nějaké informace, aby ostatní věděli, jak šablonu znovu použít. K účinnému opakovanému používání těchto šablon pomáhají některé informace o ukázkových datech a ukázkových specifikacích dokumentů pro data projektu.
Další kroky
Po vytvoření a otestování šablon(y):