Pomoc:Używanie kodu HTML

Z Wikipedii, wolnej encyklopedii
Skocz do: nawigacja, szukaj

Korzystanie ze znaczników HTML nie jest zalecane i powinno się go unikać na korzyść formatowania dostępnego w mechanizmie Wiki.

Uwagi na temat korzystania ze znaczników XHTML powstały ze względu na to, że niektóre strony, na których są powstawiane długie fragmenty kodu napisanego w XHTML, źle wyświetlają się w części przeglądarek i przy niektórych rozdzielczościach ekranu.

Uwagi wstępne[edytuj | edytuj kod]

Mechanizm wiki[edytuj | edytuj kod]

Ideą oprogramowania wiki to jest, aby można było swobodnie edytować tekst i wstawiać go na strony World Wide Web bez konieczności znajomości języka znaczników XHTML.

Zamiast tego, oprogramowanie wiki umożliwia wstawianie linków, grafiki, i formatowania tekstu za pomocą prostych znaków, łatwych do użycia dla każdego.

Mechanizm wiki jest oparty na oprogramowaniu Media-Wiki napisanym w języku skryptowym PHP. W dużym uproszczeniu skrypty te generują XHTML na podstawie zbioru danych zwartych w specjalnej bazie danych i wysyłają go do przeglądarek użytkowników. Wszystkie znaki specjalne wiki są więc automatycznie konwertowane na odpowiednie znaczniki XHTML i w zasadzie zazwyczaj nie ma powodu ich używania bezpośrednio w tekstach artykułów.

Powody, dla których lepiej nie używać XHTML w artykułach Wikipedii[edytuj | edytuj kod]

  • Kod XHTML wstawiany do tekstów artykułów może się z różnych względów "gryźć" z kodem generowanym przez skrypt PHP odpowiedzialny za całą Wikipedię. Czym dłuższy i bardziej złożony kod wstawiony "ręcznie" do tekstu artykułu tym ryzyko takich konfliktów rośnie.
  • Większość edytorów Wikipedii nie zna (i wcale nie musi znać) XHTML. Artykuły w których ten kod występuje są dla nich trudne do edycji, lub wręcz niemożliwe, a przecież ideą Wikipedii jest to, aby każdy mógł w każdej chwili zmieniać treść artykułów.
  • Raz wstawiony kod XHTML - nawet jeśli jest poprawny - może ulec uszkodzeniu przez edytora, któremu "zdaje się", że potrafi to "zrobić lepiej".
  • Ze względu na to, że Wikipedia może kiedyś zostać przeniesiona do innych mediów niż WWW, kod XHTML w tekście artykułów może w przyszłości bardzo utrudniać ten transfer, a jego usuwanie będzie wymagać dużo żmudnej pracy.

Kiedy warto korzystać z XHTML[edytuj | edytuj kod]

Mimo wszystko, czasami zdarzają się sytuacje, kiedy warto użyć znaczników XHTML. Dotyczy to przede wszystkim tworzenia złożonych tabel ułatwiających zebranie dużych ilości danych w zgrabną formę. Przykładem takiego rozsądnego zastosowania XHTML może być np. Układ okresowy pierwiastków.

Za każdym razem, przed wstawieniem XHTML warto się jednak zastanowić czy nie da się tego samego zrobić za pomocą zwykłych metod wiki.

Kiedy absolutnie nie należy korzystać z XHTML[edytuj | edytuj kod]

  • Przy edycji prostego tekstu - mechanizm wiki daje tu absolutnie wystarczające środki, aby tego nie czynić. Patrz: Pomoc:Formatowanie tekstu. Szczególnie niemile widziane jest "siłowe" formatowanie tekstu przy pomocy znacznika "font" lub lokalnie stosowanych opcji CSS, zmieniających czcionkę, jej kolor, rozmiar i adiustowanie - bo to wszystko załatwia zewnętrzny arkusz CSS, który gwarantuje jednolitość wyglądu całej Wikipedii.
  • Przy tworzeniu prostych tabel - obecnie mechanizm wiki również daje takie możliwości, co zostanie omówione poniżej. Bardziej złożone tabele mogą się jednak wciąż okazać łatwiejsze do zrobienia w XHTML.
  • Przy wstawianiu pojedynczych obrazków - obecne opcje linku "grafika" całkowicie wystarczają, aby w dość dowolny sposób wstawić pojedyncze obrazki w tekst. Patrz: Pomoc:Ilustrowanie
  • Przy tworzeniu wyliczanych list. Znaczniki list XHTML (UL, OL, LI, DEF itp) można bez trudu zastąpić znacznikami mechanizmu wiki, które są opisane w Pomoc:Formatowanie tekstu. Podobnie jak przy tekście prostym - niemile widziane jest zmieniane standardowego formatu takich list przy pomocy lokalnego CSS czy szczególnych opcji formatujących dostępnych w XHTML.

