Dobrze sformułowany dokument
Dobrze sformułowany dokument w XML to dokument, który „przestrzega zasad składni określonych w specyfikacji XML 1.0, ponieważ musi spełniać zarówno struktury fizyczne, jak i logiczne”.
Wymagania
Na poziomie podstawowym dobrze sformułowane dokumenty wymagają, aby:
- Treść być zdefiniowana.
- Treść powinna być oddzielona znacznikiem początkowym i końcowym
- Treść powinna być odpowiednio zagnieżdżona (rodzice w korzeniach, dzieci w rodzicach)
Aby dokument był dobrze sformułowany, należy ustalić zasady dotyczące deklaracji i traktowania podmiotów. W tagach rozróżniana jest wielkość liter , a atrybuty są rozdzielane cudzysłowami. Puste elementy mają ustalone reguły. Nakładające się znaczniki unieważniają dokument. Idealnie, dobrze sformułowany dokument jest zgodny z celami projektowymi XML. Inne kluczowe zasady składni podane w specyfikacji obejmują:
- Zawiera tylko prawidłowo zakodowane, legalne znaki Unicode.
- Żaden ze specjalnych znaków składniowych, takich jak
<i&,nie pojawia się, z wyjątkiem wykonywania ich ról wyznaczania znaczników. - Znaczniki początku, końca i pustego elementu, które ograniczają elementy, są prawidłowo zagnieżdżone, żadnego nie brakuje ani nie zachodzi na siebie.
- W znacznikach elementów rozróżniana jest wielkość liter; znaczniki początkowe i końcowe muszą dokładnie pasować. Nazwy tagów nie mogą zawierać żadnych znaków
!"#$%&'()*+,/;<=>?@[\]^`{|}~ ,ani spacji i nie mogą zaczynać się od-,., lub cyfra. - Istnieje jeden element „główny”, który zawiera wszystkie pozostałe elementy.
Prawidłowy dokument XML jest zdefiniowany w specyfikacji XML jako dobrze sformułowany dokument XML, który jest również zgodny z zasadami definicji typu dokumentu (DTD). Zgodnie z tutorialem XML JavaCommerce.com, „Dobrze sformułowane dokumenty XML po prostu oznaczają strony z opisowymi tagami. Nie musisz opisywać ani wyjaśniać, co oznaczają te tagi. Innymi słowy, dobrze sformułowany dokument XML nie potrzebuje DTD, ale to musi być zgodny z regułami składni XML. Jeśli wszystkie znaczniki w dokumencie są poprawnie sformułowane i zgodne z wytycznymi XML, dokument jest uważany za dobrze sformułowany.
Procesor XML, który napotka naruszenie zasad prawidłowego sformułowania, musi zgłosić takie błędy i przerwać normalne przetwarzanie. Ta polityka, czasami określana jako drakońska , wyraźnie kontrastuje z zachowaniem programów przetwarzających HTML , które mają dawać rozsądne wyniki nawet w przypadku poważnych błędów znaczników w duchu prawa Postela („Bądź konserwatywny w tym, co wysyłasz; bądź hojny w tym, co przyjmujesz”).
Znaczenie
Koncepcja dobrze sformułowanego dokumentu pozwala lepiej zrozumieć podstawową konstrukcję XML. Pomaga wyjaśnić XML poza typowym jego znaczeniem. Na przykład, podczas gdy większość definicji typów dokumentów XML wykorzystuje lewy i prawy nawias ostry jako ograniczniki treści, ściśle mówiąc nie jest to konieczne (chociaż ogranicznik powinien być zwięzły i zwięzły). Kody lewego i prawego nawiasu kątowego są konwencją, choć jasną i charakterystyczną, a nie bezwzględnym wymogiem.
Koncepcja dobrze sformułowanego dokumentu pozwala również na zrozumienie abstrakcyjnej natury XML. W rzeczywistości nie ma czegoś takiego jak XML. [ potrzebne źródło ] XML jest raczej zasadą reprezentującą zestaw zachowań i praktyk. Możliwe jest omówienie typów XML wyrażonych w definicji typu dokumentu (DTD).
Dobrze sformułowane dokumenty zwracają również uwagę na kwestię prawidłowego i poprawnego kodu XML. Według Organizacji W3 ważne dokumenty to te, które są zgodne z DTD. Reguły ważności oznaczają, że dokument jest zgodny z ograniczeniami określonymi w DTD. Dlatego tagi lub jednostki muszą być zgodne z zasadami i relacjami ustanowionymi w ramach DTD. Jednak nie ma kontroli nad tym, czy tag lub jednostka są poprawne. W ten sposób etykieta nagłówka pierwszego poziomu może być zastosowana do obiektu nagłówka drugiego poziomu i być ważna, chociaż niepoprawna.
wydawniczym rozwinął się nacisk na dobrze sformułowane dokumenty, w których stosowanie informacji rozdzielonych lewymi i prawymi nawiasami ostrymi stało się problematyczne. [ Potrzebne źródło ] Nacisk na dobrze sformułowany dokument pozwala na definiowanie, wyznaczanie granic i zagnieżdżanie treści, które mają być zarządzane w programach, które nie są XML per se, ale wykazują cechy lub potencjał, aby być dobrze sformułowane.
Narzędzia do walidacji
Dostępnych jest kilka narzędzi pozwalających określić, czy dany dokument XML jest prawidłowo sformułowany.