Встроенная справка в удобном формате

Хотите говорить о Far и не знаете, куда обратиться?
User avatar
John Doe
Бюрократ
Posts: 13855
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 73 times
Been thanked: 428 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by John Doe »

Latest post of the previous page:

Поясню, к чему я бы стремился (в идеале):

вместо #Копирование текста с экрана# - <head>Копирование текста с экрана</head>,
вместо #Ctrl-Enter# надо <kbd>Ctrl-Enter</kbd>,
Ещё нужны списки (хотя бы <ul></ul>), и какое-то подобие таблиц (хотя бы список <dl>, отформатированный в 2 колонки)
User avatar
NightRoman
Posts: 6184
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 32 times
Been thanked: 62 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by NightRoman »

Тем, кто уже знает hlf, в лом что-то другое осваивать может быть, это понятно. А посмотреть на это с точки зрения плагинописателя, который не знает hlf. Лом ведь во всем этом разбираться (не такой уж он незамысловатый hlf). В итоге где-то не будет документации, где могла бы быть...

Тема не кончится никогда, чую. В общем, я бы за обычный HTML с оговоренным набором правил и тегов, понимаемых Фаром. А старый движок hlf можно и оставить и без ломок обойтись.
User avatar
John Doe
Бюрократ
Posts: 13855
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 73 times
Been thanked: 428 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by John Doe »

Давайте попытаемся обозначить этот самый набор тегов и правил.
Например предложите как может выглядеть в html такой казалось бы незамысловатый кусок:
User avatar
NightRoman
Posts: 6184
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 32 times
Been thanked: 62 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by NightRoman »

Можно подумать над этим, да. Может, и разонравится идея. Или наоборот.
User avatar
Centaur
Posts: 1083
Joined: Tue 05 Apr, 2005 20:09
Location: Novosibirsk, Russia
Been thanked: 2 times

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by Centaur »

contents.xhtml:

Code: Select all

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head><title>Contents</title></head>
<body>
<h1>Программа управления файлами и архивами<br />
2.0 build 1807 bis5 x86<br />
Copyright © 1996–2000 Eugene Roshal<br />
Copyright © 2000–2011 FAR Group</h1>
<!-- не знаю, можно первую строчку заголовком, а остальное просто абзацем -->

<ul>
<li><a href="index.xhtml">Индекс файла помощи</a></li>
<li><a href="help.xhtml">Как пользоваться помощью</a></li><!-- если ещё актуально -->
…
<li><a href="about.xhtml">Что такое FAR</a></li>
…
</ul>
</body></html>
about.xhtml:

Code: Select all

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head><title>FAR: что это такое</title></head>
<body>
<h1>FAR: что это такое</h1>

<p><dfn>FAR</dfn> — это работающая в текстовом режиме программа управления файлами для
Windows 2000/XP/2003/Vista/2008/7, которая обеспечивает обработку файлов с
длинными именами и имеет обширный набор дополнительных функций.</p>
<!-- выделение с пассажа про длинные имена снял. ибо нефиг.
но если бы это было офигеть как круто, то там бы был <strong>…</strong> -->
</body>
User avatar
NightRoman
Posts: 6184
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 32 times
Been thanked: 62 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by NightRoman »

Имхо, то, что надо. Нормально выглядит и в редакторе Фара с колорером (а можно и спец. схему со временем соорудить для Фар-хелп-HTML). Не думаю, что HTML хелп ваять будет сложней, чем HLF. А для тех, кто вообще не знаком с HLF, уж им точно будет лучше набросать HTML, чем вникать в HLF. Даже, если он будет написан по незнанию правил Фара непонятно для Фара местами, то хоть в броузере можно будет почитать привычным образом.

(Только с расширениями xhtml у меня это все не работает в броузере (IE 9), а если обозвать привычным html, то все ок)
User avatar
DrKnS
Posts: 6114
Joined: Thu 04 Aug, 2005 06:44
Location: Kyiv
Has thanked: 12 times
Been thanked: 426 times

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by DrKnS »

Centaur wrote:

Code: Select all

<!-- выделение с пассажа про длинные имена снял. ибо нефиг.
но если бы это было офигеть как круто, то там бы был <strong>…</strong> -->
Читайте "длинные" как "over 32000" и пассаж вновь будет уместен )
LAT
Posts: 343
Joined: Thu 21 Jan, 2010 20:00
Has thanked: 22 times
Been thanked: 39 times

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by LAT »

Max Rusov wrote:Я уже предложил - усовершенствовать HLF.
= "Создать ни чем не совместимый диалект HTML для FAR'а".
LAT
Posts: 343
Joined: Thu 21 Jan, 2010 20:00
Has thanked: 22 times
Been thanked: 39 times

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by LAT »

Max Rusov wrote:Смысл в том, чтобы не устраивать ломки. Старые HLF будут работать, пусть не всегда красиво. Но их можно будет открыть, чуть поправить - и все.
Если будет [пусть даже корявый] конвертер, можно будет преобразовать старые hlf в html, и если нужно - [сравнительно] немного подправить руками. Если потребуется многим пользователям - выложить на форуме или плагринге. В крайнем случае - есть плагин hlfviewer.
User avatar
NightRoman
Posts: 6184
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 32 times
Been thanked: 62 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by NightRoman »

