Projekt nadrzędny

• CAST

CAST - Dokumentacja techniczna

• Wstęp
• Format dokumentacji

Moduły

• CAST Commons plug-in
• CAST Data Model plug-in
• CAST GDM model plug-in
• CAST Schema model plug-in
• CAST third party plug-in
• CAST Core plug-in
• CAST Data Model Query plug-in
• CAST editors framework plug-in
• CAST data navigator
• CAST graphical editors framework plug-in
• CAST Tabular view plug-in
• CAST Statistic plug-in
• CAST GDM statistic plug-in
• CAST GDM view plug-in
• CAST Importer Base plug-in
• CAST Importer Wizard plug-in
• CAST GDM Importer plug-in
• CAST properities view
• CAST Schema editor plug-in
• CAST Schema statistic plug-in
• CAST Schema view plug-in
• CAST graphical editor content miniature view
• ZEST Layout Algorithms Integration plug-in

1. Dokumentacja jest tworzona w formacie Wiki Confluence
2. Specyfikację formatu można znaleźć na stronie: Notation Guide - na razie obsługujemy tylko najprostsze znaczniki, dlatego prosze sprawdzić czy dokumentacja poprawnie się generuje (jeśli zastosowana składnia zgodna z formatem confluence nie będzie generować sie poprawnie, prosimy o feed-back) ,
3. Dokumentacja jest oparta o mavena i używa wtyczki maven-site-plugin - więcej na temat jej użycia na stronie: http://maven.apache.org/plugins/maven-site-plugin/

• $PROJECT_HOME/src/site/ - katalog domowy strony
• site.xml - plik definiujący strukturę strony, menu, etc.
• confluence - główny katalog z dokumentacją w formacie Confluence (źródła w formacje confluence - nazwa_pliku.confluence)
• resources - katalog zawierający wszystkie zasoby - podczas tworzenia strony wszystkie pliki i katalogi będą kopiowane do katalgou głównego strony
• resources/images - katalog zawierający wszystkie obrazki

1. W dokumentacji nie należy używać jawnie nazwy projektu (CAST/LINK). Zamiast tego należy używać tekstu ${shortAppName}, który w trakcie generowania strony jest zastępowany przez odpowiednią nazwę zależnie od tego w jakim celu jest generowana dokumentacja (strona WWW dla CASTa, help Eclipse dla LINKa).
2. Pliki dokumentacji muszą być zakodowane w formacie UTF-8.

1. Aby wygenerować dokumentację, należy wykonać polecenie mvn clean site. Dokumentacja jest generowana w katalogutarget/site.
2. Aby wygenerować help w formacie Eclipse, należy wykonać polecenie mvn clean site -P eclipse-help Help jest generowany w katalogu target/eclipse-help.
3. Przydatne jest używanie także parametru -e do polecenia mvn, które wyświetla szczegóły wyjątków występujących w czasie generowania strony. Pozwala to na prostszą lokalizację błędów.

1. Użycie targetu site-deploy zamiast site powoduje, że strona po wygenerowaniu jest od razu wrzucana na serwer. Opis tego mechanizmu jest dostępny w dokumentacji Maven Site, w sekcji Deploying the Site.
2. Nie należy używać site-deploy w przypadku helpu Eclipse