Как написать gvim-help-doc-like текстовый файл?

Question

Справочный документ gvim содержит «ссылки», я могу перейти к теме, нажав 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

Файлы справки Vim существуют в $ VIMRUNTIME / doc, поэтому, если вы просматриваете эти файлы и устанавливаете

set syntax=off

это даст вам представление о наценке. По сути, вы создаете ссылки, заключая их в каналы:

go to a link |here|

, который будет переходить к появлению текста ссылки, заключенного в звездочки, т.е. *here*.

Тогда вам просто нужно сделать

set filetype=help

для ваших файлов, чего вы можете достичь с помощью автокоманды.

Answer 3

Требуется выполнить команду:

:helpt[ags] {dir}

для создания новых тегов после создания файла.Подробности можно найти:

:help helpt