एक gvim-help-doc जैसी टेक्स्ट फ़ाइल कैसे लिखें?

Question

जाँचने सहायता दस्तावेज़, "लिंक" शामिल मैं द्वारा Ctrl + विषय] पर जा सकते हैं एक पाठ जो कि

Answer 1

कि विषय को समर्पित मदद में एक वर्ग है: "लेखन मदद फ़ाइलों"

देखें : help help-writing या :help helphelp.txt

अंश:

TAGS 


To define a help tag, place the name between asterisks (*tag-name*). 

(...) 

When referring to an existing help tag and to create a hot-link, place the 
name between two bars (|) eg. |help-writing|. 

अधिक जानकारी प्राप्त करने के लिए कृपया पहले उल्लिखित सहायता फ़ाइलों को पढ़ें।

Answer 2

विम की सहायता फ़ाइलें तरह से कार्य कर सकते हैं स्वरूपित करने के लिए कैसे $ VIMRUNTIME/doc में मौजूद हैं, इसलिए यदि आप इन फ़ाइलों को देखने के और

set syntax=off 

यह आपको मार्क-अप का एक विचार देगा। मूल रूप से आप उन्हें पाइप में बंद करके लिंक बनाने:

go to a link |here| 

जो तारक में संलग्न लिंक पाठ की एक घटना पर चला जाएगा, अर्थात *here*।

तो अगर आप अपनी फ़ाइलों, जो आपको एक autocommand साथ प्राप्त कर सकते हैं के लिए

set filetype=help 

करने की ज़रूरत है।

Answer 3

यह आदेश चलाने के लिए आवश्यक है:

:helpt[ags] {dir} 

नए टैग उत्पन्न करने के लिए के बाद फ़ाइल बनाई गई है। विवरण मिल सकता है:

:help helpt