xml:lang w schematach dokumentów XML

Kiedy należy stosować xml:lang, a kiedy definiować własny element lub atrybut przekazujący wartość języka w schematach dokumentów XML (DTD)?

Kiedy stosować xml:lang

Treść, która jest bezpośrdnio powiązana z dokumentem XML (zawarta w dokumencie lub uważana za część dokumentu po przetworzeniu) powinna używać atrybutu xml:lang określającego język. Atrybut ten powinnien być zarezerwowany do określenia języka treści dostarczanej przez autora.

Atrybut xml:lang jest zdefiniowany przez XML 1.0 jako atrybut używany do określania języka treści elementu HTML, włącznie z tekstem i innym typem treści (np: obrazy i pliki dźwiękowe), który znajduje się w elemencie. Wartość xml:lang odnosi się do podelementów, jak również do atrybutów powiązanych z elementem i podelementami (chociaż stosowanie języka naturalnego w atrybutach nie jest najlepszą praktyką). Wartością atrybutu xml:lang jest znacznik języka zdefiniowany przez RFC 3066 lub wersje późniejsze.

Np.: xml:lang w elemencie t:

<t xml:lang="pl"> 
   Ten tekst jest zawarty w elemencie 't'.Zastosowanie  atrybutu
   xml:lang wskazuje język, po to, żeby np.: zastosować odpowiednią 
   czcionkę lub słownik podczas przeglądania dokumentu. Gdyby nie 
   było atrybutu xml:lang, można mieć problemy z osadzonom treścią 
   taką jak np.: fraza <span xml:lang="fr">C'est la vie</span>, 
   która jest napisana w innym języku. 
</t>

Poniższy przykład pokazuje jak xml:lang jest zastosowany w innym przypadku:

Kiedy stosować własny element lub atrybut

Kiedy wartość języka jest atrybutem lub metadaną treści, która jest z poza dokumentu, nie należy stosować xml:lang. W takich przypadkach informacje na temat języka mogą być zachowane w dokumencie, ale informacje te nie odnoszą się do treści samego dokumentu XML (w tym obrazów, które są przetwarzane jako część dokumentu). W takim przypadku należy zdefiniować element lub atrybut inną nazwą, nie stosując atrybutu xml:lang. Wartość elementu lub atrybutu powinna stosować BCP 47 (lub wersje późniejsze) tak jak w przypadku xml:lang.

Oto kilka przykładów:

• element w dokumencie XML opisujący kolekcje DVD i dostępne wersje językowe
• element w bazie danych odnośnie preferencji języka klienta
• atrybut odnośnika (tak jak w XHTML) wskazujący wersję dokumentu w inym języku

Powodem, dla którego należy stworzyć własny element (lub atrybut) jest przekazanie języka jako wartości (jako części struktury danych lub metadanych na temat dokumentu zewnętrznego) a nie do określenia języka konkretnego kawałka tekstu. Unikanie użycia xml:lang do opisu wartości dotyczących języka dokumentów zewnętrznych pozwala autorom na uniknięcie problemów związanych z etykietowaniem przetwarzanych treści.

Na przykład: dokument XML może wyglądać następująco:

<item type="DVD"> 
  <title xml:lang="fr">Cyrano de Bergerac</title>    
  <!-- wskazuje na język tytułu filmu -->
  <runningTime value="137" />                        
  <!-- język nie ma znaczenia w tym przypadku -->
  <dialogue>en</dialogue>                            
  <!-- wskazuje na język dialogów -->
  <subtitles track="1" language="zh-Hant" />         
  <!-- pokazuje napisy w chińskim -->
  <subtitles track="2" language="zh-Hans" /> 
</item>

W powyższym przykładzie atrybut the xml:lang przekazuje informacje na temat języka tekstu, który pojawia się w dokumencie. Element dialogue i atrybut language są zdefiniowane w schemacie dokumentów XML i pokazują język odpowiedni dla danych pozycji. Na przykład: 'language' przekazuje informacje, że napisy w Track #1 są napisane w języku chińskim ("zh-Hant").