HelpDown — конвертер md -> htm -> hlf

Хотите говорить о Far и не знаете, куда обратиться?
User avatar
HaRT
Moderator
Posts: 8476
Joined: Tue 30 Aug, 2005 17:21
Location: Санкт-Петербург
Has thanked: 74 times
Been thanked: 136 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by HaRT » Mon 19 Mar, 2012 18:54

Latest post of the previous page:

Ответьте профану, а в чём принципиальная сложность-то?
Вот, даже консольные браузеры неплохо вроде поддерживают таблицы…
Фар есть инструмент, а не нянька. © 2009 DrKnS

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Mon 19 Mar, 2012 19:00

HaRT wrote:Ответьте профану, а в чём принципиальная сложность-то?
Вот, даже консольные браузеры неплохо вроде поддерживают таблицы…
Они динамически форматируют текст под текущее окно. А наш случай - другой. Нам надо сгенерить фиксированный HLF файл. Годный для любого окна (то есть минимально возможного, около 70). Фар не будет там таблицы форматировать динамически во время показа.

User avatar
HaRT
Moderator
Posts: 8476
Joined: Tue 30 Aug, 2005 17:21
Location: Санкт-Петербург
Has thanked: 74 times
Been thanked: 136 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by HaRT » Mon 19 Mar, 2012 19:12

Ага, ясно. Но тогда откуда ограничение в 2 колонки?
Нам надо отформатировать под фиксированную ширину 70, притом минимизировать надо общую высоту таблицы, перераспределяя слова (а в плохом случае — отдельные символы) между строками.
В ужасном случае на 1 колонку надо 2 знакоместа внутри и 1 — на разделитель справа. Всяко больше 2 колонок поместится.
Фар есть инструмент, а не нянька. © 2009 DrKnS

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Mon 19 Mar, 2012 19:18

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

А о чем вообще писать в хелпе с таблицами в 3+ колонок? Просто юз-кейс какой-нибудь хотелось бы иметь. Не приходит в голову пока.

User avatar
HaRT
Moderator
Posts: 8476
Joined: Tue 30 Aug, 2005 17:21
Location: Санкт-Петербург
Has thanked: 74 times
Been thanked: 136 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by HaRT » Mon 19 Mar, 2012 19:32

NightRoman wrote:А о чем вообще писать в хелпе с таблицами в 3+ колонок? Просто юз-кейс какой-нибудь хотелось бы иметь. Не приходит в голову пока.
Что-нибудь типа такого.

Или, скажем, описание, как осуществить какие-то действия с помощью клавиатуры и с помощью мыши.
Фар есть инструмент, а не нянька. © 2009 DrKnS

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Mon 19 Mar, 2012 20:17

А. Хорошо. Первый пример подпадает под заворачивать только последнюю колонку. Второй под 2-ю и 3-ю (жестко). ОК, буду думать дальше. Таблицы пригодятся, конечно. Кстати, как они в маркдауне реализованы - это не очень это удобно для длинных текстов. Но инлайн HTML тоже возможен на худой конец.

User avatar
John Doe
Бюрократ
Posts: 11858
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 26 times
Been thanked: 131 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by John Doe » Tue 20 Mar, 2012 08:01

HaRT wrote:Что-нибудь типа такого.
Или, скажем, описание, как осуществить какие-то действия с помощью клавиатуры и с помощью мыши.
Придумать можно разного, но на практике почему-то больше 2х колонок никто не использует. Я про реальные *.hlf

Зато в правой колонке бывает выравнивание по правому краю.
Не знаю надо ли это поддерживать в md, но обратите внимание.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Tue 20 Mar, 2012 11:57

Выравнивание-то не проблема, и у маркдауна в таблицах этот синтакс есть. В общем, подумаю еще, 2 колонки поддерживать или 2+ (и вообще таблицы, ха-ха).

