design-ubl-settings-apps/ubl-settings-video

ТЕХНИЧЕСКОЕ ЗАДАНИЕ на разработку утилиты ubl-settings-video

1. ОПИСАНИЕ:

   Графическое средство настройки вывода изображения в ОС UBLinux

2. ЭТАПЫ И СРОКИ СОЗДАНИЯ ПРИЛОЖЕНИЯ:

   1. Общий срок работ по созданию приложения составляет N дней:
      1. N дня - макет и дизайн приложения и его утверждение
      2. N дней - разработка приложения
      3. N дня - тестирование приложения и исправление ошибок
   2. Перечень этапов разработки приложения:
      1. Разработка макета и дизайна приложения
      2. Утверждение и доработка макета
      3. Создание работающего интерфейса, включая полную разработку действующих ярлыков, кнопок и т.д.
   3. Проектирование алгоритма работы приложения
   4. Написание работающего кода приложения, включая полноценно работающие элементы графического интерфейса, а также перевод (поддержка локализации En, Ru), самостоятельно
   5. Тестирование и исправление ошибок, самостоятельно
   6. Публикация

3. ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:

   1. Приложение разрабатывается под нужды операционной системы UBLinux
   2. Использование фирменного логотипа компании
   3. Название приложения, техническое: ubl-settings-video (далее ${NAME_APPLICATION})
   4. Название приложения, публичное: Настройки видеоадаптера и дисплея
   5. Стек технологий:
      1. Язык программирования: Bash или C(++)
      2. Приложение для разработки графического интерфейса: Glade 3
      3. Графические библиотеки: GTK3
      4. Операционная система разработки: UBLinux DB
   6. Структура:
      1. В исходных кодах использовать префикс корня CMAKE_INSTALL_PREFIX для сборки приложений. Например, CMAKE_INSTALL_PREFIX/share.
      2. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++) /usr/bin/${NAME_APPLICATION} (скомпилированный бинарный файл)
      3. Графическая часть, фронт /usr/share/${NAME_APPLICATION}/ui/${NAME_APPLICATION}.glade
      4. Стили виджетов GTK /usr/share/${NAME_APPLICATION}/css/${NAME_APPLICATION}.css
      5. Элементы изображений
         1. Иконки: /usr/share/icons/hicolor/scalable/apps/${NAME_APPLICATION}{*.png,*.svg} Файлы изображений png иконок должны иметь имена вида:
            • ru.ublinux.${NAME_APPLICATION}.svg
            • ru.ublinux.${NAME_APPLICATION}.${NAME_ICONS}.svg Где ${NAME_ICONS} - имя графического элемента, например: checked, warning, alert и т.д. Файлы изображений png иконок должны генерироваться из svg файла в размеры 16, 32, 48, 64 пикселей сценарием make-файла.
         2. Изображения: /usr/share/${NAME_APPLICATION}/ui/{*.png,*.svg}
      6. Локализация En/Ru

         1. Для локализации должен быть создан файл-шаблон ${NAME_APPLICATION}.pot, на его основе должны быть созданы сами po-файлы переводов на необходимые языки, через файл сборки из po-файлов компилируются mo-файлы и размещаются сценарием установки по указанному пути: /usr/share/locale/${LANG}/LC_MESSAGES/${FILE_MO} где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU", ${FILE_MO} - файл локализации программы, например, "${NAME_APPLICATION}.mo"

         2. В файле локализации .pot и .po должна присутствовать строчка информационная, показывающая позицию локализации в коде

            Пример:

            #: source/${NAME_APPLICATION}.c:41
            msgid "Example string for localization"
            msgstr "Пример строки для локализации"
            

         3. Вывод всех текстовых элементов осуществляется через средства локализации.

      7. Версия ПО
         1. Файл, в котором хранится версия - VERSION.md, находится в корне каталога проекта.
         2. При компиляции (через сценарий make-файла) данные из файла VERSION.md передаются в значение переменной (-ых) version_application в файлах-исходниках ПО.

