Projektowanie szablonów dokumentów

Szablon dokumentu definiuje strukturę, układ i treść raportu. Utworzenie poprawnego szablonu wymaga planowania, programowania, testowania i zapisywania szablonu.

Procedura

Jeśli udostępniany jest szablon do użytku w aplikacji zintegrowanej, patrz scenariusz Tworzenie raportów do użytku w zintegrowanych aplikacjach.

Pojęcia dodatkowe
Aby utworzyć szablon dokumentu, wykonaj poniższe czynności:

1: Zbierz wymagania

Różne potrzeby wymagają różnych projektów. Przed przystąpieniem do projektowania szablonu określ wymagania biznesowe i wymagania dotyczące dokumentu.

Elementy danych
Istnieje wiele różnych elementów szablonu wyświetlających różne typy informacji. Jakich informacji będą potrzebować osoby, które będą przeglądać ten dokument? Po zapoznaniu się z tymi potrzebami można rozpocząć ustalanie elementów danych:
  • Które elementy szablonu będą wyświetlały te dane? Jak dane te będą prezentowane w dokumencie wyjściowym?
  • Czy istnieje więcej niż jeden sposób prezentacji informacji? Jeśli tak, to który z nich będzie najwłaściwszy w kontekście, w którym dokument będzie przeglądany?
  • Jaka ilość danych jest niezbędna? Być może istnieje możliwość odfiltrowania niepotrzebnych danych, dzięki czemu skróci się czas generowania danych wyjściowych raportu.
Typ danych wyjściowych
Należy rozważyć, jaki typ danych wyjściowych będzie najlepiej odpowiadał potrzebom osób przeglądających dokument. Projektowany szablon może wyglądać inaczej po wygenerowaniu do różnych typów danych wyjściowych. Niektóre elementy zostały zoptymalizowane pod kątem wyświetlania w określonym formacie, a niektóre nie są obsługiwane w danych formatach. Należy zapoznać się z informacjami o tym, jak poszczególne elementy szablonu są wyświetlane w różnych formatach wyjściowych. Dzięki temu można będzie wybrać najlepiej współdziałające elementy i typ danych wyjściowych.
Jeden szablon a wiele szablonów
Czy szablon będzie używany jednorazowo czy jego części będą ponownie wykorzystywane w innych szablonach?
  • Jeden szablon: wszystkie części projektu dokumentu są zawarte w jednym szablonie. Oznacza to, że wszystkie elementy znajdują się w jednym miejscu i nie jest konieczne scalanie.
  • Wiele szablonów: można zastosować podejście modułowe, tworząc wiele szablonów i scalając je w celu utworzenia kompletnego dokumentu. Na przykład możesz utworzyć szablon spisu treści, szablon okładki przedniej, szablon danych, szablon indeksu i szablon okładki tylnej. Szablony te mogą być ponownie wykorzystywane podczas generowania różnych dokumentów.
Określ liczbę szablonów potrzebnych przy tych wymaganiach. Każdy blok szablonu można nazwać i opisać w atrybutach metadanych. Nazwa jest wyświetlana w szablonie, a opis jest wyświetlany w polu wskazówki elementu szablonu.
Kontekst wyświetlania
W jaki sposób użytkownicy będą przeglądać ten dokument?
  • Czy będzie on drukowany? Wyświetlany na ekranie? Czy będą stosowane oba te podejścia?
  • Czy będzie on uruchamiany w zintegrowanym produkcie?
Pojęcia dodatkowe

2: Zaprojektuj szablon

Podczas projektowania szablonu można zastosować następujące podejścia, aby zaoszczędzić czas.
  • Szablon można zaprojektować pod kątem udostępnienia konkretnych właściwości układu strony, takich jak wielkość strony, orientacja, marginesy, liczba kolumn, i stylów dla typów akapitów, które najprawdopodobniej zostaną użyte w dokumentach.
  • Szablon może zawierać:
    • Elementy struktury dokumentu, takie jak akapity, tabele, listy i spis treści.
    • Bloki układu dokumentów, takie jak strony wzorcowe, arkusze stylów, nagłówki i stopki.
    • Wewnętrzne i zewnętrzne style zdefiniowane przez użytkownika, takie jak formatowanie tekstu lub akapitu. Formatowanie tekstu obejmuje pogrubienie, kursywę, podkreślenie, wielkość czcionki i kolor czcionki. Formatowanie akapitu obejmuje marginesy, krawędzie, wcięcia i parametry skryptów w formie kodu JavaScript.
    • Osadzoną treść szablonu, taką jak obrazy, tekst statyczny i odwołania do plików statycznych oraz arkuszy stylów.
    • Elementy danych, takie jak atrybuty, warunki i elementy danych dynamicznych.
    • Wyodrębnianie danych w postaci zapytań i filtrów.
    • Zmienne zewnętrzne, które otrzymują wartości w czasie wykonywania, i zmienne wewnętrzne, które są używane do obliczeń. Tworzenie zmiennych zewnętrznych jest preferowaną metodą zakodowania w szablonie adresów URL źródeł danych. Jeśli adresy URL zostaną zakodowane i zostanie zmieniona nazwa serwera, konieczne będzie zaktualizowanie adresów URL w każdym szablonie. Przy użyciu zmiennych zewnętrznych można nadpisać adresy URL w czasie wykonywania. Dla szablonów osadzonych w innych produktach należy użyć zmiennych specjalnych, które są rozpoznawane przez te produkty, gdy odwołują się one do danych.
  1. Uruchom aplikację Document Studio.
  2. Utwórz nowy szablon od początku lub na podstawie istniejącego szablonu.
  3. Dodaj schemat źródła danych.
  4. Dodaj elementy.
  5. Dodaj formatowanie do elementów.
  6. Zdefiniuj treść dynamiczną.
  7. Opcjonalnie: Doprecyzuj dane przy użyciu filtrów, operacji sortowania lub warunków.

3: Przetestuj szablon

  1. Uruchom narzędzie weryfikacji.
  2. Wygeneruj podgląd.
Czynności dodatkowe:

4: Zapisz szablon

Dalsze kroki

Po utworzeniu i przetestowaniu szablonów:

Opinia