Instrukcja dodawania opisu
Wstęp
Jest to kompleksowy poradnik dodawania opisu i wykorzystywania złożonych struktur treści do przyjaznego prezentowania tekstu.
Omawiane tu sposoby dodawania różnych elementów do opisu są zgodnie z dobrymi praktykami:
- SEO,
- bezpiecznego prezentowania danych tele-adresowych,
- dostępności cyfrowej (wg wytycznych WCAG).
Dostępność cyfrowa
Opis powinien być dostępny cyfrowo, zgodny ze standardami WCAG 2.2 na poziomie AA.
W przypadku wystąpienia błędów dostępnościowych będziemy poprawiać opis. Poprawianie opisu nie będzie dotyczyć modyfikacji treści z wyjątkiem sytuacji wymaganych przez standard WCAG.
Formatowanie tekstu za pomocą Markdown
Ponieważ funkcje edytora do formatowania tekstu nie są dostępne cyfrowo, możesz wykorzystać język znaczników Markdown. Poznaj syntaksę języka znaczników Markdown. Strona otwiera się w nowym oknie
Korzystaj z shortcode'ów
W edytorze treści możesz łatwo wkleić shortcode'y, o których mowa w tej instrukcji.

1. Podział długiego opisu na części
Jeśli masz długi opis lub chcesz bardziej ustrukturalizować treść, możesz wykorzystać specjalny shortcode dla zbudowania akordeonu ("harmonijki"). Akordeon jest interaktywnym elementem, po kliknięciu w który, użytkownik rozwija treść wcześniej dla niego niewidoczną.
Do opisu możesz dodać dowolną liczbę akordeonów (harmonijek).
Zobacz, jak działa akordeon. Strona otwiera się w nowym oknie
Jak dodać akordeon?
W treści opisu wpisz shortcode:
[accordion name="Testowy akordeon 1" number="1"]
W nowym wierszu wpisz treść...
[/accordion]
Efekt
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Felis eget nunc lobortis mattis aliquam. Leo vel orci porta non pulvinar neque laoreet.
Akordeon ma obowiązkowe 2 atrybuty:
- Atrybut "name" ma wartość wyświetlaną na przycisku harmonijki.
- "Number", to kolejna unikalna liczba naturalna, gdyż możesz dodać do opisu dowolną liczbę akordeonów. Każdy akordeon powinien posiadać unikalną wartość atrybutu "number".
Treścią akordeon mogą być zarówno paragrafy teksty, jak i listy.
Przykładowe wykorzystanie
Przykładowo, możesz wykorzystać akordeony do zamieszczenia w opisie:
- regulamin wydarzenia
- program szkolenia lub warsztatu
- biogram osób prowadzących wydarzenie
- techniczne i organizacyjne szczegóły dotyczące uczestnictwa
2. Struktura nagłówków

Nagłówkiem H1 jest tytuł strony, a w opisie możesz wykorzystywać tylko nagłówek H2 i nagłówek H3.
Nagłówki służą do podziału tekstu na logiczne części. Nagłówek jest śródtytułem streszczającym zawartość wskazanej części opisu.
Możesz wielokrotnie wykorzystywać nagłówki H2 i H3. Ważne jest zachowywanie hierarchii nagłówków: nagłówek H3 jest podrzędnym elementem względem nagłówka H2.
Jeśli masz bardzo długi opis, to poszczególne jego części możesz zatytułować wykorzystując nagłówek H2. Jeśli dana część nadal jest dość długa, możesz dodatkowo ją podzielić na kolejne części używając nagłówków H3.
3. Listy elementów
Są dwa rodzaje list: listy uporządkowane (listy numerowane) i listy nieuporządkowane.
Lista numerowana (lista uporządkowana)

Przykład listy uporządkowanej (numerowanie):
- Jeden
- Dwa
- Trzy
Stosuj numerowanie zwłaszcza wtedy, kiedy jest istotna kolejność elementów listy.
Lista nieuporządkowania ("wypunktowanie")

