Future CMS Instrukcja konfiguracji (część dla Webmastera) GDZIE KOŃCZY SIĘ INTERFEJS A ZACZYNA ENGINE 3 CZY WEBMASTER MA COŚ TWÓRCZEGO DO POWIEDZENIA? 3 ZARZĄDZANIE FORMATKAMI 4 CZYM JEST FORMATKA? 4 DLACZEGO ZASTOSOWANO FORMATKI? 5 JAK DZIAŁA FORMATKA? 6 TWORZENIE NOWEJ FORMATKI 6 EDYTOWANIE ISTNIEJĄCEJ FORMATKI 9 USUWANIE NIEPOTRZEBNEJ FORMATKI 10 TWORZENIE FOLDERÓW NA DOKUMENTY 11 JAK ROZPLANOWAĆ FOLDERY? 11 ZARZĄDZANIE FOLDERAMI 12 WPROWADZANIE SERWISU DO FUTURE CMS 13 W JAKI SPOSÓB FUTURE CMS GENERUJE STRONY? 13 SUGEROWANA KOLEJNOŚĆ DZIAŁAŃ 15 SKRYPTY ZARZĄDZAJĄCE 15 GDZIE ZNAJDUJĄ SIĘ SKRYPTY ZARZĄDZAJĄCE? 16 Z CZEGO SKŁADA SIĘ SKRYPT ZARZĄDZAJĄCY? 16 MODUŁY 18 PARSOWANIE SZABLONU PODSTAWOWEGO 18 RODZAJE MODUŁÓW 19 PLIKI KONFIGURACYJNE 20 GDZIE ZNAJDUJĄ SIĘ PLIKI KONFIGURACYJNE? 20 Z CZEGO SKŁADAJĄ SIĘ PLIKI KONFIGURACYJNE? 20
SZABLONY 22 GDZIE ZNAJDUJĄ SIĘ SZABLONY? 22 SZABLONY PODSTAWOWE 22 SZABLONY MODUŁÓW 24 ZNACZNIKI 25 SZABLONY MODUŁU DOCUMENTS 25 SZABLONY MODUŁU DOCUMENTSLIST 26 SZABLON STRONY BŁĘDU 27 URUCHAMIANIE CMS-A 27 SKRYPTY STARTOWE 28 ZAPYTANIA DOMYŚLNE 29 ZAAWANSOWANA KONFIGURACJA 30 PROSTE MODYFIKACJE 31 WŁASNE ZNACZNIKI 32 PRZEKAZYWANIE DODATKOWYCH DANYCH DO SKRYPTÓW 32 MECHANIZM API 33 WYSZUKIWARKA 34 INSTALACJA 34 FORMULARZ WYSZUKIWANIA 34 SKRYPT ZARZĄDZAJĄCY 34 PLIK KONFIGURACYJNY 35 SZABLON 36 DODATKOWA FUNKCJONALNOŚĆ 38 PAMIĘĆ PODRĘCZNA 38 WIELOSTRONICOWE SPISY TREŚCI 40 PRZEŁĄCZANIE DOKUMENTÓW 40 SPIS FUNKCJI PODSTAWOWYCH 42 SPIS FUNKCJI API 44 Data ostatniej aktualizacji: 19 lipiec 2005 r.
Gdzie kończy się interfejs a zaczyna engine Konstrukcja systemu Future CMS obejmuje dwa elementy: - interfejs użytkownika, umożliwiający zarządzanie dokumentami dostępny jest dla każdego redaktora przez przeglądarkę internetową. Dzięki interfejsowi użytkownika każda uprawniona osoba może zmieniać zawartość serwisu, nawet jeżeli nie posiada wiedzy technicznej na temat tworzenia stron WWW. - silnik systemu - odpowiada za przetworzenie zapisanych za pomocą interfejsu dokumentów i wyświetlenie ich na ekranie internautów. Zadaniem webmastera przygotowującego system Future CMS do pracy jest skonfigurowanie obu tych elementów. Interfejs użytkownika musi zostać skonfigurowany w taki sposób, aby umożliwić wygodne i łatwe aktualizowanie danych w systemie przez redaktorów za pomocą przeglądarki internetowej. Z kolei konfiguracja engine u jest niezbędna aby dane wprowadzone przez redaktorów były widoczne w Internecie w ściśle określony sposób (inaczej mówiąc należy nauczyć engine jak mają wyglądać Państwa strony internetowe). Czy webmaster ma coś twórczego do powiedzenia? Wszystko to, co dotąd zostało napisane na temat Future CMS wskazuje, że zadaniem webmastera jest wyłącznie dostarczenie systemowi informacji o sposobie konfigurowania standardowej funkcjonalności. Co jednak w sytuacji, gdy serwis internetowy będzie zawierać niestandardowe mechanizmy, których nie obsługuje nasz program? Właśnie tutaj objawia się potęga Future CMS. Wbudowana w system technologia Application Programming Interface (API) pozwala webmasterowi na łatwe tworzenie nowych rozwiązań na bazie już istniejących funkcji systemu. W ten sposób uzyskuje on dostęp do dokumentów i danych systemu na różnych etapach ich przetwarzania. Mechanizm API jest przeznaczony dla webmasterów znających język programowania PHP. Dzięki API programista może dużo sprawniej tworzyć nowe narzędzia, ponieważ na jego usługach działa całe stabilne zaplecze funkcji gwarantowane przez system Future CMS. Jego zadaniem jest jedynie poszerzenie tego zaplecza o potrzebną mu funkcjonalność. Możliwości te szerzej opisujemy w rozdziale Zaawansowana konfiguracja.
Zarządzanie formatkami Pracę nad wprowadzeniem serwisu internetowego do systemu Future CMS najlepiej rozpocząć od stworzenia niezbędnych formatek. Czym jest formatka? Formatka jest to zbiór pól edycyjnych, które wypełnia redaktor tworząc lub edytując dokument w systemie Future CMS. Każdy dokument jest tworzony w oparciu o określoną formatkę, definiującą jego zawartość. Na poniższej ilustracji znajduje się strona edycyjna artykułu Kim jesteśmy w kategorii DEMO_Menu : Powyższa formatka składa się z pól opisanych jako: - Zapisz jako - Tytuł - Krótki opis - Tekst W demonstracyjnym serwisie Cafe Future system CMS wykorzystuje Tytuł i Krótki opis w spisach
treści w menu po lewej stronie. Natomiast treść pola Tekst, wraz z tytułem znajduje zastosowanie przy kliknięciu w pozycję menu i wyświetleniu pełnej treści artykułu. Pole Zapisz jako jest nazwą systemową i wykorzystywane jest wyłącznie do łatwego rozpoznania artykułu w ramach panelu redakcyjnego programu Future CMS. Dlaczego zastosowano formatki? Proste systemy CMS narzucają z góry pola, które należy wypełnić chcąc wprowadzić nowy artykuł zwykle jest to tytuł, skrót, treść, data i autor. Future CMS jest jednak systemem elastycznym, dlatego pozwala na dowolne ustalanie formatek. Dostosowane do potrzeb formatki sprawiają, że serwis nie jest szablonowy, a jego konfigurowalność jest znacznie większa. Ową elastyczność formatek uzyskano dzięki całkowitemu oddzieleniu nazewnictwa poszczególnych pól edycyjnych oraz ich zastosowania. Jedno z drugim łączy webmaster zgodnie z potrzebami danego serwisu. Ponieważ rodzaje publikowanych materiałów są bardzo różnorodne (aktualności, zdjęcia, cenniki i inne), dlatego też każdy rodzaj informacji wymaga innego rodzaju formatek.
Jak działa formatka? Każde pole edycyjne posiada opis wyświetlany redaktorom na stronie edycyjnej (takiej jak na powyższej ilustracji) w celu łatwego zrozumienia co należy wpisać w dane pole. Opis definiuje każdorazowo webmaster w trakcie tworzenia formatki. Oprócz opisu pole edycyjne posiada również swoją systemową nazwę, za pomocą której można odwołać się do danego pola bezpośrednio z szablonu HTML. Jak więc widać, formatka jest łącznikiem pomiędzy informacjami wpisywanymi przez redaktora, a serwisem internetowym, co zostanie szerzej przedstawione w dalszych rozdziałach. Formatka ma na celu jedynie zebranie od redaktora informacji związanych z danym dokumentem i zapisaniem ich w bazie danych. Sposób wykorzystania tych informacji w serwisie konfigurowany jest za pomocą szablonów i skryptów opisanych w dalszych rozdziałach. Tworzenie nowej formatki Formatkami zarządza się poprzez Menedżera formatek. Można się do niego dostać za pomocą opcji Formatki w głównym menu (u góry ekranu). Zarządzanie formatkami jest możliwe wyłącznie z poziomu użytkownika admin. Należy zalogować się do systemu jako użytkownik admin w celu ustawienia formatek. Po wejściu do Menedżera formatek pojawi się następujący ekran:
W oknach po lewej stronie dostępne są kolejno: - spis wszystkich formatek - lista dostępnych komponentów (rodzajów pól edycyjnych) - okienko ustawień komponentów Domyślnie zaraz po uruchomieniu Menedżer formatek znajduje się w trybie dodawania nowej formatki, co można poznać po numerze ID ustawionym na 0. W innym przypadku dodanie nowej formatki jest możliwe poprzez wybranie z lewej części okna opcji Tworzenie nowej formatki i kliknięcia przycisku Edycja. Ustawianie nazwy nowej formatki Nazwę formatki można ustawić w stosownym polu w oknie Formatka (po prawej stronie). Warto tworzyć nazwy kojarzące się z przeznaczeniem danej formatki (na przykład: Produkty dla opisu produktów). Ułatwi to późniejsze rozpoznawanie formatki w systemie. Dodawanie nowego pola edycyjnego do formatki
Wybierz żądany element z listy dostępnych elementów po lewej stronie. Po kliknięciu element zostanie dodany do aktualnej formatki na samym końcu (jeżeli formatka jest pusta to będzie on pierwszy). W analogiczny sposób można dodawać kolejne elementy. Zmiana kolejności elementów w formatce oraz usuwanie elementów Do zmiany kolejności elementów służą ikonki do góry oraz na dół zlokalizowane po prawej stronie każdego elementu w oknie Formatka. Ikonka z czerwonym krzyżykiem służy do usunięcia elementu z formatki. Ustawianie właściwości komponentów Po dodaniu nowego elementu należy skonfigurować jego właściwości. Aby to uczynić klikamy w ikonkę symbolizującą dany komponent (znajduje się po lewej stronie nazwy komponentu) w oknie Formatka. Po kliknięciu aktualne właściwości danego pola edycyjnego wyświetlone zostaną w okienku Ustawienia komponentów (po lewej stronie okna na samym dole). Każdy komponent posiada przynajmniej dwa pola: - Opis treść wpisana w to pole zostanie wyświetlona redaktorom na stronie edycyjnej jako opis danego elementu (warto nadawać taką nazwę, aby redaktorzy wiedzieli co wpisać w danym polu) - Name nazwa systemowa wykorzystywana w szablonach. Nazwa ta nie może powtarzać się w ramach jednej formatki (może natomiast powtarzać się w innych formatkach). W oknie Ustawienia komponentów nie należy używać polskich znaków. Niektóre komponenty posiadają dodatkowe pola w swoich właściwościach: Pole Radio / Select:
Values liczba opcji wyboru Opis i wartość opis danej opcji na stronie edycyjnej, a także wartość jaka zostanie zapisana w systemie po zaznaczeniu tej opcji. Można ponadto wybrać opcję domyślnie zaznaczoną (służą do tego pola selekcji po prawej stronie). Zaznaczenie: Value wartość jaka zostanie zapisana w systemie po zaznaczeniu opcji Właściwości komponentu zostaną zapamiętane dopiero po kliknięciu OK Zapisywanie formatki Jeżeli formatka jest gotowa i zawiera żądane elementy i ich właściwości to należy użyć opcji Zapisz w celu jej zachowania. Jeżeli wszystko przebiegło pomyślnie po kilku chwilach na liście dostępnych formatek (lewy górny róg) powinna pojawić się świeżo zapisana formatka. Wszystkie zmiany w formatce dodawanie, usuwanie i zmiana kolejności elementów nie są zapamiętywane aż do chwili kliknięcia przycisku Zapisz. Można więc dowolnie długo modyfikować formatkę, bez obawy o utratę jej pierwotnej wersji. Aby stworzyć kolejną nową formatkę należy na liście dostępnych formatek (lewy górny róg) zaznaczyć opcję Dodaj nową formatkę i kliknąć Edycja. Edytowanie istniejącej formatki W celu dokonania edycji istniejącej formatki należy otworzyć Menedżera formatek, a następnie wybrać formatkę do modyfikacji z listy dostępnych formatek (lewy górny róg) i kliknąć Edycja. Dodawanie i usuwanie nowych elementów, a także zmiana ich właściwości dokonuje się analogicznie do procedury opisanej w podrozdziale Tworzenie nowej formatki. Zachowanie wprowadzonych zmian odbywa się poprzez kliknięcie w opcję Zapisz. Wszystkie nowo naniesione zmiany w formatce będą się odnosić dopiero do nowo tworzonych dokumentów. Istniejące dokumenty wykorzystujące daną formatkę mogą być w związku z tym niepoprawnie wyświetlane! Po modyfikacji formatki należy poprawić wszystkie stare dokumenty, które ją wykorzystywały. Uwaga ta nie dotyczy zmiany kolejności pól w formatce oraz zmiany opisu komponentów.
Zachęcamy do przejrzenia formatek przygotowanych z myślą o demonstracyjnym serwisie Cafe Future. Pomoże to zrozumieć ideę działania formatek. Nasze przykładowe grupy mają nazwy: DEMO_Produkty, DEMO_Newsy i DEMO_Promocje. Usuwanie niepotrzebnej formatki Po wejściu do Menedżera formatek należy wybrać formatkę do usunięcia z listy dostępnych formatek (lewy górny róg) i kliknąć opcję Usuń. Usuwania należy dokonywać bardzo rozważnie. Proces ten jest nieodwracalny, a po usunięciu formatki przestaną działać wszystkie dokumenty ją wykorzystujące. Nie będzie możliwa edycja tych dokumentów, a nawet dostęp do nich, nie będą one ponadto wyświetlane na stronie internetowej.
Tworzenie folderów na dokumenty Ponieważ mamy już przygotowane formatki, możemy przystąpić do tworzenia struktury folderów. Będą w nich trzymane dokumenty wprowadzane do systemu przez użytkowników. Jak rozplanować foldery? Wszystkie opisane tutaj zasady mają charakter luźnych porad. Future CMS posiada możliwość sporej skalowalności, dlatego webmaster serwisu może zechcieć inaczej rozplanować system folderów. W szczególności niektóre zastosowania mechanizmu API (opisanego w dalszej części poradnika) będą tego wymagać. Bardzo ważne jest, aby struktura folderów została właściwie zaplanowała i odpowiadała strukturze serwisu internetowego. Tworząc foldery warto kierować się następnymi zasadami: 1. Każdy osobny rodzaj rodzaj dokumentu (każda formatka) powinien mieć oddzielny folder 2. W przypadku dokumentów tego samego rodzaju można pokusić się o podział dokumentów na kilka logicznych sekcji. Jest to przydatne, ponieważ Future CMS posiada funkcjonalność automatycznego tworzenia spisów treści na podstawie dokumentów opublikowanych w danej grupie. Przykład: Jeżeli do systemu wprowadzany jest serwis informacyjny z aktualnościami to warto pomyśleć nad stworzeniem osobnych folderów dla aktualności z kraju, ze świata czy też informacji sportowych. W ten sposób Future CMS pozwoli na stworzenie podstron ze spisami treści poszczególnych działów. 3. Foldery należy nazywać jak najbardziej intuicyjnie. Nazwy folderów służą głównie redaktorom wprowadzającym dane, nie są one widoczne w serwisie internetowym (chyba, że webmaster wyraźnie sobie tego zażyczy). 4. Warto grupować foldery o podobnej charakterystyce w strukturę podfolderów w celu łatwiejszego poruszania się w panelu redaktorskim. Stworzenie podfolderów nie ma wpływu na widoczność dokumentów i spisów treści w serwisie internetowym (o ile webmaster wyraźnie sobie tego nie zażyczy). Nawiązując do przykładu z poprzedniego punktu: Jeżeli stworzono osobne foldery dla newsów z kraju, ze świata i dla sportu warto stworzyć folder Aktualności i w nim dopiero właściwe podfoldery Kraj, Świat i Sport. Dzięki temu panel stanie się bardziej przejrzysty. 5. Inną (dodatkową) metodą jest grupowanie folderów zgodnie z zakresem kompetencji poszczególnych grup użytkowników. Najlepiej, aby foldery na których będzie pracować na przykład dział marketingu były odrębne w stosunku do folderów na przykład działu sprzedaży. Umożliwi to łatwe nadanie uprawnień do zarządzania folderami przez poszczególne grupy użytkowników (szczegóły zarządzania uprawnieniami dostępu do folerów znajdują się w dalszej części poradnika).
Zarządzanie folderami Sposób tworzenia i zarządzania folderami został opisany w części A przeznaczonej dla redaktorów. Aby zarządzać folderami w pełnym zakresie uprawnień należy zalogować się do systemu jako użytkownik admin. Warto przyjrzeć się ustawieniom folderów w ramach demonstracyjnego serwisu internetowego Cafe Future. Mają one nazwy: DEMO_Newsy, DEMO_Produkty i DEMO_Promocje, odpowiadające trzem rodzajom dokumentów występujących w serwisie.
Wprowadzanie serwisu do Future CMS W poprzednich rozdziałach przygotowaliśmy formatki oraz foldery. Mamy już gotowe wszystko co jest niezbędne do wprowadzania dokumentów przez redaktorów. Czas skonfigurować system Future CMS, aby potrafił wygenerować strony internetowe na podstawie wprowadzonych przez redaktorów informacji. Przed przystąpieniem do wprowadzania serwisu internetowego do systemu warto we wszystkich folderach stworzyć przykładowe dokumenty. W przeciwnym razie Future CMS nie będzie w stanie wyświetlić żadnych informacji, co utrudni prace nad serwisem. W jaki sposób Future CMS generuje strony? Gdy internauta chce otworzyć stronę internetową generowaną z pomocą systemu Future CMS, jego przeglądarka łączy się z naszym serwerem WWW, a ten następnie przekazuje zapytanie do silnika systemu Future CMS. Po przetworzeniu zapytania gotowa strona internetowa jest odsyłana do przeglądarki internauty. Każde zapytanie o stronę w Future CMS charakteryzowane jest przez dwa parametry: - numer ID strony - numer ID dokumentu Drugi z parametrów jest opcjonalny i powoduje automatyczne wczytanie stosownego dokumentu do wyświetlenia. Nie musi być stosowany tam, gdzie pojawiają się jedynie spisy treści i nie jest wyświetlana zasadnicza część dokumentu. Oba parametry zostaną szerzej omówione w dalszej części poradnika. Mechanizm działania silnika systemu Future CMS ilustruje rysunek.
ZAPYTANIE O STRONĘ odczytane zostają: ID strony, ID dokumentu USTALENIE NAZWY SKRYPTU ZARZĄDZAJĄCEGO analiza pliku id.conf w poszukiwaniu nazwy skryptu zarządzającego wyświetleniem strony. URUCHOMIENIE SKRYPTU ZARZĄDZAJĄCEGO skrypty znajdują się w katalogu: /cms/skrypty/ na koncie FTP. OTWARCIE SZABLONU PODSTAWOWEGO znajdują się one w katalogu /cms/szablony/start/ na koncie FTP. URUCHOMIENIE MODUŁU 1 (np. menu lista dokumentów) URUCHOMIENIE MODUŁU 2 (np. pełny tekst artykułu) URUCHOMIENIE MODUŁU 3 (itd.) (np. dodatkowa lista dokumentów) ANALIZA PLIKU KONFIGURACYJNEGO ANALIZA PLIKU KONFIGURACYJNEGO ANALIZA PLIKU KONFIGURACYJNEGO OTWARCIE SZABLONU DLA MODUŁU 1 OTWARCIE SZABLONU DLA MODUŁU 2 OTWARCIE SZABLONU DLA MODUŁU 3 POBIERANIE DOKUMENTÓW Z BAZY DANYCH POBIERANIE DOKUMENTÓW Z BAZY DANYCH POBIERANIE DOKUMENTÓW Z BAZY DANYCH WYGENEROWANIE STRONY wszystkie zebrane dane są scalane w jeden końcowy kod HTML OBRÓBKA STRONY wygenerowaną stronę można modyfikować za pomocą dowolnych instrukcji PHP - przez skrypt zarządzający. WYSŁANIE STRONY ostateczna wersja strony jest przesyłana do przeglądarki
Sugerowana kolejność działań Przed rozpoczęciem wprowadzania serwisu do systemu Future CMS należy przede wszystkim przygotować wersję statyczną serwisu w postaci dokumentów HTML. Zakładam także, że zostały już stworzone odpowiednie foldery i wprowadzone do nich stosowne dokumenty tę część prac opisywaliśmy w poprzednich rozdziałach. 1. Wyodrębnij stałe, powtarzające się elementy każdego dokumentu HTML do szablonów podstawowych. Jeżeli w serwisie znajdują się działy lub części znacząco różniące się od siebie konstrukcyjnie dla każdej z nich stwórz osobny szablon podstawowy. Szablon podstawowy traktuj jako element konstrukcyjny całego serwisu. 2. Z szablonu podstawowego wyodrębnij następujące elementy: - spisy treści (np. menu) powtarzające się na każdej podstronie) - elementy zlokalizowane w tym samym miejscu na każdej podstronie, ale różniące się wyglądem, budową i zawartością. Jeżeli nie uda się w sposób jednoznaczny tego zrobić to być może konieczne będzie stworzenie dodatkowego szablonu podstawowego. 3. W miejsca powyższych elementów w szablonie podstawowym wpisz odpowiednie znaczniki łatwe do skojarzenia, najlepiej pisane dużymi literami. 4. Stwórz skrypt zarządzający dla każdego rodzaju strony korzystając z funkcji $kernel->parsefile() i $kernel->parse wypełnij znaczniki w szablonie podstawowym (funkcja $kernel->start()). 5. Aby moduły ze skryptu zarządzającego zadziałały konieczne będzie stworzenie odpowiednich plików konfiguracyjnych oraz powiązanych z nimi szablonów ze znacznikami odpowiadającymi nazwom pól w formatkach. 6. Stwórz plik startowy, wskazując w wartościach domyślnych skrypt startowy odpowiadający za Twoją stronę główną. Szczegółowy opis powyższej procedury znajdziesz w następnych rozdziałach. Skrypty zarządzające Wprowadzanie serwisu do systemu rozpoczynamy od stworzenia skryptu zarządzającego. Skrypt taki będzie zwykle oddzielny dla każdego typu strony (ale niekoniecznie dla każdego wyglądu szablonu). Niniejszy poradnik będzie bazować na demonstracyjnym serwisie Cafe Future. Na początek wyjaśnimy w jaki sposób zbudowana jest tam strona główna.
Gdzie znajdują się skrypty zarządzające? Skrypty te są zlokalizowane na koncie FTP w katalogu: /cms/skrypty/ W katalogu tym można tworzyć system podkatalogów dla ułatwienia zarządzania. Skrypty zarządzające należące do serwisu demonstracyjnego zostały wgrane do katalogu: /cms/skrypty/demo/ Z czego składa się skrypt zarządzający? Jest to zwykły skrypt języka PHP z nadanym rozszerzeniem.inc. Odwołuje się on do odpowiednich funkcji w silniku systemu Future CMS. Oto jak wyląda skrypt zarządzający stroną główną Cafe Future (plik start.inc): <? $kernel->start($kernel->cfg("demo_start")); $kernel->parsefile("nagłówek", "demo/naglowek.tmpl", true); $kernel->parse('promocja', 'documentslist', 'demo/promocja.conf'); $kernel->parse('menu', 'documentslist', 'demo/skrot_newsy.conf'); $kernel->parse('tekst_glowny', 'documentslist', 'demo/skrot_produkty.conf'); $kernel->parsefile("kontakt", "demo/kontakt.tmpl", true);?> $out = $kernel->end(); LISTING 1 Zawartość pliku /cms/skrypty/demo/start.inc Wszystkie prezentowane w tym poradniku funkcje są dokładniej opisane w rozdziale Spis funkcji podstawowych oraz na naszych stronach internetowych. Zachęcamy do przejrzenia zawartych tam informacji wszystkie osoby zainteresowane pełniejszym poznaniem sposobu funkcjonowana systemu Future CMS. Definiowanie szablonu podstawowego Na samym początku skryptu start.inc wywoływana jest funkcja $kernel->start(), do której przekazywana jest ścieżka do szablonu podstawowego. Dzięki niej system CMS będzie wiedział na jakim szablonie będze pracować. Nadawanie nazwy szablonom - plik szablony.conf
W naszym przypadku została dodatkowo wykorzystana funkcja $kernel->cfg(), mająca za zadanie pobranie ścieżki do szablonu podstawowego z pliku /cms/ustawienia/szablony.conf na koncie FTP. W przypadku serwisu Cafe Future plik ten składa się wyłącznie z jednej linijki: demo_start = start/demo/start.tmpl Chcąc dodać kolejne wpisy w pliku szablony.conf podajemy je w kolejnych liniach (oddzielone pojedynczym enterem). Nazwę szablonu od ścieżki do pliku oddzielamy znakiem równości ( = ) tak jak powyżej. Korzystanie z tego sposobu przekazywania ścieżki szablonu do funkcji $kernel->start() nie jest obowiązkowe, warto je jednak stosować ze względu na wygodę późniejszych modyfikacji. Zobacz rozdział Spis funkcji podstawowych w celu poznania szczegółów. Podawanie szablonów podstawowych poprzez funkcję szablony.conf (jak w przykładzie) jest bardziej uniwersalne niż podawanie ścieżki do szablonu wprost. W razie chęci zmiany szablonu wystarczy zmiana wpisu w szablony.conf nie ma potrzebny modyfikacji każdego skryptu zarządzającego z osobna. Wstawianie modułów do szablonu W dalszych krokach w pliku start.inc następuje parsowanie szablonu podstawowego i wstawianie w określone miejsca (nazywane blokami) odpowiednich modułów. W tym miejscu można decydować jakie dane mają zostać pobrane z bazy danych i w jaki sposób mają być one wykorzystane. Szczegółowo proces wstawiania i konfiguracji modułów zostanie opisany w dalszej części przewodnika. Generowanie strony Na końcu w pliku start.inc wywoływana jest funkcja $kernel->end(), która na podstawie wszystkich zebranych informacji generuje i zwraca ostateczną wersję dokumentu. Strona wynikowa jest zapisywana do zmiennej $out. W tym miejscu można rozpocząć indywidualne parsowanie strony wygenerowanej przez CMS-a, we własnym zakresie rozszerzając tymsamym jego możliwości. Do przeglądarki internauty zostanie wysłane cały tekst, który po zakończeniu działania skryptu zarządzającego będzie się znajdował w zmiennej $out (nazwę zmiennej można zmienić). Do końca działania skryptu zmienną tę można dowolnie modyfikować. Przykłady tego rodzaju działań zawarte zostały w dalszej części przewodnika.
Moduły W poprzednim rozdziale zaprezentowany został sposób wstawiania modułów do szablonu podstawowego. Powstaje jednak pytanie czym taki moduł jest? System Future CMS pozwala podzielić kod HTML strony na części zwane właśnie modułami. Na etapie poszczególnych modułów system CMS powiąże szablony z danymi wprowadzonymi do bazy danych przez redaktorów. Sprawny podział strony na odpowiednie moduły pozwoli zautomatyzować wyciąganie zgromadzonych danych z systemu. Parsowanie szablonu podstawowego Powróćmy do przykładowego pliku start.inc. W części związanej z parsowaniem (analizą i wypełnianiem danymi) szablonu podstawowego wywoływane były dwie funkcje: $kernel->parsefile() oraz $kernel->parse(). Przyjrzyjmy się im bliżej. Funkcja $kernel->parsefile() Funkcja ta ma bardzo proste działanie. Nie dokonuje ona żadnych manipulacji danymi, jej zadanie to po prostu wstawienie do szablonu podstawowego kodu HTML z odrębnego pliku. W ten sposób wspólne części kodu dla różnych szablonów podstawowych można zgromadzić w jednym pliku, aby w ten sposób ułatwić późniejsze zmiany. Jako przykład zastosowania można podać menu serwisu lub nagłówek z logiem te elementy stron zwykle są takie same w całym serwisie. Jeżeli znajdą się w jednym pliku zamiast w kilku to ewentualne modyfikacje będą musiały być wprowadzone tylko w tym pojedynczym miejscu. W przypadku naszego serwisu demonstracyjnego zrobiliśmy tak z plikiem nagłówka (cała górna część graficzna), która została wydzielona do szablonu demo/naglowek.tmpl i powiązana z szablonem podstawowym za pośrednictwem znacznika NAGŁÓWEK. Podobnie zrobiliśmy z danymi kontaktowymi chodzi odpowiednio o plik demo/kontakt.tmpl i znacznik KONTAKT. Temat znaczników zostanie rozwinięty w dalszej części przewodnika. Zawartość obu tych plików zostanie wstawiona do szablonu podstawowego i znajdzie się w ostatecznej wersji strony. Dokładniejszy opis parametrów tej funkcji znajdziesz w rozdziale Spis funkcji podstawowych. Funkcja $kernel->parse() Jest to właściwa funkcja, zajmująca się wywoływaniem odpowiednich modułów. Każdy moduł składa się z dwóch elementów pliku konfiguracyjnego (definiuje jakie dane mają zostać pobrane z bazy danych oraz jak zostaną wyświetlone) oraz szablonu modułu (kodu HTML, w którym dane zostaną
wyświetlone). Oba elementy zostaną opisane w kolejnych rozdziałach. Opis parametrów funkcji $kernel->parse() znajduje się w rozdziale Spis funkcji podstawowych. Rodzaje modułów Poniżej umieszczony został kod skryptu zarządzającego odpowiadającego za wyświetlanie pełnych informacji o produktach (plik pelne_produkty.inc): Strona ta jest wyświetlana po kliknięciu na nazwę dowolnego rodzaju kawy na stronie głównej. <? $page = &$kernel->start('start/demo/start.tmpl'); $kernel->parsefile("nagłówek", "demo/naglowek.tmpl", true); $kernel->parse('menu', 'documentslist', 'demo/skrot_newsy.conf'); $kernel->parse('tekst_glowny', 'documents', 'demo/pelne_produkty.conf'); $out = $kernel->end();?> LISTING 2 Zawartość pliku /cms/skrypty/demo/pelne_produkty.inc Zwróćmy uwagę, że za pierwszym razem do funkcji $kernel->parse przekazany został parametr o nazwie documentslist, a za drugim documents. Są to nazwy dwóch rodzajów modułów funkcjonujących w systemie Future CMS. Oprócz nich istnieje jeszcze trzeci moduł - search, nie wykorzystany w tym miejscu. Wszystkie trzy charakteryzują się kompletnie odrębnym zachowaniem i stosowane są w różnych sytuacjach. Listy dokumentów documentslist Moduły kategorii documentlist będą służyć do tworzenia wszelkiego rodzaju spisów dokumentów wprowadzonych do systemu CMS, czyli w szczególności do tworzenia menu. Na stronie głównej serwisu demonstracyjnego (plik start.inc) moduły wykorzytujące documentslist znalazły zastosowanie przy menu bocznym (znacznik MENU) oraz przy liście produktów (znacznik TEKST_GŁÓWNY). W skrypcie pelne_produkty.inc znajduje się już tylko boczne menu, ponieważ spis kaw nie jest na tej stronie wyświetlany. Jak działają moduły oparte o documentslist? Spisy treści generowane są na podstawie dokumentów zgromadzonych we wskazanym w pliku konfiguracyjnym folderze (zobacz rozdział dotyczący zarządzania folderami w panelu redakcyjnym Future CMS-a). Konfiguracji podlegają także inne parametry wpływające na sposób wyświetlania spisu dokumentów, takie jak kolejność wyświetlania oraz ilość wyświetlonych pozycji. Sposób konfiguracji modułu opisany zostanie w kolejnym rozdziale.
Pełna treść dokumentu documents W przeciwieństwie do poprzedniego rodzaju modułów, tutaj mamy do czynienia z kategorią, która koncentruje się na pojedynczym dokumencie. Służą one do wyświetlania jego zawartości. Wypełnienie szablonu takiego modułu następuje w zasadzie automatycznie wystarczy wstawić odpowiednie znaczniki. Więcej o konfiguracji i szablonach w następnych rodziałach. W pliku pelne_produkty.inc moduł kategorii documents wykorzystywany jest do wyświetlenia pełnej informacji na temat wybranej kawy wraz ze zdjęciem. Wyszukiwarka search Moduł search to mechanizm wyszukiwarki. Pozwala on internautom przeszukiwać zawartość serwisu pod kątem zadanej frazy. Jeżeli fraza wystąpiła w żądanej części serwisu to przedstawiana jest lista dokumentów, w których miało to miejsce wraz z linkami do nich. Przykład zastosowania wyszukiwarki znajdziesz w pliku szukaj_wyniki.inc. Co ważne, moduł search stosowany jest tylko na stronie odpowiadającej za prezentację wyników. W miejscu, gdzie ma być wstawiony formularz wyszukiwania nie jest konieczne korzystanie z żadnego specjalnego modułu. Wystarczy wstawić w szablon odpowiedni formularz wyszukiwarki. Temat ten zostanie rozwinięty w osobnym rozdziale. Pliki konfiguracyjne Wiemy już czym są moduły. Teraz zajmiemy się ich konfiguracją. Gdzie znajdują się pliki konfiguracyjne? Pliki te są zlokalizowane na koncie FTP w katalogu: /cms/konfiguracja/ W katalogu tym można tworzyć system podkatalogów dla ułatwienia zarządzania, analogicznie jak w przypadku skryptów zarządzających. Pliki konfiguracyjne należące do serwisu demonstracyjnego zostały wgrane do katalogu: /cms/konfiguracja/demo/ Z czego składają się pliki konfiguracyjne?
Zawartość plików konfiguracyjnych jest zależna od rodzaju modułu, dlatego zostaną one omówione osobno dla kategorii documentslist i documents. Jednak niezależnie od rodzaju modułu sposób zapisu informacji jest podobny - pliki konfiguracyjne składają się z nazwy opcji i ich wartości, odzielonych znakiem równości. Poszczególne opcje znajdują się w osobnych liniach. Pliki konfiguracyjne modułów documentslist Oto plik konfiguracyjny skrot_produkty.conf, odpowiadający za wyświetlenie listy dostępnych kaw na stronie głownej serwisu demonstracyjnego (pominięte zostały komentarze): Template = demo/skrot_produkty.tmpl Group_ID = 5 Direction = 1 Special = 0 List_Start = 0 Page_Size = 0 LISTING 3 Zawartość pliku /cms/konfiguracja/demo/skrot_produkty.conf Oto charakterystyka poszczególnych opcji: Template wskazuje nazwę szablonu, który zostanie wykorzystany do obsługi modułu. Podana ścieżka jest adresem względnym w odniesieniu do katalogu /cms/szablony/. Group_ID tutaj podawany jest numer ID grupy, która zostanie użyta do wyświetlenia dokumentów. Direction określa kierunek wyświetlania dokumentów z grupy. Może przyjmować dwie wartości 0 lub 1. Liczba 0 oznacza kierunek od dołu (dokumenty na samym dole grupy będą wyświetlane jako pierwsze), natomiast liczba 1 to kierunek od góry. Special jeżeli liczba dokumentów ma zostać ograniczona (czyli nie zostaną wyświetlone wszystkie dokumenty z grupy) to parametr ten należy ustawić na wartość 1. W przeciwnym razie należy ustawić wartość 0 wyświetlone zostaną wszystkie dokumenty z grupy. List_Start określa od którego dokumentu w kolejności ma zostać wyświetlona lista. Numeracja rozpoczyna się od 0. Aby zadziałał wymagane jest ustawienie parametru Special na 1. Page_Size określa ile kolejnych dokumentów, począwszy od List_Start (lub pierwszego, jeżeli nie zdefiniowano List_Start), ma zostać wyświetlonych na liście. Aby opcja ta zadziałała wymagane jest ustawienie parametru Special na 1. Analizując przytoczony plik konfiguracyjny skrot_produkty.conf można stwierdzić, że wyświetlone zostaną wszystkie dokumenty z grupy o numerze ID równym 5 (DEMO_Produkty) w kolejności od góry. Wykorzystany zostanie do tego szablon /cms/szablony/demo/skrot_produkty.tmpl. Pliki konfiguracyjne modułów documents