Генерация файлов справки для vim

8

В настоящее время я пишу свою документацию непосредственно как файлы справки vim. Иногда мне нужно создать другие форматы (например, PDF). Мой рабочий процесс состоит в том, чтобы скопировать содержимое файлов справки и преобразовать их в то, что мне нужно. Это довольно утомительная работа, так как мне в основном приходится добавлять дополнительную разметку.

Мне нравится подход Markdown, который можно (например, с помощью Pandoc) преобразовать во множество выходных форматов. К сожалению, не справочные файлы vim. Я ищу конвертер, который принимает стандартный формат ввода (например, XML, Markdown, reStructed Text, обычный текст, ...) и выводит файл справки vim. Или есть другие способы автоматического создания файлов справки vim без написания такого конвертера?

Marco
источник
Вероятно, вы можете составить таблицу стилей XSLT за несколько часов.
Игнасио Васкес-Абрамс

Ответы:

11

Извините за воскрешение очень старой темы. Я автор mkd2vimdocсценария за первой ссылкой, предложенной ранее lornix . Я недавно переписал mkd2vimdocс нуля как html2vimdoc . Он по-прежнему поддерживает Markdown в качестве входного формата; он преобразует Markdown в HTML, а затем преобразует этот HTML в файл справки Vim. При переписывании основное внимание уделялось поддержке более широкого диапазона входных документов.

Новый скрипт используется мной и несколькими другими авторами плагинов, поэтому он определенно предназначен для общего использования. Если вы хотите попробовать еще раз, я бы хотел узнать, работает ли он лучше для документов, на которых вы хотите его использовать. Если это все еще не работает, не стесняйтесь создавать проблемы на GitHub.

xolox
источник
3
Добро пожаловать в SuperUser! Ответы на старые вопросы приветствуются здесь, некоторые люди все еще могут искать ответы на эти вопросы, и это хорошо, чтобы улучшить старые.
Гроностай
4

Я нашел этот скрипт, который автор создал для конвертации уценки в документацию vim. Звучит очень близко к тому, что вы ищете.

В то время как этот скрипт vim.org ( github repo ) конвертирует уценку в то, что выглядит почти как все, НО vimdoc. (вздыхает) Так близко ... может быть, небольшая модификация?

lornix
источник
Первый скрипт непригоден для общего пользования. Это может работать для стиля разметки авторов, но не правильно конвертирует ни один из моих (допустимых) файлов разметки. Второй вариант - это pandoc, очень мощный конвертер, который мне очень нравится. К сожалению, он не поддерживает vimhelp. В списке рассылки я попросил добавить поддержку для него, но ответ был таков: vimhelp - это не формат вывода общего назначения, а специализированный формат, предназначенный для документации vim, в отличие от других поддерживаемых форматов. В любом случае, большое спасибо за совет.
Марко
Мне любопытно, что это может повлечь за собой создание конвертера из markdown в vimdoc, так как большая часть vimdoc - это форматирование и специальные символы маркеров, а магия выполняется командой helptags и самой программой просмотра справки vim. Конечно, я МОГУ БЫТЬ засунуть ногу себе в рот (опять!) ... возможно, это зависит от сложности вашей первоначальной уценки.
Lornix
Умный обходной путь, предложенный в списке рассылки, заключался в создании vimhelp, который также является действительной уценкой. Недостатком является то, что разметка немного загромождена синтаксисом vim, а файлы vimhelp не подчиняются соглашениям о форматировании. Но кроме этого он пригоден для использования.
Марко