Free songs
header_good

Struktura danych

Za co odpowiadają poszczególne katalogi, podkatalogi i pliki zawarte w katalogu szkolenia ?



1. Katalog [build]

W tym katalogu znajduje się w pełni funkcjonalna wyjściowa wersja szkolenia, czyli wynik jego kompilacji.

Katalog zostaje założony przez kompilator frameworka Adapt w momencie pierwszej kompilacji szkolenia i przy każdej następnej jest aktualizowany.

Zawartość tego katalogu jest właściwym szkoleniem po skończonym projekcie.

Uwaga: Kompilator frameworka nie usuwa z katalogu [build] starych plików. Warto więc, w razie usuwania z zawartości szkolenia obszernych załączników (np. grafik, czy filmów), całkowicie usunąć ten katalog, aby kompilator mógł utworzyć go na nowo i wygenerować jego aktualną zawartość bez starej, zbędnej zawartości.



2. Katalog [src]

W tym katalogu znajdują się pliki źródłowe szkolenia, na podstawie których kompilator frameworka Adapt generuje jego wersję wyjściową do katalogu [build].

Katalog ten posiada podkatalogi, w których zawarte są posegregowane pliki źródłowe, odpowiadające za poszczególne funkcjonalności frameworka Adapt

Zawartość katalogu [src] jest w pełni wystarczalna do odtworzenia szkolenia oraz jego edycji, których to nie umożliwia zawartość katalogu [build].


2.1. Podkatalog [components]

W tym katalogu znajdują się gotowe komponenty, których można użyć przy tworzeniu zawartości szkolenia.

Każdy podkatalog tego katalogu zawiera jeden komponent i w jego środku znajdują się m.in.: dokumentacja danego komponentu, przykład jego zastosowania, pliki z kodem JavaScript odpowiadające za jego funkcjonalność (katalog [js]), czy pliki odpowiadające za jego wygląd (katalog [less]).


2.2. Podkatalog [core]

Katalog ten, jak sama nazwa wskazuje, jest rdzeniem frameworka Adapt i zawiera jego pliki główne, które odpowiadają za jego działanie.


2.3. Podkatalog [course]

W tym katalogu znajdują się podkatalogi z zawartością szkolenia w poszczególnych wersjach językowych oraz plik konfiguracyjny config.json:


2.3.1. Podkatalog [en]

W tym katalogu znajdują się podkatalogi zawierające pliki osadzone w szkoleniu oraz najważniejsze pliki .json, które definiują strukturę oraz zawartość szkolenia:


2.3.1.1. Podkatalog |images|

Zawiera pliki graficzne osadzone w szkoleniu.

2.3.1.2. Podkatalog |pdf|

Zawiera pliki .pdf osadzone w szkoleniu.

2.3.1.3. Podkatalog |video|

Zawiera pliki video osadzone w szkoleniu.

Wskazówka: Oczywiście można tu utworzyć podkatalog o dowolnej nazwie dla każdego rodzaju plików, jakie będą osadzone w szkoleniu.

2.3.1.4. Plik course.json

Plik zawiera pierwszy główny element struktury szkolenia, czyli kurs.

2.3.1.5. Plik contentObjects.json

Plik zawiera kolejne w hierarchii elementy struktury szkolenia, czyli strony, które są potomkami kursu.

2.3.1.5. Plik articles.json

Plik zawiera kolejne w hierarchii elementy struktury szkolenia, czyli artykuły, które są potomkami stron.

2.3.1.6. Plik blocks.json

Plik zawiera kolejne w hierarchii elementy struktury szkolenia, czyli bloki, które są potomkami artukułów.

2.3.1.7. Plik components.json

Plik zawiera kolejne w hierarchii elementy struktury szkolenia, czyli komponenty, które są potomkami bloków.


2.3.2. Plik config.json

Jest to główny plik konfiguracyjny szkolenia. Jest on ważny głównie przy tworzeniu szkoleń zgodnych z wymaganiami platformy SCORM. Aby status szkolenia na platformie był ustawiany na “complete” po zaliczeniu testu końcowego, plik ten powinien mieć następującą strukturę:

{
"_defaultLanguage": "en",
"_questionWeight": 1,
"_drawer": {
"_showEasing": "easeOutQuart",
"_hideEasing": "easeInQuart",
"_duration": 400
},
"_spoor": {
"_tracking": {
"_requireCourseCompleted": true,
"_requireAssessmentPassed": true,
"_shouldSubmitScore": false
},
"_reporting": {
"_comment": "Your options here are 'completed', 'passed', 'failed', and 'incomplete'",
"_onTrackingCriteriaMet": "completed",
"_onQuizFailure": "incomplete"
}
}
}


2.4. Podkatalog [extensions]

W tym katalogu znajdują się rozszerzenia frameworka Adapt, które dodają mu funkcjonalności pomocne przy tworzeniu szkolenia.

Każdy podkatalog tego katalogu zawiera jedno rozszerzenie i w jego środku znajdują się m.in.: dokumentacja danego rozszerzenia, przykład jego zastosowania, pliki z kodem JavaScript odpowiadające za jego funkcjonalność (katalog [js]), czy pliki odpowiadające za jego wygląd (katalog [less]).


2.5. Podkatalog [less]

Zawiera plik adapt.less zawierający definicje struktury graficznej całego szkolenia.

Uwaga: Ten plik nie podlega edycji przez projektanta szkolenia, lecz jest generowany automatycznie przez framework Adapt na podstawie wielu plików .less. Pliki te zawarte są w katalogu skórki graficznej użytej w szkoleniu i pojedynczo definiują wygląd poszczególnych elementów szkolenia, a wszystkie razem cały jego wygląd.


2.6. Podkatalog [menu]

W tym katalogu znajdują się wszystkie pliki, które odpowiadają za strukturę i funkcjonalność głównego menu szkolenia.


2.7. Podkatalog [templates]

Katalog ten zawiera pliki JavaScript, zawierające szablony funkcji pomocne przy oskryptowywaniu frameworka Adapt.


2.8. Podkatalog [theme]

W tym katalogu znajdują się motywy (tzw. skórki) graficzne.

Każdy podkatalog tego katalogu zawiera jeden motyw graficzny i może ich być wiele, jednak w danym momencie można używać tylko jednego motywu graficznego dla szkolenia.

W podkatalogu danego motywu znajdują się pliki, które pojedynczo definiują wygląd poszczególnych elementów szkolenia, a wszystkie razem cały jego wygląd.

W szkoleniu dostępny jest motyw domyślny adapt-contrib-vanilla, który można samodzielnie edytować dostosowując wygląd szkolenia do swoich potrzeb lub można skorzystać z innego gotowego motywu zdobytego z jakiegoś zewnętrznego źródła.