From c73814d6f45347dea6dbf698dd7313c4e3a87b76 Mon Sep 17 00:00:00 2001 From: MiraMaX166 Date: Wed, 15 Mar 2023 18:05:42 +0600 Subject: [PATCH] update readme in project ubl-settings-bootloader --- ubl-settings-bootloader/README.md | 52 ++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 18 deletions(-) diff --git a/ubl-settings-bootloader/README.md b/ubl-settings-bootloader/README.md index e64f428..572b748 100644 --- a/ubl-settings-bootloader/README.md +++ b/ubl-settings-bootloader/README.md @@ -21,7 +21,7 @@ 1. **ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:** 1. Приложение разрабатывается под нужды операционной системы UBLinux 1. Использование фирменного логотипа компании - 1. Название приложения, техническое: **ubl-settings-bootloader** + 1. Название приложения, техническое: **ubl-settings-bootloader** (далее **${NAME_APPLICATION}**) 1. Название приложения, публичное: **Загрузка системы** 1. Стек технологий: 1. Язык программирования: Bash или C(++) @@ -30,16 +30,24 @@ 1. Операционная система разработки: UBLinux DB 1. Структура: 1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++) -**/usr/bin/ubl-settings-bootloader (скомпилированный бинарный файл)** +**/usr/bin/${NAME_APPLICATION} (скомпилированный бинарный файл)** 1. Графическая часть, фронт -Файл **glade** скомпилирован в бинарный файл +**/usr/share/\${NAME_APPLICATION}/ui/\${NAME_APPLICATION}.glade** 1. Стили виджетов GTK -Файл **css** скомпилирован в бинарный файл +**/usr/share/\${NAME_APPLICATION}/css/\${NAME_APPLICATION}.css** 1. Элементы изображений -**/usr/share/ubl-settings-bootloader/images/{\*.png,\*.svg}** + 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-файла. + 1. Изображения: +**/usr/share/\${NAME_APPLICATION}/ui/{\*.png,\*.svg}** 1. Локализация En/Ru -Для локализации должен быть создан файл-шаблон ***name_programm.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: -**/usr/share/locale/\${LANG}/LC_MESSAGES/${FILE_MO}** +Для локализации должен быть создан файл-шаблон ***${NAME_APPLICATION}.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути: +**/usr/share/locale/\${LANG}/LC_MESSAGES/\${FILE_MO}** где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU", \${FILE_MO} - файл локализации программы, например, "${NAME_APPLICATION}.mo" 1. Файл с перечнем и описанием параметров передаваемых ядру @@ -116,21 +124,27 @@ 1. Функции записи в локальный конфигурационный файл и чтения-записи в глобальный конфигурационный файл должны проходить процедуру повышения привилегий прав пользователя через polkit. 1. Кнопка "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). При нажатии на кнопку происходит открытие меню с пунктами: "Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию". Загрузка текущей и глобальной конфигурации в системе через скрипт ubconfig (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"), загрузка конфигурации из файла настроек ОС ublinux.ini (выполняются команды блоков "Чтение значений: из глобального конфигурационного файла"). 1. Кнопка "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию). Сохраняет текущие настройки через скрипт ubconfig (выполняются команды блоков "Установить значение: в локальный конфигурационный файл") и в конфигурационный файл настроек ОС ublinux.ini (выполняются команды блоков "Установить значение: в глобальный конфигурационный файл"). При выборе пунктов "Сохранить в глобальную конфигурацию, Сохранить в локальную конфигурацию" происходит отдельное сохранение настроек. + 1. Кнопка с иконкой с выпадающим списком -> “Справка, О приложении” + 1. Справка - запуск браузера с переходом на ссылку: + 1. локализованный (ru_RU) вариант: +https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) + 1. локализованный (en_EN) вариант: +https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/${NAME_APPLICATION} (далее ${URLWIKI}) + 1. О приложении. Открывается диалоговое окно с выводом информации о программе: + 1. Заголовок окна по локализованному названию утилиты + 1. Копирайты, порядок: + 1. Иконка приложения + 1. Название утилиты + 1. Версия программы + 1. Название утилиты, локализованное + 1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ + 1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR + - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR" + - где $LASTYEAR - текущий год. 1. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!" 1. Строка уведомлений. Цвет в зависимости от сигнала: - песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы. - красный, пиктограмма "Восклицательный знак", сообщения об ошибках при сохранении, загрузке параметров конфигурации, при ошибках в работе программы, полученных от обработчика ошибок. - 1. Окно с выводом информации о программе: - 1. Заголовок окна по локализованному названию утилиты - 1. Копирайты, порядок: - 1. Иконка приложения - 1. Название утилиты - 1. Версия программы - 1. Название утилиты, локализованное - 1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ - 1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR - - локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR" - - где $LASTYEAR - текущий год. 1. Поля "Параметры командной строки" заполняются автоматически при выборе необходимых параметров в таблицах соответствующих блоков (активация через чекбоксы), в поле передаётся название параметра и его значение (если значение имеется), разделение через пробел. 1. При удалении параметра из поля "Параметры командной строки" соответствующий параметр теряет свой статус активности (галочка снимается) в таблице соответствующего блока. 1. При редактировании (изменении) параметра в поле "Параметры командной строки" соответствующий параметр теряет свой статус активности (галочка снимается) в таблице соответствующего блока. @@ -140,6 +154,8 @@ 1. Вывод файлов csv так же должен быть локализован средствами pot-, po-, mo- файлов. 1. **КОМАНДЫ** + 1. Справка, О приложении > Домашняя страница проекта: +xdg-open ${URLWIKI} & 1. Меню загрузки 1. Таймер выбора варианта загрузки: 1. Чтение значения: