Inkluzje XML (XInclude) Wersja 1.0

1.1 Związek z XLink

XInclude różni się od elementów łączących opisanych w [Język Połączeń XML], szczególnie łączy z wartością atrybutu show="embed". Takie połączenia zapewniają składnię niezależną od media-type dla wskazania, że źródło jest wbudowane graficznie w obrębie wyświetlanego dokumentu. XLink nie wyszczególnia szczególnego modelu przetwarzania, ale po prostu ułatwia wykrywanie linków i rozpoznanie przyłączonych metadata przez aplikację wyższego poziomu.

XInclude, z drugiej strony, wyszczególnia szczególną transformację media-type (XML na XML). Określa to szczególny model przetwarzania dla łączenia zbiorów informacji. Przetwarzanie XInclude odbywa się na niskim poziomie, często poprzez procesor rodzajowy, który udostępnia wynikowy zbiór informacj aplikacjom na wyższym poziomie.

Proste inkluzje elementów informacyjnych, jak opisano w tej specyfikacji, różnią się od transkluzji, które zachowują kontekstowe informacje takie jak styl.

1.2 Związek z Zewnętrznymi Elementami Rekordu XML

Jest wiele różnic pomiędzy zewnętrznymi elementami XInclude i [XML 1.0] lub [XML 1.1], które sprawiają, że są one technologiami uzupełniającymi.

Przetwarzanie zewnętrznych elementów (jak z resztą of DTD) odbywa się w czasie rozbioru. XInclude działa na zbiory informacji, a więc jest ortogonalne do rozbioru.

Deklaracja zewnętrznych elementów wymaga DTD lub wewnętrznego podzbioru. Umieszcza to zbiór zależności na nkluzji, na przykład składnia dla deklaracji DOCTYPE wymaga, aby element dokumentu był nazwany - ortogonalnie do inkluzji w wielu przypadkach. Parsery walidujące muszą mieć zdefiniowany całkowity model zawartości. XInclude jest ortogonalny do walidacji i nazwy elementu dokumentu.

Elementy zewnętrzne zapewniają poziom nieukierunkowania - element zewnętrzny musi być zdeklarowany i nazwany, a także oddzielnie wywołany. XInclude używa odnośników bezpośrednich. Aplikacje, które tworzą wynik XML przyrostowo mogą wyciągać korzyści z tego, że nie mają wcześniej zdeklarowanych inkluzji.

Niepowodzenie podczas ładowania elementu zewnętrznego jest zazwyczaj błędem krytycznym. XInclude pozwala autorowi na zapewnienie zawartości wartości domyślnej, która będzie używana jeśli zdalne źródło nie może być załadowane.

Składnia dla wewnętrznego podzbioru jest niewygodna dla wielu autorów prostych, dobrze stworzonych dokumentów XML. Składnia XInclude opiera się na pokrewnych konstrukcjach XML.

1.3 Związek z DTD

XInclude nie określa związku z walidacją DTD. XInclude opisuje transformację podzbiór-do-podzbioru, a nie zmianę w analizowanym zachowaniu XML. XInclude nie określa mechanizmu dla walidacji DTD wynikowego zbioru informacji.

1.4 Związek ze Schematami XML

XInclude nie określa związku z rozszerzonymi zbiorami informacji stworzonymi przez stosowanie schematu XML. Takie rozszerzone zbiory informacji mogą być dostarczane do wyjściowego zbioru informacji, lub takie rozszerzenie mogłoby być stosowane do zbioru informacji wynikającego z inkluzji.

1.5 Związek z Inkluzjami o Szczególnej Gramatyce

Inkluzje szczególnego użytku zostały wprowadzone do szczególnych gramatyk XML. XInclude zapewnia mechanizm rodzajowy dla rozpoznania i przetworzenia inkluzji, a także może zaoferować prostsze oólne doświadczenie auorskie, lepsze działanie i mniejszą nadmiarowość kodu.

3.1 Element xi:include

