1. Hierarchia zložiek
Hlavné zložky
| Zložka | Dôvod existencie |
|---|---|
| _zdroje | Zdrojové súbory pre grafický návrh stránky (PSD, AI, ...) |
| node_modules | NPM balíky (manažment cez npm install a npm uninstall)Je tu uložený kompilátor Svelte včítane všetkých dependencies a iné veci. Všetky dôležité veci ku ktorým by sa malo pristupovať sú v package.json vypísané. Radšej manuálne nechytať. |
| public | Zložka ktorej obsah by mal byť na webserveri. Skompilovaná Svelte implementácia pre finálneho používateľa + celá lokálna verzia CockpitCMS a pár vecí k nej (dokumentácia, ...). Viac info nižšie |
| src | Zdrojové svelte súbory. Koreňom je App.svelteViac info nižšie |
| src_docs | Táto mkdocs dokumentácia |
Ďalšie delenie
Rozdelenie Svelte (src)
| Zložka | Dôvod existencie |
|---|---|
| _js | Externé JS súbory ktoré sú kompilované do separátnych súborov mimo hlavnej implementácia (konkrétne do public/js zložky). Hlavná časť implementácie (public/bundle) ich raz za čas načíta/odčíta pre občasné potreby. |
| parts | Časti stránky ktoré niesú editovateľné ako komponenty v CockpitCMS a sú načítavané priamo v App.svelte |
| routes | Vlastný router (systém pre zmenu prednačítaných stránok bez refreshovania) a iné relevantné veci týkajúce sa implementácie cesty/umiestnenia na stránke. |
| scripts | Všetky funkcie, ktoré sa využívajú na rôznych miestach viac-násobne a aby neboli rôzne kopírované tak sú tu zhrnuté. Narozdiel od _js budú skompilované ako priama súčasť hlavnej implementácie |
| sections | Jednotlivé komponenty, ktoré môže editor CockpitCMS pridávať / vyhadzovať a upravovať ich hodnoty v rámci stránok. Do hlavnej časti aplikácie App.svelte sú načítavané cez Layout.svelte |
V niektorých zložkách je zložka excluded, ktorá znázorňuje že dané súbory sú momentálne nevyužívané a mimo prístupu (často-krát majú bugy, niesú dostupné v CockpitCMS pre editora).
Rozdelenie verejnej časti (public)
| Zložka | Dôvod existencie |
|---|---|
| api | Zatiaľ nezverejnený koncept StrukShop API pre prihlasovanie používateľov stránky, nakoľko existujúce CockpitCMS API je nedostatočné. |
| build | Skompilovaný hlavný Svelte program stránky načítaný cez index.html |
| cockpit | Cockpit-CMS a všetky jeho časti, addony atď. |
| cockpit-docs | Dodatočná externá dokumentácia pre Cockpit-CMS. Využívané hlavne ako pomôcka pre field-types, prípadne API |
| cockpit-docs-official | Oficiálna (vcelku nepostačujúca) dokumentácia pre Cockpit-CMS. |
| font, img | Obrázky a písma, ktoré nedokáže používateľ stránky upravovať (napr. textúry a font pre špeciálnu tému, loading animácia, ...) |
| js | Skompilované externé samo-spúšťajúce sa funkcie z src/_js, prípadne kompletne externé knižnice (FontAwesome, BrowserUpdate) |
Jazyky
Podporované jazyky sú separátne definované v App.svelte, public/index.php, public/sitemap.php a cockpit/config/config.yaml, pričom v rámci CockpitCMS a jeho API jazyk "sk" je považovaný za "default".