LAT
При том, что я в целом согласен, должен заметить, что hlfviewer не будет работать, если из Фара вынесут hlf движок. Этот вьюер просто дергает движок с нужными параметрами.

Но мне уже начинает нравится вариант старое не ломать (во всяком случае, пока), а новое попробовать. Но это все гипотетическое - кто и когда все это будет "пробовать" - неизвестно.
User avatar
John Doe
Бюрократ
Posts: 13855
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 73 times
Been thanked: 428 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by John Doe »

Centaur
А каковы шансы на реализацию этого в консоли?
User avatar
Centaur
Posts: 1083
Joined: Tue 05 Apr, 2005 20:09
Location: Novosibirsk, Russia
Been thanked: 2 times

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by Centaur »

Чего именно «этого»?

С точки зрения FAR’а как приложения и плагин-хоста, нужна функция «показать топик справки по заданным ID плагина, ID темы». В реализации на готовом (X)HTML во внешнем браузере это грубо ShellExecute(sprintf("%s\\%s\\%s.%s.html", fardir, pluginID, topicID, helpLanguage)). Плюс трудозатраты на конвертацию всего существующего контента в (X)HTML.

Если же хотеть уметь отображать разумно достаточное подмножество XHTML, то задача распадается на несколько подзадач, которые можно брать или не брать в разработку:
  • Парсер. Берётся любой готовый XML-парсер. Поддерживать совместимость с синтаксисом HTML со всеми его неоднозначностями, опциональными тэгами и т.д. — в морг.
  • Layout engine. Тут нужно будет {до,пере}рабатывать то, что уже есть в FAR’е для HLF. В частности, нужно будет поддержать нумерованные и маркированные списки и таблицы.
  • Рендерер оставить как есть, может быть, доточить немного.
  • Проблема модальности. В идеале должно быть можно открыть хелп из диалога и переключаться между ними, не закрывая ни того, ни другого. Эту задачу я не готов оценивать, там много неясного.
Я, впрочем, не уверен, что хочу писать реализацию половины ещё одного консольного веб-браузера. Если смириться с модальностью для тех трёх гиков, которые гоняют FAR через telnet/ssh, можно просто вызывать lynx или там links или чего.
Kildor
Posts: 1515
Joined: Wed 16 Mar, 2005 06:26
Location: Новосибирск
Been thanked: 1 time
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by Kildor »

А может не нужно пытаться прикручивать к фару ещё и веб-браузер? Потому как лично я периодически использую фар без запущенного браузера, и запускать его не хочется.
Ты мне не выкай!
«ФарФорум не для пользователей!»
Upd:
P.S. Я просто поддерживаю беседу.» © Народ.

xmpp:kildor@jabber.ru
User avatar
John Doe
Бюрократ
Posts: 13855
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 73 times
Been thanked: 428 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by John Doe »

Во-во. У меня те же аргументы. А браузер штука тяжёлая, особенно если загружается весь предыдущий сеанс...
Разве что использовать не полновесный браузер, а нечто вроде ie activex (glie.exe - была такая штука).
Или ещё проще - использовать .chm, как все.
Centaur wrote:Я, впрочем, не уверен, что хочу писать реализацию половины ещё одного консольного веб-браузера.
А это означает что вопрос становится ребром: готовы ли мы отказаться от отображения справки фаром.
Даже не знаю...
Хелп редко читают как роман. Чаще бывает нужно получить короткую контекстную справку, и тут очень важно чтобы она открывалась мгновенно (и закрывалась тоже). При использовании браузера мгновенность теряется, а для возврата в фар ещё и требуется Alt-Tab (или Ctrl-W или Ctrl-F4 или [...])
User avatar
NightRoman
Posts: 6184
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 32 times
Been thanked: 62 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by NightRoman »

Немного офф, но все-таки связанная с темой идея пришла тут. Для своих (а может и не только) плагинов я, пожалуй, придумал забавный сценарий. Свои хелпы можно писать на markdown, благо, я с ним дружу. Конвертеры markdown в html уже есть. А также есть и парсеры, используя которые, можно этот markdown и в hlf сконвертить (это потребует некоторой работы; все "фичи" hlf, пожалуй, не будут задействованы, ну и ладно).

Если мне не лень это будет сделать, то можно будет относительно комфортно писать хелп в маркдауне, а потом генерерить из него и hlf для Фара, и html для пользователя для "почитать в броузере". А к плагину прикладывать и то, и то.
User avatar
John Doe
Бюрократ
Posts: 13855
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 73 times
Been thanked: 428 times
Contact:

Re: Конвертер hlf->html (или "Как распечатать Help к FARy")

Post by John Doe »

В markdown я не нашёл никаких средств для "табличного" оформления, а скажем в справке фара это сплошь и рядом.
Post Reply

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