Dokumentace pro integraci RSS feedu

Návod k vytvoření a správné implementaci RSS feedu dle specifikace RSS 2.0, včetně povinných a doporučených elementů, práce s obrázky a médii, a podpory pokročilých komponent.

Ověřte správnost vašeho RSS feedu: Validátor RSS feedu

  1. Úvod

    Tento dokument slouží jako návod pro vytvoření RSS feedu, který je kompatibilní s naší aplikací. Správně vytvořený feed umožní bezproblémovou integraci obsahu a zajistí, že příspěvky budou zobrazovány správně.

  2. Struktura RSS feedu

    RSS feed musí splňovat specifikaci RSS 2.0 a obsahovat následující elementy:

    • hlavní prvek definující verzi RSS
    • obsahuje metadata feedu a seznam příspěvků
    • název feedu
    • krátký popis obsahu feedu
    • logo nebo ikona feedu
    • datum poslední aktualizace

    Každý příspěvek musí být umístěn v elementu item.

  3. Struktura položky feedu

    Každý příspěvek musí obsahovat následující elementy:

    Povinné elementy

    • Název příspěvku (delší popisný název)
    • media:title – SEO název příspěvku (krátký a výstižný)
    • URL odkaz na celý příspěvek
    • krátký popis příspěvku bez HTML značek
    • content:encoded – celý obsah příspěvku ve formátu HTML, musí být obalen do značek , aby bylo zajištěno správné zobrazení speciálních znaků a HTML struktury.
    • media:content – hlavní obrázek příspěvku s absolutní URL datum zveřejnění příspěvku
    • datum zveřejnění příspěvku

    Doporučené elementy

    • kategorie příspěvku
    • u obrázků
      • media:credit – zdroj obrázku
      • media:title – popisek obrázku (alt text)
      • media:text – viditelný popisek obrázku
  4. Obsah příspěvku

    Obsah příspěvku musí splňovat následující požadavky:

    • Musí být uveden v content:encoded
    • Může obsahovat běžné HTML značky
    • Může obsahovat embedded obsah (např. YouTube videa – iFrame content obecně)

    Zakázaný obsah

    • Nesmí obsahovat skripty
    • Nesmí obsahovat neschválené reklamní sdělení (např. reklamní boxy, provizní linky apod.)
  5. Obrázky a média

    • Všechny obrázky musí mít absolutní URL, relativní cesty nejsou podporovány
    • Obrázky musí být definovány v media:content, kde url musí vést na platný obrázek
    • media:title slouží jako alternativní text (alt)
    • media:text může obsahovat viditelný popisek obrázku
  6. Pokročilé komponenty

    Naše aplikace podporuje následující pokročilé komponenty:

    Embedded content

    Můžete přidávat příspěvky obsahující ve svém těle libovolný embedded content ve formátu iFrame, který neodporuje požadavkům na obsah. Embedded content závislý na externích skriptech není podporován.

    V případech, kdy si nejste jisti, zda embed neodporuje požadavkům na obsah, kontaktujte nás.

    Galerie

    Pokud příspěvek obsahuje obrázky, které chcete zobrazit jako galerii, použijte následující formát:

    Slideshow Preview

    Náhled zobrazení fotogalerie u příspěvku

    Je nutné vložit do RSS obrázky tímto způsobem:

    <div class="slideshow">
      <figure>
        <img src="https://vase-domena.cz/cesta-k/obrazku.jpg">
        <figcaption>Popisek obrázku</figcaption>
      </figure>
      ...
    </div>

    Element figcaption může obsahovat další vnořené HTML elementy, například em, strong apod.

  7. Ukázkový RSS feed

    <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"
         xmlns:content="http://purl.org/rss/1.0/modules/content/"
         xmlns:media="http://search.yahoo.com/mrss/">
        <channel>
            <title>Název aplikace partnera</title>
            <link>https://www.domena-partnera.cz/</link>
            <description>Krátký popis partnerské aplikace.</description>
            <image>
                <url>https://www.domena-partnera.cz/ikona-nebo-logo.png</url>
                <title>Název aplikace partnera</title>
                <link>https://www.domena-partnera.cz/</link>
            </image>
            <language>cs</language>
            <pubDate>Tue, 10 Jun 2003 04:00:00 GMT</pubDate>
            <atom:link href="https://www.domena-partnera.cz/cesta-k-feedu/rss.xml" rel="self" type="application/rss+xml"/>
            <docs>https://www.rssboard.org/rss-specification</docs>
            <item>
                <title>Název příspěvku</title>
                <media:title>SEO název příspěvku</media:title>
                <link>https://www.domena-partnera.cz/odkaz-na-prispevek</link>
                <description>
                    Krátký popis příspěvku bez HTML značek.
                </description>
                <content:encoded><![CDATA[<p>Celý obsah příspěvku s HTML značkami.</p>]]></content:encoded>
                <media:content url="https://www.domena-partnera.cz/cesta-k-obrazku/obrazek.jpg" type="image/jpeg" medium="image">
                    <media:credit>Zdroj fotografie</media:credit>
                    <media:title>Popisek fotografie - alt text.</media:title>
                    <media:text>Caption - viditelný popisek fotografie.</media:text>
                </media:content>
                <pubDate>Fri, 21 Jul 2023 09:04 EDT</pubDate>
                <category>Kategorie příspěvku</category>
                <guid isPermaLink="true">https://www.domena-partnera.cz/odkaz-na-prispevek</guid>
            </item>
        </channel>
    </rss>
  8. Další zdroje

    Tento dokument poskytuje všechny potřebné informace k vytvoření RSS feedu, který bude správně fungovat v naší aplikaci. Pokud máte další dotazy, kontaktujte naši technickou podporu.

Jakékoliv užití obsahu, včetně převzetí článků, je bez souhlasu Economia, a.s. zapovězeno.
Bez souhlasu Economia, a.s. je zapovězeno též rozmnožování obsahu pro účely automatizované analýzy textů nebo dat podle ustanovení § 39c autorského zákona.