a21glossary dla TYPO3

Kto potrzebuje słownika, ten zwykle ma problem z SEO

Wyjaśnianie terminów fachowych na stronie internetowej brzmi jak serwis dla użytkownika. W rzeczywistości a21glossary rozwiązuje konkretny problem techniczny: strony TYPO3 z treściami wymagającymi objaśnień osiągają lepsze pozycje w wynikach wyszukiwania, gdy pojęcia są wewnętrznie linkowane, indeksowane jako osobne strony i natychmiast dostępne przez tooltip. Rozszerzenie automatycznie tworzy powiązania w treści na podstawie centralnej bazy pojęć, bez konieczności ręcznego ustawiania każdego linku przez redaktorów.

Dla przedsiębiorstw z portalami fachowymi, platformami wiedzy lub produktami wymagającymi objaśnień a21glossary tworzy dokładnie tę strukturę linkowania wewnętrznego, którą Google interpretuje jako autorytet tematyczny. Zamiast ukrywać 50 pojęć w jednym FAQ, powstaje 50 samodzielnych, indeksowalnych stron z potencjałem Schema Markup.

Typowe scenariusze zastosowania

Portale fachowe z ponad 100 pojęciami. Stowarzyszenia branżowe, uczelnie wyższe i wydawnictwa specjalistyczne utrzymują słowniki z setkami wpisów. a21glossary automatycznie linkuje każdy termin przy wszystkich wystąpieniach w tekście. U jednego klienta z 340 wpisami słownikowymi gęstość linkowania wewnętrznego wzrosła o 28%, co było mierzalne w Google Search Console.

Strony produktowe z technicznym słownictwem. Producenci maszyn, firmy chemiczne i producenci sprzętu medycznego używają fachowego języka, którego kupujący i decydenci nie zawsze znają. Tooltip z 2-3 zdaniami wyjaśnienia utrzymuje czytelnika na stronie, zamiast odsyłać go do Google. Czas spędzony na stronie rośnie, współczynnik odrzuceń spada.

Wielojęzyczne platformy wiedzy. W połączeniu z obsługą języków TYPO3 słowniki można prowadzić osobno dla każdego języka. Polskie pojęcia linkują do polskich objaśnień, angielskie do angielskich. Działa to poprawnie, pod warunkiem że konfiguracja językowa w TYPO3 jest prawidłowo ustawiona.

Architektura techniczna

a21glossary działa jako post-procesor treści. Po wyrenderowaniu strony TYPO3 rozszerzenie przeszukuje wyjście HTML w poszukiwaniu zdefiniowanych pojęć i zastępuje je wersjami z linkami. Same pojęcia są przechowywane w osobnej tabeli bazy danych i zarządzane jako rekordy w module Lista.

Od wersji 12.0.0 rozszerzenie wpina się w generowanie strony przez zdarzenie PSR-14 AfterCacheableContentIsGeneratedEvent, do wersji 11 przez hook contentPostProc-all. Oznacza to, że ingeruje dopiero po pełnym wyrenderowaniu treści przez TYPO3. Dzięki temu działa niezależnie od typu elementu treści - czy to Textmedia, News czy Custom Content Elements.

Wyświetlanie tooltipów przejmuje przeglądarka: a21glossary zapisuje objaśnienie jako atrybut title w tagach abbr, acronym lub dfn i nie dostarcza JavaScriptu. Kto chce ostylować tooltip, powinien sięgnąć po rozwiązanie oparte wyłącznie na CSS, aby nie obciążać Core Web Vitals. Za pomocą atrybutu title i selektora :hover można zrealizować proste tooltipy bez ani jednej linii JavaScriptu.

Wpisy słownika są konfigurowalne przez TypoScript: które strony mają być przeszukiwane, które typy pojęć są linkowane oraz które obszary HTML są wykluczone (nawigacja, stopka, inne wpisy słownika).

Częste problemy i rozwiązania

Spadek wydajności przy dużych słownikach. Od około 500 pojęć krok post-processingu może być odczuwalny, szczególnie na stronach z dużą ilością tekstu. Rozwiązanie: aktywacja cachowania. Cache stron TYPO3 przechowuje wynik po pierwszym renderowaniu. Ponowne przetwarzanie następuje tylko przy czyszczeniu cache. Dodatkowo pomaga ograniczenie listy pojęć do faktycznie używanego słownictwa. 200 precyzyjnych pojęć jest lepsze niż 800 z wariantami.

Błędne linkowanie w istniejących linkach. a21glossary domyślnie linkuje również wewnątrz istniejących hiperłączy; nagłówki h1 do h6 są wykluczone już w ustawieniach domyślnych. Prowadzi to do zagnieżdżonych linków, które są nieprawidłowe w HTML. Przez konfigurację TypoScript można dopisać tag a do listy domyślnej: excludeTags = acronym,abbr,dfn,h1,h2,h3,h4,h5,h6,input,pre,script,a. To ustawienie powinno znaleźć się w każdej instalacji.

Konflikty z RealURL i routingiem. W starszych wersjach TYPO3 (przed v9) pojawiały się problemy, gdy strony szczegółów słownika były routowane przez RealURL. Z TYPO3 v10+ i natywnym Site Routing ten problem nie występuje. Kto nadal używa RealURL, powinien i tak przeprowadzić migrację.

Migracja i kompatybilność wersji

a21glossary został pierwotnie opracowany dla TYPO3 3.x i aktualizowany na przestrzeni lat. Od 2017 roku rozszerzenie utrzymuje Sven Wappler (WapplerSystems); dla TYPO3 v12 w TER jest jego wersja 12.0.1, która portuje rozszerzenie na nową strukturę TCA i zmieniony system hooków. Dla TYPO3 v13 dostępna jest wersja 13.0.0 przez Composer (Packagist), w TER jeszcze jej nie ma.

Przy przejściu z v11 na v12 WapplerSystems sam dostosował rozszerzenie w wersji 12.0.0: po pierwsze przeszedł z $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'] na nowy system Event Dispatcher, po drugie zaktualizował definicje TCA. Konfiguracja TypoScript pozostała bez zmian, użytkownicy aktualizują tylko rozszerzenie.

Kto planuje przejście na TYPO3 v13, stoi przed wyborem: zaktualizować a21glossary do wersji 13.0.0 lub przejść na alternatywne rozwiązanie. Jako alternatywę można zaimplementować funkcjonalność słownika bezpośrednio jako Custom Content Element z DataProcessor. Nakład pracy wynosi około 2-3 dni developerskich, a wynik jest przyszłościowy i niezależny od utrzymania przez osoby trzecie. Gosign przeprowadził tę migrację w wielu projektach i może realistycznie oszacować rzeczywisty nakład pracy na podstawie analizy istniejących danych słownikowych.