Dokumentace XML - články a aktuality

Základní pravidla

• XML aktualit a článků lze využít pro import a export z Upgates.
• Zde je k náhledu prázdné vzorové XML.
• K testování struktury XML je možno použít naše XSD.
• Tagy končící na _YN> jsou typu boolean a mohou nabývat hodnoty 0, 1, true, false.
• Datum je zapsané jako řetězec znaků ve formátu YYYY-MM-DD dle ISO 8601. Y je rok, M je měsíc a D je den. Příklad: 2020-12-30.
• Atributy language označující jazykovou mutaci používají kódy podle ISO 639-1 a jsou povinné.

Import

• Je možné provádět pouze import nových článků a aktualit, aktualizace není možná.
• Další chování importu můžete ovlivnit nastavením v administraci (viz. nápověda).

Export

• Exportují se všechny tagy s výjimkou tagů s prázdnou hodnotou. Ty mohou v exportu chybět.
• Toto XML se používá pro export dvou typů obsahu - článků a aktualit.

Struktura XML

• <TEXTS>
  • version - verze formátu XML, aktuálně je to 1.0
  • <TEXT>
    • type - typ textu, možné hodnoty:
      • article - článek
      • news - aktualita
    • <ACTIVE_YN> - zobrazit text na webu
    • <ACTIVE_FROM> - pouze aktuality, datum od kterého bude aktualita aktivní
    • <ACTIVE_TO> - pouze aktuality, datum do kterého bude aktualita aktivní
    • <CREATION_TIME> - datum vytvoření
    • <DESCRIPTIONS> - texty
      • <DESCRIPTION>
        • language - Specifikace jazykové mutace
        • <URL> - URL textu
        • <TITLE> - Název
        • <SHORT_DESCRIPTION> - Krátký popis. Bez HTML formátování
        • <LONG_DESCRIPTION> - Dlouhý popis. Formátování pouze pomocí HTML značek
    • <SEO_OPTIMALIZATION> - SEO
      • <SEO>
        • language - Specifikace jazykové mutace
        • <SEO_URL> - Vlastní koncovka URL adresy
        • <SEO_TITLE> - SEO titulek
        • <SEO_META_DESCRIPTION> - META popisek stránky
    • <CATEGORIES> - Kategorie, pouze články
      • <CATEGORY>
        • <CODE> - Kód kategorie, do které bude článek zařazen. Páruje se podle existujícího kódu kategorie
        • <NAME> - Název kategorie, do které je článek zařazen
        • <PRIMARY_YN> - Informace, zda je kategorie primární
        • <POSITION> - Pozice v kategorii
    • <IMAGES> - Obrázky
      • <IMAGE>
        • <URL> - URL adresa obrázku
        • <TITLES> - Popisky obrázku
          • <TITLE>
            • language - Specifikace jazykové mutace
        • <MAIN_YN> - Obrázek je hlavní
        • <LIST_YN> - Obrázek je seznamový
    • <FILES> - Soubory
      • <FILE>
        • <URL> - URL adresa souboru
        • <TITLES> - Popisky souborů
          • <TITLE>
            • language - Specifikace jazykové mutace
    • <METAS> - vlastní pole
      • <META>
        • type - typ vlastního pole, možné hodnoty:
          • radio - přepínač
          • checkbox - zaškrtávací políčko
          • input - textové pole
          • date - datum
          • email - email
          • number - číslo
          • select - rozbalovací nabídka
          • multiselect - multi rozbalovací nabídka
          • textarea - víceřádkové textové pole
          • formatted - víceřádkové textové pole formátované (WYSIWYG)
        • <META_KEY> - klíč vlastního pole - povolené znaky jsou malá písmena, čísla (nesmí být na první pozici) a podtržítko
        • <META_VALUE> - hodnota vlastního pole, uvádí se pokud je stejná pro všechny jazykové mutace
        • <META_VALUES> - hodnoty vlastního pole pro jednotlivé jazykové mutace
          • <META_VALUE>
            • language - specifikace jazykové mutace