Cześć!

Utworzenie szablonu to nic trudnego. W tym artykule poznasz podstawy jak zrobić swój pierwszy szablon generowania dokumentacji w Enterprise Architect, w związku z tym dowiesz się:

1. Czym jest szablon (Document Template)
2. Jak utworzyć szablon
3. Jak działa edytor szablonu
4. Czym jest sekcja
5. Jak dodawać pola z danymi
6. W jaki sposób ustawić czcionki poprzez style
7. Jak stworzyć prostą tabelę

Najłatwiej wytłumaczyć to zagadnienia na przykładzie więc poza teorią, artykuł zawiera instrukcję jak krok po kroku przygotować pierwszy szablon.

Zaczynamy!

Czym jest szablon (Document Template)?

We wpisie Generowanie Dokumentacji w Enterprise Architect – podstawy wspomniałem jak wykorzystać gotowy szablon (RTF Template). Jeżeli jesteś subskrybentem i skorzystałeś z darmowych materiałów, miałeś okazję skorzystać z gotowych szablonów przygotowanych przez mnie. Szablon dokumentacji stanowi definicję rozdziału dokumentu, dlatego m.in możemy w nim ustalić jakie dane zawierają się w ramach rozdziału, jak są rozmieszczone informację oraz jakie style odpowiadają za wygląd poszczególnych sekcji i informacji.

Jak utworzyć szablon

Chcąc utworzyć swój pierwszy szablon, musisz przejść do zakładki Resources. Otworzy Ci się ekran przeglądania Zasobów (Resources). Następnie przejdź do folderu “User Templates” , wybierz “Templates” i kliknij PPM oraz z menu rozwijanego wybierz opcję “Create Template”

W rezultacie wyskoczy Ci okienko, w którym musisz podać następujące dane.

1. New Template-nazwę szablonu.
2. Template Type-wybierz Template (więcej o typach w kolejnym wpisie).
3. Copy Template-jeżeli chcesz skopiować inny szablon, możesz tutaj go wybrać.
4. Template Grup-wskazujesz folder zapisu szablonu. Jeżeli chcesz utworzyć nowy folder, wpisz tutaj jego nazwę. Jeżeli nie wybierzesz ani nie wprowadzisz nazwy nowego folderu, to szablon zostanie dodany w domyślnym folderze (“Templates”).

Okno tworzenia nowego szablonu.

Edytor szablonu

Edytor szablonów (Document Template Designer) to narzędzie EA służące do tworzenia i edycji szablonów. Składa się on z 3 podstawowych sekcji:

1. Sekcje (Sections) -wybierasz tu poszczególne sekcje informacji, które chcesz umieścić w dokumencie.
2. Content -graficzna reprezentacja szablonu gdzie wprowadzamy informację o rozmieszczeniu informacji w ramach sekcji szablonu.
3. Pasek narzędzi (EDIT) -zestaw dedykowanych narzędzi niezbędnych w tworzeniu szablonu.

Czym jest sekcja szablonu

Sekcje szablonu składają się komponentów ułożonych w hierarchii. Każdy z komponentów ma specyficzne właściwości, które pozwalają na generowanie informacji o danym obiekcie.

Przykład

Załóżmy, że potrzebujesz z wygenerować rozdział zawierający:

1. Nazwę pakietu
2. Opis pakietu (notatka)
3. Nazwę diagramu
4. Opis diagramu (notatka)
5. Listę elementów diagramu wraz z opisami (notatka)

Przyjmijmy, że twój diagram jest umieszczony w następującej lokalizacji (w Project Browser).

Diagram jest w innym pakiecie niż jego elementy, dlatego wykonanie zadania wymaga użycia następujących sekcji.

Wybrane sekcje

W wyniku tej operacji otrzymasz następujący wynik (okno Content).

Wynik wyboru sekcji szablonu

Jak widzisz pojawiły białe i żółte obszary(Znaczniki sekcji). Zółte obszary odpowiadają za oznaczenie sekcji dokumentu, białe obszary pomiędzy stanowią treść danej sekcji i umieszczamy tam tzw. “Znaczniki pól”.

Tip. Aby ustawić sekcję w wybranym miejscu dokumentu, należy ustawić kursor w wybranym miejscu i wybrać sekcję.

Jak dodawać Znaczniki pól

Przepis jest dość prosty. Wystarczy pomiędzy znacznikami sekcji umieścić znaczniki pól, które chcemy aby były wyświetlone w rozdziale.

Znacznik pola to “wbudowane zapytanie SQL”, które pozwala pobranie informacji o danym obiekcie z bazy danych Enterprise Architect. W polu content element ten jest oznaczony szarym tłem.