Przykład listy nieuporządkowanej:
- Jeden
- Dwa
- Trzy
Ogólne wskazówki dotyczące list
Warto wykorzystywać listy, np. do prezentowania harmonogramu wydarzenia, programu szkolenia czy listy atrakcji, itd.
Listy pomagają w przekazywaniu użytkownikowi kluczowych informacji i prezentowaniu korzyści z udziału w wydarzeniu.
4. Numer telefonu i adres e-mail
W pierwszej kolejności wykorzystaj dedykowane pola edycji strony do prezentowania danych kontaktowych. W edycji strony, w zakładce "Opis: są dwa osobne pola na telefon i adres e-mail. Wpisz tam tylko dane kontaktowe: tylko 1 telefon lub tylko 1 adres e-mail bez żadnych dodatkowych rzeczy. W polu telefon nie wpisuj tzw. numeru wewnętrznego.

Dodatkowe dane tele-adresowe
W tekście opisu możesz wpisać dodatkowe numery telefonu i adresy e-mail. Zrób to jednak właściwie przynajmniej z 2 powodów:
- Twoje dane nie powinny zostać skopiowane przez boty spamerskie. Przygotowaliśmy specjalny mechanizm ograniczający ten preceder. Chroń swoje dane!
- Dane adresowe powinny zostać tak wklejone, aby były aktywnymi linkami do domyślnej aplikacji pocztowej lub wykonania połączenia telefonicznego na urządzeniu użytkownika.
Jak właściwie wpisać numer telefonu i adres e-mail?
Wykorzystać shortcode'y.
Dla numeru telefonu użyj shortcode'ów
[phone lang="pl"]678987654[/phone]
lub
[phone lang="en"]+48 678 987 654[/phone]
Wartość atrybut lang wskazuje na język dodatkowego tekstu dla czytnika, który został tu użyty.
Numer telefonu może zawierać spacje lub myślniki, aby wizualnie podzielić numer telefonu na części.
Dla adresu email użyj shortcode
[email]jan@kowalski.com[/email]
Stacjonarny numer telefonu z tzw. numerem wewnętrznym
Numer wewnętrzny nie może być elementem aktywnego linku ze stacjonarnym numerem telefonu.
W tej sytuacji należy zastosować shortcode, a za nim zwykłym tekstem określić wewnętrzny numer, np.
[phone lang="pl"]678987654[/phone], numer wew.: 123
5. Linki do stron zewnętrznych i social media
Linki (hiperłącza) powinny zostać dodane w specjalny sposób, gdyż:
- Wszystkie linki w opisie powinny otwierać się w nowym oknie (nowej karcie) przeglądarki, aby użytkownik nie opuścił serwisu Event on Click, gdzie trwa sprzedaż biletów na twoje wydarzenie. Staraj się zamieszczać jak najmniej linków, aby nie prowokować ucieczki użytkownika z serwisu w trakcie podejmowania decyzji zakupowej.
- Link otwierany w nowym oknie powinien zawierać tekst dla czytnika komunikujący ten fakt.
- Link otwierany w nowym oknie powinien zawierać ikonkę, aby uprzedzić użytkownika, że po kliknięciu zostanie przekierowany do nowego okna przeglądarki.
Aby sprostać tym wymaganiom przygotowaliśmy specjalny shortcode do tworzenia linków.
Są 2 rodzaje shortcode'ów
Kiedy potrzebujesz, aby link był w osobnym paragrafie (w osobnym wierszu)
[external_link_p link="" name="" lang="pl" reader=""]
Kiedy link ma być wykorzystany w tekście
[external_link link="" name="" lang="pl" reader=""]
Wyjaśnienie atrybutów
Link - Wartością tego atrybutu powinien być pełny URL (adresowanie bezwzględne). Link powinien zaczynać się od https:// lub http:// .
Name - Kotwica (anchor), wyświetlany tekst linku.
Lang - Wpisz wartość pl lub en, aby określić w jakim języku ma zostać dodany specjalny tekst dla czytnika informujący, że link otwiera się w nowym oknie.
Reader - Dodatkowy tekst dla czytnika, że chcesz przekazać użytkownikowi jakieś dodatkowe niezbędne informacje.
Przykłady
[external_link_p link="https://domena.com/article.html" name="Artykuł o kosmosie" lang="pl" reader="wraz z filmem o czarnych dziurach, który ma napisy oraz transkrypcję"]
[external_link link="https://domena.org/" name="Strona zespołu muzycznego Agrafka" lang="pl" reader=""]
6. Grafiki, zdjęcia
W edytorze treści możesz dodać grafikę, zdjęcie. Kliknij "dodaj medium", aby uruchomić okno modalne i wgrać swój plik. Możesz wgrać nowy plik lub wykorzystać wcześniej wgrany przez ciebie plik.
Każdy wgrany plik będzie publiczny i indeksowany przez wyszukiwarki.


