Polski:Start

Instalacja
Po pierwsze, należy pobrać najnowszą wersję Gaia Framework MXP i go zainstalować. Po zainstalowaniu Gaii, uruchom program Flash i w górnym menu wybierz Windows> Inne Panele> Gaia Framework. Dodatkowo należy usunąć pliki ASO.

Wszystko gotowe? Zaczynamy!

Tworzenie nowego projektu w Gaia
Pierwszym krokiem w tworzeniu nowego projektu jest wybranie wersji Actionscript z którego chcesz korzystać korzystać. Kliknij Create AS3 lub Create AS2. Spowoduje to przejście do "Project Panel".



Project Panel
Pierwszą rzeczą będzie nadanie nazwy nowemu projektowi. Możesz go zmienić w dowolnym momencie, więc możesz narazie pozostawić go domyślnym.

Project Folder
Następnie wybierz katalog w którym utworzony będzie projekt klikając click to select a project folder . Katalog możesz wcześniej przygotować lub wykorzystać do tego formularz.

Properties
Po nadaniu nazwy i wybraniu katalogu dla projektu nadszedł czas na podstawowe ustawienia. Możesz ustawić wielkość, położenie, fps i kolor sceny. Tak jak w przypadku nazwy te wartości możesz zmieniać w dowolnym momencie a Gaia zastosuje je do wszystkich plików.

Folder Paths
Ostatni krok jest opcjonalny i służy do modyfikowania ścieżek projektu. Gaia domyślnie używa poniższego standardu:

* lib - dla plików .fla * bin - dla plików .swf, .html, itp. * src - dla plików .as (klasy)

inne popularne ustawienie to:

* src - dla plików .fla * src/classes - dla plików .as * deploy - dla plików .swf, .html, itp.

Powyższe ustawienia dają dużą możliwość konfiguracji projektu.

Istnieje możliwość ustawienia gdzie może znajdować się plik site.xml. Na razie niech to pole pozostanie puste.

Kliknije Create New Project, Gaia utworzy nowy projekt w kilka sekund i automatycznie przejdzie do zakładki Scaffold ( zostanie to omówione potem). W następnym kroku zostaną omówione pliki które zostały utworzone przy tworzeniu nowego projektu.



Pliki projektu


Jak widać Gaia utworzyła wszystkie foldery które ustawiono w poprzednim kroku.


 * Katalog lib zawiera pliki main.fla, preload.fla.
 * Katalog bin zawiera wszystkie opublikowane pliki ( i inne np xml )
 * Katalog src zawiera klasy AS
 * Katalog templates zawiera template fla i AS
 * Plik project.gaia to plik xml zawierający konfigurację projektu

Katalog bin:



W tym momencie zawiera pliki index.html, preload.swf, ste.xml i katalog js z SWFObject i SWFAddress.

Obiekt flashowy jest osadzony za pomocą SWFObject. Wymiary i wyrównanie są automatycznie ustawione.

Następnym krokiem jest analiza pliku site.xml 

Plik site.xml
Gaia używa pliku XML do zdefiniowania struktury strony.

Podstawowy wygląd site.xml jest następujący:

   

Gałęzie (Branches)
Gaia używa gałęzi jako struktury stron. Gałęzie działają jak katalogi albo adresy url. Każde odgałęzienie jest poprzedzone slashem ( np: index/nav/home). Do budowania gałęzi są używane znaczniki id każdej gałęzi.

Powyższa struktura przedstawia tylko jedną możliwą gałąź.

Gałąź składa się ze stron ( odgałęzień). Każda strona może posiadać wiele gałęzi przez co może budować złożone struktury. Każde odgałęzienie reprezentuje osobny plik swf który zostanie załadowany w momencie przejścia do wybranej gałęzi.

Gaia automatycznie ładuje pełne odgałęzienie poczynając od strony index kończąc na ostatniej stronie. Powyższa struktura site.xml nie pozwala na wczytanie index/nav ponieważ plik nav posiada kolejne odgałęzienia które zostaną automatycznie wczytane. To zdarzenie można nadpisać ustawiając parametr landing.

Szczegółowe informacje o pliku site.xml można znaleźć w sekcji Site XML w dokumentacji.

