--=REKLAMA=--
--=REKLAMA=--
Jednym z celów przebudowy systemu pomocy przeprowadzonej w Joomla 1.6 było zapewnienie większej elastyczności w stosowaniu serwerów pomocy. Przed wydaniem Joomla 1.6 uruchomienie serwera pomocy wymagało instalacji Joomla 1.0 lub Joomla 1.5, chyba że ktoś potrafił dokonać skomplikowanego przepisania adresów internetowych w .htaccess. Powodem tego ograniczenia była zakodowanie struktury adresów ekranów pomocy, czego nie można było zmienić bez zmiany kodu źródłowego.
Począwszy od wydania Joomla 1.6 system pomocy podręcznej może być zbudowany w sposób bardzo elastyczny, nieograniczony do serwowania ekranów pomocy tylko z instalacji Joomla. Poniższe notatki zawierają informacje, jak serwować ekrany pomocy z kilku różnych platform. Lista nie jest wyczerpująca. Nie trzeba nawet uruchamiać systemu zarządzania treścią, aby udostępniać pliki pomocy; mogą to być nawet statyczne strony HTML (czy XML).
Podstawowym założeniem przy obsłudze ekranów pomocy w Joomla 1.6 (i nowszych) jest dodanie klucza referencyjnego do pola alias artykułu. Jako że zapewnione zostało wsparcie prostych adresów, ekrany pomocy będą pobierane za pomocą aliasu także po włączeniu przepisywania adresów. Należy przy tym pamiętać, że dodanie klucza referencyjnego do pola xreference, jak to było w przypadku Joomla 1.5, nie przyniesie efektu, ponieważ nie odpowiada metodzie findkey, która została wdrożona w Joomla 1.6.
Pamiętaj, że klucze referencyjne do adresów URL będą przekazywane za pośrednictwem tłumaczenia systemu (plików językowych) i najprawdopodobniej nie będą takie same, jak klucze referencyjne widoczne w kodzie PHP dla danego ekranu.
Prawdopodobnie nie zechcesz wyświetlać żadnych menu, pasków nawigacyjnych, stopek i innych modułów zdobiących ekrany pomocy, aby nie rozpraszać użytkownika. Można w tym celu włączyć dodatkowy argument do adresu internetowego witryny serwującej pomoc, takiego jak tmpl=component, który spowoduje załadowanie domyślnego podszablonu albo template=help, który załaduje specjalnie napisany szablon „help”, ale oba te sposoby mają podstawową wadę: kliknięcie odnośnika wyświetlanego na pierwszym ekranie pomocy przenosi użytkownika z powrotem do domyślnego szablonu witryny, gdy wyświetlana jest następna strona. Oczywiście, można przypisać specjalny szablon do każdej strony ekranów pomocy, ale jest to zadanie dość pracochłonne i oznacza, że strony ekranów pomocy będą korzystać ze specjalnego szablonu „help” nawet podczas dostępu za pośrednictwem strony głównej.
Z tego powodu zaleca się, aby skonfigurować oddzielną instancję Joomla specjalnie do obsługi ekranów pomocy, a następnie utworzyć domyślny szablon, który nie zawiera żadnych zbędnych elementów.
Możliwe jest serwowanie ekranów pomocy z Joomla 1.5 w taki sam sposób, jak opisano powyżej dla Joomla 1.6. Innymi słowy przez umieszczenie każdego klucza referencyjnego w aliasie artykułu z odpowiednim ekranem pomocy. Można również skorzystać ze starej metody findkey, używanej do udostępniania ekranów pomocy w Joomla 1.5 i jego poprzedniku Joomla 1.0. Wiąże się to z wprowadzeniem klucza referencyjnego w polu Klucz odnośnika w parametrach rozszerzonych na stronie Utwórz/Edytuj artykuł.
Aby w Joomla 1.6 i nowszych uzyskać dostęp do pomocy serwowanej z Joomla 1.5 za pomocą metody findkey, adres internetowy serwera pomocy w pliku XML powinien mieć następującą postać:
http://www.domain.com/index2.php?option=com_content&task=findkey&tmpl=component&keyref={keyref}.{major}{minor}
Na przykład, jeśli chcesz, aby udostępnić pomoc związaną z kluczem referencyjnym "MenedzerMojegoKomponentu", należy umieścić informacje w artykule na serwerze pomocy Joomla i wpisać w polu Klucz odniesienia w prawym dolnym rogu edytora artykułu wartość "MenedzerMojegoKomponentu". Tytuł (ani alias) artykułu nie ma znaczenia, ponieważ nie jest używany do pobierania tego artykułu, gdy stosowany jest ten sposób uzyskiwania dostępu do systemu pomocy.
Zwróć uwagę, że wykorzystanie index2.php zamiast index.php skutkuje wyjściowym kodem HTML z minimalnym oznakowaniem artykułu, ale kolejne kliknięcie spowoduje powrót do standardowego szablonu, więc jedynym realnym rozwiązaniem jest utworzenie domyślnego szablonu witryny i przeznaczenie witryny na ekrany pomocy.
Począwszy od Joomla 1.6 oficjalne angielskie ekrany pomocy serwowane są z wiki ze strony http://docs.joomla.org, dzięki czemu system pomocy może być łatwiej i szybciej doskonalony i aktualizowany przez społeczność. Strony wiki pobierane są za pośrednictwem adresów URL, które zawierają tytuł strony. W efekcie zastosowanie kluczy referencyjnych w odniesieniu do stron wiki jest bardzo proste.
Jednakże i w tym przypadku mamy do czynienia z opisanym wcześniej problemem zbędnych elementów nawigacyjnych i innych modułów, które nie powinny być wyświetlane na ekranach użytkowników systemu pomocy. Zalecane w przypadku serwowania pomocy z Joomla postawienie osobnej instalacji Mediawiki z okrojona wersją szablonu (skórką w polskim żargonie Mediawiki) nie jest dobre, ponieważ ponieważ u podstaw pomysłu używania wiki jest zachęcenie społeczności do współtworzenia ekranów pomocy, co po zastosowaniu beznawigacyjnego interfejsu byłoby trudne do osiągnięcia.
Rozwiązanie przyjęte w brytyjskiej wersji angielskich ekranów pomocy dla Joomla 1.6 polega na wykorzystaniu serwera pośredniczącego (proxy), który wykorzystuje MediaWiki web API, aby wydobyć dane z wiki i przedstawić je w okrojonej wersji szablonu. Serwer proxy posługuje się w tym celu instancją Joomla, ale inne rozwiązania są również możliwe.
Informacje przepływają w następujący sposób. Ekran pomocy jest wywoływany przez użytkownika zalogowanego do zaplecza Joomla. Żądanie przekazywane jest do komponentu com_help w Joomla działającym na serwerze pośredniczącym http://help.joomla.org/proxy/. Komponent przetwarza żądanie, aby ustalić (odczytać) klucz referencyjny, który wykorzystuje w żądaniu o dane przesyłanym do strony wiki http://docs.joomla.org za pomocą Web API MediaWiki. Wiki zwraca żądane dane w pliku XML, które następnie wyodrębnia komponent com_help, co wymaga przeprowadzenia pewnych przekształceń, takich jak zastąpienie łączy i odnośników względnych bezwzględnymi, usunięcie nadmiarowych informacji, takich jak spisy treści i kategoryzacja. Następnie komponent tworzy stronę internetową, przepuszczając ją przez domyślny szablon HTML który dodaje nagłówki i stopki, informację o prawach autorskich i dane licencyjne, a następnie wysyła ją do przeglądarki użytkownika.