Динамический контент через RSS ленту (пользовательская версия) - История изменений

N.Bloshkin: /* Принцип действия */

2023-09-18T12:09:18Z

Принцип действия

← Предыдущая версия		Версия от 15:09, 18 сентября 2023
Строка 20:		Строка 20:
	[[File:Логика работы.png\|thumb\|center\|Логика работы функционала\|800px]]		[[File:Логика работы.png\|thumb\|center\|Логика работы функционала\|800px]]
	== '''Принцип действия''' ==		== '''Принцип действия''' ==
	{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. \|warn}}		{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. Инструкцию по настройке можно найти в статье: [[Динамический контент через RSS ленту (версия для системного администратора)]] \|warn}}
	После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>		После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>
	Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.<br>		Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.<br>
Строка 97:		Строка 97:
	После настройки всех параметров необходимо нажать кнопку "Сохранить".<br>		После настройки всех параметров необходимо нажать кнопку "Сохранить".<br>
	После всех манипуляций нужная информация должна выводиться на устройство в соответствии с расписанием.		После всех манипуляций нужная информация должна выводиться на устройство в соответствии с расписанием.

	=='''Итоговый результат'''==		=='''Итоговый результат'''==
	Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.		Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.
	</translate>		</translate>

N.Bloshkin в 13:37, 15 сентября 2023

2023-09-15T13:37:21Z

← Предыдущая версия		Версия от 16:37, 15 сентября 2023
Строка 1:		Строка 1:
			<languages/>
	<translate>		<translate>
	<!--T:1-->		<!--T:1-->

N.Bloshkin: Отметить эту версию для перевода

2023-09-15T13:22:57Z

Отметить эту версию для перевода

← Предыдущая версия		Версия от 16:22, 15 сентября 2023
Строка 1:		Строка 1:
	<translate>		<translate>
			<!--T:1-->
	=='''Описание ситуации'''==		=='''Описание ситуации'''==
	Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.		Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.
Строка 9:		Строка 10:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:2-->
	=== '''Логика работы''' ===		=== '''Логика работы''' ===
	# Сначала системный администратор настраивает работу приложения пользователя через RSS.		# Сначала системный администратор настраивает работу приложения пользователя через RSS.
Строка 24:		Строка 26:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:3-->
	==='''Настройка контента "Текст"''' ===		==='''Настройка контента "Текст"''' ===
	==== '''Подготовка''' ====		==== '''Подготовка''' ====
Строка 34:		Строка 37:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:4-->
	==== '''Работа с контентом типа "Текст"''' ====		==== '''Работа с контентом типа "Текст"''' ====
	Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.		Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.
Строка 55:		Строка 59:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:5-->
	==== '''Дополнительные возможности''' ====		==== '''Дополнительные возможности''' ====
	При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:		При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:
Строка 78:		Строка 83:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:6-->
	=== '''Создание расписания для устройства ''' ===		=== '''Создание расписания для устройства ''' ===
	Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".		Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".

N.Bloshkin в 13:22, 15 сентября 2023

2023-09-15T13:22:45Z

← Предыдущая версия		Версия от 16:22, 15 сентября 2023
Строка 1:		Строка 1:
			<translate>
	=='''Описание ситуации'''==		=='''Описание ситуации'''==
	Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.		Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.
Строка 6:		Строка 7:
	* Вывода динамического контента (бегущих дорожек) на устройства		* Вывода динамического контента (бегущих дорожек) на устройства
	* Создание "контента", схожего с информационным табло и последующим вывод его на устройства		* Создание "контента", схожего с информационным табло и последующим вывод его на устройства
			</translate>
			<translate>
	=== '''Логика работы''' ===		=== '''Логика работы''' ===
	# Сначала системный администратор настраивает работу приложения пользователя через RSS.		# Сначала системный администратор настраивает работу приложения пользователя через RSS.
Строка 19:		Строка 22:
	Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.		Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.
	[[File:Путь до текстового контента.png\|thumb\|center \| Путь до текстового контента\|800px]]		[[File:Путь до текстового контента.png\|thumb\|center \| Путь до текстового контента\|800px]]
			</translate>
			<translate>
	==='''Настройка контента "Текст"''' ===		==='''Настройка контента "Текст"''' ===
	==== '''Подготовка''' ====		==== '''Подготовка''' ====
