RSS-straumstaðfestir

Uppbygging og kröfur RSS 2.0 og Atom 1.0 strauma

RSS 2.0 og Atom 1.0 eru tveir útbreiddustu staðlarnir fyrir dreifingu á stafrænu efni. Þótt báðir staðlar þjóni þeim tilgangi að miðla uppfærslum til lesenda, fylgja þeir ólíkum reglum um uppbyggingu og lágmarkskröfur gagna.

Í RSS 2.0 straumi er grunnurinn XML-skjal þar sem rótareiningin verður að innihalda nákvæmlega eitt beint <channel>. Ef fleiri eða færri slíkar einingar finnast, gefur kerfið villuna „RSS verður að innihalda nákvæmlega eitt beint <channel>; ‹count› fundust.“. Inni í þessari rás eru einstakar færslur skilgreindar með <item> einingum. Fyrir hverja færslu í RSS-straumi gildir sú regla að annaðhvort titill (title) eða lýsing (description) verður að vera til staðar. Þáttarinn les einnig önnur lykilsvið á borð við einkvæmt auðkenni (GUID), tengil (link) og útgáfudagsetningu (publication date).

Atom 1.0 staðallinn fylgir strangari reglum um uppbyggingu. Hér er rótareiningin <feed> og færslur eru skilgreindar sem <entry>. Fyrir hverja Atom-færslu þarf að uppfylla kröfur um einkvæmt auðkenni (ID), titil (title), uppfærslutíma (updated), höfundarupplýsingar (author inheritance), varatengla (alternate links) og reglur um innihald eða útdrátt (content or summary).

Algeng vandamál og villur í XML-straumum

Við smíði og flutning á straumum koma oft upp villur í mörkun sem gera það að verkum að lesarar geta ekki túlkað efnið. RSS-straumstaðfestirinn greinir þessi vandamál og gefur nákvæmar skýrslur um hvar villurnar liggja.

Algengustu villurnar sem koma upp við greiningu eru:

• Rangt uppsett XML: Ef skjalið fylgir ekki grunnreglum XML (til dæmis ef merki lokast ekki eða stafir eru rangt kóðaðir) birtist villan „Lagaðu rangt uppsett XML og staðfestu það aftur.“.
• Óleyfilegar yfirlýsingar: Ef skjalið inniheldur DOCTYPE-yfirlýsingu þarf að fjarlægja hana, annars gefur tólið villuna „Fjarlægðu DOCTYPE-yfirlýsinguna áður en straumurinn er athugaður.“.
• Óstutt snið eða útgáfur: Ef reynt er að hlaða inn eldri sniðum eða óþekktum skjölum birtast villur á borð við „Notaðu RSS 2.0 skjal með <rss> eða Atom 1.0 skjal með <feed>.“ eða „Staðfestirinn styður ‹format› ‹expected›; ‹actual› greindist.“.
• Tvítekin auðkenni: Einkvæm auðkenni færslna mega ekki endurtaka sig. Ef það gerist birtist villan „Þetta ID endurtekur gildið sem sást fyrst í línu ‹first›.“.

Mikilvægi réttra tengla og hlutverk xml:base

Tenglar og auðkenni í straumum verða að vera rétt uppsett svo lesarar geti vísað notendum á réttar vefsíður. Tólið þáttar öll svið sem innihalda tengla og athugar hvort hægt sé að túlka þau sem gild URL- eða URI-vistföng. Ef tengill er gallaður birtist villan „Lagaðu ‹field›; ekki er hægt að þátta tengilinn sem URL- eða URI-tilvísun.“.

Í Atom-straumum er leyfilegt að nota afstæðar vísanir ef rótareiningin eða viðkomandi eining skilgreinir grunnvistfang með xml:base eiginleikanum. Ef xml:base er ekki til staðar verða allir tenglar að vera algildir. Ef afstæður tengill finnst án þess að hægt sé að leysa hann, birtir tólið villuna „Notaðu algilt vistfang fyrir ‹field›; aðeins Atom-tilvísanir með nothæft xml:base mega vera afstæðar.“. Fyrir einkvæm auðkenni í Atom gildir enn strangari regla: þau verða alltaf að vera algild IRI-vistföng, og afstæð auðkenni eru aldrei leyfð. Ef það er brotið birtist villan „Notaðu algilt IRI fyrir ‹field›; afstæð auðkenni eru ekki gild Atom ID.“.

Kröfur um höfunda og innihald í Atom-færslum

