Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:rss

Компонент "Генератор RSS"

Панель управленияКомпонентыГенератор RSS

Описание

Компонент отвечает за формирование и вывод лент RSS на сайте.

Список лент RSS

При переходе по пути > Панель управленияКомпонентыГенератор RSS будет показан список всех лент RSS сайта. Каждую ленту можно выключить, разрешить или запретить кэширование ленты и задать настройки.

Ленту нельзя создать в админке, поддержка RSS формируется разработчиками компонентов. В комплекте InstantCMS по умолчанию поддерживаются ленты RSS для типов контента.

Настройки лент RSS

Для каждой ленты существуют базовые настройки и настройки, добавляемые (если это необходимо) компонентом, для которого эта лента предназначена.

Лента включена

Позволяет включать и выключать ленту.

Описание ленты

Небольшое описание ленты, которое будет выводиться в теге <description> ленты.

Количество записей в ленте

Количество материалов, отображаемых в ленте.

Шаблон ленты RSS

Можно выбрать шаблон для формирования ленты. Шаблон - это, как правило, XML разметка, в которой должным образом выводятся данные. По умолчанию доступны два шаблона: классический RSS

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">

и RSS лента, сформированная по рекомендациям Яндекс. Вы можете по аналогии делать свои шаблоны вывода, которые нужно разместить по пути /templates/default/controllers/rss/. После чего они появятся в опции автоматически.

Обратите внимание! Вы можете использовать сразу все шаблоны ленты, таким образом у вас будет несколько лент с разной разметкой. Для использования разных шаблонов лент необходимо к базовому URL rss ленты добавить GET параметр template с названием нужного шаблона. По умолчанию используется шаблон, заданный в настройках ленты. Например, у вас URL ленты для типа контента «Новости» site.ru/rss/feed/news. По умолчанию в настройках указан шаблон feed.tpl.php. Чтобы не меняя настроек указать другой шаблон, например yandex_feed.tpl.php, вы должны сформировать URL вот так: /rss/feed/news?template=yandex_feed

Изображение

Для каждой ленты можно загружать изображение, оно будет показано в теге <image> ленты.

Кэширование

Для каждой из лент можно включить кэширование и задать интервал обновления кэша. Движок сформирует ленту от нужного компонента и создаст временный файл по пути /cache/rss/file.name.rss, где file.name - это некий набор символов. После, при повторном запросе ленты, если время жизни кэша не истекло, CMS уже не будет обращаться к компоненту, формирующему ленту, а выведет RSS из кэша.

Другие настройки

Как было уже отмечено выше, компоненты могут добавлять свои поля настроек для своих лент. Например, компонент «Контент» (Типы контента) для каждой ленты добавляет блок опций, где нужно выбрать поля для элементов ленты: название, описание, изображение, дату и так далее.

Вывод на сайте

На самом сайте ленты обычно показываются справа от названия списка (который поддерживает RSS) соответствующей иконкой с активной ссылкой на саму ленту. Также движок формирует специальный тег, который сигнализирует браузеру, что для данной страницы есть RSS лента, например:

<link title="Название ленты" type="application/rss+xml" rel="alternate" href="http://site.ru/rss/feed/articles">

Назад к разделу Компоненты

manual/components/rss.txt · Последнее изменение: 23.05.2018 21:50 — fuze