मैं मार्कडाउन नोट्स या इनलाइन टिप्पणियों से विम प्रलेखन कैसे उत्पन्न करूं, या प्रलेखन जोड़ने के बेहतर तरीके हैं?


14

यह एक में दो तरह के सवाल हैं। हाल ही में मैं बहुत समय बिता रहा हूँ vimscript में गहराई से सीखना, vim का इंटर्नल सीखना और vim plugins लिखना मेरा पहला कदम है। इस प्रक्रिया के दौरान, मैं अलग-अलग मार्कडाउन फाइलों में व्यापक नोट्स रख रहा हूं और बहुत सारी इनलाइन 'डॉक्यूमेंट्स' टिप्पणियों को विम्सस्क्रिप्ट फाइलों में जोड़ रहा हूं।

मुझे लगता है कि मुझे अंत में कुछ कोड मिला है जो साझा करने के लायक है, और कुछ वास्तविक दस्तावेज जोड़ना शुरू करना चाहते हैं । मैंने अपनी स्वयं की किसी भी हेल्पडॉक फ़ाइल को अभी तक अधिकृत नहीं किया है, इसलिए मैं अभी भी उस प्रक्रिया का पता लगा रहा हूं।

इस वर्कफ़्लो के किसी भी अनुभव या ठोस समझ के बिना, ऐसे दो कार्य हैं जिन्हें मैं जानने की कोशिश कर रहा हूँ:

  1. Vim / vimscript पर मेरे मार्कडाउन 'नोट्स' फाइलों से हेल्पडॉक फाइल बनाना, इसलिए मैं किसी भी समय vim से जल्दी और आसानी से / संदर्भ पढ़ सकता / सकती हूं।
  2. मेरी vimscript फाइलों से इनलाइन प्रलेखन (जिस तरह से करने के लिए इसी तरह की पार्स shocco शेल स्क्रिप्ट के लिए काम करता है) vimscripts के लिए संबद्ध helpdoc उत्पन्न करने के लिए।

विचारों पर कोई सुझाव या सलाह ( यह एक बुरा विचार है क्योंकि ..., एक बेहतर विचार है ... ), या उन्हें कैसे पूरा किया जाए, इसकी बहुत सराहना की जाएगी।


1
भले ही मुझे मार्कड को विम के हेल्प फ़ाइल प्रकार में परिवर्तित करने के तरीके का पता नहीं है, लेकिन मुझे उन्हें लिखने के लिए एक अच्छे परिचय का पता है: learnvimscriptthehardway.stevelosh.com/chapters/54.html
EvergreenTor

जवाबों:


7

जहाँ तक मुझे पता है कि वर्तमान में समस्या के लिए कोई अच्छा समाधान नहीं है, लेकिन बहुत से लोग उन्हें हल करने में दिलचस्पी लेंगे।

मार्कडाउन HTML का सुपरसेट है, इसलिए मैं कहूंगा कि मार्कडाउन से विम तक मदद के लिए रूपांतरण में एक ललाट दृष्टिकोण सफल होने की संभावना नहीं है। यदि आप हास्केल बोल सकते हैं तो आप पंडोक के लिए एक विम सहायता बैकेंड लिखने की कोशिश कर सकते हैं । अगर यह सही नहीं है, तो यह एक बहुत अच्छा समाधान होगा।

इसे दूसरे तरीके से करने के लिए कुछ प्रयास किए गए हैं, विम मदद पृष्ठों को कुछ उपयोगी प्रारूप में परिवर्तित करें। सफलता की अलग-अलग डिग्री के साथ, आधिकारिक मदद के HTML और पीडीएफ संस्करणों का निर्माण करने वाली कुछ लिपियाँ तैर रही हैं। लेकिन वे सभी स्टाइल में अधिक या कम समरूप होने में मदद पर भरोसा करते हैं। यहां तक ​​कि पंडोक जैसी किसी चीज के लिए एक विम मदद पाठक एक सार्थक परियोजना होगी।

विम कोड से दस्तावेज़ीकरण निकालने के लिए, पायथन, जावास्क्रिप्ट में विम के लिए एक पार्लर है, और खुद विम्लपर, जिसका नाम विमप्परर है । यह बहुत अच्छा है, कुछ ऐसा लिखना मुश्किल नहीं होना चाहिए जो विम्ल स्रोतों को पार्स करता है और विशेष रूप से तैयार की गई टिप्पणियों को डंप करता है। इन टिप्पणियों को किसी चीज़ में बदलने में सक्षम होने के नाते, कहते हैं, POD अत्यधिक उपयोगी होगा।


4

html2vimdoc.py

सबसे आशाजनक उपकरण html2vimdoc.pyजो मैंने पाया है वह यहाँ पाया जा सकता है http://peterodding.com/code/vim/tools और github पर । यह मार्कडाउन और html को विम के हेल्प फॉर्मेट में बदल सकता है। विज्ञापित विशेषताएं हैं:

  • यह जटिल HTML धन्यवाद के साथ सौदा कर सकता है [BeautifulSoup] बी.एस.
  • शीर्षकों के लिए स्वचालित रूप से Vim मदद फ़ाइल टैग उत्पन्न करता है
  • शीर्षकों और टैग से सामग्री की तालिका बनाता है
  • नेस्टेड ब्लॉक संरचनाओं जैसे नेस्टेड सूचियों, सूचियों के अंदर पूर्वनिर्मित ब्लॉक आदि का समर्थन करता है।
  • सूची आइटम की औसत संख्या के आधार पर सूची आइटम को संकुचित और विस्तारित करता है

एक पुराना विकल्प https://github.com/mklabs/vim-markdown-helpfile है

Https://superuser.com/q/415470/generating-help-files-for-vim पर भी चर्चा हुई है

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.