Opened 4 years ago

Closed 16 months ago

Last modified 15 months ago

#597 closed задача (готово)

РЭ: добавить описание функция экспорта и импорта настроек плат

Reported by: alx Owned by: Vladimir
Priority: major Component: Руководство по эксплуатации
Keywords: Cc:

Description

Начиная с sw:r1859 добавлены две новые функции: экспорт настроек платы и импорт настроек платы. Для доступа к ним в веб-интерфейсе в диалогах конфигурации всех плат добавлено дополнительное меню, открывающееся при клике символа в левом верхнем углу диалога:


При клике в меню пункта "Экспорт настроек..." текущие настройки платы сохраняются в виде документа XML.

При клике в меню пункта "Импорт настроек..." открывается диалог с полем выбора файла для импорта настроек. После выбора файла необходимо нажать кнопку "Загрузить", после чего настройки из файла будут загружены в блок и переданы плате.

Необходимо добавить описание этих функций в РЭ аппаратуры MC04-DSL-3U.

Attachments (1)

ss1.jpg (42.9 KB ) - added by alx 4 years ago.

Download all attachments as: .zip

Change History (18)

by alx, 4 years ago

Attachment: ss1.jpg added

in reply to:  description ; comment:1 by Vladimir, 17 months ago

Replying to alx:

Начиная с sw:r1859 добавлены две новые функции: экспорт настроек платы и импорт настроек платы. Для доступа к ним в веб-интерфейсе в диалогах конфигурации всех плат добавлено дополнительное меню, открывающееся при клике символа в левом верхнем углу диалога:

А ты бы мог сделать так, чтобы в этом диалоге жёлтое поле "Экспорт настроек..."
размещалось немного повыше, чтобы не закрывать названия граф "Порт" и "Комментарий":
если твой скриншот разместить в РЭ, то юзеры не увидят эти названия...
Если сможешь исправить это, то пришли новый скриншот.


При клике в меню пункта "Экспорт настроек..." текущие настройки платы сохраняются в виде документа XML.

При клике в меню пункта "Импорт настроек..." открывается диалог с полем выбора файла для импорта настроек. После выбора файла необходимо нажать кнопку "Загрузить", после чего настройки из файла будут загружены в блок и переданы плате.

Необходимо добавить описание этих функций в РЭ аппаратуры MC04-DSL-3U.

in reply to:  1 ; comment:2 by alx, 17 months ago

Replying to Vladimir:

А ты бы мог сделать так, чтобы в этом диалоге жёлтое поле "Экспорт настроек..."
размещалось немного повыше, чтобы не закрывать названия граф "Порт" и "Комментарий":

Мог бы, но не считаю это хорошей идеей. Так как высота желтого поля больше, чем высота заголовка диалога, чтобы это поле не закрывало часть "тела" диалога (все, что под заголовком), его придется рисовать выше, чем заголовок диалога. А, так как заголовок может быть в сомом верху страницы (особенно для диалогов большой высоты), то получается, что желтое поле будет выходить за границы страницы, то есть его верхняя часть будет не видна. Это первое.

Второе (и главное) - даже если желтое поле закрыло что-то важное, пользователь может кликнуть за пределами этого поля - и оно исчезнет. Поэтому необходимость в изменении расположения поля не вижу.

если твой скриншот разместить в РЭ, то юзеры не увидят эти названия...

А зачем юзерам видеть эти надписи? Какое отношение надписи "Порт" и "Комментарий" имеют к функциям экспорта и импорта настроек платы?

Если сможешь исправить это, то пришли новый скриншот.

Как я уже написал выше, исправить могу, но не буду.

in reply to:  2 ; comment:3 by Vladimir, 17 months ago

Replying to alx:

Replying to Vladimir:

высота желтого поля больше, чем высота заголовка диалога, чтобы это поле не закрывало часть "тела" диалога (все, что под заголовком), его придется рисовать выше, чем заголовок диалога. А, так как заголовок может быть в сомом верху страницы (особенно для диалогов большой высоты), то получается, что желтое поле будет выходить за границы страницы, то есть его верхняя часть будет не видна.