4. ТЕХНИЧЕСКОЕ ЗАДАНИЕ:

   1. Ярлык (desktop-файл):
      1. Type: Application
      2. Exec: ubl-settings-video
      3. Categories: X-UBL-SettingsManager;X-UBL-SystemSettings
   2. Главное окно:
      1. Требования к внешнему виду:
         1. Адаптивный (резиновый) дизайн.
         2. Наличие элементов интерфейса:
            1. Статических - не меняют свою ширину при изменении размеров окна или родительского элемента.
            2. Динамических - меняют свою ширину при изменении размеров окна или родительского элемента. Обычно занимают пространство от края до края окна или родительского элемента, либо пространство от рядом расположенного элемента до до края окна или родительского элемента.
         3. Минимальный размер окна до прекращения масштабирования 800 на 600 пикселей.
         4. Шапка в стиле приложений GTK3 с содержимым:
            1. Иконка приложения. Статический элемент. Выравнивание по левому краю.
            2. Кнопка с выпадающим списком "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). Статический элемент. Выравнивание по левому краю.
            3. Заголовок окна, название приложения. Выравнивание по центру между элементами.
            4. Кнопка с выпадающим списком "Сохранить" -> ("Сохранить глобальную и локальную конфигурацию, Сохранить глобальную конфигурацию, Сохранить локальную конфигурацию"). Статический элемент. Выравнивание по правому краю.
            5. Кнопка с иконкой с выпадающим списком -> "Справка, О приложении". Статический элемент. Выравнивание по правому краю.
            6. Стандартные элементы окна, кнопки "Свернуть, Минимизировать/На весь экран, Закрыть"
         5. В верхней части крупный логотип утилиты, с права от него краткое описание утилиты. Фон заполнен изображением. Статические элементы. Выравнивание по левому краю.
         6. Строка уведомления, представляющая собой полосу с инфографикой строки уведомлений. Динамический элемент. От края до края окна по горизонтали.
         7. Рабочая область.
      2. Требования к "Рабочей области". Динамический элемент. От края до края по горизонтали и вертикали окна. Выводятся группы настроек запуска:
         1. Блок с заголовком "Драйвер". Динамический элемент. От края до края окна по горизонтали.
            1. чекбокс "Автоматический выбор и использование драйвера". Статический элемент. Выравнивание по левому краю.
            2. лэйбл "Проприетарный драйвер:". Статический элемент. Выравнивание по левому краю. Неактивен, если активирован чекбокс "Автоматический выбор и использование драйвера".
            3. текстовое поле, активное, недоступное для редактирования. Содержит в себе текст с наименованием используемого проприетарного драйвера. Если проприетарный драйвер не используется - выводится надпись "Не используется". Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами. Неактивен, если активирован чекбокс "Автоматический выбор и использование драйвера".
         2. кнопка с иконкой "Настроить". Вызов окна "Настройка проприетарного драйвера". Статический элемент. Выравнивание по левому краю. Неактивна, если активирован чекбокс "Автоматический выбор и использование драйвера".
         3. лэйбл "Отказоустойчивый драйвер nVidia:". Статический элемент. Выравнивание по левому краю.
         4. комбобокс с вариантами выбора отказоустойчивого драйвера nVidia: "Отключен", "fbdev". Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
         5. лэйбл "Отказоустойчивый драйвер AMD/ATI:". Статический элемент. Выравнивание по левому краю.
         6. комбобокс с вариантами выбора отказоустойчивого драйвера AMD/ATI: "Отключен", "fbdev". Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
         7. Блок с заголовком "Настройка экрана". Динамический элемент. От края до края окна по горизонтали.
            1. динамические элементы (могут перемещаться друг относительно друга), представленные иконками дисплеев, включающих в себя графические элементы:
               • иконка "звёздочка" - видна у монитора с атрибутом "Основной". Статический элемент. Выравнивание по левому краю.
               • иконка "шестерёнка" - видна у всех, вызывает окно "Настройка: Монитор [ПОРТ_ПОДКЛЮЧЕНИЯ]". Статический элемент. Выравнивание по левому краю.
            2. чекбокс "Не выключать дисплеи". Статический элемент. Выравнивание по левому краю.
         8. Блок с заголовком "Гибридная графика". Динамический элемент. От края до края окна по горизонтали.
            1. чекбокс "Только дискретное видео (AMD/ATI)". Статический элемент. Выравнивание по левому краю.
         9. Блок с заголовком "Дополнительно". Динамический элемент. От края до края окна по горизонтали.

