UWAGA: Strona zawiera materiały archiwalne. Większość artykułów dotyczy Joomla! 1.0
Start arrow Administracja arrow Boty arrow Boty: GeSHi - Koloruj kod
Boty: GeSHi - Koloruj kod Drukuj Email
GeSHi - Koloruj kod - GeSHi umożliwia listowanie w artykułach i materiałach statycznych kodu źródłowego programów komputerowych - koloruje w zróżnicowany sposób składnię oraz generuje łącza do specyfikacji funkcji cytowanych języków programowania.

Opis bota

Rozszerza właściwości komponentu Materiały [Content]. Spełnia podobną rolę, jak bot MOS Code (Code Support). Umożliwia listowanie w artykułach i materiałach statycznych kodu skryptów, programów komputerowych.

Zadanie bota polega na rozpoznaniu cytowanego kodu jako przeznaczonego do wyświetlenia a nie wykonania, a następnie odpowiednim sformatowaniu go.

Bot korzysta z silnika podświetlającego GeSHi. Możliwości ślicznej Gejszy są jednak znacznie bogatsze niż mosCode - może formatować w odmienny sposób aż 30 języków programowania. W Joomla! zaimplementowano możliwość zróżnicowanego podświetlania 7 języków skryptowych - CSS, HTML (Strict) javaScript, PHP, PHP Brief, SQL, XML.

Od mosCode różni go jeszcze inna cecha - nazwy funkcji zastosowanego w kodzie języka programowania są łączami do ich specyfikacji na stronach projektów. Dzięki temu użytkownik może sprawdzić znaczenie funkcji, znaczenie użytych w niej atrybutów.

Typ

Bot należy do grupy modyfikujących treść - content. Skrypty bota integrujące Gejszę z Joomla! - geshi.php.xml i geshi.php.xml - winny być umieszczone w folderze /mambots/content. Natomiast skrypty GeSHi umieszczone są w podkatalogu /mambots/content/geshi.

Stosowanie dodatku

Umieść cytowany kod programu w znaczniku HTML pre z parametrem lang i - jako atrybut- tego parametru - kodem języka. Wzór:

<pre lang="xml">Tutaj Twój kod ... </pre>

Dodatek Gejsza w wersji dla Joomla! podświetla kod następujących, najczęściej stosowanych języków programowania i skryptów:

  • CSS                  ⇒ wpisz parametr z atrybutem: lang="css"
  • Html4 Strict     ⇒ wpisz parametr z atrybutem: lang="html4strict"
  • JavaScript       ⇒ wpisz parametr z atrybutem: lang="javascript"
  • PHP                  ⇒ wpisz parametr z atrybutem: lang="php"
  • PHP Brief         ⇒ wpisz parametr z atrybutem: lang="php-brief"
  • SQL                  ⇒ wpisz parametr z atrybutem: lang="sql"
  • XML                  ⇒ wpisz parametr z atrybutem: lang="xml"

Obsługa innych języków

Jeśli cytujesz w artykułach w Twojej witrynie inne języki programowania i chcesz skorzystać z możliwości oferowanych przez Gejszę, pobierz pełną wersję GeSHi z witryny projektu.

