Новая страница: «== '''Описание виджета''' == Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию с новостных ресурсов в нескольких режимах: # Статичной новости с графическим контентом # В режим бегущей строки Виджет...»
(не показано 12 промежуточных версий этого же участника)
Строка 1:
Строка 1:
<languages/>
<translate>
<!--T:1-->
== '''Описание виджета''' ==
== '''Описание виджета''' ==
Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию с новостных ресурсов в нескольких режимах:
Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию. Виджет работает в формате бегущей строки с настраиваемыми параметрами. Виджет предназначен для операционных систем: Windows и Ubuntu Linux.
# Статичной новости с графическим контентом
# В режим бегущей строки
Виджет получает информацию с помощью URL-ссылки, которая является для него источником и выводит полученные по ссылке новости на экран в виде новостного блока. При помощи настроек виджета можно сделать вывод новостей на устройство уникальным и индивидуальным, в зависимости от требований пользователя.
== '''Добавление виджета в личный кабинет''' ==
== '''Добавление виджета в личный кабинет''' ==
Чтобы добавить данный виджет в личный кабинет пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" - архива.
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" -архива.
[[File:Пример_виджета_rss.png|thumb|center| Пример виджета в формате ".zip" - архива|800px]]
[[File:Виджет_котировок.png|thumb|center| Пример виджета в формате ".zip" -архива|800px]]
После пользователь должен авторизоваться в личном кабинете и перейти в раздел "Контент".
После пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела "Контент" в личном кабинете |800px]]
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
В разделе "Контент" необходимо перетянуть данный виджет из локального хранилища в раздел "Контент". После того как пользователь перенесет виджет в личный кабинет он отобразиться в списке с контентом.
В разделе «Контент» необходимо перетащить данный виджет из локального хранилища в раздел «Контент». После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
[[File:Перенос_виджета rss.png|thumb|center| Пример отображения переноса виджета с помощью drag-n-drop|800px]]
[[File:Перенос_виджета rss.png|thumb|center| Пример отображения переноса виджета с помощью drag-n-drop|800px]]
{{Note|Если у пользователя много различного контента в личном кабинете, то он может воспользоваться функцией сортировки и выбрать нужный тип контента "Виджет". Воспользовавшись данной функциональностью, он сможет просмотреть все добавленные в личный кабинет виджеты.
{{Note|Если у пользователя много различного контента в личном кабинете, то можно использовать функцию сортировки и выбрать нужный тип контента - «Виджет». Воспользовавшись данной функциональностью, пользователь сможет просмотреть все добавленные в личный кабинет виджеты.
[[File:Виджеты.png|thumb|center| Пример отображения правильной сортировки для более удобного поиска виджета |800px]]|warn}}
[[File:Вилдет_в_лк.png|thumb|center| Пример отображения правильной сортировки для более удобного поиска виджета |800px]]|warn}}
{{Note|Альтернативным способом добавления данного виджета является раздел личного кабинета "Галерея виджетов".
== '''Получение данных для виджета''' ==
[[File:Галерея_виджетов лк.png|thumb|center| Пример отображения раздела "Галерея виджетов" в личном кабинете|800px]]
Виджет отправляет запросы на получение цен по API. Виджет получает два вида цен:
В данном разделе пользователь должен найти данный виджет и загрузить его.
* Цены последних сделок по инструментам;
[[File:Виджет_бегущей_строки.png|thumb|center| Пример отображения виджета в разделе "Галерея виджетов"|800px]]|warn}}
* Цены закрытия торговой сессии по инструментам.
Получая ответ, виджет обрабатывает эти цены для котировок и на основе полученных данных отображает изменения котировок.<br>
Далее виджет отправляет еще один запрос по APi, который включает в себя следующие параметры:
* Отношение инструмента (валюта, акция, драгоценные металлы) к валюте;
* Иконки для отображения инструмента;
При получении ответа виджет преобразует информацию и выводит на устройство.
{{Note|Работа виджета через API осуществляется с помощью токена, который можно указать в настройках виджета.|warn}}
== '''Настройка виджета''' ==
Пользователю необходимо найти свой виджет в личном кабинете и дважды кликнуть по нему. Таким образом, будет осуществлен переход на главную страницу виджета.
[[File:Главная_страницавиджета.png|thumb|center| Пример отображения главной страницы виджета |800px]]
Для перехода в настройки виджета пользователю необходимо кликнуть по иконке настроек, отображаемой в виде шестеренки.
[[File:Иконка_настроек_виджета.png|thumb|center| Пример отображения иконки настроек |800px]]
Далее пользователю откроется страница с настройками виджета. На этой странице пользователю доступны три вида настроек виджета:
# Основные настройки — отвечают за процесс работы виджета;
# Настройки котировок — отвечают за вывод и отображение котировок в самом виджете;
# Отладка — отвечает за параметры отображения информации на устройстве.
Ниже будет представлен список параметров для каждой группы настроек.
=== '''Основные настройки''' ===
Список параметров в разделе «Основные настройки»:
* Фон виджета — выбирают фон, который будет использоваться для бегущей строки. Цвет можно указать с помощью HEX -кода [https://colorscheme.ru/html-colors.html можно узнать в сети];
* Время хранения кеша — прописывается время хранения кеша в минутах. Используется в ситуациях, когда виджет не получает данные и берёт их из кеша;
* Видео-заглушка — выбрать видеоконтент, который будет использоваться в качестве заглушки при отсутствии данных и завершения отображения данных из кеша.
[[File:Основные_настройки.png|thumb|center| Пример отображения настроек из раздела «Основные настройки»|800px]]
=== '''Настройки котировок''' ===
Список параметров в разделе «Настройки котировок»:
* Токен — указывается токен для подключения по API;
* Частота запроса — указывается частота запроса в секундах;
* Добавить котировку — открывает модальное окно в настройках позволяющее создать котировку:
** Иконка «Скрыть котировку» — позволяет убрать отображение котировки при проигрывании виджета в трансляции. Отображается иконкой в виде глаза;
** Иконка «Удалить котировку» — позволяет удалить котировку из виджета. Отображается иконкой в виде мусорной корзины
** Название котировки — указывается название для настройки котировок;
** Идентификатор инструмента — указывается идентификатор инструмента, полученный по API;
** Количество лотов к рублю — указывается количество лотов к рублю.
[[File:Добавление_котировки.png|thumb|center| Пример отображения настроек из раздела «Настройки котировок»|800px]]
=== '''Отладка''' ===
Список параметров в разделе «Отладка»:
* Ширина виджета в пикселях — указывается ширина виджета в пикселях;
* Высота одного сегмента экрана — указывается высота сегмента экрана в пикселях;
* Ширина сегмента (сегменты от 1 до 8) — указывается ширина сегмента экрана в пикселях;
* Относительное смещение сегмента (от 1 до 8) относительно оси X — указывается смещение сегментов относительно оси Х в пикселях.
[[File:Настройки_отладка.png|thumb|center| Пример отображения настроек из раздела «Отладка»|800px]]
== '''Завершение настройки виджета''' ==
{{Note|После завершения работ по настройки виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
[[File:Применение_настрок.png|thumb|center| Пример отображения кнопки «Применить настройки»|800px]]
Далее виджет растянется на весь экран и пользователю должен нажать на кнопку «Сохранить», внизу по центру экрана.
[[File:Сохран.png|thumb|center| Пример отображения кнопки «Сохранить»|800px]]|warn}}
== '''Загрузка и скачивание настроек''' ==
В процессе взаимодействия с настройками виджета пользователь может загрузить и выгрузить настройки виджета. Каждое из указанных действий можно сделать по отдельным иконкам в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
[[File:Иконки_загрузки.png|thumb|center| Пример отображения иконок загрузить и выгрузить настройки виджета |800px]]
== '''Ограничения''' ==
В данном виджете присутствуют следующие ограничения:
* Виджет может работать максимум на 8 экранах.
== '''Добавление настроенного виджета в трансляцию''' ==
Чтобы полностью ознакомиться с работой данной функциональности пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе «Обсуждения» вверху страницы.
[[File:Обсуждение_котировки_валю.png|thumb|center| Пример отображения вкладки «Обсуждения» на wiki-странице |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию. Виджет работает в формате бегущей строки с настраиваемыми параметрами. Виджет предназначен для операционных систем: Windows и Ubuntu Linux.
Добавление виджета в личный кабинет
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" -архива.
Пример виджета в формате ".zip" -архива
После пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
Пример отображения раздела «Контент» в личном кабинете
В разделе «Контент» необходимо перетащить данный виджет из локального хранилища в раздел «Контент». После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
Пример отображения переноса виджета с помощью drag-n-drop
Если у пользователя много различного контента в личном кабинете, то можно использовать функцию сортировки и выбрать нужный тип контента - «Виджет». Воспользовавшись данной функциональностью, пользователь сможет просмотреть все добавленные в личный кабинет виджеты.
Пример отображения правильной сортировки для более удобного поиска виджета
Получение данных для виджета
Виджет отправляет запросы на получение цен по API. Виджет получает два вида цен:
Цены последних сделок по инструментам;
Цены закрытия торговой сессии по инструментам.
Получая ответ, виджет обрабатывает эти цены для котировок и на основе полученных данных отображает изменения котировок.
Далее виджет отправляет еще один запрос по APi, который включает в себя следующие параметры:
Отношение инструмента (валюта, акция, драгоценные металлы) к валюте;
Иконки для отображения инструмента;
При получении ответа виджет преобразует информацию и выводит на устройство.
Работа виджета через API осуществляется с помощью токена, который можно указать в настройках виджета.
Настройка виджета
Пользователю необходимо найти свой виджет в личном кабинете и дважды кликнуть по нему. Таким образом, будет осуществлен переход на главную страницу виджета.
Пример отображения главной страницы виджета
Для перехода в настройки виджета пользователю необходимо кликнуть по иконке настроек, отображаемой в виде шестеренки.
Пример отображения иконки настроек
Далее пользователю откроется страница с настройками виджета. На этой странице пользователю доступны три вида настроек виджета:
Основные настройки — отвечают за процесс работы виджета;
Настройки котировок — отвечают за вывод и отображение котировок в самом виджете;
Отладка — отвечает за параметры отображения информации на устройстве.
Ниже будет представлен список параметров для каждой группы настроек.
Основные настройки
Список параметров в разделе «Основные настройки»:
Фон виджета — выбирают фон, который будет использоваться для бегущей строки. Цвет можно указать с помощью HEX -кода можно узнать в сети;
Время хранения кеша — прописывается время хранения кеша в минутах. Используется в ситуациях, когда виджет не получает данные и берёт их из кеша;
Видео-заглушка — выбрать видеоконтент, который будет использоваться в качестве заглушки при отсутствии данных и завершения отображения данных из кеша.
Пример отображения настроек из раздела «Основные настройки»
Настройки котировок
Список параметров в разделе «Настройки котировок»:
Токен — указывается токен для подключения по API;
Частота запроса — указывается частота запроса в секундах;
Добавить котировку — открывает модальное окно в настройках позволяющее создать котировку:
Иконка «Скрыть котировку» — позволяет убрать отображение котировки при проигрывании виджета в трансляции. Отображается иконкой в виде глаза;
Иконка «Удалить котировку» — позволяет удалить котировку из виджета. Отображается иконкой в виде мусорной корзины
Название котировки — указывается название для настройки котировок;
Идентификатор инструмента — указывается идентификатор инструмента, полученный по API;
Количество лотов к рублю — указывается количество лотов к рублю.
Пример отображения настроек из раздела «Настройки котировок»
Отладка
Список параметров в разделе «Отладка»:
Ширина виджета в пикселях — указывается ширина виджета в пикселях;
Высота одного сегмента экрана — указывается высота сегмента экрана в пикселях;
Ширина сегмента (сегменты от 1 до 8) — указывается ширина сегмента экрана в пикселях;
Относительное смещение сегмента (от 1 до 8) относительно оси X — указывается смещение сегментов относительно оси Х в пикселях.
Пример отображения настроек из раздела «Отладка»
Завершение настройки виджета
После завершения работ по настройки виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
Пример отображения кнопки «Применить настройки»
Далее виджет растянется на весь экран и пользователю должен нажать на кнопку «Сохранить», внизу по центру экрана.
Пример отображения кнопки «Сохранить»
Загрузка и скачивание настроек
В процессе взаимодействия с настройками виджета пользователь может загрузить и выгрузить настройки виджета. Каждое из указанных действий можно сделать по отдельным иконкам в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
Пример отображения иконок загрузить и выгрузить настройки виджета
Ограничения
В данном виджете присутствуют следующие ограничения:
Виджет может работать максимум на 8 экранах.
Добавление настроенного виджета в трансляцию
Чтобы полностью ознакомиться с работой данной функциональности пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе «Обсуждения» вверху страницы.
Пример отображения вкладки «Обсуждения» на wiki-странице
