Generowanie plików pomocy dla vima

8

Obecnie piszę moją dokumentację bezpośrednio jako pliki pomocy vim. Czasami muszę generować inne formaty (np. PDF). Moja praca polega na kopiowaniu zawartości plików pomocy i przekształcaniu ich w coś, czego potrzebuję. Jest to dość żmudna praca, ponieważ w większości muszę dodać dodatkowe znaczniki.

Podoba mi się podejście Markdown, które można (np. Używając Pandoc) przekształcić w różne formaty wyjściowe. Niestety nie vim plików pomocy. Szukam konwertera, który przyjmuje standardowy format wejściowy (np. XML, Markdown, tekst reStructsed, zwykły tekst,…) i wyświetla plik pomocy vim. Czy jest jakiś inny sposób automatycznego generowania plików pomocy vim bez pisania takiego konwertera?

vim Marco
źródło
Prawdopodobnie w kilka godzin utworzysz arkusz stylów XSLT.
Ignacio Vazquez-Abrams,

Odpowiedzi:

11

Przepraszamy za wskrzeszenie bardzo starego wątku. Jestem autorem mkd2vimdocskryptu za pierwszym linkiem sugerowanym wcześniej przez lornix . Niedawno przepisałem mkd2vimdocod podstaw jako html2vimdoc . Nadal obsługuje Markdown jako format wejściowy; Konwertuje Markdown na HTML, a następnie konwertuje HTML na plik pomocy Vima. Podczas przepisywania skupiono się na obsłudze szerszego zakresu dokumentów wejściowych.

Nowy skrypt jest używany przeze mnie i kilku innych autorów wtyczek, więc jest zdecydowanie przeznaczony do ogólnego użytku. Jeśli chcesz spróbować jeszcze raz, chciałbym usłyszeć, czy teraz działa lepiej dla dokumentów, na których chcesz go używać. Jeśli nadal nie działa, możesz utworzyć problem w GitHub.

Xolox
źródło
3
Witamy w SuperUser! Doceniamy odpowiadanie na stare pytania, niektórzy ludzie mogą nadal szukać odpowiedzi na te pytania i poprawianie starych jest w porządku.
gronostaj
4

Znalazłem ten skrypt, który autor stworzył, aby przekonwertować markdown na dokumentację vim. Brzmi bardzo blisko tego, czego szukasz.

Podczas gdy ten skrypt vim.org ( github repo ) konwertuje markdown w coś, co wygląda prawie na wszystko ALE vimdoc. (westchnienie) Tak blisko ... może drobna modyfikacja?

lornix
źródło
Pierwszy skrypt nie nadaje się do ogólnego użytku. Może to działać w stylu znaczników autorów, ale nie przekonwertowało poprawnie jednego z moich (ważnych) plików znaczników. Druga opcja to pandoc, bardzo sprawny konwerter, który bardzo mi się podoba. Niestety nie obsługuje vimhelp. Poprosiłem na liście mailowej o dodanie obsługi tego, ale odpowiedź była taka, że ​​vimhelp nie jest formatem wyjściowym ogólnego przeznaczenia, ale specjalnym formatem przeznaczonym do dokumentacji vima, w przeciwieństwie do innych obsługiwanych formatów. W każdym razie wielkie dzięki za wskazówkę.
Marco
Jestem ciekawy, co to może oznaczać utworzenie konwertera od markdown do vimdoc, ponieważ większość vimdoc to formatowanie i znaki specjalne, podczas gdy magia jest wykonywana przez polecenie helptags, a vim pomaga samej przeglądarce. Oczywiście, Mógłbym wsadzić stopę do ust (znowu!) ... może zależy to od złożoności początkowego przeceny.
lornix,
Sprytnym obejściem zasugerowanym na liście mailingowej było stworzenie vimhelp, który jest również ważnym znacznikiem. Wadą jest to, że przecena jest nieco zaśmiecona składnią vima, a pliki vimhelp nie są zgodne z konwencjami formatowania. Ale poza tym jest użyteczny.
Marco