zg wrote:хелп у фара — больное место. особенно перед каждым релизом. поэтому их в принципе и отменили.
Не секрет что в хелпе присутствуют неточности, устаревшая информация, неописаны новые или неочевидные возможности.
В английском файле помощи многие места непереведены.
Неудивительно, ведь фар растёт, и хелп за ним не поспевает - некому им заниматься, в бесплатном проекте-то.
Предлагаю в этой теме всем желающим участвовать в улучшении файла помощи фара и стандартных плагинов.
Неполный список мест вообще неосвещённых в справке:
@UserMenu - не описана возможность двигать пункты с помощью Ctrl-стрелки.
В @FileAssoc сочетания описаны, но не отображаются в статусе меню. (Для сравнения: в @HighlightList и описаны, и отображаются)
при копировании с панели имён файлов в буфер обмена используется также формат CF_HDROP...
@PanelSettings: [x] Right click selects files
@ShowPluginInfo (информация о плагине из меню плагинов по F3)
Места, требующие доработки:
@FileMasks - не описано как правильно искать файлы в именах которых содержатся символы "[" и "]".
@EditorSearch, @RegExp, @RegExpRepl - не отражены ограничения редактора при поиске многострочных выражений.
Например, в хелпе S&R по этому поводу сказано:
В силу специфики редактора FAR файл при поиске обрабатывается только
построчно: вы не можете захватить вашей строкой для поиска две или несколько
строк, а также знаки конца строки.
Главное меню
пользователя может быть только одно. Главное меню вызывается в том случае, если
для текущей папки отсутствует местное меню. Местное меню может быть расположено
в любой папке. Вы можете в любой момент переключиться между местным меню и
главным меню с помощью клавиш #Shift-F2#. Вы также можете вызвать местное меню
из родительской папки с помощью клавиши #BkSpace#.
Из @CodePagesMenu надо общую часть о кодовых страницах выделить в отдельный раздел, для того чтобы можно было сослаться на него из других разделов (например @FileSaveAs и @FileOpenCreate)
@MaskGroupsSettings
несколько топиков ссылаются сюда, но не указано, где это настраивается.
build 3298 Экспериментально: в масках файлов можно смешивать обычные маски и регулярные выражения
Диалог создания ссылки (Alt-F6) - выделить в отдельный раздел. Имхо он должен быть отдельным от общего, чтобы корректно ссылаться на общий из других разделов.
@PluginsManagerSettings - нет хватает описаний.
Нужны перекрёстные ссылки с @ChoosePluginMenu
@MenuCmd и @MiscCmd пересекаются
@FileDiz (настройка File descriptions)
Описать пункты (и разницу между ними):
Использовать кодовую страницу ANSI по умолчанию
Сохранять в UTF8
На досуге немного перелопатил хелп.
Предлагаю следующие улучшения:
"Содержание" и "Синтаксис" совмещены в одну страницу.
Навигация стала удобней, поскольку теперь оттуда можно переместиться в любой раздел в один переход.
Из всех разделов удалены многократные упоминания о "двойном синтаксисе".
<prefix>:<command>[<options>] <object>
или
<command>:[<options>] <object>
Вместо этого об этом упоминается 1 раз - в "Замечаниях".
За счёт устранения дублирования улучшена читаемость справки, и уменьшен размер страниц (большинство помещается на 1 экран).
Имхо этот двойной синтаксис вообще не несёт ни малейшей пользы.
Из "Замечаний" убран пункт, не соответствующий действительности:
1. Для префикса far имена команд можно сокращать до первой буквы.
В "Синтаксисе" из командной строки убрал угловые скобки, чтобы не путались с операторами перенаправления вывода, описываемыми там же.
Было: <command>:[<options>] <object>
Стало: command:[options] object
Во-первых опции есть не только у команды edit.
Во-вторых опциональность опций и в то же врямя обязательность указания квадратных скобок несколько сбивают с толку.
В связи с предыдущим пунктом отредактировал раздел "Edit".
В разделах помощи к командам view, edit, clip, load, unload отсутствовала ссылка на "Содержание" (в остальных такая ссылка есть).
Сделал чтобы было однотипно.
"load" и "unload" содержат ссылки друг на друга.
Сделал то же для пар view/edit и goto/whereis.
Те изменения, которые будут одобрены, оформлю в виде патча, в том числе и в английской справке.
Доделал хелп FarCmds.
Перед отправкой на мантис выкладываю здесь, на случай если найдутся какие неточности.
Изменения по сравнению с предыдущей версией:
В паре мест убрал дублирование информации.
Главная страница теперь практически полностью помещается на одном экране. Вот если бы ещё в хелпе самого фара был раздел о префиксах...
Откорректировал раздел link:.
Терминология приведена в соответствие с принятой в фаре.
Перекроил раздел "Перехват вывода".
Теперь он почти в 2 раза короче, без потери информации.
Можно сократить ещё сильнее, т.к. присутствует дублирование.
Поправлены/добавлены линки.
Все изменения перенёс в FARCmdsEng.hlf.
Заодно убрал русские букоффки (за перевод не ручаюсь, кто может проверьте)
Re: FarCmds (FAR Commands)
Posted: Tue 18 May, 2010 11:43
by Andrey Budko
Команда #load# позволяет загрузить плагин #имя_DLL_модуля#.
Команда #unload# позволяет загрузить плагин #имя_DLL_модуля#.
3. Переработан кусок по макросам. Действует "второй" режим для post и check:
текст макроса берётся из заданного файла:
macro:post < имяфайла
macro:check < имяфайла
...
2. В качестве эксперимента :-)
команда "whereis:", так же как и "goto:", имеет второй режим:
путь к файлу или каталогу берётся из заданного файла:
goto: <имяфайла
В процессе внесены следующие изменения:
Разделы goto и whereis объединены, во избежание копипасты.
В результате обобщения кое-что пришлось переформулировать, возможно не самым удачным образом (жду предложений по улучшению).
Термин Каталог заменён на папку (как в хелпе самого фара).
Заменён не везде, осталась ещё сама команда "Такой же каталог", и соответствующий ей раздел помощи.
Как быть с ней? Переименовать и в хелпе, и в lng?
Раздел macro "уплотнён", чтобы помещаться на 1 экран.
Re: Улучшение файла помощи фара
Posted: Wed 16 Jun, 2010 20:34
by Imp_GL
"Выбор плагина" и "Настройка автозавершения" вообще отсутствуют в справке. Где бы про них почитать? Чтобы хоть понять что это за пункты (особенно первый, со вторым более понятно) и что делает каждая настройка в этих пунктах.
Re: Улучшение файла помощи фара
Posted: Wed 16 Jun, 2010 21:24
by John Doe
В шапке темы под спойлером есть ссылка.
А вообще хелп по "выбору плагина" можно сказать существует: надо взять его из The Underscore, и немного адаптировать.
Re: Улучшение файла помощи фара
Posted: Tue 27 Jul, 2010 08:38
by John Doe
John Doe wrote:Добавил в хелп FarCmds информацию о нововведениях
...
svs 26.07.2010 10:41:25 +0300 - build 71
...
2. Добавка в хелп (в английском есть русские буковки)
macro:post < имяфайла
macro:check < имяфайла
goto: <имяфайла
2 Skirda
Может всё же как-то объединим усилия?
Re: Улучшение файла помощи фара
Posted: Tue 27 Jul, 2010 11:22
by Skirda
Я не против.
Я даже за то, чтобы в farcmds унифицировать перенаправлялки.
Re: Улучшение файла помощи фара
Posted: Thu 19 Aug, 2010 09:25
by John Doe
svs 18.08.2010 22:31:22 +0300 - build 1644 wrote:1. Mantins#0001305: wish: Show some cols of Find window
Настройка колонок находится в диалоге "Find file advanced options" (в поисковике кнопка "Advanced")
Синтаксис типов колонок - как у панелей. Отличия и ограничения - описаны в хелпе к диалогу "Find file advanced options".
В результате в хелпе получилось 2 практически одинаковых куска.
Может лучше в помощи к опциям поиска (@FindFileAdvanced) ограничиться ссылкой на @PanelViewModes + описание отличий?