Szablony: Różnice pomiędzy wersjami

Z JoggerWiki
Skocz do: nawigacji, wyszukiwania
(→‎Wpisy)
(→‎Wpisy)
Linia 28: Linia 28:
 
* <code><ENTRY_BLOCK></code>
 
* <code><ENTRY_BLOCK></code>
 
** <code><ENTRY_SUBJECT></code>
 
** <code><ENTRY_SUBJECT></code>
−
** <code><ENTRY_CONTENT_SHORT/>/code>
+
** <code><ENTRY_CONTENT_SHORT/></code>
 
** <code><ENTRY_CONTENT_SHORT_EXIST></code>
 
** <code><ENTRY_CONTENT_SHORT_EXIST></code>
 
** <code><ENTRY_CONTENT_LONG/></code> <small>(strona komentarzy)</small>
 
** <code><ENTRY_CONTENT_LONG/></code> <small>(strona komentarzy)</small>

Wersja z 04:57, 23 wrz 2007

Wytyczne dla twórców szablonów

WORK IN PROGRESS

Szablon dostępny publicznie musi być odporny na większość zmian przeprowadzanych przez początkującego bloggera z poziomu panelu. Musi być także kompletny oraz przetestowany w naturalnych warunkach (np: podgląd komentarza, zablokowanie komentarzy)

Elementy obowiązkowe

Podstawowy szablon musi mieć następujące części:

  • Wpisy
  • Przeglądanie stron wpisów (kategorii, archiwum)
  • Komentarze
  • Formularz dodawania komentarza
  • Podgląd komentarza
  • Link do logowania / wylogowania
  • Adres trackback
  • RSS wpisów i komentarzy
  • Lista stron
  • Lista grup linków

W przypadku RSS dopuszczalne jest skorzystanie z konstrukcji <link/> w części <head></head> dokumentu.

Wpisy

Wymagane tagi:

  • <ENTRY_BLOCK>
    • <ENTRY_SUBJECT>
    • <ENTRY_CONTENT_SHORT/>
    • <ENTRY_CONTENT_SHORT_EXIST>
    • <ENTRY_CONTENT_LONG/> (strona komentarzy)
    • <ENTRY_COMMENT_HREF/>

Należy zakładać, że blogger może chcieć skrócić wpis za pomocą taga <EXCERPT>, dlatego wymagane jest korzystanie na stronie wpisów z tagów <ENTRY_CONTENT_SHORT/> i <ENTRY_CONTENT_SHORT_EXIST></ENTRY_CONTENT_SHORT_EXIST> wraz z linkiem do dalszej części wpisu. Na stronie komentarzy należy skorzystać z <ENTRY_CONTENT_SHORT/> i <ENTRY_CONTENT_LONG/> otoczonego elementem z (na przykład) id="more", aby link kierował od razu do dalszej części, a nie początku wpisu.

Przeglądanie stron wpisów

Wymagane tagi:

  • <PAGE_BLOCK_EXIST>
  • <PAGE_PREV_EXIST>
    • &PAGE_PREV_HREF;
  • <PAGE_NEXT_EXIST>
    • &PAGE_NEXT_HREF;

Komentarze

Wymagane tagi:

  • <COMMENT_BLOCK_EXIST>
  • <COMMENT_BLOCK>
  • <COMMENT_NICK/>
  • <COMMENT_CONTENT/>
  • <COMMENT_EDIT_EXIST>
    • &COMMENT_EDIT_HREF;
  • <COMMENT_ALLOWED_BLOCK>
  • <COMMENT_NONE_BLOCK>
  • <COMMENT_LOGGED_BLOCK>

Należy pamiętać o 3 ostatnich tagach określających czy komentowanie zostało zablokowane. W przypadku monitu o login, powinno się podać adres http://login.jogger.pl/login/ jako że chodzi o logowanie joggerowców (poziom 2 wpisu), a nie użytkowników tego jednego bloga.

Pierwszy tag stosuje się, aby stwierdzić czy już jakieś komentarze się pojawiły (szablon nie przejdzie walidacji, jeśli będzie pusty <ol> gdzie zwykle umieszcza się komentarze).

Wymagany jest także link edycji komentarza, aby nie dokładać problemów komentującemu.

Standardowe tagi:

  • &COMMENT_ID;
  • <COMMENT_DATE/>
  • <COMMENT_HOUR/>
  • <ADMIN_BLOCK>
    • &ADMIN_COMMENT_EDIT_HREF;
    • &ADMIN_COMMENT_BLOCKIP_HREF;
    • &ADMIN_COMMENT_REMOVE_HREF;

