Dzień 17: Definiowanie akronimów

Mark Pilgrim użył 50 akronimów i skrótów na swoim blogu w miesiącu, w którym pisał tą książkę: ADA, ALT, AOL, API, CGI, CMS, CSS, CTRL, DMV, DNS, DTD, EFF, FAQ, FSF, GFDL, GIA, GPL, HTML, IE, IIRC, IIS, IO, KB, KDE, LONGDESC, MB, MSDN, MSN, MT, Mac, NC, OPML, P2P, PGDN, PGUP, PBS, PDF, PONUR, RSS, RU, SOAP, SSN, TDD, US, VNC, W3C, WCAG, WYSIWYG, Win, XHTML oraz XML.

Jeżeli rozpoznajesz wszystkie 50, gratuluję; przed Tobą świetlana przyszłość redaktora technicznego. Jeżeli jednak nie, z pewnością docenisz fakt, że każdy z nich został zdefiniowany przez tag <acronym> i po umieszczeniu kursora myszy nad dowolnym z nich możesz zobaczyć co on oznacza. To działa we wszystkich nowych przeglądarkach i równocześnie jest nieszkodliwe dla Netscape 4.

Powinieneś opisywać akronim za każdym razem, kiedy go używasz, lub przynajmniej raz w artykule czy wpisie bloga.

Kto na tym skorzysta?

  1. Michał skorzysta. Kiedy Michał umieszcza kursor nad akronimem, Opera pokazuje jego rozwinięcie jako tooltip.
  2. Bill skorzysta. Mozilla robi nawet więcej - automatycznie pokazuje akronimy podkreślone kropkowaną linią. Kiedy Bill umieszcza kursor myszy nad akronimem, Mozilla wyświetla rozwinięcie akronimu jako tooltip. (Poniżej zobaczymy jak możesz zdefiniować odpowiednie style CSS i uzyskać podobny efekt w innych przeglądarkach graficznych. Taka technika jest zastosowana na stronach tego podręcznika.)
  3. Google skorzysta. Google indeksuje rozwinięcia akronimów tak samo jak same akronimy, tak więc można je znaleźć zarówno po skrócie jak i po wersji pełnej.
  4. Chciałbym powiedzieć, że Jadzia również skorzysta. Jednak ani JAWS ani żaden inny screen reader aktualnie nie czyta rozwinięć akronimów. Mam nadzieję, że pewnego dnia będą to robić, a wtedy już będziesz na to gotowy.

Jak to zrobić?

Za pierwszym razem, kiedy używasz na stronie akronimu, oznacz go tagiem <acronym>, podając rozwinięcie w atrybucie title np. tak:

<acronym title="As Soon As Possible" lang="en">ASAP</acronym>

Użytkownicy systemu niByLog mogą zautomatyzować ten proces definiując skróty. W menu "edycja makr" zdefiniuj akronimy, których często używasz, np.:

makro: ASAP

rozwinięcie: <acronym title="As Soon As Possible" lang="en">ASAP</acronym>

Następnie edytując wpis wystarczy wpisać =ASAP= (ze znakami równości) i niByLog zamieni to na tag <acronym> z tytułem zgodnie z definicją skrótu.

Analogicznie mogą postąpić użytkownicy systemu Radio, definiując skróty w menu "Shortcuts", np.:

Name: ASAP

Value: <acronym title="As Soon As Possible" lang="en">ASAP</acronym>

(Pamiętaj, żeby przełączyć typ wejścia z "WYSIWYG" na "Source" tak aby móc wprowadzać bezpośrednio kod HTML.)

Edytując wpis wystarczy wpisać "ASAP" (w cudzysłowie) i Radio zamieni go na tag <acronym> z tytułem zgodnie z definicją skrótu.

Jak to zrobić: style CSS

Jako dodatkowe usprawnienie możesz zmienić wygląd wszystkich akronimów i skrótów za pomocą arkusza stylów kaskadowych (CSS). Poniższa reguła powoduje dodanie do akronimów kropkowanego podkreślenia (efekt podobny jak zachowanie domyślne w Mozilli):

acronym {
  border-bottom: 1px dotted black;
}

Ponadto, poniższa reguła, użyta w arkuszu stylów dla wydruku strony, automatycznie dodaje rozwinięcie akronimu w nawiasie za jego skrótem. Niestety to działa tylko na wydruku z Mozilli (i jej pochodnych) oraz z Opery, ale jest nieszkodliwe dla innych przeglądarek.

acronym:after {
  content: " (" attr(title) ")";
}

Zobacz także

Używasz akronimów nie mając pewności co oznaczają? Sprawdź to (strony w języku angielskim):

Postscriptum

Niektórzy guru z obsesją na temat poprawności znaczników zwracają uwagę na istnienie taga <abbr> (od angielskiego abbreviation) specjalnie dla skrótów nie będących akronimami. Mają rację o tyle, że faktycznie skrót to nie to samo co akronim. Niestety żadna z wersji Internet Explorera dla Windows nie obsługuje tego taga; nie pokazuje podpowiedzi w ogóle. Dlatego zarówno dla skrótów jak i akronimów używaj taga <acronym>.