Строка 27:		Строка 32:
	В данном случае заместо последний цифры (54) в запросе идёт - Company ID.		В данном случае заместо последний цифры (54) в запросе идёт - Company ID.
	Его можно просмотреть в личном кабинете на иконку пользователя.		Его можно просмотреть в личном кабинете на иконку пользователя.
			</translate>
			<translate>
	==== '''Работа с контентом типа "Текст"''' ====		==== '''Работа с контентом типа "Текст"''' ====
	Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.		Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.
Строка 46:		Строка 53:
	[[File:Подготовленный шаблон.png\|thumb\|center \| Пример шаблона\|300px]]		[[File:Подготовленный шаблон.png\|thumb\|center \| Пример шаблона\|300px]]
	В итоге, внутри шаблона будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>		В итоге, внутри шаблона будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
			</translate>
			<translate>
	==== '''Дополнительные возможности''' ====		==== '''Дополнительные возможности''' ====
	При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:		При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:
Строка 67:		Строка 76:
	Далее пользователь переименовывает трансляцию и сохраняет настройки, кликнув по иконке сохранения справа от названия.		Далее пользователь переименовывает трансляцию и сохраняет настройки, кликнув по иконке сохранения справа от названия.
	[[File:Название трансляции.png\|thumb\|center \| Строка для переименования трансляции\|300px]]		[[File:Название трансляции.png\|thumb\|center \| Строка для переименования трансляции\|300px]]
			</translate>
			<translate>
	=== '''Создание расписания для устройства ''' ===		=== '''Создание расписания для устройства ''' ===
	Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".		Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".
Строка 81:		Строка 92:
	=='''Итоговый результат'''==		=='''Итоговый результат'''==
	Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.		Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.
			</translate>

N.Bloshkin в 13:07, 15 сентября 2023

2023-09-15T13:07:25Z

← Предыдущая версия		Версия от 16:07, 15 сентября 2023
Строка 70:		Строка 70:
	Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".		Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".
	Выбрав своё устройство он находит в списке раздел "Расписание"		Выбрав своё устройство он находит в списке раздел "Расписание"
	Перейдя во всплывшее окно, пользователь увидит календарь. на котором ему надо будет выбрать дату и нажать "Добавить новое"		[[File:Путь до расписания.png\|thumb\|center \| путь до расписания\|300px]]
			Перейдя во всплывшее окно, пользователь увидит календарь, на котором ему надо будет выбрать дату и нажать "Добавить новое"
			[[File:Добавление расписания.png\|thumb\|center \| Добавление расписания\|300px]]
	Далее откроется окно с базовыми параметрами расписания.		Далее откроется окно с базовыми параметрами расписания.
	Дополнительные параметры расписания можно увидеть нажав на клавишу "Ещё"		[[File:Стандартные параметры расписания.png\|thumb\|center \| Стандартные параметры расписания\|300px]]
	После настройки всех параметров необходимо нажать кнопку "Сохранить"		Дополнительные параметры расписания можно увидеть нажав на клавишу "Ещё".
			[[File:Развёрнутые параметры расписания.png\|thumb\|center \| Развёрнутые параметры расписания\|300px]]
			После настройки всех параметров необходимо нажать кнопку "Сохранить".<br>
	После всех манипуляций нужная информация должна выводиться на устройство в соответствии с расписанием.		После всех манипуляций нужная информация должна выводиться на устройство в соответствии с расписанием.
	=='''Итоговый результат'''==		=='''Итоговый результат'''==
	Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.		Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.

N.Bloshkin в 12:59, 15 сентября 2023

2023-09-15T12:59:46Z

← Предыдущая версия		Версия от 15:59, 15 сентября 2023
Строка 65:		Строка 65:
	[[File:Зоны в трансляции.png\|thumb\|center \| Зоны контента\|300px]]		[[File:Зоны в трансляции.png\|thumb\|center \| Зоны контента\|300px]]
	Подставляет нужный ему контент в определённому зону. Кроме текстового с информацией, которую мы настраивали выше, остальной контент может быть любой.<br>		Подставляет нужный ему контент в определённому зону. Кроме текстового с информацией, которую мы настраивали выше, остальной контент может быть любой.<br>
	Далее пользователь переименовывает трансляцию и сохраняет настройки.		Далее пользователь переименовывает трансляцию и сохраняет настройки, кликнув по иконке сохранения справа от названия.
			[[File:Название трансляции.png\|thumb\|center \| Строка для переименования трансляции\|300px]]
	=== '''Создание расписания для устройства ''' ===		=== '''Создание расписания для устройства ''' ===
	~~Заходим~~ в раздел "Расписание".		Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство".
			Выбрав своё устройство он находит в списке раздел "Расписание"
			Перейдя во всплывшее окно, пользователь увидит календарь. на котором ему надо будет выбрать дату и нажать "Добавить новое"
			Далее откроется окно с базовыми параметрами расписания.
			Дополнительные параметры расписания можно увидеть нажав на клавишу "Ещё"
			После настройки всех параметров необходимо нажать кнопку "Сохранить"
			После всех манипуляций нужная информация должна выводиться на устройство в соответствии с расписанием.
	=='''Итоговый результат'''==		=='''Итоговый результат'''==
	Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.		Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.

