--=REKLAMA=--

System pomocy/Dodanie przycisku pomocy do przybornika

Z Joomla!WikiPL

Jeśli zobaczysz kod jednego z wielu wbudowanych komponentów Joomla, możesz znaleźć sposób na dodanie przycisku pomocy do paska narzędzi komponentu, który to będzie odwołaniem do komponentu Banners:

JToolBarHelper::help( 'JHELP_COMPONENTS_BANNERS_BANNERS' );

Pojedynczy argument jako klucz referencji jest początkowo pozbawiony lokalizacji, lecz po przekazaniu do JText::_() zyskuje lokację, która będzie wyświetlana w adresie URL. To powszechny sposób na zebranie całego paska narzędzi w pliku komponentu widoku (view.html.php).

Tym niemniej, to wywołanie tylko ekranu pomocy na domyślnym serwerze pomocy, co w rzeczywistości użyteczne jest tylko w przypadku wbudowanych komponentów. Dla programistów którzy chcą dodać ekran pomocy do ich rozszerzeń, muszą dodać dodatkowe argumenty w JToolBarHelper::help.

Istnieje bowiem wiele sposobów na zlokalizowanie plików pomocy systemu, co przekłada się na tworzenie elastycznego wsparcia dla odbiorców. Pierwszym krokiem w dodaniu wsprarcia do Twojego rozszerzenia to zdecydowanie, gdzie pliki pomocy będą się znajdować. Najczęściej znajdują się w dystrybucji rozszerzenia. Może warto się zastanowić, czy nie umieścić ich na innej stronie?

Pomoc lokalna

Jeśli materiały pomocy są dołączone do instalowanego rozszerzenia, to drugi argument w JToolBarHelper::help powinien być ustawiony na "true", tak jak w przykładzie poniżej:

JToolBarHelper::help( 'MY_COMPONENT_HELP_VIEW_TYPE1', true );

To wywołanie dla języka klucza MY_COMPONENT_HELP_VIEW_TYPE1 używa do znalezienia wartości, jeśli nie to się nie powiedzie, to następuje konstrukcja lokalnej ścieżki do plików pomocy. Na przykład, jeśli plik języka komponentu /language/pl-PL/pl-PL.com_my_component.ini zawiera ciąg klucz - wartość.

MY_COMPONENT_HELP_VIEW_TYPE1="view_type1"

wówczas ścieżka skonstruowanego pliku to

/components/com_my_component/help/en-GB/view_type1.html

Uwagi dla zaawansowanych

  • plik rozszerzenia może przyjąć rozszerzenia .html (jako domyślne) lub .xml. Aby użyć rozszerzenia .xml, powinieneś użyć formatu DocBook, po czym wprowadzić odwołanie w pliku języka. Na przykład, jeśli kluczem-wartośią będzie MY_COMPONENT_HELP_VIEW_TYPE1="view_type1.xml", to ścieżką będzie /components/com_my_component/help/pl-PL/view_type1.xml.
  • możesz ustalić inną sieżkę niż wyznacza to ścieżka komponentu dołączając "helpURL" jako parametr w Twoim komponencie.
  • możesz nadpisać własne materiały pomocy z poziomu strony dodając łańcuchy znaków, które nadpiszą język systemu

Zewnętrzna pomoc

Jeślu rozwijasz rozszerzenie Joomla i chciałbyś umieścić materiały pomocy na własnym serwerze, jest możliwe nadpisać generowane przez Joomla adresów URL, poprzez uzyskanie pełnej kontrolu nad ich lokalizacją. Na przykład, jeśli serwer pomocy znajduje się na http://www.example.com/pl-PL/help-server i hostujesz tam wszystkie pliki pomocy. Wówczas:

$help_url  = 'http://www.example.com/{language}/help-server';
JToolBarHelper::help( 'MY_COMPONENT_HELP_VIEW_TYPE1', false, $help_url );

jako pary klucz-wartość with language key-value pair

MY_COMPONENT_HELP_VIEW_TYPE1="view_type1"

będzie generować http://www.example.com/pl-PL/help-server/view_type1 jako URL pomocy. Zauważ, że dla anglosaskich użytkoników (w tym przykładzie Wielka Brytania) przeznaczony jest adres http://www.example.com/en-GB/help-server/view_type1_in_english, natomiast plikiem z parami klucz-wartość będzie /language/en-GB/en-GB.com_my_component.ini

MY_COMPONENT_HELP_VIEW_TYPE1="view_type1_in_English"

W budowaniu adresów URL z materiałami pomocy istnieje duża dowolność, nie ma potrzeby hostować materiałów pomocy na instancji Joomla (które miało miejsce w Joomla przed wersją 1.6). Materiały pomocy to zwyczajne strony, strony wiki, fora, sieci społecznościowe itp.

Zauważ, że dokumentacja wiki Joomla http://docs.joomla.org nie jest używana do hostowania materiałów pomocy. Strony stworzone w tym celu będą usuwane.

Uwagi dla zaawansowanych

Choć możliwe jest dołączenie nazwy komponentu w adresie, ale istnieją sytuacje, w których może chcesz nadpisać nazwę komponentu automaczynie. Na przykład, jeśli chcesz wiele komponentów jako częśći pakietu, ale chcesz aby wszystkie odwoływały się do tych samych materiałów pomocy, o ile są częścią tego samego komponentu. W podobnych przypadkach jest możliwe, aby podać czwarty argument do JToolBarHelper::help, który nadpisze nazwę komponentu. Na przykład:

JToolBarHelper::help( 'MY_COMPONENT_HELP_VIEW_TYPE1', false, '', 'com_mycomponent' );

z URL określonym jako

http://www.example.com/{komponent}/{klucz}/{kod_jezyka}

będzie generować URL (dla polskich użytkowników)

http://www.example.com/com_mycomponent/view_type1/pl

Zobacz także

© Ten materiał jest dokładnym albo swobodnym tłumaczeniem artykułu http://docs.joomla.org/Help_system/Adding_a_help_button_to_the_toolbar udostępnionego na licencji JEDL na witrynie: Oficjalnej dokumentacji Joomla!.Pierwszy autor oryginału: Davenport Chris Davenport.


Dziękujemy za wkład

» Procek (Łukasz Leśniewski),