Я бы попробовал "втиснуть": например, немного приподнял бы поле заголовка над таблицей
и немного сократил бы ширину строк "Экспорт..." и "Импорт..." :-)

Второе (и главное) - даже если желтое поле закрыло что-то важное, пользователь может кликнуть за пределами этого поля - и оно исчезнет. Поэтому необходимость в изменении расположения поля не вижу.

Читатель РЭ не сможет кликнуть на странице РЭ :-)

А зачем юзерам видеть эти надписи? Какое отношение надписи "Порт" и "Комментарий" имеют к функциям экспорта и импорта настроек платы?

Размещать в огромном РЭ почти рядом 2 почти одинаковых и больших рисунка
не рационально: после существующего рисунка идёт описание граф на рисунке вкладки,
поэтому желательно, чтобы эти графы было видно.

Если сможешь исправить это, то пришли новый скриншот.

Как я уже написал выше, исправить могу, но не буду.

Я это предполагал и заранее сделал скриншот этого окна в демо-доступе,
дорисовал в Визио красную стрелочку в поле заголовка и над ней разместил надпись:
"Экспорт / Импорт настроек".
Кроме того, под "Рис. 5.68 Вкладка Плата FO-08" добавил твой текст:
"При клике в меню, открывающемся при клике символа в левом верхнем углу диалога, на пункте "Экспорт настроек..." текущие настройки платы сохраняются в виде документа XML"
Теперь уже всем будет ясно, что это за 3 чёрточки "в левом верхнем углу диалога".
Если есть предложение, как лучше перефразировать этот текст, то подскажи,
но ИМХО мой рисунок и текст все могут понять правильно.

in reply to:  3 ; comment:4 by alx, 17 months ago

Replying to Vladimir:

Я бы попробовал "втиснуть": например, немного приподнял бы поле заголовка над таблицей

Это будет нерациональное использование площади дисплея. Пользователи с маленькими дисплеями будут недовольны...

и немного сократил бы ширину строк "Экспорт..." и "Импорт..." :-)

Там и так размер шрифта 8pt! Куда его еще сокращать? Сделать 6pt? Он станет совсем нечитаемым! Ты пробовал читать текст, набранный таким шрифтом? :)

А что делать, если в этом меню появится третий пункт? Еще уменьшать? :)

Второе (и главное) - даже если желтое поле закрыло что-то важное, пользователь может кликнуть за пределами этого поля - и оно исчезнет. Поэтому необходимость в изменении расположения поля не вижу.

Читатель РЭ не сможет кликнуть на странице РЭ :-)

При чем тут РЭ? Мы же говорим об изменении веб-интерфейса...

in reply to:  4 ; comment:5 by Vladimir, 17 months ago

Replying to alx:

Replying to Vladimir:

Я бы попробовал "втиснуть": например, немного приподнял бы поле заголовка над таблицей

Это будет нерациональное использование площади дисплея. Пользователи с маленькими дисплеями будут недовольны...

На пару миллиметров это не вызовет недовольства :-)

и немного сократил бы ширину строк "Экспорт..." и "Импорт..." :-)

Там и так размер шрифта 8pt! Куда его еще сокращать? Сделать 6pt? Он станет совсем нечитаемым! Ты пробовал читать текст, набранный таким шрифтом? :)

Шрифт менять не надо: сейчас над словами "Экспорт..." и "Импорт..."
относительно много жёлтого фона - его можно бы сократить...

А что делать, если в этом меню появится третий пункт? Еще уменьшать? :)

Когда появится, тогда и будем решать :-)

Читатель РЭ не сможет кликнуть на странице РЭ :-)

При чем тут РЭ? Мы же говорим об изменении веб-интерфейса...

А для чего: чтобы в РЭ на одном рисунке (скриншоте) было видно и названия граф
и было видно, где это меню.

