Opened 8 years ago

Closed 5 years ago

Last modified 22 months ago

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

Исправить названия линий refclk — at Version 16

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

Description (last modified by alx)

В веб-интерфейсе названия линий синхронизации приведены к единой системе: refclk0 и refclk1. Исправлены следующие места:

  • вкладка "Генератор": REF0,REF1 заменено на REFCLK0,REFCLK1;
  • конфигурация плат SM-01,SM-02,TE-01: refclk заменено на refclk1;
  • конфигурация платы VE-01: refclk1, refclk2 заменено на refclk0, refclk1.

Надо внести соответствующие изменения в руководство.

Change History (16)

comment:1 by san, 8 years ago

Cc: san added

конфигурация плат SM-01,SM-02,TE-01: refclk заменено на refclk1;

Видимо опечатка, на самом деле refclk0

comment:2 by alx, 7 years ago

Owner: changed from anatoly to andrei
Status: newassigned

Все тикеты по РЭ переданы Андрею.

comment:3 by san, 7 years ago

milestone: Текущие работы2 очередь

Milestone renamed

comment:4 by san, 6 years ago

Owner: changed from andrei to Vladimir

comment:5 by san, 5 years ago

Т.к. в аппаратуре теперь система наименования единая, думаю что нужно, кроме предложенного в тикете, найти и исправить ВСЕ встречающиеся в РЭ упоминания:
REF0 -> Refclk0
REF1 -> Refclk1

Здесь и пригодится суперспособность считать сколько раз в РЭ встречается слово :-D

Last edited 5 years ago by san (previous) (diff)

comment:6 by Vladimir, 5 years ago

Такой суперспособностью обладает поиск в Ворде:
все слова по указанному виду Ворд находит за 1 секунду!

Таким образом, в тексте РЭ-42-10 сочетание REF0 = 8 раз, REF1 = 5 раз,
а заменить все слова по образцу Ворд сможет за 2 секунды.
Но тут дело сложнее: эти неправильные названия встречаются на рисунках,
а исправление рисунков займёт больше времени и править надо одновременно текст+Рис,
т.к. текст ссылается на рисунок.
Слова на рисунках Врорд не ищет, не считает и не исправляет,
а, например, на Рис.6.37 эти сочетания букв встречаются 7 раз.

comment:7 by Vladimir, 5 years ago

В РЭ-42-10 согласно комменту 5 от САН заменил все
REF0 -> Refclk0
REF1 -> Refclk1
включая обозначения на Рис.6.37 и 6.38

Обращаю внимание, что это немного не соответствует обозначению в тексте этого тикета:
"refclk заменено на refclk1", у меня теперь везде первая буква R заглавная, как у САН.

Если все согласны, то тикет закрою.

comment:8 by Vladimir, 5 years ago

В тексте РЭ общее число Refclk 38 раз

in reply to:  7 comment:9 by alx, 5 years ago

Replying to Vladimir:

Обращаю внимание, что это немного не соответствует обозначению в тексте этого тикета:
"refclk заменено на refclk1", у меня теперь везде первая буква R заглавная, как у САН.

Если все согласны, то тикет закрою.

Я не возражаю. Надеюсь, что у читателя есть голова на плечах, и различие в регистре одной буквы не поставит его в тупик - надеюсь, читатель догадается, что это одно и то же...

comment:10 by Vladimir, 5 years ago

А всё-таки, как на самом деле правильно: большая или маленькая буква r/R ?
Почему Саша указал R ?

in reply to:  10 comment:11 by alx, 5 years ago

Replying to Vladimir:

А всё-таки, как на самом деле правильно: большая или маленькая буква r/R ?

Как правильно, написано в описании тикета:

  • вкладка "Генератор": REFCLK0, REFCLK1;
  • конфигурация плат SM-01,SM-02,TE-01,VE-01,VE-02: refclk0, refclk1.
Last edited 5 years ago by alx (previous) (diff)

comment:12 by san, 5 years ago

Почему Саша указал R

Для единообразности, чтобы вам проще было. Думаю, что пользователи переживут различие в регистре букв на картинке и в тексте.

in reply to:  12 comment:13 by Vladimir, 5 years ago

Replying to san:

Почему Саша указал R

Для единообразности, чтобы вам проще было. Думаю, что пользователи переживут различие в регистре букв на картинке и в тексте.

Два Знатока предлагают 3 разных варианта названия одного и того же
явления / свойства / функции в одном и том же Документе РКД:
REFCLK / Refclk / refclk и в то же время говорят о единообразности! :-)
Договорились бы уж между собой: мне исправить совсем не трудно и не долго,
а иначе народ будет думать, что REFCLK - это очень важное свойство,
Refclk - этот так себе, а на refclk - вообще можно "наплевать" :-)
А хуже того, подумают, что это совершенно разные сигналы синхронизации
и долго будут искать различия :-)

Если уж САН предлагает Refclk, но тогда надо выпустить тикет на исправление
всех надписей REFCLK и refclk во всех окнах Системы Управления, например,
на "Рис. 6.36 Вкладка Генератор для управления режимами синхронизации",
т.к. если в окнах надписи типа REFCLK, то и в тексте описания этих окон
должно быть именно так же, а не иначе.
Или уж вообще ничего не менять, а оставить 2 применяемых уже 8 лет варианта:
REFCLK и refclk - как в этом Тикете у Алекса...

comment:14 by san, 5 years ago

тикет на исправление всех надписей REFCLK и refclk во всех окнах Системы Управления

Я за использование одинаковой терминологии. Поддерживаю ваше предложение, напишите тикет в проект SW-01.

in reply to:  14 comment:15 by Vladimir, 5 years ago

Description: modified (diff)
Resolution: готово
Status: assignedclosed

Replying to san:

тикет на исправление всех надписей REFCLK и refclk во всех окнах Системы Управления

Я за использование одинаковой терминологии. Поддерживаю ваше предложение, напишите тикет в проект SW-01.

Инициатива единообразности впервые была от тебя в комментах 5 и 12,
так почему бы тебе, как инициатору и Ответственному на написать этот тикет
и тем более, что я никогда не заглядываю с проект SW-01 - мне хватает и проекта РЭ,
к тому же мой авторитет в обозначениях функций Системы управления ниже, чем твой и Алекса,
а ещё к этому же ты назвался Ответственным - вот и прояви единоначалие! :-)

Ещё раз я просмотрел все 38 случаев употребления сочетаний типа
REFCLK / Refclk / refclk и увидел, что все они присутствуют на разных скринах
разных окон - так что разнообразие исходит от "художника" окон.

Сейчас я исправил все тексты описания окон, чтобы названия в окне и тексте описания совпали,
так что теперь Тикет 65 полностью учтён и его можно закрыть.
Как только изменятся окна, так я снова исправлю текст описания в соответствии с новыми рисунками окон по новым тикетам про изменение рисунков окон.

comment:16 by alx, 5 years ago

Description: modified (diff)

Я не вносил в РЭ-42-10 от 12.05.2020 никакие изменения. Не надо писать от моего имени то, чего я не делал.

Note: See TracTickets for help on using tickets.