Pobierz tutaj pełną wersję GeSHi (http://qbnz.com/highlighter/).

Aby zapewnić obsługę dodatkowych języków, wykonaj następujące czynności:

  • Rozpakuj pobrany pakiet na swoim lokalnym komputerze.
  • Odszukaj i prześlij na serwer plik nowyJęzyk.php do katalogu\mambots\content\geshi\geshi.

To wszystko! Zajrzyj jeszcze np. na stronie projektu do instrukcji, by dowiedzieć się, jakiego użyć atrybutu dla parametru lang.

Publikacja

Aby bot spełniał swe funkcje, musi być opublikowany, czyli włączony.

Instalator Joomla! nie włącza tego bota. Jeśli chcesz niego korzystać, należy go opublikować. Można również dokonać zmiany niektórych cech dodatku według opisu poniżej.

O edytorze bota

Wszystkie właściwości konfiguracyjne bota można modyfikować w edytorze: Boty: GeSHi - Koloruj kod. Otwarcie strony edytora blokuje możliwość edycji cech bota przez innych administratorów. Opuszczenie edytora bez zachowania zmian lub skorzystania z przycisku Anuluj również skutkuje blokowaniem elementu do edycji. Aby zapobiec nagłemu opuszczeniu edytora i zablokowaniu bota wyłączone są opcje menu administracyjnego. Ale inne standardowe narzędzia panelu administracyjnego są aktywne - Ścieżka powrotu, moduły poczty, moduł Wyloguj. Nie należy z nich korzystać podczas edycji właściwości bota. Z tych samych powodów nie należy korzystać przycisku Wstecz przeglądarki!.

Pasek narzędzi znajduje się w prawym górnym rogu okna. Poniżej, w obszarze roboczym znajduje się dwuczęściowy formularz właściwości dodatku. Po stronie lewej - właściwości ogólnych, zwanych detalami, po prawej - parametrów. Jeśli dodatek nie wymaga ustawiania parametrów, znajdziesz tam stosowny komunikat.

Pasek narzędzi

W pasku narzędzi znajdują się 4 przyciski. Ich funkcje są następujące:

Przycisk Zapisz Zapisz [Save]: Zachowuje wprowadzone zmiany. Kończy pracę w edytorze bota. Odblokowuje bota do edycji przez innych administratorów. Kliknij ten przycisk, aby zakończyć edycję właściwości bota i powrócić do menedżera .

Przycisk: Zastosuj Zastosuj [Apply]: Umożliwia zapisanie efektów pracy bez opuszczania edytora bota. Jeśli edycja trwa dłużej niż domyślny czas trwania sesji, chroni przed automatycznym wylogowaniem i utratą niezapisanych danych. Kliknij ten przycisk, aby zapisać dotychczas wprowadzone zmiany. Potem możesz kontynuować pracę lub opuścić edytor, wydając polecenie Zapisz lub Anuluj.

Przycisk: Anuluj Anuluj [Cancel]: Umożliwia opuszczenie edytora bota bez zapisywania zmian wprowadzonych po ostatnim ich zachowaniu. Odblokowuje bota do edycji przez innych administratorów. Kliknij ten przycisk, aby zakończyć edycję właściwości bota i powrócić do menedżera. Wszystkie zmiany wprowadzone po ostatnim użyciu przycisku Zastosuj zostaną utracone.

Przycisk: Pomoc Pomoc [Help]: Wywołuje okno pomocy podręcznej, objaśniającej właściwości bota i znaczenie opcji dostępnych w edytorze. Korzystaj z tego przycisku, ilekroć potrzebujesz objaśnień na temat właściwości edytowanego elementu.

Szczegóły bota

Każdy bot charakteryzuje się 7 podstawowymi właściwościami.

Edycja właściwości bota GeSHi

Znaczenie i sposób definiowania właściwości omówiono poniżej:

  • Nazwa [Mambot Name]: Nazwa widoczna jest tylko w panelu administracyjnym. Nie jest używana do rozpoznawania dodatku przez Joomla!. Możesz ją dowolnie zmieniać lub pozostawić bez zmian. Wpisz dowolny, ale objaśniający rolę dodatku tekst.
  • Folder [Folder]: Oznacza typ bota. Wskazuje, w którym z folderów katalogu /mambots umieszczone są jego pliki. Bot GeSHi - Koloruj kod należy do typu content. Jego pliki winny być umieszczone w folderze /mambots/content
  • Plik dodatku [File]: Nazwa pliku zawierającego główny skrypt bota (bez rozszerzenia ’.php’). W przypadku, gdy edytujesz właściwości zainstalowanego bota, nie zmieniaj tej nazwy!
  • Kolejność [Order]: Kolejność uaktywniania funkcji opublikowanego bota, a nie tylko w wykazie!. Możesz zmienić jedynie uporządkowanie botów w granicach jednego typu. Aby ustalić kolejność, kliknij nazwę bota, przed którym chcesz umieścić dodatek aktualnie edytowany. Jeśli boty działają poprawnie, ich kolejność należy pozostawić bez zmian!. Kolejności niektórych botów nie można zmienić.
  • Uprawnienia [Acces Level]: Wybór jednej z grup ustala prawa do korzystania z funkcji bota. Dysponujesz trzema opcjami:
    • Public - dostęp publiczny: funkcje opublikowanego bota będą dostępne dla wszystkich użytkowników,
    • Registered - dostęp ograniczony dla zarejestrowanych: funkcje opublikowanego bota będą dostępne tylko dla zalogowanych użytkowników,
    • Special - dostęp ograniczony specjalny: funkcje opublikowanego dodatku będą dostępne tylko dla zalogowanych użytkowników z uprawnieniami specjalnymi - autorów, redaktorów, wydawców, operatorów i administratorów. Prawa dostępu użytkownikom w menu Witryna ⇒ Użytkownicy [Site ⇒ User Manager].
  • Opublikowany [Published]: Tak włącza funkcje bota, Nie wyłącza działanie.
  • Opis [Description]: Opis funkcji bota i instrukcje objaśniające sposób korzystania z dodatku. Treść opisu pobierana jest z pliku .xml dodatku z sekcji description.

Parametry

Dla tego dodatku nie określa się żadnych parametrów.

Widok komunikatu: Parametrów nie określa się

Tematy pokrewne

Zapoznaj się również artykułami:


Uwagi, źródła

Jeżeli masz sugestie odnośnie treści lub chcesz zgłosić poprawki do tego rozdziału, skomentuj go albo umieść wiadomość na forum: Dokumentacja - Propozycje, zmiany, poprawki

Dziękujemy!

Stefan Wajda, Zespół Dokumentacji PCJ

 
« poprzedni artykuł   następny artykuł »