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

Хотите говорить о Far и не знаете, куда обратиться?
User avatar
John Doe
Бюрократ
Posts: 13851
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:

NightRoman wrote:лишние хлопоты всем, включая плагинописателей, которым придется учить этот формат...
Учить формат это громко сказано. 5 тегов что ли?
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 »

John Doe wrote:Учить формат это громко сказано. Допустимых тегов будет не много.
Не, ну имеется в виду для тех кто ваще не знает, что такое HTML (такие есть вообще среди плугописателей?).

А так да, все верно, с HTML проще некуда. Документация по формату хелпа была бы тривиальная - сам HTML описывать не надо, а надо лишь описать основные правила разметки, трактуемые Фаром особым образом, и набор поддерживаемых тегов.
User avatar
HaRT
Moderator
Posts: 10855
Joined: Tue 30 Aug, 2005 17:21
Has thanked: 221 times
Been thanked: 358 times

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

Post by HaRT »

Современный HTML хорош только для конечного представления контента. Для исходного представления данных он подходит только при жесточайшем вынесении какого бы то ни было форматирования в CSS.
Фар есть инструмент, а не нянька. © 2009 DrKnS
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 »

HaRT
Это верно. Но с учетом того, что тот хтмл, что предназначен для понимания Фаром будет весьма примитивен, то не надо усложнять задачи. А задачи 2: 1) чтоб Фар понимал и показывал; 2) чтоб открыть в броузере целиком для чтения, поиска, печати, и чтоб там работали ссылки. То, что в броузере текст будет выглядеть примитивно - никого особо не будет волновать, имхо. Да полно такой примитивной HTML документации с плоским текстом по многим продуктам, и ничего.
User avatar
Alexey Samlyukov
Posts: 1765
Joined: Tue 15 Mar, 2005 17:28
Been thanked: 7 times
Contact:

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

Post by Alexey Samlyukov »

хелпы никто не читает. лучше б плагины интересные сочиняли.
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 »

HaRT wrote:Современный HTML хорош только для конечного представления контента. Для исходного представления данных он подходит только при жесточайшем вынесении какого бы то ни было форматирования в CSS.
CSS встроить в HTML-файл.
UPD. Хотя нет, для единообразия с помощью к плагинам, наверное, лучше отдельным файлом.
User avatar
John Doe
Бюрократ
Posts: 13851
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 »

Форматирование в css однозначно.
А из тегов вообще мизер что нужно, сами посудите:
- заголовки и якоря
- ссылки
- подсветка
- списки (или таблицы)

А незнакомые теги фар может просто игнорировать (но можно использовать для улучшения форматирования в полноценном браузере).
Max Rusov
Posts: 3651
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 2 times
Been thanked: 19 times

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

Post by Max Rusov »

...А можно оставить старые занавески. Кроме Help к Far есть еще Help'ы к плагинам... Право, написать конвертер из Hlf в любые другие форматы гораздо проще, чем затевать бодягу по переписыванию всех хелпов.
User avatar
John Doe
Бюрократ
Posts: 13851
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 »

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

А хелпы не переписать надо, а по сути лишь переформатировать.

P.S.
Но конечно никто не отменяет существование неподдерживаемых плагинов.
Для них можно оставить текущий движок, по возможности выделив его в отдельное приложение.
Max Rusov
Posts: 3651
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 2 times
Been thanked: 19 times

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

Post by Max Rusov »

Да и не костыльный можно. Wiki же как-то форматируется, хотя там тоже неоднозначностей много.

При необходимости можно дополнить hlf несколькими фичами (типа таблицы), не ломая совместимости.
User avatar
John Doe
Бюрократ
Posts: 13851
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 »

Max Rusov wrote:При необходимости можно дополнить hlf несколькими фичами (типа таблицы), не ломая совместимости.
Это тоже можно.
Но тогда неясно кто напишет нормальный конвертер.

P.S.
Но работа по преобразованию старых файлов с учётом новых фич всё равно на человеке.
И всё рано нужен новый (или обновлённый) движок.
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 »

Вариант с HTML в качестве исходного и конечного же формата плох тем, что даёт автору слишком много свободы. Будет затруднительно поддерживать единообразие оформления.

С XML-based (и markdown-like) вариантами проблема другого характера. Представим, что пользователь поставил плагин, с которым идёт xml help. В какой момент должны сгенерироваться html-странички для просмотра браузером, и чем достигается, что они будут перегенерированы при обновлении FAR’а? (Получается, что генерировать нужно либо при установке/апгрейде FAR’а и плагинов, либо при вызове справки, причём сразу все страницы, чтобы ссылки работали. Делать кастомный «протокол» типа msit-store нельзя, потому что это ограничит выбор браузера. Висеть http-сервером на 31137 порту — работать будет, но изврат же.)

Встроенный движок — решает проблему работы через telnet/ssh, но не решает проблему модальности. Впрочем, работая удалённо, я бы, может, предпочёл переключиться в браузер и сказать «farmanager.com/plugins/netbox». Ну, то есть, при условии наличия практики публикации хелпов на сайте. (Возможно, требует работающего plugring’а.)
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 »

Centaur wrote:Вариант с 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 »

Max Rusov wrote:...А можно оставить старые занавески. Кроме Help к Far есть еще Help'ы к плагинам... Право, написать конвертер из Hlf в любые другие форматы гораздо проще, чем затевать бодягу по переписыванию всех хелпов.
Я тоже во многом консерватор, и такая позиция очень разумна. Но переписывать хелпы не надо, надо конвертить. Речь о том, что приличный конвертер hlf -> html был бы очень полезен уже сейчас. И это может пригодиться для полного перехода на HTML хелп. Последнее может никогда и не случится, и останутся старые занавески. А приличный конвертер в HTML все равно будет востребован всегда (со старыми занавесками - для их конвертации в HTML, с новыми занавесками (если они HTML) для конвертации старых hlf в новый формат, а не переписывания их).
Max Rusov
Posts: 3651
Joined: Wed 23 Nov, 2005 11:11
Location: Москва-Питер
Has thanked: 2 times
Been thanked: 19 times

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

Post by Max Rusov »

Мне не нравится только идея сделать html нативным форматом для help'а. Все остальное, меня по большому счету, мало трогает...
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 »

Max Rusov wrote:Мне не нравится только идея сделать html нативным форматом для help'а. Все остальное, меня по большому счету, мало трогает...
Просто интересно, почему не нравится? Потому что чтоб не менять/ломать (резон есть) или потому что hlf больше нравится (тоже возможно)?
Post Reply

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