Znacznik pola

Przepis na umieszczenie znacznika pola:

1. Kliknij PPM pomiędzy znacznikami sekcji gdzie, chcesz umieć pole (biały obszar)
2. Wybierz opcję Insert Field
3. Wybierz interesujący Cię typ Znacznika pola.

Przykład

Wykonując kroki zgodnie z powyższą instrukcję, dodaj pola zgodnie z przykładem poniżej.

Wybór odpowiednich znaczników pola dla zadania z przykładu

W wyniku powyższych operacji przygotowałeś szablon . Zadanie wykonane. Przy czym nie wygląda to zbyt estetycznie, więc pracujemy dalej.

W jaki sposób poprawnie ustawić czcionki

W Enterprise Architect podczas generowania dokumentacji podobnie jak w WORD warto używać zdefiniowanych szablonów stylu. Skorzystać z nich można jedynie, wtedy gdy tekst ma przypisane odpowiednie style nagłówka i posiadamy odpowiedni szablon (skorzystamy ze wbudowanych w EA).

Przypisanie stylu do tekstu wykonujesz poprzez:

1. Zaznaczenie tekstu, któremu chcesz nadać styl.
2. Następnie wybranie z narzędzi opcję zmiany stylu dla tekstu.
3. Wybranie rodzaj stylu tekstu (np. Heading 1).

Przykład / Zadanie

Przypisz styl:

1. Heading 1 do {Pkg.Name}
2. Heading 2 do {Diagram.Name}
3. Diagram Image do {Diagram.DiagramImg}

Przypisane style dla szablonu styli normal.rtf

Jak stworzyć prostą tabelę

Podczas tworzenia tabeli w EA masz dwie drogi do wyboru. Są to:

1. Stworzenie tabeli w WORD i skopiowanie jej do EA.
2. Stworzenie tabeli w EA za pomocą dedykowanego narzędzia.

W związku z tym że artykuł dotyczy Enterprise Architect wybierzemy drugą opcję. Tworzenie tabel jest umieszczone w pasku narzędzi w sekcji paragraph i kafelku Table.
Wystarczy wybrać opcję “Insert Table” oraz podać liczbę wierszy i kolumn. Następnie zatwierdzić i tabela gotowa!

Następnie możemy skorzystać z dodatkowych opcji edycji tabel zmienić np. kolor komórki, szerokość obramowania lub wybrać wiersz nagłówka.

Przykład

Chciałbym, abyś dla sekcji elementów diagramu stworzył prostą tabelkę składającą się z dwóch kolumn i dwóch wierszy. Następnie nadaj pierwszemu wierszowi właściwość “Header Row” oraz pokoloruj tło komórki na szaro.Na końcu w drugim wierszu tabeli dodaj pola {ElementName} i {ElementNotes}. Podsumowując przykład, jeżeli poprawnie wykonałeś zadanie powinieneś otrzymać wynik podobny do zaprezentowanego poniżej.

Gratuluję!

Podsumowując wynikiem przeczytania i przerobienia zadania z artykułu powinien być twój nowy szablon. Oczywiście musisz jeszcze go przetestować na swoim repozytorium i ewentualnie dostosować. Ze względu na to że jest to cześć wiedzy o EA owiana złą sławą (To wcale nie jest trudne!) to mogą pojawić się pytania, więc jeżeli masz pytania w związku z artykułem i przykładem pisz śmiało w sekcji kontakt!

Co dalej?

Wkrótce pojawi się kolejny wpis związany z szablonami. Artykuł ten będzie dotyczył nieco bardziej zaawansowanych funkcji jak fragmenty więc warto to przećwiczyć przykład z artykułu. Jeżeli jesteś subskrybentem bloga masz dostęp do materiałów na moim dysku Google.

Bibliografia

1. Sparx User Guide 15.1 – Design Custom Document Templates https://sparxsystems.com/enterprise_architect_user_guide/ 15.1/model_publishing/rtfstyletemplateeditor.html [Dostęp 10.08.2020r]
2. Edycja szablonów RTF https://eablogpl.blogspot.com/2012/12/edycja-szablonow-rtf.html [Dostęp 10.08.2020r]
3. Customizing RTF Templates in Enterprise Architect https://www.youtube.com/watch?v=qmfmQbiN31k [Dostęp 11.08.2020r]
4. Generowanie Dokumentacji w Enterprise Architect – podstawy https://www.analizatozalezy.pl/index.php/2020/07/07/ generowanie-dokumentacji-w-ea-podstawy/#Szablon_dokumentacji_(RTF_Template) [Dostęp 17.08.2020r]