Приложение "RSS новостей сайта": различия между версиями
Abushyk (обсуждение | вклад) |
Abushyk (обсуждение | вклад) |
||
(не показано 10 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
== Описание == | == Описание == | ||
− | Приложение организовывает xml-фид данных согласно формату RSS предназначенных для быстрого информирования клиентов о новых поступлениях на сайте. Приложение формирует два фида - для новостей и для объявлений. | + | Приложение организовывает xml-фид данных согласно формату RSS предназначенных для быстрого информирования клиентов о новых поступлениях на сайте. Приложение формирует два фида - для новостей и для объявлений.<br /> |
+ | Адреса фидов следующие: | ||
+ | <pre> | ||
+ | Новости - ваш_сайт/rss/ | ||
+ | Объявления - ваш_сайт/rss/data/ | ||
+ | Статьи - ваш_сайт/rss/articles/ | ||
+ | </pre> | ||
== Общая информация == | == Общая информация == | ||
Строка 7: | Строка 13: | ||
<br/> | <br/> | ||
== Настройки == | == Настройки == | ||
+ | === Общие === | ||
'''Включить экспорт RSS (apps.rss.enable)''' - включает\выключает работу модуля<br /> | '''Включить экспорт RSS (apps.rss.enable)''' - включает\выключает работу модуля<br /> | ||
Строка 17: | Строка 24: | ||
'''Название генератора RSS канала (apps.rss.generator)''' - Название генератора RSS канала<br /> | '''Название генератора RSS канала (apps.rss.generator)''' - Название генератора RSS канала<br /> | ||
− | '''Адрес электронной почты лица, ответственного за редакционное содержание (apps.rss.editor_email)''' - Адрес электронной почты лица, ответственного за редакционное содержание<br /> | + | '''Адрес электронной почты лица, ответственного за редакционное содержание (apps.rss.editor_email)''' - Адрес электронной почты лица, ответственного за редакционное содержание. Указывается в виде имени email и имени лица. напр.: |
+ | <pre>luksa@dallas.example.com (Frank Luksa)</pre><br /> | ||
− | '''Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала (apps.rss.webmaster_email)''' - Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала<br /> | + | '''Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала (apps.rss.webmaster_email)''' - Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала. Указывается в виде имени email и имени лица. напр.: |
+ | <pre>luksa@dallas.example.com (Frank Luksa)</pre><br /> | ||
+ | '''Длинна RSS канала (apps.rss.length)''' - количество новостей выгружаемых в фид новостей<br /> | ||
− | + | === Новости === | |
− | '''Системное имя поля с текстом для новости (apps.rss.news_text)''' - системное имя поля модели news, которое будет расценено как описание новости. По умолчанию anons | + | '''Системное имя поля с текстом для новости (apps.rss.news_text)''' - системное имя поля модели news, которое будет расценено как описание новости. По умолчанию anons<br /> |
− | |||
− | |||
+ | '''Системное имя поля фото новости (apps.rss.news_image)''' - системное имя поля модели news, которое будет расценено как сопровождающее новость фото. По умолчанию image<br /> | ||
+ | |||
+ | '''Системное имя поля заголовка новости (apps.rss.news_title)''' - системное имя поля модели news, которое будет расценено как заголовок новости. По умолчанию title<br /> | ||
+ | |||
+ | '''Время кеширование в секундах для фида новостей (apps.rss.news_cachediff)''' - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования.<br /> | ||
+ | |||
+ | === Объявления === | ||
'''Разрешить RSS для объявлений (apps.rss.enable_realty)''' - разрешает\запрещает генерацию фида объявлений<br /> | '''Разрешить RSS для объявлений (apps.rss.enable_realty)''' - разрешает\запрещает генерацию фида объявлений<br /> | ||
Строка 41: | Строка 56: | ||
'''Список системных имен полей для описания объекта (apps.rss.data_descriptionfields)''' - набор системных полей модели data, которые дополнят описание. Например можно задать строку вида | '''Список системных имен полей для описания объекта (apps.rss.data_descriptionfields)''' - набор системных полей модели data, которые дополнят описание. Например можно задать строку вида | ||
− | country_id,region_id | + | <pre>country_id,region_id</pre> |
и тогда в шаблоне формирующем дополнительную часть описания (/apps/rss/site/template/realty_view_ext.tpl) можно будет получить вывод этих параметров в автовыводе, либо организовать его самому. Важно помнить, что в расширенном режиме идет сжатая выборка данных, поэтому получить доступ к каким либо полям, которые не указаны в этой настройке, будет нельзя. Следовательно, если вам нужно вывести некоторые данные в описание, укажите их в этой настройке.<br /> | и тогда в шаблоне формирующем дополнительную часть описания (/apps/rss/site/template/realty_view_ext.tpl) можно будет получить вывод этих параметров в автовыводе, либо организовать его самому. Важно помнить, что в расширенном режиме идет сжатая выборка данных, поэтому получить доступ к каким либо полям, которые не указаны в этой настройке, будет нельзя. Следовательно, если вам нужно вывести некоторые данные в описание, укажите их в этой настройке.<br /> | ||
− | '''Системное имя поля даты размещения объекта (apps.rss.data_date)''' - системное имя поля модели data, которое будет использовано как дата добавления объекта. Явного функционала эта настройка не имеет в данный момент. При не указании используется стандартное data_added. | + | '''Системное имя поля даты размещения объекта (apps.rss.data_date)''' - системное имя поля модели data, которое будет использовано как дата добавления объекта. Явного функционала эта настройка не имеет в данный момент. При не указании используется стандартное data_added.<br /> |
− | Длинна RSS канала объявлений (apps.rss.data_length) - количество объявлений выгружаемых в фид объявлений. | + | |
+ | '''Длинна RSS канала объявлений (apps.rss.data_length)''' - количество объявлений выгружаемых в фид объявлений.<br /> | ||
+ | |||
+ | '''Время кеширование в секундах для фида объявлений (apps.rss.data_cachediff)''' - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования.<br /> | ||
+ | |||
+ | === Статьи === | ||
+ | |||
+ | '''Системное имя поля описания статьи (apps.rss.articles_text)''' - системное имя поля модели article, которое будет расценено как описание статьи. По умолчанию anons<br /> | ||
+ | |||
+ | '''Системное имя поля изображения статьи (apps.rss.articles_image)''' - системное имя поля модели article, которое будет расценено как сопровождающее статью фото. По умолчанию отсутствует<br /> | ||
+ | |||
+ | '''Системное имя поля заголовка статьи (apps.rss.articles_title)''' - системное имя поля модели article, которое будет расценено как заголовок статьи. По умолчанию title<br /> | ||
+ | |||
+ | '''Длинна RSS канала статей (apps.rss.articles_length)''' - количество статей выгружаемых в фид.<br /> | ||
+ | |||
+ | '''Время кеширование в секундах для фида статей (apps.rss.articles_cachediff)''' - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования. |
Текущая версия на 18:14, 5 февраля 2016
Содержание
Описание
Приложение организовывает xml-фид данных согласно формату RSS предназначенных для быстрого информирования клиентов о новых поступлениях на сайте. Приложение формирует два фида - для новостей и для объявлений.
Адреса фидов следующие:
Новости - ваш_сайт/rss/ Объявления - ваш_сайт/rss/data/ Статьи - ваш_сайт/rss/articles/
Общая информация
Для фида новостей отбираются все новости в количестве длины фида отсортированные в порядке убывания даты добавления.
Для фида новостей отбираются все активные объявления в количестве длины фида отсортированные в порядке убывания даты добавления.
Настройки
Общие
Включить экспорт RSS (apps.rss.enable) - включает\выключает работу модуля
Название RSS канала (apps.rss.title) - Название RSS канала
Описание RSS канала (apps.rss.description) - Описание RSS канала
Код языка канала (apps.rss.language) - Код языка канала
Название генератора RSS канала (apps.rss.generator) - Название генератора RSS канала
Адрес электронной почты лица, ответственного за редакционное содержание (apps.rss.editor_email) - Адрес электронной почты лица, ответственного за редакционное содержание. Указывается в виде имени email и имени лица. напр.:
luksa@dallas.example.com (Frank Luksa)
Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала (apps.rss.webmaster_email) - Адрес электронной почты лица, ответственного за технические вопросы, касающиеся канала. Указывается в виде имени email и имени лица. напр.:
luksa@dallas.example.com (Frank Luksa)
Длинна RSS канала (apps.rss.length) - количество новостей выгружаемых в фид новостей
Новости
Системное имя поля с текстом для новости (apps.rss.news_text) - системное имя поля модели news, которое будет расценено как описание новости. По умолчанию anons
Системное имя поля фото новости (apps.rss.news_image) - системное имя поля модели news, которое будет расценено как сопровождающее новость фото. По умолчанию image
Системное имя поля заголовка новости (apps.rss.news_title) - системное имя поля модели news, которое будет расценено как заголовок новости. По умолчанию title
Время кеширование в секундах для фида новостей (apps.rss.news_cachediff) - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования.
Объявления
Разрешить RSS для объявлений (apps.rss.enable_realty) - разрешает\запрещает генерацию фида объявлений
Тип формирования фида объявлений (0-стандартный, 1-расширенный) (apps.rss.data_mode) - устанавливает режим настроек фида объявлений. 0 - стандартный на усмотрение модуля, 1 - расширенный, разрешающий изменение стандартных полей.
Системное имя поля фото объекта (apps.rss.data_image) - системное имя поля модели data, которое будет расценено как фото объекта. По умолчанию image. Применимо и в стандартном режиме, и в расширенном.
Системное имя поля заголовка объекта (apps.rss.data_title) - системное имя поля модели data, которое будет расценено как заголовок объекта. В стандартном режиме не работает. Для заголовка используется заголовок аналогичный тому, который отображается на сайте в карточке объекта. В расширенном режиме при не указании или указании несуществующего поля будет применен алгоритм формирования заголовка как в стандартном режиме.
Системное имя поля описания объекта (apps.rss.data_description) - системное имя поля модели data, которое будет расценено как описание объекта. В стандартном режиме не работает. Для описания используется автосформированный набор данных из модели изменить или отформатировать который можно путем изменения шаблона /apps/rss/site/template/realty_view.tpl или его локальной копии.
В расширенном режиме при не указании или указании несуществующего поля описание формироваться не будет.
Максимальная длинна описания (apps.rss.data_description_max) - ограничение на длину описания взятого из поля, указанного настройкой apps.rss.data_description. Применяется только если эта настройка указана в виде числа большего нуля. Следует помнить, что если в тексте описания встречаются разметочные теги, то при отсутствии обрезки они будут входить в описание. Если же применить обрезку, то перед укорачиванием описания все теги будут вырезаны.
Список системных имен полей для описания объекта (apps.rss.data_descriptionfields) - набор системных полей модели data, которые дополнят описание. Например можно задать строку вида
country_id,region_id
и тогда в шаблоне формирующем дополнительную часть описания (/apps/rss/site/template/realty_view_ext.tpl) можно будет получить вывод этих параметров в автовыводе, либо организовать его самому. Важно помнить, что в расширенном режиме идет сжатая выборка данных, поэтому получить доступ к каким либо полям, которые не указаны в этой настройке, будет нельзя. Следовательно, если вам нужно вывести некоторые данные в описание, укажите их в этой настройке.
Системное имя поля даты размещения объекта (apps.rss.data_date) - системное имя поля модели data, которое будет использовано как дата добавления объекта. Явного функционала эта настройка не имеет в данный момент. При не указании используется стандартное data_added.
Длинна RSS канала объявлений (apps.rss.data_length) - количество объявлений выгружаемых в фид объявлений.
Время кеширование в секундах для фида объявлений (apps.rss.data_cachediff) - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования.
Статьи
Системное имя поля описания статьи (apps.rss.articles_text) - системное имя поля модели article, которое будет расценено как описание статьи. По умолчанию anons
Системное имя поля изображения статьи (apps.rss.articles_image) - системное имя поля модели article, которое будет расценено как сопровождающее статью фото. По умолчанию отсутствует
Системное имя поля заголовка статьи (apps.rss.articles_title) - системное имя поля модели article, которое будет расценено как заголовок статьи. По умолчанию title
Длинна RSS канала статей (apps.rss.articles_length) - количество статей выгружаемых в фид.
Время кеширование в секундах для фида статей (apps.rss.articles_cachediff) - время кеширования фида в секундах. Значение отличное от положительного целого числа означает отключение кеширования.