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

Хотите говорить о Far и не знаете, куда обратиться?
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 »

Latest post of the previous page:

Даже если "повесить в дистре", то кто будет синхронизировать с hlf?

Вопрос риторический, ответ я дал постом выше.
User avatar
Mr.Merak
Posts: 178
Joined: Sun 10 Jan, 2010 16:22
Been thanked: 1 time

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

Post by Mr.Merak »

John Doe wrote:Даже если "повесить в дистре", то кто будет синхронизировать с hlf?
А причем тут синхронизация? Справка он-лайн - никаких офлайн вариантов.
Проблема фары №1: нет печати "из коробки"
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 »

Никаких это странно. Тот же Chm никто не отменял.

Значит предлагаете hlf на свалку?
Обсуждалось http://forum.farmanager.com/viewtopic.php?f=3&t=3950
User avatar
Mr.Merak
Posts: 178
Joined: Sun 10 Jan, 2010 16:22
Been thanked: 1 time

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

Post by Mr.Merak »

На свалку ЭТО просится уже лет эдак... много :)

CHM - да, хороший современный вариант, но я не верю что его кто-то в дистр будет ложить
Проблема фары №1: нет печати "из коробки"
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 »

Mr.Merak wrote:но я не верю что его кто-то в дистр будет ложить
В дистре уже 3 штуки.
В чём вы видите проблему?
User avatar
DrKnS
Posts: 5903
Joined: Thu 04 Aug, 2005 06:44
Location: Kyiv
Has thanked: 11 times
Been thanked: 364 times

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

Post by DrKnS »

Mr.Merak wrote:Справка он-лайн - никаких офлайн вариантов.
Справка вообще рудимент, всё равно же никто не читает.
User avatar
Mr.Merak
Posts: 178
Joined: Sun 10 Jan, 2010 16:22
Been thanked: 1 time

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

Post by Mr.Merak »

2John Doe
проблема не положить - проблема юзать по F1 ))
Проблема фары №1: нет печати "из коробки"
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 »

По F1 вызывать можно и chm, если на то пошло.
User avatar
Skirda
Posts: 3475
Joined: Wed 16 Mar, 2005 11:01
Been thanked: 5 times

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

Post by Skirda »

John Doe wrote:Пути 2: 1) менять формат hlf
Это как бы намек на то, что от тебя будет полная спека формата + патч на новый движок-отображалку хелпа?
John Doe wrote:2) генерировать hlf из чего-то типа markdown
Это как бы намек на то, что ты готов перелопатить весь хелп и в дальнейшем макрдаунить результат?

Я как бы не против (да и ни кто не против), вот только что-то дальше проЖектов дело не прет (а значит можно сделать вывод, что текущее состояние всех устраивает).
Ну эт так, написал чисто поржать.

А если серьезно, то любой перевод хелпа в любой формат (с <pre> или без него, пофигу) - мартышкин труд. Если уж делать, то писать некую книгу, и не просто копипастом из хелпа, а нормальный такой учебник, чтобы и читался легко и своей легкостью усвоения материала привлекал бы...
We are the Borg. You will be assimilated.
So Say We All!
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 »

Skirda wrote:
John Doe wrote:Пути 2: 1) менять формат hlf
Это как бы намек на то, что от тебя будет полная спека формата + патч на новый движок-отображалку хелпа?
Это как бы намёк, что второй путь безболезненнее :-)

Skirda wrote:
John Doe wrote:2) генерировать hlf из чего-то типа markdown
Это как бы намек на то, что ты готов перелопатить весь хелп и в дальнейшем макрдаунить результат?
Перелопатить нужно только 1 раз.
И далее работать уже исключительно с 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 »

Для справки (ха, каламбур). Некоторое время назад я сделал переход на маркдаун в справке Фарнет и моих модулей для него (перевод hlf в md руками пришлось сделать, конечно; частично замены с регекспами помогли, но немного). Т.е. документацию и справку пишу теперь только в маркдауне, а из него генерю и hlf для Фара, и html для посмотреть в броузере. Не пожалел. Подход очень удобный оказался и прижился.

Минусы в таком подходе есть. Но плюсов гораздо больше оказалось.
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 »

Skirda wrote:Я как бы не против (да и ни кто не против), вот только что-то дальше проЖектов дело не прет
В корне не согласен.
1. По результату предыдущего такого обсуждения была создана функционирующая система трансляции markdown в html и hlf.
2. Немного выше можно заметить что Mr.Merak высказывал готовность участвовать, если его труд войдёт в дистрибутив.

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

Отмашка реально нужна, т.к. я не уверен что добавить net/powershell в систему сборки фара будет просто.
professor_k
Posts: 7
Joined: Mon 25 Mar, 2013 19:47

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

Post by professor_k »

Есть довольно много wiki-движков, которые поддерживают markdown. Таким образом, я бы представлял себе общий воркфлов следующим образом:
1. Существующая справка конвертируется в markdown, очевидно — вручную. Можно — при помощи того же wiki, удобнее, видно по ходу результат.
2. В момент завершения конвертации, wiki становится центральным репозиторием справки. Все последующие изменения — только туда. Разграничение прав/модерация/и т. д. — решаются средствами движка.
3. При билде тянется последняя (проверенная) версия, конвертится из md в hlf и упаковывается в сборку.

Можно для истории снепшот 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 »

Работа по переводу справки по силам 1 человеку.
Сделать это за 1 раз проще, чем координировать действия 10 человек в вике.

И как я понимаю (по отсутствию ответа на прошлый пост) - запуску PS/.net на сервере проблематичен, а другого конвертера у нас нет.
User avatar
HaRT
Moderator
Posts: 9774
Joined: Tue 30 Aug, 2005 17:21
Location: Санкт-Петербург
Has thanked: 128 times
Been thanked: 267 times

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

Post by HaRT »

John Doe wrote:Сделать это за 1 раз проще, чем координировать действия 10 человек в вике.
Вики подключается уже после того, как произошла начальная конвертация. Да и в Вики будет нужна не столько координация, сколько модерация.
Фар есть инструмент, а не нянька. © 2009 DrKnS
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 »

Пардон, я что-то пропустил.
Накой нам вики вообще? Уже ведь пробовали?
Post Reply

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