--=REKLAMA=--
--=REKLAMA=--
Każdy ekran zaplecza administracyjnego Joomla lub rozszerzenia Joomla, które ma swój obszar na zapleczu, powiązane jest z unikalnym kluczem referencyjnym, który używany jest do generowania adresu URL, z którego pobierane są informacje systemu pomocy podręcznej. Joomla konwertuje ten klucz referencyjny na adresy URL, które są wywoływane przez przyciski Pomoc w paskach narzędzi (przybornikach). Po kliknięciu przycisku otwiera się nowe okno przeglądarki ze stroną z wygenerowanego adresu URL. W przypadku brytyjskich ekranów pomocy podręcznej adresy URL prowadzą do odpowiedniej strony dokumentacji wiki Joomla, tak, aby ekrany pomocy mogły być utrzymywane i aktualizowane przez społeczność Joomla. Dla Joomla klucze referencyjne są znormalizowane, a ich pełna lista dostępna jest dla Joomla 2.5 tutaj, a dla Joomla 3.x. Projektanci rozszerzeń mogą konstruować własne klucze referencyjne i zapewnić swoje własne ekrany pomocy.
Dostępne serwery pomocy definiowane są w pliku XML, który może zawierać odrębne pozycje dla każdego zainstalowanego języka. Domyślny serwer pomocy ustawiany jest w Konfiguracji globalnej i może być zastępowany przez poszczególnych użytkowników w ich profilach. Listy dostępnych serwerów pomocy można zmieniać ręcznie, edytując plik XML znajdujący się w systemie plików Joomla /administrator/help/helpsites-MM.xml, gdzie mm to główne i podrzędne numery wersji Joomla łączone bez kropki (np. '25' dla Joomla 2.5). Na przykład, ścieżka pliku helpsites dla Joomla 2.5 to /administrator/help/helpsites-25.xml. Format pliku XML opisany jest tutaj.
Jeśli nie zostanie określony zewnętrzny adres internetowy ekranów pomocy, system będzie poszukiwać lokalnych plików pomocy w katalogu /administrator/help/ln-LN. Domyślna dystrybucja Joomla zawiera kompletny zestaw brytyjskich (en-GB) lokalnych plików pomocy, ale są to tylko atrapy zawierające klikalne łącza do najnowszych ekranów pomocy, które serwowane są z dokumentacji wiki Joomla.
Adres URL, który wywołuje przycisk na pasku narzędzi, zbudowany jest z połączenia adresu URL serwera pomocy podanego w pliku XML oraz z klucza referencyjnego ekranu pomocy i innych informacji kontekstowych. Osiąga się to poprzez podstawienie zawartości w miejsce kodów (znaczników) w adresie serwera pomocy w pliku XML. Kody te zastępowane są przez informacje kontekstowe, aby wygenerować ostateczny adres URL, który będzie używany przez system pomocy. Pełną listę kodów można znaleźć tutaj
Należy pamiętać, że adresy mogą być całkowicie zlokalizowane - przed podstawieniem do adresu URL klucze referencyjne ekranów pomocy są modyfikowane przez system tłumaczenia interfejsu. Na przykład ekran Menedżer artykułów jest powiązany z kluczem referencyjnym "JHELP_CONTENT_ARTICLE_MANAGER".
W przypadku pomocy brytyjskiej angielski plik językowy en-GB.ini zawiera wpis:
JHELP_CONTENT_ARTICLE_MANAGER = "Content_Article_Manager"
Dlatego do adresu URL jako klucz referencyjny zostanie podstawiony ciąg "Content_Article_Manager". Plik helpsites-25.xml definiuje domyślny adres URL serwera pomocy w w brytyjskiej odmianie angielskiego (en-GB):
http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help{major}{minor}:{keyref}
Ten adres zawiera kilka kodów odnoszących się do podstawowego punktu odniesienia, {keyref}. W tym przykładzie kody {major} i {minor} zastępuje się odpowiednio numerem wersji głównej i rozwojowej (dodatkowym), tak że w efekcie zostanie wygenerowany adres
http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help25:Content_Article_Manager
Zobacz pełne listy kodów referencyjnych systemu pomocy:
Nie istnieją żadne ograniczenia w strukturze adresu serwera pomocy określonego w pliku XML (helpsites-MM.xml) poza oczywistym wymogiem, że po podstawieniu kodów musi prowadzić w pożądane miejsce. Na przykład, jeśli chcesz korzystać z instalacji Joomla 1.5 jako serwera pomocy, to możesz skorzystać z "tradycyjnego" mechanizmu dostępu, używajac formy adresu:
http://www.domena.com/index2.php?option=com_content&task=findkey&tmpl=component&keyref={keyref}.{major}{minor}
W tym przypadku trzeba dodać klucz referencyjny do pola Klucz odnośnika w kazdym artykule Joomla powiązanym z systemem pomocy. Przykładowo, jeśli chcesz dostarczyć informacji pomocniczych związanych z kluczem referencyjnym MójKomponent_Menedżer, to należy napisać artykuł z pomocnymi informacjami i w opcjach artykułu w polu Klucz odnośnika w prawy dolnym rogu ekranu edytora artykułu wpisać "MójKomponent_Menedżer". Tytuł (lub alias) artykułu nie ma znaczenia, ponieważ nie jest on używany przez system pomocy do pobierania tego artykułu.
Podsumowując, aby wygenerować adres wywoływany przez przycisk Pomoc, wykonywane są następujące kroki:
Klucz referencyjny ekranu pomocy ---> Tłumaczenie języka ---> wzorzec adresu URL w pliku helpsites.xml ---> Przycisk w przyborniku
Należy pamiętać, że klucze referencyjne ekranów pomocy zmieniły się w sposób znaczący między Joomla 1.5 i 1.6. Główne klucze referencyjne stosowane w Joomla 1.5 można znaleźć tutaj, używane w Joomla 2.5 tutaj, a używane w Joomla 3.x tutaj.