Но ИМХО нарисованная стрелочка на рисунке в РЭ с указанием,
что это такое и чего содержи, достаточно для понимания, где и что есть,
а если будет много пунктов меню, то я напишу над стрелкой слова: "Меню настройки"

Других замечаний по тикету вижу, что нет, поэтому закрою.

in reply to:  description ; comment:6 by Vladimir, 17 months ago

Resolution: готово
Status: newclosed

Replying to alx:

Начиная с sw:r1859 добавлены две новые функции: экспорт настроек платы и импорт настроек платы. Для доступа к ним в веб-интерфейсе в диалогах конфигурации всех плат добавлено дополнительное меню, открывающееся при клике символа в левом верхнем углу диалога:
Необходимо добавить описание этих функций в РЭ аппаратуры MC04-DSL-3U.

В РЭ-55 от 09.12.2022 описание добавлено, рисунок дополнен.

in reply to:  5 ; comment:7 by alx, 17 months ago

Replying to Vladimir:

Шрифт менять не надо: сейчас над словами "Экспорт..." и "Импорт..."
относительно много жёлтого фона - его можно бы сократить...

А, понял. Ты предлагаешь сократить межстрочные интервалы. Боюсь, этого будет недостаточно чтобы размер меню уменьшился до размера заголовка.

А что делать, если в этом меню появится третий пункт? Еще уменьшать? :)

Когда появится, тогда и будем решать :-)

Не будем. :) Спасибо за предложение. Я его рассмотрел, но аргументы счел неубедительными.

У меня только просьба - в следующий раз для своего предложения создай, пожалуйста, тикет в проекте sw-01.

in reply to:  7 comment:8 by Vladimir, 17 months ago

Replying to alx:

Replying to Vladimir:

Шрифт менять не надо: сейчас над словами "Экспорт..." и "Импорт..."
относительно много жёлтого фона - его можно бы сократить...

А, понял. Ты предлагаешь сократить межстрочные интервалы. Боюсь, этого будет недостаточно чтобы размер меню уменьшился до размера заголовка.

На это тоже есть хорошая поговорка:
-"Кто хочет - тот ищет способы и на ходит!,
вот я успешно нашёл способ, вставил в РЭ и закрыл тикет.

а кто не хочет - тот ищет причины и тоже находит!" :-)
а ты тоже нашёл причины и успешно отказался делать, но я не против :-)

А что делать, если в этом меню появится третий пункт? Еще уменьшать? :)

Когда появится, тогда и будем решать :-)

Не будем. :) Спасибо за предложение. Я его рассмотрел, но аргументы счел неубедительными.

У меня только просьба - в следующий раз для своего предложения создай, пожалуйста, тикет в проекте sw-01.

in reply to:  6 ; comment:9 by alx, 16 months ago

Resolution: готово
Status: closedreopened

Replying to Vladimir:

В РЭ-55 от 09.12.2022 описание добавлено, рисунок дополнен.

Насколько я вижу, в РЭ-55 описание функций экспорта и импорта настроек добавлено в раздел "Настройка платы FO-08" и только в него. Таким образом, прочитав РЭ, читатель будет думать, что только плата FO-08 имеет функции экспорта и импорта настроек. В действительности это не так - функции экспорта и импорта настроек имеются у всех плат, о чем прямо было написано в описании этого тикета. Вынужден переоткрыть тикет.

Предлагаю либо добавить аналогичное описание в разделы описаний всех остальных (кроме FO-08) типов плат, либо перенести описание этих функций в какой-либо общий для всех плат раздел РЭ.

in reply to:  9 ; comment:10 by Vladimir, 16 months ago

Replying to alx:

Replying to Vladimir:

В РЭ-55 от 09.12.2022 описание добавлено, рисунок дополнен.

Предлагаю либо добавить аналогичное описание в разделы описаний всех остальных (кроме FO-08) типов плат, либо перенести описание этих функций в какой-либо общий для всех плат раздел РЭ.

