Generando archivos de ayuda para vim

8

Actualmente escribo mi documentación directamente como archivos de ayuda vim. A veces necesito generar otros formatos (por ejemplo, PDF). Mi flujo de trabajo es copiar el contenido de los archivos de ayuda y transformarlos en algo que necesito. Este es un trabajo bastante tedioso, ya que principalmente tengo que agregar un marcado adicional.

Me gusta el enfoque de Markdown, que puede (por ejemplo, usar Pandoc) transformarse en una variedad de formatos de salida. Lamentablemente no vim archivos de ayuda. Estoy buscando un convertidor que tome un formato de entrada estándar (p. Ej. XML, Markdown, texto reStructed, texto plano, ...) y genere un archivo de ayuda vim. ¿O hay algún otro medio para generar automáticamente archivos de ayuda vim sin escribir ese convertidor yo mismo?

vim Marco
fuente
Probablemente podría juntar una hoja de estilo XSLT en unas pocas horas.
Ignacio Vázquez-Abrams

Respuestas:

11

Perdón por resucitar un hilo muy viejo. Soy el autor del mkd2vimdocguión detrás del primer enlace sugerido por lornix anteriormente. Recientemente reescribí mkd2vimdocdesde cero como html2vimdoc . Todavía es compatible con Markdown como formato de entrada; convertirá Markdown a HTML y luego convertirá ese HTML a un archivo de ayuda de Vim. El enfoque durante la reescritura fue el soporte para una gama más amplia de documentos de entrada.

El nuevo script está siendo utilizado por mí y varios otros autores de complementos, por lo que definitivamente está destinado a un uso general. Si desea intentarlo de nuevo, me encantaría saber si ahora funciona mejor para los documentos en los que desea usarlo. Si todavía no funciona, puede crear un problema en GitHub.

xolox
fuente
3
¡Bienvenido a SuperUser! Aquí se agradece responder viejas preguntas, algunas personas aún pueden estar buscando respuestas y está bien mejorar las viejas.
gronostaj 01 de
4

Encontré este script, que el autor creó para convertir markdown a la documentación de vim. Suena muy cerca de lo que estás buscando.

Si bien este script vim.org ( repositorio github ) convierte el descuento en lo que parece casi todo, PERO vimdoc. (suspiro) Tan cerca ... ¿tal vez una ligera modificación?

lornix
fuente
El primer script no se puede usar para uso general. Podría funcionar para el estilo de marcado de los autores, pero no convirtió uno de mis archivos de marcado (válido) correctamente. La segunda opción es pandoc, un convertidor muy capaz que me gusta mucho. Desafortunadamente, no es compatible con vimhelp. Pedí en la lista de correo que agregara soporte para él, pero la respuesta fue que vimhelp no es un formato de salida de propósito general, sino un formato especializado destinado a la documentación de vim, en contraste con los otros formatos compatibles. De todos modos, muchas gracias por el consejo.
Marco
Tengo curiosidad sobre lo que podría implicar crear un convertidor de markdown a vimdoc, ya que la mayoría del vimdoc es el formato y los caracteres de marcadores especiales, mientras que la magia se realiza mediante el comando helptags y el propio visor de ayuda vim. Por supuesto, PODRÍA poner mi pie en mi boca (¡otra vez!) ... tal vez depende de la complejidad de su rebaja inicial.
lornix
Una solución inteligente sugerida en la lista de correo era crear vimhelp, que también es una rebaja válida. El inconveniente es que la rebaja está un poco abarrotada de sintaxis vim y los archivos vimhelp no obedecen a las convenciones de formato. Pero aparte de eso es utilizable.
Marco