Документация по разметке файла справки vim

Есть ли полный источник документации по формату разметки, используемому в файлах справки vim? :help write-local-help предоставляет некоторую информацию, но не документирует, например, разметку, используемую для обозначения разделов в кавычках.

обновление: я также обнаружил это сообщение в рассылке vim-use список, который предоставляет немного больше информации, чем вышеупомянутая запись справки.


person intuited    schedule 02.10.2010    source источник


Ответы (2)


Кажется, все по-прежнему придерживаются чтения другого файла справки или чтения файла синтаксиса.

Я нашел следующие две дополнительные ссылки:

person JBert    schedule 29.06.2014
comment
The Learn Vimscript The Hard Way: ссылка на документацию превосходна... именно то, что доктор прописал! - person JESii; 04.12.2017

:e $VIMRUNTIME/syntax/help.vim

Это покажет вам, как vim окрашивает свои собственные файлы справки.

:help write-local-help

также покажет вам пример.

person Benoit    schedule 02.10.2010
comment
Я надеюсь найти ссылку, похожую на ту, которую вы (и я) упомянули, но более полную. Файл синтаксиса справки, безусловно, подробен, но чтение набора регулярных выражений, как правило, не лучший способ научиться писать разметку. Кроме того, если существует авторитетная ссылка, код окраски синтаксиса может измениться в будущих версиях vim таким образом, чтобы эта ссылка по-прежнему учитывалась. - person intuited; 02.10.2010
comment
ОП специально сказал, что файл бесполезен - person JESii; 04.12.2017