Улучшение файла помощи фара

Хотите говорить о Far и не знаете, куда обратиться?
DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

Latest post of the previous page:

Упоминание о Ctrl-Alt-F (фильтрация элементов меню) добавлено в следующие разделы справки: @DriveDlg, @UserMenu, @PluginCommands и @PluginsConfig.
http://bugs.farmanager.com/view.php?id=1535
На мой вгляд, этого достаточно. Если же человек ни разу не нажал F1 ни в меню пользователя, ни в меню плагинов, ни в меню настроек плагинов, ни в меню выбора диска, тогда он вряд ли сделает это в каком-то другом меню.

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

DV wrote:Упоминание о Ctrl-Alt-F (фильтрация элементов меню) добавлено в следующие разделы справки: @DriveDlg, @UserMenu, @PluginCommands и @PluginsConfig.
http://bugs.farmanager.com/view.php?id=1535
На мой вгляд, этого достаточно. Если же человек ни разу не нажал F1 ни в меню пользователя, ни в меню плагинов, ни в меню настроек плагинов, ни в меню выбора диска, тогда он вряд ли сделает это в каком-то другом меню.
Например в списке ассоциаций фильтр ну очень полезен, в отличии от @DriveDlg и @UserMenu...

Если поглядеть на раздел @KeyRef, то обнаруживается, что вообще отсутствует отдельный раздел с перечнем Клавиатурных команд общих для всех меню (кстати диалоги тоже не представлены отдельным разделом, хотя некоторые команды и перечислены в @MiscCmd).

Я так думаю правильнее создать специальный раздел для меню, где среди прочего упомянуть и Ctrl-Alt-F.
А во всех вышеперечисленных разделах добавить ссылку "См. также клавиатурные команды общие для всех меню".

P.S.
Есть раздел @KeyMacroMenuList, но ссылка на него дана только в индексе, что в корне неправильно.

User avatar
SlashNet
Posts: 591
Joined: Fri 20 Mar, 2009 09:43
Location: Львов
Has thanked: 4 times

Re: Улучшение файла помощи фара

Post by SlashNet »

Вставлю и свои 5 копеек.
В справке о меню пользователя нет упоминания о CtrlUp/CtrlDown.

UPD: Долго сообщение набирал - за меня уже написали
ədиw wo⊥є ʚ o⊥ʎнdəʚədəu əɔʚ

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

SlashNet wrote:UPD: Долго сообщение набирал - за меня уже написали
Очень долго, см. дату.
Hint: первый пост на странице это шапка :)

User avatar
SlashNet
Posts: 591
Joined: Fri 20 Mar, 2009 09:43
Location: Львов
Has thanked: 4 times

Re: Улучшение файла помощи фара

Post by SlashNet »

Я туплю...
ədиw wo⊥є ʚ o⊥ʎнdəʚədəu əɔʚ

DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

John Doe wrote:Я так думаю правильнее создать специальный раздел для меню, где среди прочего упомянуть и Ctrl-Alt-F.
Если двигаться этим путём, возникает два вопроса, плюс бонусный:
1. Как назвать этот раздел? Нужно какое-то более-менее общее название, в то же время отражающее специфику использования.
2. Как назвать ссылку на этот раздел и в какой форме её упоминать? Вариант "См. также/See also" не подходит, так как многие затрагиваемые разделы справки уже содержат "См. также/See also" со ссылкой на клавиатурные макросы, например.
3. Наконец, для полной определённости нужен полный и окончательный список тех разделов справки, в которые следует добавить ссылку на наш раздел меню.

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

DV wrote:1. Как назвать этот раздел? Нужно какое-то более-менее общее название, в то же время отражающее специфику использования.
@MenuCmd
DV wrote:2. Как назвать ссылку на этот раздел и в какой форме её упоминать? Вариант "См. также/See also" не подходит, так как многие затрагиваемые разделы справки уже содержат "См. также/See also" со ссылкой на клавиатурные макросы, например.
Имхо, вполне подходит, только "См. также" надо будет вынести за скобки:

Code: Select all

    См. также:
    - Клавиатурные команды общие ~для всех меню~@MenuCmd@.
    - Cписок ~макроклавиш~@KeyMacroUserMenuList@, доступных в меню пользователя.
DV wrote:3. Наконец, для полной определённости нужен полный и окончательный список тех разделов справки, в которые следует добавить ссылку на наш раздел меню.
Я составил этот список ещё вчера, сегодня дополнил.
Возможность что я что-то пропустил конечно остаётся...