Ograniczenia dla plików graficznych
- Dozwolone formaty: JPG, JPEG, PNG
- Maksymalna waga pliku: 1 MB
- Pliki przechowywane są na twoim koncie organizatora przez 12 miesięcy
Porady
- Staraj się jak najmniej dodawać plików graficznych, aby strona twojego wydarzenia wczytywała się w przeglądarce użytkownika możliwie najszybciej, jak to tylko jest możliwe.
- Wgrywaj pliki graficzne o maksymalnej szerokości 1920px. Nie ma sensu wgrywania większych plików graficznych.
- Przed wgraniem pliku graficznego dokonaj jego kompresji, aby maksymalnie zminimalizować jego wagę. W sieci najdziesz do tego wiele bezpłatnych narzędzi.
- Jeśli chcesz pokazać użytkownikowi galerię swoich zdjęć, wpierw utwórz galerię na swojej stronie internetowej lub profilu w portalu społecznościowym, a potem dodaj w opisie link do strony z galerią.
Tekst alternatywny dla grafiki (ALT)
Podczas wgrywania swojego pliku możesz zdefiniować tekst alternatywny. Jeśli grafika przekazuje pewne informacje dla użytkownika, trzeba dodać tekst alternatywny zawierający krótki tekst. ALT nie może być długim tekstem.
Jeśli grafika zawiera wiele tekstu, np. harmonogram wydarzenia, jest to błąd. Dodaj te treści w formie tekstowej, a nie w formie grafiki.
Alternatywnie możesz dodać link do pliku z harmonogramem wydarzenia.
Wgrywanie plików
Podczas dodawania grafiki do opisu możesz zdefiniować tekst alternatywny (ALT) oraz rozmiar grafiki.


