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

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

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

Post by NightRoman » Sun 12 Feb, 2012 19:46

Latest post of the previous page:

John Doe wrote:В markdown я не нашёл никаких средств для "табличного" оформления, а скажем в справке фара это сплошь и рядом.
markdown поддерживает встроенный html (просто буквально вставленные куски html), так что в нем оформить можно многое в принципе.

User avatar
Michael Lukashov
Posts: 484
Joined: Mon 23 Jan, 2006 09:38
Been thanked: 9 times
Contact:

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

Post by Michael Lukashov » Sun 12 Feb, 2012 19:49

+1 за markdown. https://github.com/mojombo/github-flavored-markdown демонстрирует пример использования табличного оформления.

Kildor
Posts: 1515
Joined: Wed 16 Mar, 2005 06:26
Location: Новосибирск
Contact:

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

Post by Kildor » Mon 13 Feb, 2012 02:12


Две таблицы.
Вообще, из того что я успел понять — маркдаун это такой конструктор лего, и каждый добавляет туда свои фишки, в зависимости от своего желания и умения.
Ты мне не выкай!
«ФарФорум не для пользователей!»
Upd:
P.S. Я просто поддерживаю беседу.» © Народ.

xmpp:kildor@jabber.ru

User avatar
Centaur
Posts: 1083
Joined: Tue 05 Apr, 2005 20:09
Location: Novosibirsk, Russia
Been thanked: 1 time

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

Post by Centaur » Mon 13 Feb, 2012 03:34

Markdown с кусочками HTML — это уже довольно сложный (для парсинга) язык разметки, обладающий всеми недостатками HTML и добавляющий свои. (В частности, из readme к гитхабовскому диалекту (кстати, наличие диалектов уже само по себе серьёзный недостаток) видно, что в исходной версии подчёркивания внутри слов интерпретировались как выделение курсивом части слова. Решили же проблему костылём — запретили выделять курсивом часть слова, кроме как включением HTML.)

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

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

Post by NightRoman » Mon 13 Feb, 2012 05:03

Другой вариант предыдущей идеи об альтернативных методах написания хелпа + чтобы и html вариант был. Можно подумать о конвертере незамысловатого html (с определенной структурой, конечно) в hlf.

Тогда любителям html можно писать просто в html, а потом конвертить в hlf. Для любителей же markdown (или чего-то еще, что позволяет получить html) ничего особо не меняется, только схема ваяния такая - markdown (исходник, там собственно сочиняется и пишется хелп) -> html (одним из существующих конвертеров) -> hlf (надо подумать над таким конвертером).

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

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

Post by NightRoman » Mon 13 Feb, 2012 05:20

Centaur wrote:Markdown с кусочками HTML — это уже довольно сложный (для парсинга) язык разметки, обладающий всеми недостатками HTML и добавляющий свои. ...
Это факт. Только если все это для Фара, то кусочки html будут простые и строго оговоренные (не так уж много в консоли возможностей изобразить это адекватно). Это упрощает ситуацию.

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

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

Post by John Doe » Mon 13 Feb, 2012 11:36

Kildor wrote:
Две таблицы.
А это сработает? В доке такого не видел.

Kildor
Posts: 1515
Joined: Wed 16 Mar, 2005 06:26
Location: Новосибирск
Contact:

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

Post by Kildor » Mon 13 Feb, 2012 15:14

> А это сработает? В доке такого не видел.
В php-маркдауне — работает.
Ты мне не выкай!
«ФарФорум не для пользователей!»
Upd:
P.S. Я просто поддерживаю беседу.» © Народ.

xmpp:kildor@jabber.ru

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

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

Post by John Doe » Tue 14 Feb, 2012 18:16

Кстати да, работают таблички.
Вот тут есть песочница: http://www.toptensoftware.com/markdowndeep/dingus

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

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

Post by NightRoman » Tue 14 Feb, 2012 18:22

Просто для справки, может кому пригодится, MarkdownDeep (там, где эта песочница) - это то, что я в итоге выбрал для работы с маркдауном. Пробовал несколько .NET библиотек, эта лучшая пока (меня полностью устраивает, скажем так). Опенсорс. Есть JavaScript Edition (не пробовал).

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

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

Post by NightRoman » Tue 14 Feb, 2012 18:39

В маркдауне мне не нравится только одно :) Простенькую схему для колорера под него я написал без проблем, а вот для хорошей - то ли моих знаний колдовства со схемами не хватает, то ли колорер имеет-таки принципиальные ограничения. Например, не знаю, как блоки в точности описать, они суть на индентациях устроены, а в колорере нет особо такого понятия (а не мешало бы...).

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

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

Post by HaRT » Tue 14 Feb, 2012 18:51

Фар есть инструмент, а не нянька. © 2009 DrKnS

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

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

Post by NightRoman » Sun 19 Feb, 2012 09:25

Technology preview :). Написал простенький конвертер html -> hlf (для меня уже годится, буду пользовать, но когда дойдут руки до публичной версии - не знаю). В результате схема markdown -> html -> hlf показала себя вполне рабочей. Сразу видны и плюсы (немало), и минусы (немного, но есть) такого подхода (в детали не буду вдаваться). Само собой, минусы можно со временем сократить, плюсы умножить.

В аттаче исходный хелп на markdown (пишем руками) + html & hlf (получены конвертацией). Это хелп для PowerShellFar, как раз пример хелпа, где html версия может быть полезна, ибо в этом хелпе не столько про Far UI речь, сколько про фичи и особенности PowerShell в PowerShellFar.

UPD: удалены устаревшие примеры.

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


Post Reply

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