Własny szablon: Jak to działa

Z JoggerWiki
Skocz do: nawigacji, wyszukiwania

Jak to działa?

Znaczniki

W Joggerze większość znaczników wstawia się w specjalne bloki. Bloki mają dwa zadania:

  1. W przypadku wpisów, listy odnośników, listy pozycji archiwum i komentarzy blok pokazuje Joggerowi, którą część szablonu ma powtórzyć wyświetlając kolejny wpis, komentarz itd. Tak więc wszystko co umieścimy w bloku COMMENT_BLOCK będzie powielone wraz z każdym dodanym komentarzem.
  2. Są też trzy bloki, które mają inne zadanie. Chodzi o ADMIN_BLOCK, LOGGED_USER_BLOCK, NOUSER_BLOCK - treść w nich zawarta jest widoczna tylko dla określonych użytkowników (odpowiednio: dla właściciela, gościa zalogowanego i gościa niezalogowanego). Na przykład, tagi z grupy <ADMIN_[...]_HREF/> można wstawić do bloku <ADMIN_BLOCK>, by zwykli odwiedzający nie widzieli linków administracyjnych.

Niektóre tagi funkcjonują zupełnie samodzielnie i mogą zostać użyte wszędzie. Zaliczają sie do nich przede wszystkim tagi pokazujące status Jabbera, opis i ikonkę dostępności oraz 3 inne znaczniki (<JID/>, <ALL_ENTRIES_HREF/> i <COMMENT_FORM/>).

Obowiązują dwa sposoby zapisu tagów pojedynczych, tj. takich, które wstawiają określony tekst. Oprócz zwykłego <NAZWA_ZNACZNIKA/>* można napisać &NAZWA_ZNACZNIKA;. Drugiego sposobu można użyć wtedy, gdy tag ma być argumentem jakiegoś atrybutu HTML, dzięki czemu uzyskamy well-formed XML. Np. <img src="/files/obrazek.gif" alt=""/> lub <a href="&ARCHIVE_HREF;"> <ARCHIVE_HREF_DESCR/></a>

  • - Uwaga: ważne jest, by w zapisie <NAZWA_ZNACZNIKA/> przed znakiem "/" (slash) nie było spacji. Więcej: Bugger - zgłoszenie nr 47.

Co zmienić w ustawieniach?

By Jogger użył niestandardowego schematu, należy zmienić w ustawieniach dwie opcje: Własne szablony dla strony joggera i Własne szablony dla komentarzy. Mamy tam do wyboru dwa różne "tak".

Tak, uproszczony
Kiedyś był to jedyny sposób obsługi szablonów. Polega to na tym, że szablon składa się jedynie z zawartości elementu BODY. Nie należy nawet umieszczać żadnego DTD, <head> i tym podobnych. Pominąć trzeba także sam znacznik <body> oraz </body>. Wszystko dlatego, że Jogger sam uzupełni szablon i ostatecznie wyświetli poprawną stronę. Na początek pliku zostanie wstawione np.: 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="pl">

<head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <meta name="robots" content="noindex, nofollow">
        <title>Jogger :: staszyna@chrome.pl</title>
        <link rel="stylesheet" href="/files/style.css" type="text/css">
</head>

<body>

A na koniec: 

</body>
</html>

Plik /files/style.css to CSS naszego szablonu. Musi być oddzielnym plikiem, bo przy uproszczonych schematach nie mamy dostępu do elementu HEAD. Dodatkowo można zauważyć, że nie mamy wpływu na DOCTYPE schematu ani na tytuł joga. Drugi problem rozwiązał marcoos, pierwszy jest nierozwiązywalny. I właśnie z tego powodu powstał drugi sposób obsługi schematów.

Tak, pełny
Jeśli wybierzemy tę opcję, Jogger nie będzie ingerował w kod schematu. Mamy więc pełną swobodę w ustawianiu np. DTD, znaczników meta, tytułu, elementów LINK, języka joga itd. Dwie wskazówki:

  1. zalecane jest, by wstawić następujący znacznik meta: <meta name="robots" content="noindex, nofollow" />. Dlatego.
  2. ścieżka do wgranych do Joggera plików stylów CSS to /files/nazwa_pliku.css, co za tym idzie aby użyć arkusza styli należy wstawić: 
    <link rel="stylesheet" href="/files/nazwa_pliku.css" type="text/css" title="Podstawowy styl" />

