Вимоги до надання джерел даних в стрічку новин порталу Укрнет.
Зміст
Додаток 1. Технічні вимоги до Джерела новин Партнера
Додаток 2. Приклад джерела з новинами для однієї рубрики
Додаток 3. Приклад Джерела з новинами для кількох рубрик
Загальні вимоги
- Партнер - це сайт / інформаційний ресурс, який хоче транслювати новини в стрічку новин порталу Укрнет.
- Джерело новин - RSS джерело новин партнера.
- Один Партнер може мати одне або декілька Джерел новин.
- Всі новини в стрічці новин порталу Укрнет розподіляються по рубриках: Політика, Економіка, Події, Суспільство, Регіональні новини, Технології, Наука, Авто, Спорт, Здоров'я, Шоу-бізнес, За кордоном, Курйози, Фоторепортаж, Відео, Lifestyle, Все про їжу.
- Для підключення в стрічку новин порталу Укрнет Партнер повинен надати посилання на своє Джерело / Джерела новин.
- Джерело новин повинно повністю відповідати вимогам, описаним в Додатку 1 цього документу.
- Кожне Джерело новин Партнера може містити новини для однієї або декількох рубрик порталу Укрнет:
- Якщо джерело новин містить новини ВИКЛЮЧНО однієї рубрики, наприклад «Політика», то для кожного такого джерела Партнера необхідно вказати чітку і однозначну відповідність рубрикам порталу Укрнет.
Приклад:
- Якщо джерело новин містить новини ВИКЛЮЧНО однієї рубрики, наприклад «Політика», то для кожного такого джерела Партнера необхідно вказати чітку і однозначну відповідність рубрикам порталу Укрнет.
Джерело Партнера |
В яку рубрику на порталі подавати новини |
http://www.partnerurl.com/rss/source1.rss |
Політика |
http://www.partnerurl.com/rss/source2.rss |
Економіка |
http://www.partnerurl.com/rss/source3.rss |
Курйози |
- Якщо джерело новин Партнера містить новини декількох рубрик або всі новини Партнера, то для кожної з новин в Джерелі необхідно вказувати рубрику, до якої відноситься новина - вказувати рубрику необхідно в тезі <category>. Крім того, необхідно надати список відповідності між рубриками Партнера і рубриками на порталі Укрнет.
Приклад списку відповідності рубрик:
- Якщо джерело новин Партнера містить новини декількох рубрик або всі новини Партнера, то для кожної з новин в Джерелі необхідно вказувати рубрику, до якої відноситься новина - вказувати рубрику необхідно в тезі <category>. Крім того, необхідно надати список відповідності між рубриками Партнера і рубриками на порталі Укрнет.
Рубрика Партнера |
Рубрика Укрнет |
Гаджети |
Технології |
Світ |
За кордоном |
Гроші |
Економіка |
- Якщо джерело новин має чітку регіональну спрямованість і містить новини по конкретному регіону України, наприклад «Житомир», то необхідно повідомити про цей факт менеджеру Укрнет. Для регіональних джерел не допускається публікація загальнонаціональних, світових і тематичних новин (наприклад Авто). Якщо Партнеру необхідно подавати на портал новини як загальної, так і регіональної спрямованості - необхідно створювати для регіональних і загальних новин - окремі джерела.
- Не допускається дублювання одних і тих самих новин в різних джерелах одного Партнера.
Додаток 1. Технічні вимоги до Джерела новин Партнера
Експорт Даних для розміщення заголовків і анотацій новин на Укрнет здійснюється в XML-based (https://www.w3.org/TR/REC-xml) форматі RSS 2.0 (https://blogs.law.harvard.edu/tech/rss). Нижче міститься опис елементів RSS 2.0, що використовуються для експорту Даних, необхідні коментарі і приклад експортного файлу.
- <?xml version="1.0" encoding="utf-8"?>
- Найперший рядок.
- Якщо це не вказано явно в заголовку, кодуванням файлу вважається utf-8.
- В іншому випадку потрібно обов'язково вказувати кодування xml файлу. Найбільш вживані кодування:
windows-1251, utf-8, koi8-r. - Увага: фактичне кодування, що віддається вебсервером, повинно ЗАВЖДИ збігатися з кодуванням, зазначеним в заголовку XML.
- <rss version="2.0" xmlns:xml="http://www.w3.org/XML/1998/namespace">
- Обов'язковий кореневий елемент RSS-файлу.
- Атрибут version повинен мати значення 2.0: version="2.0"
- Можливе підключення xmlns атрибутів:
- При наданні новин двома мовами необхідно додавати неймспейс xmlns:xml="http://www.w3.org/XML/1998/namespace" в форматі <rss version="2.0" xmlns:xml="http://www.w3.org/XML/1998/namespace">
-
При використанні <content:encoded> необхідно додавати неймспейс xmlns:content="https://purl.org/rss/1.0/modules/content/" в форматі
<rss version="2.0" xmlns:xml="http://www.w3.org/XML/1998/namespace"> - При підключенні RSS джерела в форматі Укрнет.Новини елемент повинен виглядати:
<rss version="2.0" xmlns:media="https://search.yahoo.com/mrss/" xmlns:ukrnet="https://www.ukr.net">
- <channel>
- Обов'язковий елемент.
- Знаходиться всередині елемента <rss> і включає інформацію про джерело і його вміст.
- В <channel> може міститися будь-яка кількість елементів <item>.
- <title>
- Обов'язкове поле.
- Назва Джерела rss, наприклад, "Наші новини".
- Знаходиться в <channel>.
- В випадку, якщо експортується вміст усього сайту, зазначте його назву, наприклад:
<title>Наші новини</title>. - Якщо експортується розділ сайту, зазначте назву сайту і розділу через двокрапку:
<title>Наші новини: технології</title>.
- <language>
- Обов'язкове поле у випадку якщо всі новини однією мовою.
- Знаходиться в <channel>.
- Якщо новини подаються двома мовами, поле має бути відсутнє, для кожної мови в <item> має бути присутній свій ідентифікатор (дивіться нижче).
- Допустимі значення: 'uk-UA', 'ru-UA', 'ru-RU', 'uk', 'ru'.
- <item>
- Обов'язковий елемент.
- Інформація про одну новину.
- Знаходиться в <channel>.
- Якщо не вказано загальну мову новин, або мова новини відрізняється від загальної, то необхідно це чітко вказати, наприклад <item xml:lang="uk-UA"> або <item xml:lang="ru-UA">.
- <title>
- Обов'язковий елемент.
- Заголовок новини.
- Знаходиться в <item>.
- У заголовку новини не повинно бути HTML коду.
- Написання заголовка повністю великими літерами (Caps Lock) не допускається.
- Не рекомендується також наявність крапки в кінці заголовка.
- У заголовку не повинні міститися назва джерела, дата/час повідомлення, сео-слова, назви рубрик, службові примітки («оновлено», «доповнено», «фоторепортаж», «відео» та ін.) та неінформативні звороти, які не є невід’ємною частиною заголовка (наприклад, «Терміново!» або «Сенсація»).
- Якщо в заголовку присутні спецсимволи в явному вигляді, потрібно використовувати «<![CDATA[]]>», наприклад: <title><![CDATA[Текст заголовка зі <спецсимволами> в явному вигляді]]></title>.
- <link>
- Обов'язкове поле.
- Посилання на новину.
- Знаходиться в <item>.
- 'link' вважається унікальним ідентифікатором новини від партнера, не зважаючи на те з якої RSS він прийшов.
- Увага: кожна новина має бути розміщена на окремій сторінці, що відкривається за вказаною адресою, при цьому заголовок і початок тексту видно на першому екрані роздільної здатності 1024 × 768.
- При переході з заголовка, розміщеного в стрічці Укрнет, повинна відкриватися тільки одна новинна сторінка з текстом, який відповідає суті заголовка.
- Наявність по URL, вказаною в <link> більше однієї новини (стрічки новин) не допускається.
- URL розрізняються тільки в частині до '#', тобто: https://www.some-host.ua/news.html#2545 і https://www.some-host.ua/news.html#5794 вважаються ідентичними і НЕ допускаються.
- <description>
- Необов'язковий елемент.
- Короткий опис повідомлення.
- Знаходиться в <item>.
- В description описується короткий зміст новини - 3-4 речення.
- В description не повинно бути HTML коду.
- Якщо в description присутні спецсимволи в явному вигляді, потрібно використовувати <![CDATA[ ТЕКСТ ]]>.
- <category>
- <category> - рубрика (розділ, категорія), до якої відноситься Новина.
- Знаходиться в <item>.
- Якщо у партнера декілька тематичних джерел, наприклад в одному джерелі партнер передає тільки новини політики, у другому - новини економіки, то даний елемент не є обов'язковим.
- Якщо у партнера джерело передає тільки новини для рубрики «Спорт» то даний параметр не обов'язковий.
- Якщо джерело партнера містить новини для всіх рубрик порталу - даний параметр є обов'язковим.
- <enclosure>
- Обов'язковий елемент.
- Зображення до новини.
- Знаходиться в <item>.
- Мінімальний розмір зображення - 300 пікселів по стороні.
- Якщо в повідомленні міститься декілька зображень (фото), або зображення і відео файл, елемент <enclosure> повторюється.
- Більш детально можна подивитись в прикладі «Good_RSS_Full.xml», де в кінці документа описані всі типи аудіо, відео та зображень.
- Якщо є декілька варіантів одного зображення, що відрізняються за розміром, в <enclosure> повинен бути зазначений URL зображення найбільшого розміру.
- <pubDate>
- Обов'язкове поле.
- Дата та час створення новини на сайті видання в форматі RFC-822 (https://www.w3.org/Protocols/rfc822/#z28), наприклад «Thu, 18 Feb 2019 16:06:02 +0200».
- Знаходиться в <item>.
- <full-text><![CDATA[<p>Текст новини, відформатований відповідно вигляду на самому сайті. HTML форматування повинне бути присутнє повністю та без змін.</p>]]></full-text>
- Обов'язкове поле.
- Тіло новини.
- Знаходиться в <item>.
- Для передачі повного тексту новин допускаються поля: <full-text>, <fulltext>, <ukrnet:fulltext>, <ukrnet:full-text>, <content:encoded>.
- Містить повний текст новини з HTML форматуванням.
- Обов'язково потрібно використовувати <![CDATA[ ТЕКСТ З HTML ФОРМАТУВАННЯМ ]]>.
Зауваження: Весь текст, що знаходиться в елементах <title>, <description>, <link>, <full-text> повинен мати наступний вигляд.
- Всі спецсимволи ( &, “,<,>. і тд.) в тексті повинні бути декодовані.
- Якщо в тексті присутні спецсимволи ( &, “,<,>. і тд.) в явному вигляді, то текст повинен братися в тег <![CDATA[ Текст заголовка з <&спецсимволами> в явному вигляді ]]>.
Додаток 2. Приклад джерела новин для сайтів, які мають дві мовні версії (наприклад, для рубрики Події)
- Якщо новини різними мовами подаються у двох окремих RSS
-
Українська:
<?xml version="1.0" encoding="UTF-8"?> <rss version="2.0"> <channel> <title>Наші новини українською</title> <link>http://www.nashi-novyny.ua</link> <description> Тестове RSS джерело українською з мінімальним і обов'язковим набором елементів. </description> <language>uk-UA</language> <item> <title>Це перша новина українською в даному РСС</title> <guid xml:lang="ru-UA">https://www.nashi-novyny.ua/Persha_novyna_RUS.html</guid> <link>https://www.nashi-novyny.ua/Persha_novyna_UKR.html</link> <description>Перша новина українською в RSS.</description> <pubDate>Thu, 18 Feb 2010 16:06:02 +0200</pubDate> <category>Події</category> <full-text> <![CDATA[<p>Перша новина українською в RSS з самим мінімальним набором обов'язковиx елементів.</p>]]> </full-text> <enclosure url="https://www.nashi-novyny.ua/Zobrashennya_dlya_Persha_novyna_UKR.jpg" type="image/jpeg"/> </item> </channel> </rss>
- Російська:
<?xml version="1.0" encoding="UTF-8"?> <rss version="2.0"> <channel> <title>Наши новости на русском</title> <link>http://www.nashi-novyny.ua</link> <description>Тестовый RSS источник на русском языке с минимальным и обязательным набором элементов. </description> <language>ru-UA</language> <item> <title>Это первая новость на русском в данном РСС</title> <guid xml:lang="uk-UA">https://www.nashi-novyny.ua/Persha_novyna_UKR.html</guid> <link>https://www.nashi-novyny.ua/Persha_novyna_RUS.html</link> <description>Первая новость на русском в RSS.</description> <pubDate>Thu, 18 Feb 2010 16:06:02 +0200</pubDate> <category>Події</category> <full-text> <![CDATA[<p>Первая новость на русском в RSS с самым минимальным набором обязательных элементов.</p>]]> </full-text> <enclosure url="https://www.nashi-novyny.ua/Zobrashennya_dlya_Persha_novyna_RUS.jpg" type="image/jpeg"/> </item> </channel> </rss>
-
Українська:
- Якщо новини подаються в одній RSS двома мовами
<?xml version="1.0" encoding="UTF-8"?> <rss version="2.0"> <channel> <title>Наші новини українською та россійською</title> <link>http://www.nashi-novyny.ua</link> <description>Тестове RSS джерело українською та россійською з мінімальним і обов'язковим набором елементів.</description> <item xml:lang="uk-UA"> <title>Це перша новина українською в даному РСС</title> <guid xml:lang="ru-UA">https://www.nashi-novyny.ua/Persha_novyna_RUS.html</guid> <link>https://www.nashi-novyny.ua/Persha_novyna_UKR.html</link> <description>Перша новина українською в RSS.</description> <pubDate>Thu, 18 Feb 2010 16:06:02 +0200</pubDate> <category>Події</category> <full-text> <![CDATA[<p>Перша новина українською в RSS з самим мінімальним набором обов'язковиx елементів.</p>]]> </full-text> <enclosure url="https://www.nashi-novyny.ua/Zobrashennya_dlya_Persha_novyna_UKR.jpg" type="image/jpeg"/> </item> <item xml:lang="ru-UA"> <title>Это первая новость на русском в данном РСС</title> <guid xml:lang="uk-UA">https://www.nashi-novyny.ua/Persha_novyna_UKR.html</guid> <link>https://www.nashi-novyny.ua/Persha_novyna_RUS.html</link> <description>Первая новость на русском в RSS.</description> <pubDate>Thu, 18 Feb 2010 16:06:02 +0200</pubDate> <category>Події</category> <full-text> <![CDATA[<p>Первая новость на русском в RSS с самым минимальным набором обязательных элементов.</p>]]> </full-text> <enclosure url="https://www.nashi-novyny.ua/Zobrashennya_dlya_Persha_novyna_RUS.jpg" type="image/jpeg"/> </item> </channel> </rss>
Додаток 3. Приклад Джерела з новинами для кількох рубрик
В даному випадку це джерело що поставляє новини в кілька рубрик порталу
Список відповідності рубрик
Рубрика Партнера |
Рубрика Укрнет |
Події |
Події |
Новини України |
Міські новини |
ФОТО |
Фоторепортаж |
Вміст джерела
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
<channel>
<title>Наші новини </title>
<link>https://www.nashi-novyny.ua</link>
<description>Тестове RSS джерело, що поставляє новини в кілька категорій порталу</description>
<item>
<title>Це перша новина в даному РСС</title>
<link>https://www.nashi-novyny.ua/Pervaja_novost.html</link>
<description>
<![CDATA[
<p>Перша новина в RSS , що поставляє новини в кілька категорій порталу</p>
]]>
</description>
<category>Події</category>
<pubDate>Thu, 18 Feb 2010 16:06:02 +0200</pubDate>
<full-text>
<![CDATA[
<p>Перша новина в RSS , що поставляє новини в кілька категорій порталу</p>
]]>
</full-text>
</item>
<item>
<title>Це друга новина в даному РСС</title>
<link>https://www.nashi-novyny.ua/vtoraja_novost.html</link>
<description>
<![CDATA[
<p>Друга новина в RSS , що поставляє новини в кілька категорій порталу</p>
]]>
</description>
<category>Новини України</category>
<pubDate>Thu, 18 Feb 2010 16:04:02 +0200</pubDate>
<full-text>
<![CDATA[
<p>Друга новина в RSS, що поставляє новини в кілька категорій порталу.</p>
<p>Текст новини в якому "<спецсимволи>" в явному вигляді.</p>
]]>
</full-text>
</item>
<item>
<title>Це третя новина в даному РСС</title>
<link>https://www.nashi-novyny.ua/tretjya_novost.html</link>
<description>
<![CDATA[
<p>Третя новина в RSS, що поставляє новини в кілька категорій порталу.</p>
]]>
</description>
<category>ФОТО</category>
<pubDate>Thu, 18 Feb 2010 16:00:02 +0200</pubDate>
<full-text>
<![CDATA[
<p>Третя новина в RSS, що поставляє новини в кілька категорій порталу.</p>
<p>Текст новини в якому "<спецсимволи>" в явному вигляді.</p>
]]>
</full-text>
</item>
</channel>
</rss>
Корисні посилання
https://adline.kiev.ua/rssexample/Good_RSS_minimal.xml
Приклад RSS джерела, яке містить мінімальну кількість елементів RSS необхідну для передачі новин в стрічку порталу Укрнет. Зверніть увагу, що даний RSS містить новини тільки з розділу «Технології», тому в ньому немає тегів <category>.
https://adline.kiev.ua/rssexample/Good_RSS_Full.xml
Приклад RSS джерела, де можна подивитись, в якому вигляді потрібно прикріплювати мультимедіа файли до новини, а також повний список мультимедіа файлів. У цьому RSS для кожної новини вказана категорія, оскільки джерело транслює новини для усіх рубрик.
Додаткові формати
Ми також приймаємо rss в інших форматах:
- WordPress
Якщо ваш сайт зроблений на WordPress, то ми приймаємо джерело новин, яке майже завжди доступне за стандартною адресою, наприклад https://your-site.ua/?feed=rss або https://your-site.ua/feed/ (в залежності від налаштувань сайту). Детальніше про RSS потоки в WordPress можна дізнатися тут (WordPress Feeds).