Сами таблицы в маркдауне весьма примитивные, оказывается (или я не знаю продвинутый синтаксис). Взамен HTML таблицы иной раз имеет смысл пользовать для длинных текстов, иначе придется в редакторе длинные строки иметь, что в Фаре не очень удобно.

User avatar
John Doe
Бюрократ
Posts: 11858
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 26 times
Been thanked: 131 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by John Doe » Tue 20 Mar, 2012 12:37

Большинство таких простых таблиц (как в справке фара) семантически представляют собой definition lists.
Именно семантически, но ведь и визуально definition list можно изобразить таблицей (с помощью стилей).

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Tue 20 Mar, 2012 12:51

Думал об этом. Мысль стоящая. Причем, списки определений удобно набирать в маркдауне, не то что таблицы. Подумаю, но это уже получается конвенция, да и вид в броузере (без стилей) будет отличаться существенно от хелп вьюера. Такие отличия и конвенции надо бы минимизировать (но не обязательно сводить к 0, конечно).

User avatar
John Doe
Бюрократ
Posts: 11858
Joined: Wed 27 Apr, 2005 20:42
Has thanked: 26 times
Been thanked: 131 times

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by John Doe » Tue 20 Mar, 2012 13:00

А в md нельзя аккуратненько класс указать?
Чтобы всё было "по-честному", без конвенций.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Tue 20 Mar, 2012 13:15

Не знаю, наверное, можно (так или сяк). Но это уже рокет-сайенс получается. Но все же учту и эту возможность. В общем, все равно еще надо думать, путей сильно больше одного.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Tue 20 Mar, 2012 18:32

https://github.com/nightroman/FarHelpDown/downloads
v0.0.22.7 - Nested lists up to level 3 support all features
(речь о схеме markdown.hrc, хелп-конвертер не поддерживает вложенные списки)

В итоге схема markdown.hrc теперь делает все, что от нее было задумано получить, со следующими оговорками:

* Inline HTML should be valid XML.
* Opened spans are always colored.
* Blockquote contents is not parsed.
* List levels 4: only items are parsed.
* List levels 5+: all is colored as code.
* List levels: 4, 8, 12 spaces or 1, 2, 3 tabs.

Дальше будет в основном оптимизация и вылавливание ошибок, можно начинать жаловаться на них.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: FarHelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Thu 22 Mar, 2012 07:16

https://github.com/nightroman/FarHelpDown/downloads
v0.0.22.8 - markdown.hrc, nested lists

* Fixed exotic cases of stoppers in nested lists.
* Used different regions for link text and marks.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: HelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Sun 06 Jan, 2013 17:52

Проект теперь называется HelpDown и включен в исходники FarNet. Сборки выкладываются вместе с остальными сборками FarNet тут:
http://code.google.com/p/farnet/downloads/list

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: HelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Sat 15 Mar, 2014 06:06

Следующий этап развития проекта.

Far 3.0.3831 поддерживает горизонтальные разделительные линии в файлах помощи (Mantis#0002619). Поддержка этого добавлена и в HtmlToFarHelp. Удалена лишняя теперь опция CenterRule.

Приложения распространяются не через Google Code downloads, а как два NuGet пакета:

https://www.nuget.org/packages/MarkdownToHtml
https://www.nuget.org/packages/HtmlToFarHelp

Разделение сделано, так как MarkdownToHtml имеет применение сам по себе, не обязательно в связке с HtmlToFarHelp для генерации файлов помощи.

User avatar
NightRoman
Posts: 5904
Joined: Fri 18 Aug, 2006 13:52
Location: Cambridge, UK
Has thanked: 10 times
Been thanked: 11 times
Contact:

Re: HelpDown — конвертер md -> htm -> hlf

Post by NightRoman » Thu 20 Mar, 2014 06:14

HtmlToFarHelp Release Notes

v1.0.2

Added missing HLF option PluginContents. Without it help files are not shown in the plugin help list ([F1] [ShiftF2]).

Post Reply

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