N.Bloshkin в 12:46, 15 сентября 2023

2023-09-15T12:46:55Z

← Предыдущая версия		Версия от 15:46, 15 сентября 2023
Строка 42:		Строка 42:
	Следующим этапом необходимо выбрать нужную строку для создания из нее шаблона запроса.		Следующим этапом необходимо выбрать нужную строку для создания из нее шаблона запроса.
	[[File:Нужная строка.png\|thumb\|center \| Пример нужной строки для шаблона\|300px]]<br>		[[File:Нужная строка.png\|thumb\|center \| Пример нужной строки для шаблона\|300px]]<br>
	После клика по ~~нужной строке~~ - сформируется шаблон ~~строки~~.		После клика по выделенной строе - сформируется шаблон с параметрами. Он отобразится в пустой строке сверху.
	Перед ~~ним~~, в строке, необходимо текстом ~~указать "что за~~ информация" будет выводиться.		Перед параметрами, в строке, необходимо текстом прописать какая информация будет выводиться.
	~~Получится так что в шаблоне~~ будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>		[[File:Подготовленный шаблон.png\|thumb\|center \| Пример шаблона\|300px]]
			В итоге, внутри шаблона будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
			==== '''Дополнительные возможности''' ====
	При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:		При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:
	* ~~Редактирование текста~~		* Частота обновления информации (как часто клиентское приложение SmartPlayer будет обращаться на сервер за новыми данными)
	* Шрифт		* Шрифт
	* Размер шрифта		* Размер шрифта
	* Частота обновления информации (как часто клиентское приложение SmartPlayer будет обращаться на сервер за новыми данными)		* Цвет шрифта
			* Выравнивание текста
			* "Жирный" текст
			* Курсивный текс
			* Подчеркнутый текст
			[[File:Настройка текста в контенте.png\|thumb\|center \| Список настроек для редактирования текста\|300px]]
	Последний шаг - нажимаем на кнопку "Сохранить"		Последний шаг - нажимаем на кнопку "Сохранить"
	=== '''Создание трансляции''' ===		=== '''Создание трансляции''' ===
	Следующим этапом идёт создание трансляции.<br>		Следующим этапом идёт создание трансляции.<br>
	~~Пользователь переходит~~ в раздел "Трансляции" ~~и делит~~ окно ~~трансляции~~ на зоны~~, как ему нужно~~.		Пользователю необходимо перейти в раздел "Трансляции".
	Подставляет нужный ему контент в определённому зону. Кроме текстового ~~контента~~, остальной контент может быть любой.<br>		[[File:Создание трансляции.png\|thumb\|center \| Раздел "Трансляция" в личном кабинете\|300px]]
			Далее ему необходимо разделить "окно контента" на зоны и заполнить их нужным контентом.
			[[File:Зоны в трансляции.png\|thumb\|center \| Зоны контента\|300px]]
			Подставляет нужный ему контент в определённому зону. Кроме текстового с информацией, которую мы настраивали выше, остальной контент может быть любой.<br>
	Далее пользователь переименовывает трансляцию и сохраняет настройки.		Далее пользователь переименовывает трансляцию и сохраняет настройки.
	=== '''Создание расписания''' ===		=== '''Создание расписания для устройства ''' ===
	Заходим в раздел "Расписание".		Заходим в раздел "Расписание".
			=='''Итоговый результат'''==
			Нужная для пользователя информация выводится на устройствах и автоматически обновляется, без дополнительных настроек и манипуляций.

N.Bloshkin в 11:45, 15 сентября 2023

2023-09-15T11:45:23Z