САН предложил добавить это описание в "6.2.1 Вкладка Платы – список установленных плат и аварий"
Я создал подпункт: "6.2.1.1 Экспорт / Импорт настроек плат"
Описание получилось в двух вариантах:
"При клике в меню, открывающемся при клике символа [тут рисунок символа из трёх чёрточек] в левом верхнем углу диалога, на пункте "Экспорт настроек..." текущие настройки платы сохраняются в виде документа XML.
При клике в меню пункта "Импорт настроек..." открывается диалог с полем выбора файла
для импорта настроек. После выбора файла необходимо нажать кнопку "Загрузить", после чего настройки из файла будут загружены в блок и переданы плате."
Это практически твой текст из описания этого тикета.
И для обсуждения мой вариант:
"При клике символа меню [рисунок] в левом верхнем углу диалога, можно кликнуть пункт
"Экспорт настроек..." - тогда текущие настройки платы сохраняются в виде документа XML,
либо кликнуть пункт "Импорт настроек..." - тогда открывается диалог с полем выбора файла
для импорта настроек. После выбора файла необходимо нажать кнопку "Загрузить",
после чего настройки из файла будут загружены в блок и переданы плате."
Помоги выбрать вариант описания: твой, или мой :-)
Во всех платах будет ссылка на этот пункт "6.2.1.1"

in reply to:  10 ; comment:11 by alx, 16 months ago

Replying to Vladimir:

Описание получилось в двух вариантах:

....

Помоги выбрать вариант описания: твой, или мой :-)

Я не понял, в чем отличие одного варианта от другого. Я вижу в них совершенно одинаковые действия... Или это шутка такая? :)

in reply to:  11 ; comment:12 by Vladimir, 16 months ago

Replying to alx:

Replying to Vladimir:

Описание получилось в двух вариантах:

Я не понял, в чем отличие одного варианта от другого. Я вижу в них совершенно одинаковые действия...

Оба варианта про одно и то же, но сформулированы по разному, начиная с первой строчки:

  1. При клике в меню, открывающемся при клике символа [рис.] в левом верхнем углу диалога,

на пункте "Экспорт настроек..." текущие настройки платы сохраняются в виде документа XML.

  1. При клике символа меню [рис.] в левом верхнем углу диалога, можно кликнуть пункт "Экспорт настроек..." - тогда текущие настройки платы сохраняются в виде документа XML, либо кликнуть пункт

В первом варианте 2 абзаца, а во втором только 1.

in reply to:  12 ; comment:13 by alx, 16 months ago

Replying to Vladimir:

Оба варианта про одно и то же, но сформулированы по разному,

Выбор формулировки оставляю на твое усмотрение.

in reply to:  13 comment:14 by Vladimir, 16 months ago

Replying to alx:

Replying to Vladimir:

Оба варианта про одно и то же, но сформулированы по разному,

Выбор формулировки оставляю на твое усмотрение.

Тогда будет мой вариант.

Для плат типа ST-... скриншоты сделаны без заголовка окна платы,
поэтому в пункте "5.14.2 Настройка плат ST-018, ST-116, ST-124"
добавлен абзац:
"В заголовке окна платы слева находится меню, открывающееся при клике символа [Рис.] для выбора пунктов экспорта или импорта настроек платы, описание которых находится в п. 6.2.1.1."

comment:15 by Vladimir, 16 months ago

В РЭ-56 от 26.01.2023 на всех рисунках окон с заголовком "Плата ..."
над рисунком окна добавлен текст "Меню: Экспорт / Импорт настроек (описание в п. 6.2.1.1)",
а также стрелка от слова "Меню" на символ меню слева в заголовке окна.
Название пункта по ссылке: "6.2.1.1 Экспорт / Импорт настроек плат"

in reply to:  description comment:16 by Vladimir, 16 months ago

Resolution: готово
Status: reopenedclosed

Replying to alx:

Необходимо добавить описание этих функций в РЭ аппаратуры MC04-DSL-3U.

В РЭ-56 от 26.01.2023 добавлено описание Экспорт / Импорт настроек плат

comment:17 by san, 15 months ago

milestone: 1 очередь

Milestone deleted

Note: See TracTickets for help on using tickets.