Element xi:include posiada następujące atrybuty:

href

Wartość, która po odpowiednim uwolnieniu (patrz 4.1.1 Uwalnianie wartości atrybutu href) została wykonana, daje w wyniku odnośnik URI lub odnośnik IRI, określające umieszczenie źródła do zawarcia. Atrybut href jest opcjonalny; brak tego atrybutu jest taki sa, jak przy określaniu href="", tj., odnośnik jest do tego samego dokumentu. Jeśli brakuje atrybutu href kiedy parse="xml", atrybut xpointer musi wystąpić. Identyfikatory fragmentowe nie mogą być użyte; ich obecność jest błędem krytycznym. Wartość, która jest wynikiem, jest syntaktycznie nie ważna dla URI lub IRI, powinna być zgłoszona jako błąd krytyczny, ale niektóre implementacje mogą uważać ją za niepraktyczną do odróżnienia tego przypadku od błędu źródłowego.

Uwaga:

URI kończące się na # jest uważane przez [IETF RFC 2396] za mające pusty identyfikator fragmentu. Takie URI powodowałoby błąd krytyczny jak opisano powyżej.

Uwaga:

Kluczową cechą XInclude jest to, że zezwala, by źródło było uformowane do typu user-specified dla inkluzji (XML lub tekst). Otrzymany media type jest zatem zasadniczo ignorowany dla celów przetwarzania inkluzjii i składnia identyfikatora fragmentu otrzymanego media type nie będzie generalnie odpowiednia do typu user-specified. Dla inkluzji parse="xml" podźródła są identyfikowane przez oddzielny atrybut xpointer, który jest stosowany po formowaniu. Kiedy to nie zapobiega identyfikacji podźródeł dokumentów XML przez URI (Patrz Struktura World Wide Web [Identyfikacja]), zapobiega ono użyciu tych identyfikatorów bezpośrednio w obrębie XInclude.

parse

Wskazuje, czy włączyć źródło jako przeanalizowany XML czy jako tekst. Atrybut parse pozwala XInclude na danie autorowi włączanego dokumentu pierwszeństwa na serwerze włączanego dokumentu co do tego, jak przetworzyć załączoną zawartość. Wartość "xml" wskazuje, że źródło musi być przeanalizowane jako XML i zbiór informacji scalony. Wartość "text" wskazuje, że źródło musi być załączone jako znaki elementu informacji. Ten atrybut jest opcjonalny. Kiedy pominięty, wartość "xml" jest sugerowana (nawet przy braku wartości domyślnej deklaracji). Wartości inne niż "xml" i "text" są błędem krytycznym.

Uwaga:

Dla interoperacyjności pomiędzy systemami walidującymi i niewalidującymi, odstęp nie powinien się pojawić w atrybucie parse.

xpointer

Kiedy parse="xml", XPointer (patrz [Struktura XPointer]) zawarta w atrybucie xpointer jest wyznaczona do identyfikacji część źródła do załączenia. Ten atrybut jest opcjonalny; kiedy jest pominięty, całe źródło jest zawarte. Atrybut xpointer nie może wystąpić kiedy parse="text". Jeżeli atrybut xpointernie występuje, atrybut href musi występować.

Uwaga:

Ponieważ atrybut xpointer nie jest odnośnikiem URI, %-uwolnienie nie może wystąpić w XPointer, ani nie ma potrzeby, aby procesor zastosował, lub zmienił takie uwolnienie.

encoding

Kiedy parse="text", czasami jest niemożliwe, by poprawnie wykryć kodowanie źródła tekstu. Atrybut encoding określa jak źródło ma być tłumaczone Wartością tego atrybutu jest EncName, jak opisano w specyfikacji XML, część 4.3.3, zasada [81]. Atrybut encoding nie ma wpływu kiedy parse="xml".

accept