← Предыдущая версия		Версия от 14:45, 15 сентября 2023
Строка 16:		Строка 16:
	{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. \|warn}}		{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. \|warn}}
	После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>		После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>
	Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и ~~находим раздел с текстом~~.<br>		Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.<br>
	Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.		Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.
	[[File:Путь до текстового контента.png\|thumb\|center \| Путь до текстового контента\|800px]]		[[File:Путь до текстового контента.png\|thumb\|center \| Путь до текстового контента\|800px]]
	=== '''Настройка контента "Текст"''' ===		==='''Настройка контента "Текст"''' ===
	[[File:Ид компании.png\|thumb\|right \| Расположение ID - Company\|~~300px~~]]		==== '''Подготовка''' ====
			[[File:Ид компании.png\|thumb\|right \| Расположение ID - Company\|150px]]
	Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.<br>		Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.<br>
	URL будет выглядеть примерно так:<br>		URL будет выглядеть примерно так:<br>
	<code>https://rc-api.smartplayer.org/v2/company-rss/feed/54</code><br>		<code>https://rc-api.smartplayer.org/v2/company-rss/feed/54</code><br>
	В данном случае заместо последний цифры(54) в запросе идёт - Company ID.		В данном случае заместо последний цифры (54) в запросе идёт - Company ID.
	Его можно просмотреть в личном кабинете на иконку пользователя.		Его можно просмотреть в личном кабинете на иконку пользователя.
	[[File:~~Тип источника~~.png\|thumb\|~~right~~ \| ~~Варианты источников~~\|300px]]		==== '''Работа с контентом типа "Текст"''' ====
	~~Далее~~ вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.		Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.
			[[File:Раздел контент.png\|thumb\|center \| Блок "Контент" в личном кабинете\|300px]]
			Следующим шагом - пользователь должен создать новый текстовый контент по кнопке.
			[[File:Путь текстового контента.png\|thumb\|center \| Текстовый контент\|800px]]
			После нажатия кнопки "Добавить новый текст" откроется окно настроек.<br>
			[[File:Окно настроек текста.png\|thumb\|center \| Окно настроек текста\|800px]]
			Внутри окна первое на что нужно обратить внимание, строка - "Выбрать тип источника". В этой строке выбираем вариант "URL-источник".
			После проведённых манипуляций вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
			[[File:Тип источника.png\|thumb\|center \| Варианты источников\|300px]]
	{{Note\|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. \|warn}}		{{Note\|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. \|warn}}
	Далее сервер SmartPlayer распарсивает URL ~~и позволяет выбрать поле, которое будет показываться клиентским приложением~~.<br>		Далее сервер SmartPlayer распарсивает URL. Данные по распаршенной ссылку будут выглядеть примерно так:
	~~В данном случае это будет поле (~~из ~~скрина)~~<br>		[[File:Распаршенный URL.png\|thumb\|center \| Пример распаршенного URL \|300px]]<br>
			Следующим этапом необходимо выбрать нужную строку для создания из нее шаблона запроса.
			[[File:Нужная строка.png\|thumb\|center \| Пример нужной строки для шаблона\|300px]]<br>
	После клика по нужной строке - сформируется шаблон строки.		После клика по нужной строке - сформируется шаблон строки.
	Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.		Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.
	Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>		Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
	~~[[File:Окно редактур контента.png\|thumb\|center \| Примеры параметров контента "Текст"\|800px]]~~
	При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:		При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:
	* Редактирование текста		* Редактирование текста

N.Bloshkin в 12:07, 12 сентября 2023

2023-09-12T12:07:34Z

← Предыдущая версия		Версия от 15:07, 12 сентября 2023
Строка 27:		Строка 27:
	Его можно просмотреть в личном кабинете на иконку пользователя.		Его можно просмотреть в личном кабинете на иконку пользователя.
	[[File:Тип источника.png\|thumb\|right \| Варианты источников\|300px]]		[[File:Тип источника.png\|thumb\|right \| Варианты источников\|300px]]
	~~Первоначально необходимо выбрать тип источника. В нашем случае - это URL - источник.<br>~~		Далее вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
	~~Вставляем~~ URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
	{{Note\|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. \|warn}}		{{Note\|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. \|warn}}
	Далее сервер SmartPlayer распарсивает URL и позволяет выбрать поле, которое будет показываться клиентским приложением.<br>		Далее сервер SmartPlayer распарсивает URL и позволяет выбрать поле, которое будет показываться клиентским приложением.<br>

N.Bloshkin в 11:31, 12 сентября 2023

2023-09-12T11:31:53Z

