Gerando arquivos de ajuda para o vim

8

Atualmente, escrevo minha documentação diretamente como arquivos de ajuda do vim. Às vezes, preciso gerar outros formatos (por exemplo, PDF). Meu fluxo de trabalho é copiar o conteúdo dos arquivos de ajuda e transformá-los em algo que eu preciso. Este é um trabalho bastante tedioso, pois eu principalmente tenho que adicionar marcações adicionais.

Gosto da abordagem do Markdown, que pode (por exemplo, usando Pandoc) ser transformada em uma variedade de formatos de saída. Infelizmente não arquivos de ajuda do vim. Estou procurando um conversor que use um formato de entrada padrão (por exemplo, XML, Markdown, texto reestruturado, texto sem formatação ...) e produz um arquivo de ajuda do vim. Ou existe algum outro meio de gerar automaticamente arquivos de ajuda do vim sem precisar escrever esse conversor?

vim Marco
fonte
Você provavelmente poderia reunir uma folha de estilo XSLT em algumas horas.
Ignacio Vazquez-Abrams

Respostas:

11

Desculpe por ressuscitar um segmento muito antigo. Eu sou o autor do mkd2vimdocscript por trás do primeiro link sugerido por lornix anteriormente. Recentemente, reescrevi mkd2vimdocdo zero como html2vimdoc . Ele ainda suporta Markdown como formato de entrada; ele converterá o Markdown em HTML e, em seguida, o converterá em um arquivo de ajuda do Vim. O foco durante a reescrita foi no suporte a uma maior variedade de documentos de entrada.

O novo script está sendo usado por mim e por vários outros autores de plug-ins, portanto, ele definitivamente se destina ao uso geral. Se você quiser tentar outra vez, gostaria de saber se agora funciona melhor para os documentos em que você deseja usá-lo. Se ainda assim não funcionar, fique à vontade para criar um problema no GitHub.

xolox
fonte
3
Bem-vindo ao SuperUser! A resposta a perguntas antigas é apreciada aqui, algumas pessoas ainda podem estar procurando respostas e é bom melhorar as antigas.
gronostaj
4

Encontrei esse script, que o autor criou para converter a marcação para documentação do vim. Parece muito perto do que você está procurando.

Enquanto esse script do vim.org ( github repo ) converte a marcação para o que parece quase tudo, mas o vimdoc. (suspiro) Tão perto ... talvez uma ligeira modificação?

lornix
fonte
O primeiro script não pode ser usado para uso geral. Pode funcionar para o estilo de marcação dos autores, mas não converteu um único dos meus arquivos de marcação (válidos) corretamente. A segunda opção é o pandoc, um conversor muito capaz de que gosto muito. Infelizmente, ele não suporta vimhelp. Pedi na lista de discussão para adicionar suporte, mas a resposta foi que o vimhelp não é um formato de saída de uso geral, mas um formato especializado destinado à documentação do vim, em contraste com os outros formatos suportados. Enfim, muito obrigado pela dica.
Marco
Estou curioso para saber o que pode levar à criação de um conversor de markdown para vimdoc, pois a maior parte do vimdoc é de formatação e de caracteres especiais, enquanto a mágica é feita pelo comando helptags e pelo vim ajuda o próprio visualizador. Claro, eu poderia colocar o pé na boca (de novo!) ... talvez isso dependa da complexidade da sua remarcação inicial.
Lornix
Uma solução inteligente sugerida na lista de discussão foi criar o vimhelp, que também é uma remarcação válida. A desvantagem é que a redução é um pouco confusa com a sintaxe do vim e os arquivos do vimhelp não obedecem às convenções de formatação. Mas, além disso, é utilizável.
Marco