Warto podać (i prawie zawsze jest na to miejsce) czas dodania komentarza oraz linki administracyjne. Przydaje się też permalink do komentarza – można podlinkować w tym przypadku timestamp.

Formularz dodawania komentarza

Wszystkie tagi są obowiązkowe. Należy pamiętać, że istnieją 3 stany formularza:

  • Admin – widzi 2 pola (treść, podpis)
  • Joggerowiec – widzi 3 pola (treść, podpis, śledzenie wątku (checkbox włącz / submit wyłącz)
  • Gość - widzi cztery pola (treść, podpis, strona www, kod catpcha)

Podgląd komentarza

Wymagane tagi:

  • <COMMENT_PREVIEW_EXIST>
    • <COMMENT_PREVIEW_BODY/>

Z uwagi na możliwość użycia Textile, ważne jest aby zapewnić komentującemu możliwość podejrzenia komentarza.

Na przycisk Podgląd powinien być położony mniejszy nacisk niż na Dodaj komentarzy – można to prosto osiągnąć przez pogrubienie tekstu w "Dodaj". Zazwyczaj umieszcza się go po prawej stronie od "Dodaj", ale zależy też wiele od designu.

Kwestia przewinięcia do podglądu - nie zaleca się dodawania "#id-preview" do action="" formularza, ponieważ zostanie on dodany do paska adresu nawet jeśli nie użyliśmy podglądu, a po prostu wysłaliśmy komentarz. Potrzebna tutaj jest ingerencja ze strony Joggera.

Jesli uzywamy <ol> do pokazywania listy komentarzy i z tego powodu okalamy ją <COMMENT_BLOCK_EXIST> (walidacja gdy nie bedzie zadnych komentarzy), podgląd nie może byc umieszczony w tej samej liście – gdy nie będzie żadnego komentarza, nie będzie można też użyć podglądu.

Logowanie

Jogger dość mocno zaznacza opcje prywatności - należy umożliwić bloggerom skorzystanie z nich przez zalogowanie się na blog.

Można to zrobić na dwa sposoby - albo użytkownikiem jest ktoś spoza Jogger.pl, albo jego użytkownik. W pierwszym przypadku musi widzieć link href="&USER_LOG_IN_HREF;", w drugim najlepiej href="http://login.jogger.pl/login/".

Adres trackback

Wymagane tagi:

  • <ENTRY_TRACKBACK_EXIST>
  • &ENTRY_TRACKBACK_HREF;

Link do trackbacka powinien być zawsze widoczny.

O wiele ważniejsze jednak jest rozdzielenie trackbacków i komentarzy w szablonie. Domyślnie wyświetlane są razem, ale istnieje możliwość przygotowania miejsca w szablonie gdyby blogger zmienił ustawienia.

RSS

RSS* powinien być obowiązkowo dodany do <head> szablonu. Warto też dodać go na stronie komentarzy, bowiem często umyka możliwość śledzenia wątku.

Nie zaleca się korzystania z tagi &RSS;, ponieważ nowocześniejszym i lepszym wyborem jest stadard Atom.

* - jako nazwa technologii, nie standardu

Lista stron

Wymagane tagi:

  • <PAGES_BLOCK_EXIST>
  • <PAGES_BLOCK>
    • &PAGES_HREF;
    • <PAGES_HREF_DESCR/>

Lista grup linków

Wymagane tagi:

  • <LINK_GROUP_BLOCK>
    • <LINK_GROUP_DESCR/>
    • <LINK_BLOCK>
      • &LINK_HREF;
      • <LINK_HREF_DESCR/>
      • <LINK_XFN_EXIST>
        • &LINK_XFN_REL;

Z uwagi na możliwość stworzenia wielu grup linków, należy zawsze umieszczać konstrukcję pozwalającą na wyświetlenie ich wszystkich. Należy też dodawać opcjonalny atrybut relacji XFN, ponieważ jest to dość mocno zaznaczone w panelu ze względu na ważność tego mikroformatu.

Elementy standardowe

Poniższe elementy mogą być pominięte, jeśli układ / design szablonu nie pozwala bądź znacznie utrudnia dodanie takich elementów. Brak n/w nie uniemożliwia korzystania z bloga, aczkolwiek nie zaleca się usuwania na raz listy archiwum i kategorii.

  • Tytuł bloga
  • Miniblog
  • Tagi wpisu
  • Przeglądanie wpisów pojedynczo (poprzedni, następny)
  • Lista archiwum
  • Lista kategorii

W przypadku minibloga, specjalnie oddzielona lista wpisów jest bardzo mile widziana i jeśli tylko da się ją umieścić w sidebarze bloga, powinno się tak robić.

Źródło „http://wiki.jogger.pl/index.php?title=Szablony&oldid=3652”