Wartość atrybutu accept może być używane przez procesor XInclude, aby wspomóc w ustalaniu zawartości. Kiedy procesor XInclude pobiera źródło przez HTTP, powinien umieścić wartość atrybutu accept, jeśli taki istnieje, w żądaniu HTTP jako nagłówek Accept, jak opisano w części 14.1 [IETF RFC 2616]. Wartości zawierające znaki poza obszarem #x20 do #x7E są zabronione w nagłówkach HTTP, i muszą być oflagowane jako błędy krytyczne.

accept-language

Wartość atrybutu accept-language może być użyta przez procesor, aby wspomóc przy ustalaniu zawartości. Kiedy procesor XInclude pobiera źródło przez HTTP, powinien umieścić wartość atrybutu accept-language jeśli taki istnieje, w żądaniu HTTP jako nagłówek Accept-Language, jak opisano w części 14.4 [IETF RFC 2616]. Wartości zawierające znaki poza obszarem #x20 do #x7E są zabronione w nagłówkach HTTP, i muszą być oflagowane jako błędy krytyczne.

Atrybuty inne niż te wymienione powyżej mogą być umieszczone na elemencie xi:include. Nazwy atrybutów bez prefiksów są zarezerwowane dla przyszłych wersji tej specyfikacji i muszą być ignorowane przez procesory XInclude 1.0.

Własność potomna elementu xi:include może zawierać pojedynczy element xi:fallback; wystąpienie więcej niż jednego elementu xi:fallback, elementu xi:include, lub jakiegokolwiek innego elementu z przestrzeni nazw XInclude jest błędem krytycznym. Inna zawartość (tekst, instrukcje przetwarzania, komentarze, elementy poza przestrzenią nazw, następcy elementów potomków) nie jest wymuszona przez tę specyfikację i jest ignorowana przez procesor XInclude, tzn. nie ma wpływu na przetwarzanie załączania i nie występuje we własnościach potomnych wyniku zbioru wartości. Taka zawartość może być użyta przez aplikacje analizujące przedinkluzjyjny zbiór informacji, lub udostępniona aplikacjom poinkluzyjnym poprzed środki inne niż normalne własności zbioru informacji.

Następujący (nienormatywny) fragment DTD przedstawia próbkę deklaracji dla elementu xi:include:

<!ELEMENT xi:include (xi:fallback?)>

<!ATTLIST xi:include
    xmlns:xi        CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
    href            CDATA       #IMPLIED
    parse           (xml|text)  "xml"
    xpointer        CDATA       #IMPLIED
    encoding        CDATA       #IMPLIED
    accept          CDATA       #IMPLIED
    accept-language CDATA       #IMPLIED
>

3.2 Element xi:fallback

Element xi:fallback pojawia się jako potomek elementu xi:include. Zapewnia mechanizm dla odzyskiwania zaginionych źródeł. Kiedy wystąpi błąd krytyczny, element xi:include jest wymieniany wraz z zawartością elementu xi:fallback. Jeżeli element xi:fallback jest pusty, element xi:include jest usunięty z wyniku. Jeżeli brakuje elementu xi:fallback, błąd źródła prowadzi do in a błędu krytycznego.

Element xi:fallback potomek elementu xi:include. Jest to błąd krytyczny elementu xi:fallback, pojawiający się w dokumencie w jakimkolwiek innym miejscu, niż bezpośredni potomek xi:include (przed przetarzaniem inklucji na zawartości elementu.) Jest to błąd krytyczny dla elementu xi:fallback, zawierającego jakiekolwiek elementy z przestrzeni nazw XInclude inne niż xi:include.

Atrybuty mogą być umieszczone na elemencie xi:fallback. Nazwy atrybutów bez prefiksów są zarezerwowane dla przyszłych wersji tej specyfikacji i muszą być ignorowane przez procesory XInclude 1.0.

Następujący (nienormatywny) fragment DTD przedstawia próbkę deklaracji dla elementu xi:fallback:

<!ELEMENT xi:fallback ANY>

<!ATTLIST xi:fallback
    xmlns:xi   CDATA   #FIXED   "http://www.w3.org/2001/XInclude"
>

4.1 Zawarta lokalizacja

Wartość atrybutu href po uwolnieniu zgodnie z 4.1.1 Uwalnianie wartości atrybutu href, jest interpretowane zarówno jako odnośnik URI, lub odnośnik IRI. Podstawowy URI dla odpowiednich URI lub IRI jest podstawowym URI elementu xi:include, jak wyszczególniono w [Podstawie XML]. [Definicja: URI lub IRI wynikające z rozdzielania znormalizowanej wartości atrybutu href (lub pusty ciąg znaków, jeśli nie pojawia się żaden atrybut) do zupełnej formy URI lub IRI jest zwany zawartą lokalizacją.]

Brak wartości dla atrybutu href, zarówno przez pojawienie href="", lub braku atrybutu href, przedstawia przypadek, który może być niekompatybilny z pewnymi strategiami implementacji. Na przykład, procesor XInclude może nie mieć tekstowego odwzorowania źródłowego zbioru informacji, do włączenia jako parse="text", lub może być niezdolny do dostępu innej części dokumentu przy użyciuparse="xml" i xpointer, przez znaczenia strumieniowalności. Implementacja może wybrać jakikolwiek lub wszystkie braki wartości dla atrybutu href takiego, jak błędy źródłowe. Implementacje powinny dokumentować warunki, pod jakimi takie błędy źródłowe występują.

4.2 Elementy zawarte kiedy parse="xml"

Kiedy parse="xml", zawarta lokalizacja (include location) ma usuniętą pośredniość, źródło jest załadowane, a zbiór informacji jest stworzony poprzez analizę źródła tak, jakby typ media był aplikacją/xml (łącznie z oznaczeniem znaku kodowania).

Źródła, które są z jakiegokolwiek powodu niedostępne (na przykład nie istnieje źródło, występują problemy z łącznością, lub ograniczenia bezpieczeństwa chronią go przed załadowaniem, schemat URI nie może być załadowany, źródło ma nieobsługiwane kodowanie, lub źródło jest nie jest zdeterminowane jako XML przez specyficzne mechanizme implementacyjne) powodują błąd źródła. Źródła posiadające źle utworzony XML powodują błąd krytyczny.

[Definicja: elementy xi:include w tym zbiorze informacji są rekurencyjnie przetwarzane, aby stworzyć uzyskany zbiór informacji. Dla odnośnika intra-document (przez atrybut xpointer ) źródłowy zbiór informacji jest używany jako uzyskany zbiór informacji.]

[Definicja: Część uzyskanego zbioru informacji, który ma być zawarty jest zwany celem inkluzji (inclusion target).] Element informacyjny dokumentu uzyskanego zbioru informacji służy jako cel inkluzji, chyba, że występuje atrybut xpointer i identyfikuje podźródło. Atrybuty XPointer w formach opisanych w [Planie XPointer] i [Schemacie elementu XPointer] muszą być obsługiwane. Procesory XInclude opcjonalnie wspierają inne formy XPointer, takie jak te opisane w [Schemacie XPointer xpointer()]. Błąd w XPointer jest błędem źródła.

[Schemat XPointer xpointer()] nie jest określony w kategoriach [Zbioru Informacji XML], ale w zamian bazuje na Modelu Danych [XPath 1.0], ponieważ Zbiór Informacji XML nie został jeszcze rozwinięty. Odwzorowanie pomiędzy lokalizacjami węzła XPath i elementami informacyjnymi jest bezpośrednie. Jednakże, xpointer() zakłada, że wszystkie elementy rekordu zostały rozszerzone. Zatem błąd krytyczny ma za zadanie próbować rozwiązać schemat xpointer() w dokumencie, który zawiera nierozszerzoną informację odnośnika elementu rekordu .

Zbiór zawartych elementów najwyższego poziomu jest uzyskiwany z uzyskanego zbioru informacji .

4.3 Elementy Zawarte kiedy parse="text"