Dobre zasady wstawiania kodu XHTML[edytuj | edytuj kod]

Normy XHTML-a[edytuj | edytuj kod]

Skrypt wiki generuje w miarę poprawny XHTML, zgodny ze standardem 1.0 uzgodnionym przez W3C. Taki kod wyświetla się poprawnie w większości nowych przeglądarek WWW.

Kod wstawiany do tekstów artykułów powinien przeto również trzymać się tego standardu. Patrz: http://www.w3.org/TR/xhtml1/

Zgodność własnego kodu z tym standardem można sprawdzić "przepuszczając go" przez parser kodu o nazwie "tidy", który jest dostępny bezpłatnie na stronie -> http://tidy.sourceforge.net/#binaries.
Można do tego celu wykorzystać także Validator na stronie http://validator.w3.org/

Czystość i elegancja kodu[edytuj | edytuj kod]

Ze względu na to, że kod XHTML wstawiany do tekstów artykułów może być kiedyś w przyszłości edytowany przez kogoś innego, warto jest poświęcić odrobinę czasu aby był on elegancki i czysto napisany. Warto więc stosować "programistyczne wcięcia", nie tworzyć zbyt długich linii kodu, aby nie zawijał się on w oknie edycyjnym itd. Kod ten warto jest opatrzyć jasnymi komentarzami, które ułatwią zrozumienie jego struktury, oraz wyraźnie oddzielić go od właściwego tekstu, tak aby łatwo było w tekście odnaleźć jego początek i koniec.

Poprawność kodu[edytuj | edytuj kod]

Kod powinien być przed wstawieniem dokładnie sprawdzony. Poprawny kod jest właściwie wyświetlany w ogromnej większości przeglądarek.

Kod z błędami jest wyświetlany w nieprzewidywalny sposób. Często zdarza się, że błędny kod daje oczekiwane przez autora wyniki, w jego ulubionej przeglądarce i przy jego ulubionej rozdzielczości ekranu. Jednak jest bardzo prawdopodobne, że w innej przeglądarce, lub nawet tej samej, ale używanej w innym systemie operacyjnym lub przy innej rozdzielczości, kod ten da fatalne rezultaty.

Stąd należy sprawdzić, czy wszystkie znaczniki w kodzie, które wymagają zamknięcia, zostały zamknięte, czy nie ma w nim błędów w osadzaniu znaczników, czy są one użyte adekwatnie i czy składnia wszystkich znaczników jest poprawna.

Bardzo użyteczny w tym może być już wcześniej wspomniany parser "tidy".

Uwagi techniczne[edytuj | edytuj kod]

Tabele[edytuj | edytuj kod]

Jak wspomniano wyżej, używanie znaczników HTML na Wikipedii nie jest zalecane. Tyczy się to także tabel. Znaczniki wikimarkup dają możliwości tworzenia tabel identyczne z tymi oferowanymi przez HTML, a są czytelniejsze dla osób nieznających HTML-a.

Szczegóły wstawiania tabel w oparciu o wikimarkup opisano na stronie Pomoc:Tabele.

Obrazki w tabelkach[edytuj | edytuj kod]

W przypadku pojedynczych obrazków nie należy stosować tabel do ich pozycjonowania względem tekstu, gdyż niepotrzebnie to komplikuje kod, a identyczne efekty można uzyskać za pomocą metod opisanych na stronie Pomoc:Ilustrowanie.

Zbiory obrazków należy umieszczać w galeriach, według poniższego przykładu.

Kod:

<gallery>
Image:Torun zamek krzyzacki ruiny wiezy.jpg|przykładowy tekst #1
Image:Torun zamek krzyz.jpg|przykładowy tekst #2
Image:Torun gdanisko.jpg
</gallery>

Efekt:

Zobacz też[edytuj | edytuj kod]

Pomoc:Znaczniki

Linki zewnętrzne[edytuj | edytuj kod]

Kursy (X)HTML