Zastosowanie mikroformatów

Ładowanie interfejsu API mikroformatów

Obiekt Microformats można utworzyć za pomocą nowego mechanizmu ładowania skryptów dostępnego w programie Firefox 3. Aby skorzystać z interfejsu API, należy najpierw załadować obiekt:

Components.utils.import("resource://gre/modules/Microformats.js");

Po załadowaniu interfejsu API można korzystać z mikroformatów, używając podanych poniżej metod. Informacje na temat przetwarzania mikroformatów znajdują się artykule Przetwarzanie mikroformatów w języku JavaScript.

Wstępnie zdefiniowane mikroformaty

W programie Firefox 3 zaimplementowano definicje kilku popularnych mikroformatów:

adr

Reprezentuje adres (np. zamieszkania lub korespondencyjny).

geo

Reprezentuje lokalizację geograficzną (określaną za pomocą długości i szerokości geograficznej).

hCard

Reprezentuje informacje kontaktowe dotyczące osób.

hCalendar

Reprezentuje pozycję w kalendarzu (np. spotkanie).

tag

Używany w celu dodawania znaczników do innych mikroformatów.

Metody

add()

Dodaje nowy mikroformat do modułu mikroformatu.

add(nazwa, definicja);

Parametry

<tt>nazwa</tt>

Nazwa mikroformatu, który ma zostać dodany do modułu mikroformatu.

<tt>definicja</tt>

Struktura języka JavaScript opisująca mikroformat. Aby uzyskać szczegółowe informacje, patrz Opisywanie mikroformatów w języku JavaScript.

count()

Zwraca liczbę istniejących w dokumencie mikroformatów, które spełniają podane kryteria.

liczbaMikroformatow = Microformats.count(nazwa, element_główny, uwzględniaj_rekurencyjnie_ramki);

Parametry

<tt>nazwa</tt>

Nazwa mikroformatu, którego egzemplarze są liczone.

<tt>element_główny</tt>

Argument opcjonalny. Element DOM, od którego ma być rozpoczęte przeszukiwanie. Domyślnie jest to element content.document (innymi słowy, cały dokument).

<tt>uwzględniaj_rekurencyjnie_ramki</tt>

Argument opcjonalny. W przypadku podania wartości true w przeszukiwaniu uwzględnione będą ramki potomne. Wartością domyślną jest true.

Zwracana wartość

Liczba całkowita określająca liczbę mikroformatów, które spełniają podane kryteria.

debug()

Zwraca ciąg znaków określający obiekt mikroformatu.

zrzucanyCiag = debug(obiekt_mikroformatu)

Parametry

<tt>obiekt_mikroformatu</tt>

Obiekt mikroformatu, którego zrzut jest wykonywany.

Zwracana wartość

Ciąg znaków opisujący zawartość podanego obiektu mikroformatu.

get()

Zwraca tablicę z obiektami mikroformatów, odpowiadającymi znalezionym mikroformatom spełniającym podane kryteria.

tablicaMikroformatow = Microformats.count(nazwa, element_główny, opcje, tablica_docelowa);

Parametry

<tt>nazwa</tt>

Nazwa poszukiwanego mikroformatu.

<tt>element_główny</tt>

Element DOM, od którego ma być rozpoczęte przeszukiwanie.

<tt>opcje</tt>

Argument opcjonalny. Obiekt JavaScript zawierający zero lub więcej następujących wskaźników:

<tt>recurseFrames</tt>

W przypadku podania wartości true w przeszukiwaniu uwzględnione będą ramki potomne. Wartością domyślną jest true.

<tt>showHidden</tt>

W przypadku podania wartości true dodawane są ukryte mikroformaty; w przeciwnym przypadku są one ignorowane. Wartością domyślną jest false.

<tt>debug</tt>

W przypadku korzystania z trybu debugowania należy podać wartość true; w przeciwnym przypadku należy podać wartość false. Wartością domyślną jest false.

<tt>tablica_docelowa</tt>

Argument opcjonalny. Tablica zawierająca obiekty mikroformatów, do której dodawane będą rezultaty wyszukiwania.

Zwracana wartość

Nowa tablica zawierająca obiekty mikroformatów, które spełniały podane kryteria, lub tablica określona w obiekcie <tt>microformats</tt>, do której dodano nowe, znalezione obiekty mikroformatów.

getNamesFromNode()

Zwraca listę rozdzielonych znakami spacji nazw mikroformatów, które odpowiadały podanemu węzłowi mikroformatu.

listaNazw = Microformats.getNamesFromNode(węzeł);

Parametry

<tt>węzeł</tt>

Węzeł, z którego ma zostać pobrana lista nazw mikroformatów.

Zwracana wartość

Jeżeli podany <tt>węzeł</tt> jest mikroformatem, zwracany jest ciąg znaków stanowiący listę rozdzielonych znakami spacji nazw mikroformatów, które odpowiadały podanemu węzłowi. Jeżeli węzeł nie jest mikroformatem, nie jest zwracana żadna wartość.

getParent()

Zwraca nadrzędny węzeł podanego mikroformatu lub węzła potomnego mikroformatu.

wezelNadrzedny = Microformats.getParent(węzeł);

Parametry

<tt>węzeł</tt>

Węzeł, którego węzeł nadrzędny ma być pobrany.

Zwracana wartość

Węzeł nadrzędny podanego węzła. Jeżeli podany <tt>węzeł</tt> nie jest mikroformatem ani węzłem potomnym mikroformatu, nie jest zwracana żadna wartość.

isMicroformat()

Określa, czy podany węzeł DOM jest mikroformatem.

wskaznik = Microformats.isMicroformat(węzeł);

Parametry

<tt>węzeł</tt>

Węzeł DOM, który ma zostać sprawdzony.

Zwracana wartość

true, jeżeli węzeł jest mikroformatem; w przeciwnym przypadku zwracana jest wartość false.