Дополнительно ссылка нужна в @KeyRef и @Index.

P.S.
Сам раздел должен в свою очередь содержать ссылку на @KeyMacroMenuList.

DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

FarHlf.12.1.diff - добавлен раздел @MenuCmd и ссылки на него:
http://bugs.farmanager.com/view.php?id=1535

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

Косметика:
  1. Неоправданный верхний регистр после двоеточия. Если бы "Клавиатурные команды" начинались с другой строки, то другое дело.

    Code: Select all

    +    См. также: Клавиатурные команды, общие ~для всех меню~@MenuCmd@.
    Мне кажется стоит указывать с новой строки даже если всего один пункт.
  2. А тут наоборот, "список" почему-то с маленькой буквы.

    Code: Select all

    +    См. также:
     
    +    список ~макроклавиш~@KeyMacroUserMenuList@, доступных в меню пользователя.
    +    Клавиатурные команды, общие ~для всех меню~@MenuCmd@.
Кстати, почему вы решили не выделять пункты минусом?

User avatar
Centaur
Posts: 1083
Joined: Tue 05 Apr, 2005 20:09
Location: Novosibirsk, Russia
Been thanked: 2 times

Re: Улучшение файла помощи фара

Post by Centaur »

John Doe wrote:Кстати, почему вы решили не выделять пункты минусом?
Потому что это неправильно?

Пункты маркированного списка выделяются либо каким-нибудь буллитом (• и подобными), либо, в российской типографской традиции, каким-нибудь тире.

DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

John Doe wrote:Неоправданный верхний регистр после двоеточия
Исправил в FarHlf.12.2.diff.
Кстати, я могу удалять предыдущие прикрепленные файлы? Что-то не нашёл, как.
John Doe wrote:Кстати, почему вы решили не выделять пункты минусом?
В разделе @KeyMacro было без минусов.

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

Centaur wrote:в российской типографской традиции, каким-нибудь тире.
Я полностью согласен, только вот смысла нет наводить типографику в одном отдельно взятом разделе. Если кто возьмётся поправить во всей документации - тогда да, будет смысл поддерживать.
DV wrote:В разделе @KeyMacro было без минусов.
Да, но там немного другая ситуация: пункты списка выделены за счёт того что каждый от начала и до конца является ссылкой.
А с минусами (которые на самом деле должны быть тире) примеров тоже достаточно, вот первый попавшийся: @CmdLine

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

А "как было" эталоном служить может не всегда, например было "См. так_же".

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

1. Патч почему-то не затрагивает раздел @Menus
2. В каждый из разделов @LeftRightMenu @FilesMenu @CmdMenu @OptMenu по-видимому стоит добавить и См. также список ~макроклавиш~@KeyMacroMenuList@, доступных в меню.

DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

John Doe wrote:1. Патч почему-то не затрагивает раздел @Menus
Потому что @Menus не является "обычным" меню. Я даже не могу сказать, работают ли в нём хоть какие-то клавиатурный комбинации, кроме "горячих" (подсвеченных) букв.
John Doe wrote:2. В каждый из разделов @LeftRightMenu ...
Так они же все ссылаются на @MenuCmd, который, в свою очередь, ссылается на @KeyMacroMenuList.

И вообще, я устал. Патч для справки предложен, и если я что-то упустил, то, как бы, "исходники открыты".

User avatar
John Doe
Бюрократ
Posts: 12648
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 35 times
Been thanked: 268 times

Re: Улучшение файла помощи фара

Post by John Doe »

DV wrote:Потому что @Menus не является "обычным" меню.
Резон в этом есть, и кстати именно поэтому ссылку на @KeyMacroMenuList тоже надо оттуда переместить в подразделы.
DV wrote:И вообще, я устал.
Теперь вы понимаете почему хелп никто не хочет обновлять :-)
В любом случае, спасибо за то что сделали!

Кто бы теперь аналогичную процедуру проделал для диалогов...

DV
Posts: 387
Joined: Mon 07 Aug, 2006 08:23
Has thanked: 14 times
Been thanked: 14 times

Re: Улучшение файла помощи фара

Post by DV »

John Doe wrote:Кто бы теперь аналогичную процедуру проделал для диалогов...
Я вот смотрю, что результат моих стараний насчёт Ctrl-Alt-F тихо себе пылится на Мантисе... Не очень воодушевляет это на обновление файла помощи, isn't it? ;)

Post Reply

Return to “Обсуждение Far Manager”