← Предыдущая версия		Версия от 14:31, 12 сентября 2023
Строка 1:		Строка 1:
	== '''Описание ситуации'''		=='''Описание ситуации'''==
	Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.		Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.
	=== '''Для чего это можно использовать''' ===		=== '''Для чего это можно использовать''' ===
	Такой контент хорошо ~~подходить~~ для нескольких форматов:		Такой контент хорошо подходит для нескольких форматов:
	* Вывода статичного текстового контента на устройства		* Вывода статичного текстового контента на устройства
	* Вывода динамического контента (бегущих дорожек) на устройства		* Вывода динамического контента (бегущих дорожек) на устройства
Строка 14:		Строка 14:
	[[File:Логика работы.png\|thumb\|center\|Логика работы функционала\|800px]]		[[File:Логика работы.png\|thumb\|center\|Логика работы функционала\|800px]]
	== '''Принцип действия''' ==		== '''Принцип действия''' ==
	{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS ~~лентами~~ и возможность подключаться к нашему серверу через API. \|warn}}		{{Note\|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. \|warn}}
	После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.		После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>
	Для этого в личном кабинете ему необходимо необходимо перейти в раздел ~~контент~~ и находим раздел с текстом.		Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и находим раздел с текстом.<br>
	Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.		Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.
	=== '''Настройка "~~текстового~~" ~~контента~~''' ===		[[File:Путь до текстового контента.png\|thumb\|center \| Путь до текстового контента\|800px]]
	* Первоначально необходимо выбрать тип источника. В нашем случае - это URL - источник.		=== '''Настройка контента "Текст"''' ===
	~~Необходимо вставить~~ URL нашего ~~свагера~~ в раздел "RSS - источника" и нажимаем иконку просмотра.		[[File:Ид компании.png\|thumb\|right \| Расположение ID - Company\|300px]]
	Далее сервер SmartPlayer распарсивает URL и позволяет выбрать поле, которое будет показываться клиентским приложением.		Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.<br>
	В данном случае это будет поле (из скрина)		URL будет выглядеть примерно так:<br>
			<code>https://rc-api.smartplayer.org/v2/company-rss/feed/54</code><br>
			В данном случае заместо последний цифры(54) в запросе идёт - Company ID.
			Его можно просмотреть в личном кабинете на иконку пользователя.
			[[File:Тип источника.png\|thumb\|right \| Варианты источников\|300px]]
			Первоначально необходимо выбрать тип источника. В нашем случае - это URL - источник.<br>
			Вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
			{{Note\|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. \|warn}}
			Далее сервер SmartPlayer распарсивает URL и позволяет выбрать поле, которое будет показываться клиентским приложением.<br>
			В данном случае это будет поле (из скрина)<br>
	После клика по нужной строке - сформируется шаблон строки.		После клика по нужной строке - сформируется шаблон строки.
	Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.		Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.
	Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.		Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
			[[File:Окно редактур контента.png\|thumb\|center \| Примеры параметров контента "Текст"\|800px]]
	При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:		При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:
	* Редактирование текста		* Редактирование текста
Строка 31:		Строка 41:
	* Размер шрифта		* Размер шрифта
	* Частота обновления информации (как часто клиентское приложение SmartPlayer будет обращаться на сервер за новыми данными)		* Частота обновления информации (как часто клиентское приложение SmartPlayer будет обращаться на сервер за новыми данными)
	~~Далее~~ нажимаем "Сохранить"		Последний шаг - нажимаем на кнопку "Сохранить"
	=== '''Создание трансляции''' ===		=== '''Создание трансляции''' ===
	Следующим этапом идёт создание трансляции.		Следующим этапом идёт создание трансляции.<br>
	~~Мы заходим~~ в раздел "Трансляции" и ~~делим~~ окно трансляции на зоны.		Пользователь переходит в раздел "Трансляции" и делит окно трансляции на зоны, как ему нужно.
	~~Подставляем~~ нужный ~~нам~~ контент. Он может быть любой~~, кроме того, который мы создали для отображения текста~~.		Подставляет нужный ему контент в определённому зону. Кроме текстового контента, остальной контент может быть любой.<br>
	~~Переименовываем~~ трансляцию и ~~сохраняем~~ настройки ~~трансляции~~.		Далее пользователь переименовывает трансляцию и сохраняет настройки.
	=== '''Создание расписания''' ===		=== '''Создание расписания''' ===
	Заходим в раздел "Расписание".		Заходим в раздел "Расписание".