XML i struktura drzewa
Gaia wczytuje strony zaczynając od położonych najwyżej kierując się do końca wybranego odgałęzienia. Kolejne wczytane strony umieszczane na tle wczytanych uprzednio. Można zmienić to ustawienie poprzez modyfikacje atrybutu depth.

Site Node
Pierwszym elementem pliku site.xml jest. Ten element nie wymaga dodatkowych atrybutów, za to posiada dwa opcjonalne: title i menu.

Index Page
Pierwszym potomkiem jest znaczniki z id="index". Gaia wymaga aby pierwsza strona nosiła nazwę "index".

Strona "index" jest specjalna z dwóch powodów. Może zostać załadowana przed innymi stronami, a także jest załadowana na tle innych podstron.

Strony (Pages)
W szablonie site.xml, pierwszy potomek strony "indeks" to strona z id "nav". Ta strona została utworzona w celu globalnej nawigacji: to przede wszystkim załadowanie strony ponad innymi przez modyfikacje parametru "dept", co ważniejsze, występuje dla każdej podstrony.

Następna strona jest ostatnią stroną i w tym przypadku nosi nazwę "home". Ta strona posiada tytuł ustawiony na "Start". Ten tekst pojawi się na pasku tytułu przeglądarki gdzie widać napis % PAGE% w miejscu węzła atrybutu tytuł. Jest znany także jako "terminal strony", ponieważ jest to ostatni potomek węzła.

Tylko terminal stron (lub  strony z loading = "true") będzie wyświetlał tytuł w pasku przeglądarki, więc wystarczy umieścić tytuł na końcowych węzłach stron aby zastąpić % PAGE%.

Preloader domyślnie wyświetla tytuł ładowanej zawartości obok paska postępu. Więcej na ten temat przeczytasz w dziale Preloader.

Dodawanie stron do site.xml
Ponżej przykładowy plik site.xml z rozbudowaną strukturą:

       

W tym momencie istnieją 3 branche


 * 1) "index/nav/people/friends"
 * 2) "index/nav/people/family/tree"
 * 3) "index/nav/home"

Tylko ostatni węzeł posiada tytuł. W gałęzi znajduje się dodatkowy atrybut "menu"

Dodanie atrybutu menu="true" do strony pozwoli użyć nawigacji która znajduje się pod prawym przyciskiem myszy.

Note: Strony bez tytułu nie będą wyświetlane w menu.

Można też zauważyć że w menu pojawiła się pozycja "family". Jest to poprawny zapis ale zaraz po wejściu na węzeł "family" zostanie załadowana podstrona "tree".

W tym momencie struktura site.xml jest gotowa, można przejść do następnego kroku "Scaffolding".

Scaffolding
Pora na Scaffolding!

Class Package
Po powrocie do Flash'a do panelu Gaia Framework można zobaczyć że zakładka Scaffold jest zaznaczone. Na samej górze jest pole Class Package z wypełnionym polem "pages".

Oto przykład jak może wyglądać pakiet. Gdy klientem jest właściciel strony company.com, to Class Package będzie wyglądał następująco:

com.company.website

Dla projektów Gaia lepiej jest gdy na końcu pakietu zostanie dodana nazwa "pages":

com.company.website.pages

Na tym etapie można pozostawić domyślną nazwę "pages"

Scaffolding
Teraz wystarczy nacisnąć przycisk "Scaffold Project" Gaia zajmie się resztą.

Gaia utworzy pliki FLA bazując na nazwach swf w site.xml. Ustawi ścieżki publikacji domyślnie do katalogu bin, dodaj pliki do Publish Panel, stworzy klasy dla każdej strony i ustawi document class dla każdego pliku FLA. AS2 scaffolding creates exclude.xml files for each Flash page file to dramatically reduce swf file sizes.

Po zakończeniu scaffoldingu zosatnie uaktywniony nowy tab: Publish. Gaia opublikuje całą stronę i uruchomi main.fla.

Używając prawego przycisku myszy można nawigować pomiędzy stronami.

W tym momencie utworzyłęś pierwszą stronę używając Gaia Framework w zaledwie kilka minut!

Następnym krokiem jest sekcja Pages.