Atom 1.0 gerir ríkar kröfur um höfundaupplýsingar og hvernig efni er sett fram. Ef straumurinn sjálfur inniheldur ekki upplýsingar um höfund, verður hver einasta færsla að hafa skilgreindan höfund. Ef þetta vantar birtir tólið villuna „Bættu <author> við strauminn eða beinum <author> við hverja færslu.“ eða „Bættu <author> við þessa færslu, <source> hennar eða strauminn.“.

Þegar kemur að innihaldi færslna gilda eftirfarandi reglur:

1. Varatenglar: Ef Atom-færsla inniheldur ekki innfellt efni, verður hún að hafa varatengil (alternate link). Ef hann vantar birtist villan „Bættu við öðrum <link> þegar Atom-færsla hefur ekkert innfellt <content>.“.
2. Ytra innihald: Ef einingin <content> notar src eiginleika til að vísa í ytra efni, má hún ekki innihalda innfelldan texta eða undireiningar. Þá birtist villan „Þegar <content> notar src skaltu fjarlægja innfelldan texta og undireiningar.“.
3. Útdráttur: Ef innihald Atom-færslu er hýst á ytri vefsíðu eða er ekki á lesanlegu textasniði, verður að fylgja útdráttur (summary). Ef hann vantar birtist villan „Bættu við <summary> þegar Atom-efni er utanaðkomandi eða ekki læsilegt sem texti.“.

Dagsetningar og sniðreglur

Bæði RSS og Atom krefjast þess að dagsetningar fylgi stöðluðum sniðum svo hugbúnaður geti flokkað færslur eftir tímaröð. RSS notar yfirleitt RFC 822 sniðið (t.d. Wed, 02 Oct 2002 13:00:00 GMT) á meðan Atom notar ISO 8601 sniðið (t.d. 2002-10-02T15:00:00Z). Ef dagsetning fylgir ekki tilskildu sniði eða inniheldur ógild gildi, gefur staðfestirinn villuna „Notaðu raunverulega dagsetningu á því sniði sem straumurinn krefst.“.

Öryggi og vinnsluferli gagna

Þegar þú notar þennan RSS-straumstaðfesti fer öll greining og vinnsla fram beint í vafranum þínum. Engum gögnum er hlaðið upp á ytri netþjóna og ekkert er vistað af hálfu BroBroGo.

Tólið vinnur eingöngu með það XML-magn sem límt er inn í textasvæðið, með hámarki upp á 500.000 stafi í hverri athugun. Ef inntakið fer yfir þessi mörk birtast villuboðin „Verkfærið tekur við allt að ‹max› stöfum í hverri athugun.“. Ef vinnslan tekur of langan tíma eða stöðvast, birtast skilaboðin „Staðfestingin tók of langan tíma. Prófaðu minni straum.“ eða „Ekki tókst að ljúka staðfestingu.“.

Athugaðu að tólið prófar aðeins uppbyggingu og algengar sniðreglur XML-skjalsins. Það opnar aldrei útiandandi tengla eða vefslóðir, sem þýðir að aðgengi, áframsendingar, SSL-skilríki og raunverulegt innihald áfangastaðarins eru ekki prófuð. Skýrslan sannar því ekki að efnið sé rétt, öruggt eða tilbúið til útgáfu, heldur staðfestir hún eingöngu tæknilega uppbyggingu gagnaformanna.

Algengar spurningar

Hvaða straumsnið styður staðfestirinn?

Hann staðfestir núverandi RSS 2.0 og Atom 1.0 skjöl. Eldri RSS-, RDF/RSS 1.0- og Atom 0.3-straumar eru greindir en ekki athugaðir eftir röngum reglum.

Opnar eða prófar hann tengla í straumnum?

Hann þáttar svið sem innihalda tengla og leysir afstæðar Atom-tilvísanir með xml:base. URL eru aldrei opnuð, svo aðgengi, áframsendingar, skilríki og efni áfangastaðar eru ekki prófuð.

Hvaða færslusvið eru athuguð?

Fyrir RSS item er athugað hvort title eða description sé til staðar og GUID, tengill og útgáfudagur lesin. Fyrir Atom entry eru ID, title, updated, erfðir author, varatenglar og reglur content eða summary athugaðar.

Hversu mörg vandamál og færslur sýnir skýrslan mest?

Til að tryggja afköst í vafra birtir tólið að hámarki 200 vandamál og 100 færslur í einu. Ef straumurinn inniheldur fleiri atriði, birtast tilkynningar um að niðurstöðurnar hafi verið styttar.