Dodatkowo, Jogger daje nam możliwość ustawienia typu MIME plików szablonu, dzięki czemu osiągalna jest pełna poprawność XHTML 1.1. W panelu administracyjnym można wybrać przy pozycji Typ MIME następujące opcje: (podaję za marcoosem)

  • text/html - dobry dla HTML 4, dozwolony dla XHTML 1.0
  • application/xhtml+xml - zalecany dla XHTML 1.0, wymagany dla XHTML 1.1, XHTML Basic i pewnie kiedyś XHTML2.0
  • NOWY! application/xml - więcej: Bugger - zgłoszenie nr 57 (OK).
  • negocjacja typu mime - jeśli User Agent akceptuje application/xhtml+xml - wyślij jako application/xhtml+xml, jeśli nie - wyślij jako text/html (błędnie, ale żeby działało). Wszystkiemu winne jest oczywiście MSIE, które w ogóle nie rozumie application/xhtml+xml i pliki XHTML wysłane w ten sposób próbuje zapisać na dysku użytkownika.

Co trzeba przygotować?

Najlepiej przygotować trzy pliki: szablon strony głównej, szablon strony z komentarzami i plik (pliki) CSS. Jeśli nie zrobimy np. strony komentarzy, Jogger użyje zaznaczonego w ustawieniach gotowego schematu. Można też oczywiście style CSS umieścić w sekcji HEAD szablonu, pod warunkiem, że używamy pełnych schematów. Jednak zewnętrzny plik arkusza stylów wydaje się być wygodniejszym rozwiązaniem. Można to także połączyć, ogólne style spiąć w oddzielnym pliku, a definicje potrzebne tylko np. do strony komentarzy umieścić już w samym szablonie. Należy tylko pamiętać o umieszczaniu bezwględnych ścieżek do plików (/files/blabla.png zamiast files/blabla.png), gdyż strony wpisów, komentarzy itd. są umieszczane w podkatalogach.

Pliki (do 1MB) można wgrać do Joggera poprzez panel administracyjny, Wszystkie umieszczone będą w katalogu /files/

Grafika może być oczywiście dowolna, z bardziej nietypowych rzeczy można przygotować favikonę a także dwa pliki, których Jogger będzie używał do pokazywania statusu właściciela. Te dwa pliki muszą nazywać się online.png i offline.png (patrz też: opis <STATUS_IMAGE/>).

Kilka wskazówek

  • Polecam walidator (X)HTML i walidator CSS.
  • Nie jest to wymagane w żadnym regulaminie, ale przez internetową uprzejmość można umieścić w szablonie np. taką stopkę:
Powered by <a href="http://www.jogger.pl">Jogger</a>.
Copyright (c) 2002-2003 Justin Mecham oraz JabberPL Group.<br />
Wszystkie prawa zastrzeżone. <a href="http://jogger.pl/info.php?id=legal">Legalność</a>;

<a href="http://www.jogger.pl/about.php">Informacje</a>
  • Dobrze jest zadbać o przejrzysty layout - czytający powinien od razu wiedzieć, który wpis czyta, który skomentuje klikając odpowiedni link, a nawet która data odnosi się do którego wpisu.
  • Należy pamiętać o oczach czytelników.
  • Jeśli robicie szablon w poprawnym XHTML, to i tak to zrobicie, ale na wszelki wypadek przypominam o atrybucie alt przy grafice. Jeśli grafika jest wyłącznie dekoracyjna i nie ma wpływu na treść lub działanie użytkownika, należy dodać alt="". Polecam bardzo ciekawy artykuł o atrybutach alt.
  • UNIKOD!!! to bardzo wa?ne, nawet je?li jedynym tekstem jaki znajdzie si? w czystym szablonie b?dzie stopka. W Windows można albo za pomocą Ogonk?w 97, albo zapisuj?c pliki w systemowym Notatniku z kodowaniem UTF-8. (brak polskich znaków celowy)

Zmiany w nazwach znaczników

By uprościć i ujednolicić nazewnictwo Joggerowych znaczników, zmienione zostały nazwy nastepujących tagów: 

ENTRIES_BLOCK --> ENTRY_BLOCK
ENTRIES_DAY --> ENTRY_DAY_BLOCK
COMMENT_HREF --> ENTRY_COMMENT_HREF

COMMENT_HREF_DESCR --> ENTRY_COMMENT_HREF_DESCR
USER_LOGIN_HREF --> USER_LOG_IN_HREF
USER_BLOCK --> LOGGED_USER_BLOCK
USER_LOGIN_NAME --> LOGGED_USER_NAME
USER_LOGOUT_HREF --> LOGGED_USER_LOG_OUT_HREF

PUT_JID --> JID
IMAGES_DIR --> CUSTOM_DIR
Źródło „http://wiki.jogger.pl/index.php?title=Własny_szablon:_Jak_to_działa&oldid=3755”