Овај чланак објашњава како правилно писати КСМЛ показујући пример. Билтен Веб Вритер написан је у облику КСМЛ-а; називамо га АМЛ или Абоут Маркуп Лангуаге. Иако је ово радни документ, то није добро обликован или важећи КСМЛ документ.
Добро обликован
Постоје нека специфична правила за креирање добро обликованог КСМЛ документа:
- КСМЛ декларација мора бити на првом месту у сваком документу.
- Коментари нису важећи у оквиру ознаке. Коментари не смеју да садрже две цртице у низу, осим почетка и краја коментара.
- Ознаке морају имати завршну ознаку или, на пример, бити затворене унутар саме синглетон ознаке.
- Сви атрибути ознака морају се наводити, по могућности двоструки наводници, осим ако сам атрибут садржи двоструке наводнике.
- Сваки КСМЛ документ мора садржати један елемент који у потпуности садржи све остале елементе.
Постоје само два проблема са документом због којих документ није добро обликован:
- Прва ствар која АМЛ документу треба је изјава КСМЛ декларације.
- Други проблем је што ниједан елемент у потпуности не затвара све остале елементе. Да бисмо то поправили, додаћемо спољни елемент контејнера:
Уношењем те две једноставне промене (и осигурањем да сви елементи садрже само ЦДАТА) претвориће необликовани документ у добро обликован документ.
Важећи КСМЛ документ се проверава према дефиницији типа документа (ДТД) или КСМЛ шеми. То су скуп правила која је креирао програмер или организација за стандардизацију која дефинишу семантику КСМЛ документа. Они рачунару говоре шта да ради са маркирањем.
У случају О Маркуп Лангуаге, пошто ово није стандардни КСМЛ језик, попут КСХТМЛ или СМИЛ, ДТД би креирао програмер. Тај ДТД би се највероватније налазио на истом серверу као и КСМЛ документ и наведен на врху документа.
Пре него што започнете са развојем ДТД-а или шеме за своје документе, требало би да схватите да се КСМЛ документ самообликовањем, само ако је добро обликован, сам описује и да му зато није потребан ДТД.
На пример, уз наш добро обликован АМЛ документ постоје следеће ознаке:
Ако сте упознати са билтеном Веб Вритер, можда ћете препознати различите одељке билтена. То олакшава стварање нових КСМЛ докумената у истом стандардном формату. Увек бисмо ставили наслов у целој дужини у ознаку и УРЛ првог одељка у ознаку.
ДТД
Ако се од вас захтева да напишете важећи КСМЛ документ, било да бисте користили податке или их обрађивали, укључили бисте га у свој документ са ознаком. У овој ознаци дефинишете основну КСМЛ ознаку у документу и локацију ДТД-а (обично веб УРИ).
На пример:
Једна лепа ствар код ДТД декларација је та што можете изјавити да је ДТД локални за систем у коме је КСМЛ документ је са „СИСТЕМОМ“. Такође можете указати на јавни ДТД, као што је ХТМЛ 4.0 документ:
Када користите обоје, говорите документу да користи одређени ДТД (јавни идентификатор) и где да га пронађе (системски идентификатор).
Коначно, можете да укључите интерни ДТД директно у документ, унутар ознаке ДОЦТИПЕ. На пример (ово није потпуни ДТД за АМЛ документ):
КСМЛ шема
Да бисте креирали важећи КСМЛ документ, такође можете да користите документ КСМЛ шеме да бисте дефинисали свој КСМЛ. КСМЛ шема је КСМЛ документ који описује КСМЛ документе. Научите како да напишете шему.
Белешка
Само указивање на ДТД или КСМЛ шему није довољно. КСМЛ који се налази у документу мора следити правила у ДТД или шеми. Коришћење валидационог парсера је једноставан начин да проверите да ли ваш КСМЛ поштује ДТД правила. Много таквих парсера можете пронаћи на мрежи.