7. Film YouTube, Vimeo
W edytorze wklej link do filmu YouTube lub Vimeo. Link powinien być w osobnym paragrafie. Po zapisaniu zmian zobaczysz na stronie wyrenderowany player z możliwością odtworzenia filmu, o ile nie ma żadnej blokady po stronie ustawień filmu w serwisie YouTube czy Vimeo.
Zadbaj o to, aby film miał dobry tytuł, gdyż zostanie on dodany w atrybucie "title" dla "iframe" tego player'a. Jeśli nie możesz zmienić tytułu filmu, warto w tekście przed filmem dodać kilka dodatkowych słów.
Nie dodawaj zbyt wielu filmów, gdyż to może negatywnie wpłynąć na performance strony, a efekcie czego twoja strona będzie wgrywać się wolniej w przeglądarce użytkownika.
Przekazywanie i sprzedaż dostępu do filmów wideo
Alternatywnie, możesz przekazać użytkownikom dostęp do filmów wideo dopiero po zakupie biletu lub rejestracji na wydarzenie.
Instrukcja przekazywania i sprzedaży dostępu do filmów wideo. Strona otwiera się w nowym oknie
8. Załączanie plików
Wykorzystaj sposób opisany w punkcie nr 5. Link zewnętrzny może prowadzić także bezpośrednio do pliku do pobrania.
Zadbaj o dodatkowe informacje w opisie linku, np.:
[external_link_p link="https://domena.com/article.pdf" name="Artykuł o kosmosie (plik PDF, 2 MB)" lang="pl" reader=""]
Gdzie wgrać swój plik?
- Plik możesz wgrać na dowolny zewnętrzny dysk sieciowy. Zadbaj o to, aby to było bezpieczne miejsce przechowywania twoich plików.
- Możesz grać plik PDF (max. 15 MB) w swoim edytorze i wykorzystać bezpośredni link do tego pliku do zbudowania shortcode'u.
Dostarczanie plików po zakupie biletu
Alternatywnie możesz przekazywać uczestnikom pliki w innej formie: po zakupie biletu lub rejestracji na wydarzenie, uczestnik otrzyma wiadomość mailową z biletem i opcjonalnie załączonymi plikami.
Instrukcja dostarczania i sprzedaży plików. Strona otwiera się w nowym oknie
9. Różne porady
1. Wymienianie elementów z użyciem ukośnika
Jeśli wykorzystujesz ukośnik do wymieniania różnych rzeczy, stosuj spację po każdym użyciu ukośnika. W przeciwnym razie czytnik ekranu może to potraktować jako 1 słowo i w efekcie użytkownikowi będzie trudniej zrozumieć twój opis.
Niepoprawne przykłady
Jeden/Dwa/Trzy
40zł/os.
Poprawne przykłady
Jeden / dwa / trzy
lub
Jeden/ Dwa/ Trzy
40 zł / osoba
2. Rozwijaj niestandardowe skróty do pełnych słów
Czytniki ekranu mogą niewłaściwie przeczytać użyte skróty, np. 40 zł / os.
Użyj pełnego zapisu, np. 40 zł . osoba
Zamiast skrótu FB napisz Facebook. Dotyczy to wszystkich portali społecznościowych.
Skróty dotyczące walut, jednostek miar i wag nie trzeba rozwijać.
Popularne skrótowce pisz wielką literą, np. PKP.
3. Rodzaj męski i żeński polskich słów
Zapisy takich słów, które mogą być nieczytelne dla czytników ekranu:
zrobił(a)
zrobił_a
Najlepszy sposób
zrobił, zrobiła
4. Nie używaj słowa tutaj
Tworząc link nie używaj słów typu "tutaj", "kliknij tutaj". Nazwa hiperłącza (kotwica) powinna określać, czego dotyczy, np. strona firmy Agrafka, profil zespołu Motto itd.
5. Nie używaj ani wyśrodkowania ani justowania tekstu
Tekst powinien być wyrównany do lewej strony.
Nie stosuj justowania tekstu. Strona internetowa nie jest bowiem publikacją naukową ani książką. Justowane teksty trudniej się czyta.
6. Słowa w innym języku
Jeśli strona ma wybraną walutę "złoty" (PLN), to użyte w opisie słowa w innych językach niż język polski powinny być w HTML otagowane w następujący sposób:
<span lang="en">Facebook</span>
Wartość atrybutu "lang" wskazuje na język użytego słowa.
Edytor treści ma zakładkę "Wizualny" oraz "Kod". Modyfikacji HTML dokonasz w zakładce "Kod".
7. Tabele
Nie przewidujemy możliwość dodawania tabeli w edytorze treści z uwagi na jej skomplikowaną strukturę w kodzie.
Jeśli chcesz przekazać użytkownikowi informacje w formie tabeli:
- Dodaj informacje do pliku Word lub Excel
- Zamieść plik w zewnętrznym dysku sieciowym
- Zamieść w opisie link do tego zewnetrznego pliku
- Jeśli chcesz zamieścić tabelę w pliku PDF, zadbaj o jego zgodność ze standardem PDF/UA