Generieren von Hilfedateien für vim

8

Derzeit schreibe ich meine Dokumentation direkt als vim-Hilfedateien. Manchmal muss ich andere Formate generieren (zB PDF). Mein Arbeitsablauf besteht darin, den Inhalt der Hilfedateien zu kopieren und in etwas umzuwandeln, das ich benötige. Dies ist eine ziemlich mühsame Arbeit, da ich meistens zusätzliches Markup hinzufügen muss.

Ich mag den Ansatz von Markdown, der (z. B. mit Pandoc) in eine Vielzahl von Ausgabeformaten umgewandelt werden kann. Leider nicht vim Hilfedateien. Ich suche einen Konverter, der ein Standardeingabeformat (z. B. XML, Markdown, reStructed Text, Nur-Text usw.) verwendet und eine vim-Hilfedatei ausgibt . Oder gibt es eine andere Möglichkeit, automatisch vim-Hilfedateien zu generieren, ohne selbst einen solchen Konverter zu schreiben?

vim Marco
quelle
Sie könnten wahrscheinlich in ein paar Stunden ein XSLT-Stylesheet zusammenschlagen.
Ignacio Vazquez-Abrams

Antworten:

11

Entschuldigen Sie die Wiederbelebung eines sehr alten Threads. Ich bin der Autor des mkd2vimdocSkripts hinter dem ersten Link, den Lornix zuvor vorgeschlagen hat. Ich habe kürzlich mkd2vimdocvon Grund auf als html2vimdoc umgeschrieben . Markdown als Eingabeformat wird weiterhin unterstützt. Markdown wird in HTML konvertiert und anschließend in eine Vim-Hilfedatei konvertiert. Der Schwerpunkt während des Umschreibens lag auf der Unterstützung einer größeren Anzahl von Eingabedokumenten.

Das neue Skript wird von mir und mehreren anderen Plug-In-Autoren verwendet und ist daher definitiv für den allgemeinen Gebrauch gedacht. Wenn Sie es noch einmal versuchen möchten, würde ich gerne hören, ob es jetzt besser für die Dokumente funktioniert, für die Sie es verwenden möchten. Wenn es immer noch nicht funktioniert, können Sie ein Problem auf GitHub erstellen.

xolox
quelle
3
Willkommen bei SuperUser! Die Beantwortung alter Fragen wird hier sehr geschätzt. Einige Leute suchen möglicherweise noch nach Antworten auf diese Fragen, und es ist in Ordnung, die alten zu verbessern.
Gronostaj
4

Ich habe dieses Skript gefunden, das der Autor erstellt hat, um Markdown in VIM-Dokumentation zu konvertieren. Klingt sehr nah an dem, was Sie suchen.

Während dieses vim.org-Skript ( github repo ) Markdown in fast alles konvertiert, ABER vimdoc. (seufzt) So nah ... vielleicht eine kleine Modifikation?

lornix
quelle
Das erste Skript ist für den allgemeinen Gebrauch unbrauchbar. Es könnte für den Markup-Stil des Autors funktionieren, aber es hat keine meiner (gültigen) Markdown-Dateien korrekt konvertiert. Die zweite Option ist Pandoc, ein sehr leistungsfähiger Konverter, den ich sehr mag. Leider wird vimhelp nicht unterstützt. Ich habe auf der Mailingliste darum gebeten, Unterstützung dafür hinzuzufügen, aber die Antwort war, dass vimhelp im Gegensatz zu den anderen unterstützten Formaten kein allgemeines Ausgabeformat ist, sondern ein spezielles Format für die vim-Dokumentation. Trotzdem vielen Dank für den Tipp.
Marco
Ich bin gespannt, was es bedeuten könnte, einen Konverter von Markdown zu Vimdoc zu erstellen, da der größte Teil des Vimdoc aus Formatierungen und Sonderzeichen besteht, während die Magie durch den Befehl helptags und den vim help viewer selbst ausgeführt wird. Natürlich KÖNNTE ich (wieder!) Meinen Fuß in meinen Mund stecken ... vielleicht hängt es von der Komplexität Ihres anfänglichen Abschlags ab.
Lornix
Eine intelligente Problemumgehung, die auf der Mailingliste vorgeschlagen wurde, bestand darin, vimhelp zu erstellen, was auch ein gültiger Abschlag ist. Der Nachteil ist, dass der Markdown mit der Vim-Syntax etwas überladen ist und die Vimhelp-Dateien nicht den Formatierungskonventionen entsprechen. Aber ansonsten ist es brauchbar.
Marco