Онлайн версия документации

Разработка Far.
Post Reply
User avatar
techie
Posts: 761
Joined: Mon 03 Oct, 2005 22:42
Has thanked: 28 times
Been thanked: 2 times

Онлайн версия документации

Post by techie » Tue 21 Oct, 2014 06:29

HaRT wrote:
techie wrote:Нужна веб версия документации. Оффлайн - это хорошо, но бравзер с гуглом уже удобнее.
Наслаждайтесь. Дальнейшие претензии — к Гуглу. :evil:
Есть план:
  • Найти место где это будет лежать - viewtopic.php?f=16&t=8527
  • Переместить /trunk/unicode_far/*.hlf.m4 в /trunk/unicode_far/help/*.hlf
  • Написать парсер для .hlf формата на Python (чтобы получить полную дата модель для трансформации)
  • Написать конвертер из .hlf модели в гипертекст (и в формат Far заодно)
  • Обратить внимание на Sphinx - посмотреть исходную дата модель после ReStructureText - doctree (можно ли перегнать в неё)
  • Добиться рендеринга текста хоть в каком-нибудь HTML формате
  • Забахать темплейт с fixed-size шрифтами, чтобы воспроизвести окно F1
На текущий момент не хватает знаний по m4. Для чего конкретно он здесь нужен и какие правила он отрабатывает? Чем лучше это описано, тем быстрее можно приступить к хакингу.

Эта ссылка на формат *.hlf актуальная и полная?

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

Онлайн версия документации

Post by John Doe » Tue 21 Oct, 2014 06:50

>Добиться рендеринга текста хоть в каком-нибудь HTML формате
"Хоть в каком-то" можно хоть сейчас.

>Написать конвертер из .hlf модели в гипертекст (и в формат Far заодно)
Жаль некому.
Обсуждение тут: viewtopic.php?f=3&t=3950

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

Онлайн версия документации

Post by HaRT » Tue 21 Oct, 2014 11:35

techie wrote: на Python
techie wrote: на Sphinx
techie wrote: doctree
Инструменты надо выбирать под требования (requirements), а требования-то и не формализованы.
Кроме того, обязательно надо прежде изучить имеющийся опыт: хоть применение того же Markdown — пользуйтесь поиском по форуму.
Фар есть инструмент, а не нянька. © 2009 DrKnS

User avatar
techie
Posts: 761
Joined: Mon 03 Oct, 2005 22:42
Has thanked: 28 times
Been thanked: 2 times

Онлайн версия документации

Post by techie » Tue 04 Nov, 2014 20:06

Требования к хелпу Far:
- удобно линковать страницы помощи без HTML тэгов
- держать хелп в памяти в компактном формате
- удобно работать с помощью без мыши

Требования к онлайн формату:
- быть онлайн

Насчёт изучения опыта - надо суммировать. Появляются новые технологии, которые *возможно* решают предыдущие проблемы, но о проблемах никто не помнит, а объём информации на форуме уже неосилить.

User avatar
techie
Posts: 761
Joined: Mon 03 Oct, 2005 22:42
Has thanked: 28 times
Been thanked: 2 times

Онлайн версия документации

Post by techie » Tue 04 Nov, 2014 20:15

Отфильтрованный список проблем:

viewtopic.php?p=90462#p90462 (только третий спойлер актуален)

Post Reply

Return to “Development”