5. ОСОБЕННОСТИ

   1. При загрузке утилиты по умолчанию загружаются данные из локального конфигурационного файла (выполняются команды блоков "Чтение значений: из локального конфигурационного файла").
   2. Функции записи в локальный конфигурационный файл и чтения-записи в глобальный конфигурационный файл должны проходить процедуру повышения привилегий прав пользователя через polkit.
   3. Сохранение должно происходить только при наличии изменённых данных в элементах форм приложения, в противном случае выводить в информационной строке сообщение: "Нечего сохранять!".
   4. Кнопка "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). При нажатии на кнопку происходит открытие меню с пунктами: "Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию". Загрузка текущей и глобальной конфигурации в системе через скрипт ubconfig (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"), загрузка конфигурации из файла настроек ОС ublinux.ini (выполняются команды блоков "Чтение значений: из глобального конфигурационного файла").
   5. Кнопка "Сохранить" -> ("Сохранить глобальную и локальную конфигурацию). Сохраняет текущие настройки через скрипт ubconfig (выполняются команды блоков "Установить значение: в локальный конфигурационный файл") и в конфигурационный файл настроек ОС ublinux.ini (выполняются команды блоков "Установить значение: в глобальный конфигурационный файл"). При выборе пунктов "Сохранить глобальную конфигурацию, Сохранить локальную конфигурацию" происходит отдельное сохранение настроек.
   6. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!"
   7. Строка уведомлений. Цвет в зависимости от сигнала:
      • песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы.
      • красный, пиктограмма "Восклицательный знак", сообщения об ошибках при сохранении, загрузке параметров конфигурации, при ошибках в работе программы, полученных от обработчика ошибок.
   8. Кнопка с иконкой с выпадающим списком -> "Справка, О приложении"
      1. Справка - запуск окна с встроенным браузером (WebKitWebView) с переходом на ссылку:
         1. локализованный (ru_RU) вариант: https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI})
         2. локализованный (en_EN) вариант: https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) Если WebKitWebView не доступен, то запуск через xdg-open ${URLWIKI}.
      2. О приложении. Открывается диалоговое окно с выводом информации о программе:
         1. Заголовок окна по локализованному названию утилиты
         2. Копирайты, порядок:
            1. Иконка приложения
            2. Название утилиты
            3. Версия программы (переменная version_application)
            4. Название утилиты, локализованное
            5. Ссылка "Домашняя страница проекта" на https://ublinux.ru/
            6. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR
               • локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR"
               • где $LASTYEAR - текущий год.

6. КОМАНДЫ

7. ПОМОЩЬ И ПАРАМЕТРЫ ЗАПУСКА

   1. Помощь

      • Пример вывода:

        ${NAME_APPLICATION} version: $VERSION Application Description for UBLinux

        Использование: ${NAME_APPLICATION} [OPTIONS...] Параметры приложения: $OPTIONS

        Где $OPTIONS - параметры запуска, $VERSION - версия программы (переменная version_application).

   2. Параметры запуска:

      1. -h, --help - Показать параметры справки
      2. -V, --version - Показать текущую версию
      3. --lock-help - Блокировка вызова справки
      4. --lock-save - Блокировка сохранения локальной и глобальной конфигурации
      5. --lock-save-local - Блокировка сохранения локальной конфигурации
      6. --lock-save-global - Блокировка сохранения глобальной конфигурации
      7. --lock-load-global - Блокировка загрузки глобальной конфигурации

   3. Действия при указанных параметрах:

      1. --lock-help - делать неактивным пункт "Справка" в выпадающем списке кнопки с иконкой.
      2. --lock-save - делать неактивной кнопку "Сохранить".
      3. --lock-save-local - делать неактивным пункт "Сохранить локальную конфигурацию" в выпадающем списке кнопки "Сохранить".
      4. --lock-save-global - делать неактивным пункт "Сохранить глобальную и локальную конфигурацию" и "Сохранить глобальную конфигурацию" в выпадающем списке кнопки "Сохранить".
      5. --lock-load-global - делать неактивным пункт "Сохранить глобальную и локальную конфигурацию" и "Загрузить глобальную конфигурацию" в выпадающем списке кнопки "Загрузить".

8. ПРИБЛИЗИТЕЛЬНЫЙ МАКЕТ ПРИЛОЖЕНИЯ.

   1. Главное окно