Kiedy parse="text", zawarta lokalizacja jest usunięta i źródło jest pobrana i przetworzona do zbioru znaków elementów informacji. Ta cecha ułatwia inkluzje działania przykładów XML, zarówno jak i innych formatów opartych na tekście.

Źródła, które są niedostępne z jakiegokolwiek innego powodu (np. źródło nie istnieje, utrudnienia w łączności lub wymogi bezpieczeństwa chronią go przed pobraniem go, schemat URI nie jest pobieralny, lub źródło jest kodowaniem niewspomaganym), powodują błąd źródła.

Kodowanie takiego źródła jest jest określone przez:

• zewnetrzną informację kodującą, jeśli jest dostępna, w przeciwnym wypadku

• jeżeli typ media źródła to text/xml, aplikacja/xml, lub odpowiada konwencjom text/*+xml lub aplikacja/*+xml jak opisano w Typach Media XML [IETF RFC 3023], kodowanie jest rozpoznawane tak, jak opisano w XML, w przeciwnym wypadku

• wartość atrybutuencoding jeśli taki istnieje to

• UTF-8.

Sekwencja bajtów poza obszarem dozwolonym przez kodowanie to błąd krytyczny. Znaki niedozwolone w dokumantach XML to również błąd krytyczny.

Każdy znak uzyskany z transformacji źródła jest przedstawiony w elementach zawartych najwyższego poziomu jako element informacji znaku ze zbiorem kodów znaku do kodów znaków w kodowaniu ISO 10646, oraz zbiorem odstępów zawartości elementu , do błędnych.

[Model Znaków] omawia normalizację zawartego tekstu.

4.4 Zachowanie rezerwy awaryjnej

Procesory XInclude muszą wykonać zachowanie rezerwy awaryjnej w przypadku błędu źródła, w następujący sposób:

Jeżeli potomkowie elementu informacyjnego xi:include w źródłowym zbiorze informacji zawierają dokładnie jeden element xi:fallback, zawarte elementy najwyższego poziomu składają się z elementów informacyjnych odpowiadających wynikowi wykonania przetwarzania XInclude na potomkach elementu xi:fallback. Jest to błąd krytyczny jeśli jest zero lub więcej niż jeden element xi:fallback.

4.5 Tworzenie wynikowego zbioru informacji

Wynikowy zbiór informacji jest kopią źródłowego zbioru informacji, z każdym elementem xi:include przetworzonym następująco:

Element informacyjny dla elementu xi:include jest znaleziony. [Definicja: Własność parent (przodek) tego elementu odnosi się do elementu informacyjnego zwanego include parent.] Własność children (potomek) elementu include parent jest zmodyfikowana przez zastąpienie elementu informacyjnego xi:include przez zawartymi elementami najwyższego poziomu . Własnością parent każdego zawartego elementu jest ustawienie include parent.

Błędem krytycznym jest próba zastąpienia elementu xi:include pojawiającego się jako element dokumentu (najwyższy poziom) w źródłowym zbiorze informacji z czymś innym, niż lista zero lub więcej komentarzy, zero lub więcej instrukcji przetwarzania, oraz jeden element.

Niektóre procesory mogą nie być w stanie przedstawić własności elementu przestrzenią nazw in-scope jeżeli nie zawiera ona wiązań dla wszystkich prefiksów ograniczonych przez ich przodków przestrzenie nazw in-scope. Takie procesory mogą zatem zawierać dodatkowe wiązania przestrzeni nazw odziedziczone po include parent w przestrzeniach nazw in-scope zawartych elementów.

Historia inkluzji takiego zawartego elementu najwyższego poziomu jest zarejestrowana we własności rozszerzenia zawarta historia (include history). Własność zawarta historia to lista elementów informacyjnych, przedstawiających elementy xi:include dla rekursywnych poziomów inkluzji. Jeżeli własność zawarta historia już pojawia się na zawartym elemencie najwyższego poziomu, to element informacyjny xi:include jest przyłączony do listy. Jeśli nie istnieje żadna własność zawartej historii, to własność jest dodawana z pojedynczą wartością elementu informacyjnego xi:include.

Wszystkie zawarte elementy będą pojawiać się w wynikowym zbiorze informacji. Zawiera to nierozszerzone informacyjne elementy rekordu jeżeli są obecne.

Odnośniki wewnątrz dokumentu w obrębie elementów xi:include są rozwiązane na źródłowym zbiorze informacji. Efektem tego jest, że porządek, w jakim elementy xi:include są przetwarzane, nie wpływa na wynik.

W następującym przykłądzie, drugie włączenie zawsze wskazuje na pierwszy element xi:include, a nie na siebie, niezależnie od porządku, w jakim włączenia są przetwarzane. W ten sposób wynikiem tej inkluzji są dwie kopie something.xml (coś.xml), i nie powstaje inkluzyjny błąd pętli.

<x xmlns:xi="http://www.w3.org/2001/XInclude">   <xi:include href="something.xml"/>
<xi:include xpointer="xmlns(xi=http://www.w3.org/2001/XInclude)xpointer(x/xi:include[1])"
parse="xml"/>
</x>

5.1 Zgodność znaczników

przedmiot informacyjny typu element jest zgodny z tą specyfikacją jeżeli spełnia wymagania strukturalne dla zawartych elementów określonych w tej specyfikacji. Ta specyfikacja nie narzuca żadnych szczególnych ograniczeń dla schematów DTD lub XML; zgodność ma zastosowanie wyłącznie do elementów i atrybutów.

5.2 Zgodność zastosowania

Zastosowanie jest zgodne z XInclude jeżeli:

• wspiera [XML 1.0] i [Przestrzenie nazw w XML] lub [XML 1.1] i [Przestrzenie nazw w XML 1.1], [Zbiorze Informacji XML], [Podstawie XML], [Strukturze XPointer], oraz [Schemacie element() XPointer] ;

• zaprzestaje przetwarzania kiedy napotyka na błąd krytyczny;

• przestrzega obowiązkowych warunków, (musi) przedłożonych w tej specyfikacji i dla jakichkolwiek innych warunków (powinien i może), wybiera, aby przestrzegać, przestrzega ich w zalecany sposób; i

• wykonuje sprawdzanie zgodności znaczników zgodnie ze wszystkimi ograniczeniami zgodności pojawiającymi się w tej specyfikacji.

Wsparcie dla [Schematu XPointer xpointer()] nie jest obowiązkowa dla pełnej zgodności XInclude. Radzi się autorom, by używali xpointer() i innych schematów implementacji XPointer.

5.3 Zgodność zbioru informacji XML

Ta specyfikacja jest zgodna ze [Zbiorem informacji XML]. Następujące przedmioty informacyjne muszą być obecne w wejściowych zbiorach wartości, aby umożliwić poprawne przetwarzanie:

• przedmioty informacyjne typu dokument z własnościami potomkowie i podstawowy URI.

• Przedmioty informacyjne typu element z własnościami nazwa przestrzeni nazw, nazwa lokalną, potomkowie, atrybuty, podstawowy URI i przodek.

• Przedmioty informacyjne typu atrybut z własnościami nazwa przestrzeni nazw, nazwa lokalna i znormalizowana wartość.

Dodatkowo przetwarzanie XInclude może generować w wyniku następujące rodzaje przedmiotów informacyjnych:

• przedmiot informacyjny typu znak z własnościami kod znaku, odstęp zawartości elementu i przodek.

XInclude rozszerza zbiór informacji o własność zawarta historia, która w wyniku może pojawić się na następujących typach przedmiotów informacyjnych:

• przedmiot informacyjny typu element .

• instrukcja przetwarzania przedmiotów informacyjnych.

• przedmioty informacyjne typu komentarz.

• przedmioty informacyjne typu znak.

XInclude również rozszerza zbiór informacji o własność język, która w wyniku może pojawić się na przedmiotach informacyjnych typu element .