Vim के लिए मदद फ़ाइल बनाना


8

वर्तमान में मैं अपने दस्तावेज़ को सीधे vim help files के रूप में लिखता हूँ। कभी-कभी मुझे अन्य प्रारूपों (जैसे पीडीएफ) को उत्पन्न करने की आवश्यकता होती है। मेरा काम प्रवाह मदद फ़ाइलों की सामग्री की प्रतिलिपि बनाना और उन्हें मेरी ज़रूरत की चीज़ में बदलना है। यह काफी थकाऊ काम है, क्योंकि मुझे ज्यादातर अतिरिक्त मार्कअप जोड़ना पड़ता है।

मैं मार्कडाउन के दृष्टिकोण को पसंद करता हूं, जो (जैसे पंडोक का उपयोग करके) विभिन्न प्रकार के आउटपुट प्रारूपों में बदल सकता है। दुर्भाग्य से मदद फ़ाइलों को विम नहीं। मैं एक कनवर्टर की तलाश कर रहा हूं जो एक मानक इनपुट प्रारूप लेता है (जैसे एक्सएमएल, मार्कडाउन, रीस्ट्रक्टेड टेक्स्ट, सादा पाठ, ...) और एक vim मदद फ़ाइल को आउटपुट करता है। या क्या इस तरह के एक कनवर्टर खुद को लिखने के बिना vim मदद फ़ाइलों को स्वचालित रूप से उत्पन्न करने का कोई अन्य साधन है?


आप शायद कुछ घंटों में एक XSLT स्टाइलशीट में एक साथ धमाका कर सकते हैं।
इग्नासियो वाज़क्वेज़-अब्राम्स

जवाबों:


11

एक बहुत पुराने सूत्र को फिर से जीवित करने के लिए क्षमा करें। मैं लिरोनिक्सmkd2vimdoc द्वारा पहले सुझाए गए पहले लिंक के पीछे की पटकथा का लेखक हूं । मैं हाल ही में html2vimdoc के रूप में जमीन से फिर से लिखा था । यह अभी भी इनपुट प्रारूप के रूप में मार्कडाउन का समर्थन करता है; यह मार्कडाउन को एचटीएमएल में बदल देगा और फिर उस एचटीएमएल को विम मदद फ़ाइल में बदल देगा। पुनर्लेखन के दौरान फोकस इनपुट दस्तावेजों की एक विस्तृत श्रृंखला के लिए समर्थन पर था।mkd2vimdoc

नई स्क्रिप्ट का उपयोग स्वयं और कई अन्य प्लग-इन लेखकों द्वारा किया जा रहा है, इसलिए यह निश्चित रूप से सामान्य उपयोग के लिए है। यदि आप इसे एक और कोशिश देना चाहते हैं, तो मुझे यह सुनना अच्छा लगेगा कि अब यह उन दस्तावेज़ों के लिए बेहतर काम करता है जिन्हें आप इसका उपयोग करना चाहते हैं। यदि यह अभी भी काम नहीं करता है, तो GitHub पर एक मुद्दा बनाने के लिए स्वतंत्र महसूस करें।


3
SuperUser में आपका स्वागत है! पुराने सवालों के जवाब की सराहना यहां की जाती है, कुछ लोग अभी भी उन पर जवाब की तलाश में हैं और पुराने लोगों को सुधारना ठीक है।
गोरोस्तज

4

मुझे यह स्क्रिप्ट मिली , जिसे लेखक ने मार्कडाउन को विम डॉक्यूमेंटेशन में बदलने के लिए बनाया। आप जो खोज रहे हैं उसके बहुत करीब लगता है।

हालांकि यह vim.org स्क्रिप्ट ( github repo ) मार्कडाउन को लगभग हर चीज जैसे BUT vimdoc की तरह दिखता है। (आह) इतना करीब ... शायद थोड़ा सा संशोधन?


सामान्य उपयोग के लिए पहली स्क्रिप्ट अनुपयोगी है। यह लेखकों के मार्कअप शैली के लिए काम कर सकता है, लेकिन इसने मेरी (मान्य) मार्कडाउन फ़ाइलों में से एक को भी सही तरीके से नहीं बदला है। दूसरा विकल्प पैंडॉक है, एक बहुत ही सक्षम कनवर्टर मुझे बहुत पसंद है। दुर्भाग्य से, यह vimhelp का समर्थन नहीं करता है। मैंने मेलिंग सूची पर इसके लिए समर्थन जोड़ने के लिए कहा, लेकिन प्रतिक्रिया थी कि विमहेल्प सामान्य उद्देश्य आउटपुट प्रारूप नहीं है, लेकिन अन्य समर्थित स्वरूपों के विपरीत, विम प्रलेखन के लिए एक विशेष प्रारूप है। वैसे भी, टिप के लिए बहुत बहुत धन्यवाद।
मार्को

मैं उत्सुक हूं कि यह मार्कडैम से विमडोक तक एक कनवर्टर बनाने के लिए क्या हो सकता है, क्योंकि अधिकांश विमडॉक प्रारूपण और विशेष मार्कर वर्ण हैं, जबकि जादू हेल्पैगस कमांड द्वारा किया जाता है और विम खुद दर्शक की मदद करता है। बेशक, मैं अपने मुंह में (फिर से!) अपना पैर रख सकता हूं ... हो सकता है कि यह आपके शुरुआती निशान की जटिलता पर निर्भर करता हो।
लोर्निक्स

मेलिंग सूची में सुझाए गए एक स्मार्ट वर्कअम को vimhelp बनाना था जो कि वैध मार्कडाउन भी हो। दोष यह है कि मार्कडाउन विम सिंटैक्स के साथ थोड़ा सा जुड़ा हुआ है और विमहेल्प फाइलें प्रारूपण सम्मेलनों को नहीं मानते हैं। लेकिन इसके अलावा यह प्रयोग करने योग्य है।
मार्को
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.