Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Хотите говорить о Far и не знаете, куда обратиться?
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

Latest post of the previous page:

Мне кажется, что все это не туда должно идти. HLF - это историческое наследие, неплохой формат, но мертвый во многих смыслах. Вот от него надо уходить в сторону какого-то иного формата и существующих инструментов для этого формата. Поддержку старого оставлять, вероятно, но новые хелпы писать на чем-то более современном. Ситуация похожая с макроязыком. Весьма прогрессивно было заменить доморошенный трудноразвиваемый язык на продвинутый, стандартный и с кучей фич.

А работать в сторону конвертеров в неразвивающийся HLF не слишком хорошо. В том же моем конвертере HelpDown, например, не все фичи HLF можно описать в md. И некоторые фичи md не имеют смысла в HLF. И еще много нюансов.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

NightRoman
На позапрошлой странице Skirda продемонстрировал готовность принять патч на отображалку хелка.
А без этого... Только конвертация.
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

John Doe wrote:NightRoman
На позапрошлой странице Skirda продемонстрировал готовность принять патч на отображалку хелка.
А без этого... Только конвертация.
Понятно. Но конвертация - тупиковый путь без большого будущего, ведь сам HLF никто наверняка не будет развивать. А вот если бы Фар сам мог рендерить что-то википодобное по набору файлов - это было бы интересно и прогрессивно. Возможно даже полезно не только для внутреннего хелпа Фара и плагинов.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

Конвертация это не тупиковый путь, а промежуточный этап.
Никто не мешает научить фар в последствии отображать md напрямую.
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

Ну то есть я бы думал в этом направлении, но не в сторону конвертеров. Если пока нет ресурсов и желающих, то ничего не делать. Не исключено, что они появятся. Или лучшие идеи появятся.
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

John Doe wrote:Конвертация это не тупиковый путь, а промежуточный этап.
Никто не мешает научить фар отображать md в последствии
А md не идеал, по-моему. Это кандидат, да. Но если думать о поддерживаемом в будущем формате, то надо куда большую работу по оценке кандидатов и выбору провести.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

NightRoman wrote:Если пока нет ресурсов и желающих, то ничего не делать. Не исключено, что они появятся. Или лучшие идеи появятся.
Вот уж врядли.
NightRoman wrote:Но если думать о поддерживаемом в будущем формате, то надо куда большую работу по оценке кандидатов и выбору провести.
Может поделитесь хотя бы начальными соображениями?
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

John Doe wrote:
NightRoman wrote:Если пока нет ресурсов и желающих, то ничего не делать. Не исключено, что они появятся. Или лучшие идеи появятся.
Вот уж врядли.
Я уже проводил аналогию с макроязыком. И желающие, и ресурсы нашлись.
поделитесь хотя бы начальными соображениями?
Вики формат, наверное, надо учесть тоже для начала. Но я его и инструменты для него детально не изучал, ничего более сказать не могу.
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

В идеале должна быть википодобная система, которая была бы полезна и не только для Фара. То есть может легко писаться в файлах и рендериться на лету в Фаре, но в любой момент может быть сконвертирована в набор HTML, PDF, CHM и т.п. Если планировать ее таким образом, то стимулов создать такую систему *разработки и показа* документации может быть больше. И пользы от нее тоже.
Last edited by NightRoman on Tue 16 Apr, 2013 12:34, edited 1 time in total.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

NightRoman wrote:Я уже проводил аналогию с макроязыком. И желающие, и ресурсы нашлись.
Плохая аналогия.
В макроязыке мы получили огромный прирост функциональности. И база (LuaFAR) к тому времени уже существовала несколько лет.
А что мы получим в хелпе?

Имхо нечего там особо развивать.
Формат, пригодный для публикации на сайте - это уже большое достижение. Он по определению (полу)автоматически пригоден для chm и pdf.
NightRoman wrote:
поделитесь хотя бы начальными соображениями?
Вики формат, наверное, надо учесть тоже для начала.
Зачем он сдался?
Интересуют реальные практические соображения.
Давайте начнём с того, чего вам не хватило в md?
Т.е. что искать в альтернативах?
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

Я все сказал, думаю. Спорить мне вроде не о чем, и в данный момент я немного занят.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

У нас же не видеочат, ответите когда пожелаете.
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

John Doe wrote:Давайте начнём с того, чего вам не хватило в md? Т.е. что искать в альтернативах?
Это хороший вопрос.
-- Наличие спецификации формата. В мд есть только неформальное описание от автора. В простых случаях хватает, в сложных разные тулзы трактуют всяк по своему, ибо строгости нет.
-- Наличие инструментов. Каких? Разных. Не буду развивать. Для мд более-менее интрументы есть, тут дела неплохи.
-- Документация в нескольких файлах. Мд не для этого, изначально он заточен под один документ.
-- Перекрестные ссылки. Мд тоже не очень хорош для этого. Диалекты мд это реализуют, но это неродные прикрутки.
-- Таблицы в мд - просто смех. Лучше уж встроенный ХТМЛ пользовать. Но эта фича (встроенный ХТМЛ) в мд, кстати, не от хорошей жизни, а от плохой.

Ну это так, что первое в голову пришло.
User avatar
John Doe
Бюрократ
Posts: 13233
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 45 times
Been thanked: 335 times

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by John Doe »

Неоднозначности трактовки, вытекающие из отсутствия формальной спецификации это не очень хорошо, но для наших целей несущественно.
По настоящему этого можно избежать только в основанных на xml форматах, а оно нам надо?
Сложные таблицы особо не нужны. 2 столбца без разделителя - с головой.
А вот документация в нескольких файлах, и перекрёстные ссылки - это очень важно (но вы пишите, что диалекты умеют?)
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

John Doe wrote:Сложные таблицы особо не нужны. 2 столбца без разделителя - с головой.
Там даже это проблема, если в колонках не одно-два слова, а текст, абзац, а то и несколько (даже вообще не уверен, что это возможно).
User avatar
NightRoman
Posts: 6053
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 20 times
Been thanked: 50 times
Contact:

Re: Справка Far в легко читаемом формате (PDF, HTML и т.п.)

Post by NightRoman »

Ни XML, ни HTML, как основа документации я бы не выбирал. МД - неплохой кандидат. Но другие форматы я бы тоже изучил прежде чем закладываться на мд надолго. Надо исследовать эту область и выбирать предположительно оптимальное что-то. Но идеального ничего не будет, надо понимать сразу. Поэтому будет очень полезно подумать вначале, найти и взвесить плюсы и минусы, а уж потом вкладываться.
Post Reply

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