Vim 네이티브 도움말 문서(doc/*.txt)를 작성하고 서식을 지정하기 위한 표준 가이드입니다.
도움말 파일 작성하기
파일 생성 및 파일타입 설정
:edit doc/myplugin.txt
:set filetype=help " 렌더링 및 태그 강조 미리보기
:set filetype=text " 일반 텍스트 편집 모드
작성 중에는 ft=text를 사용하고, 서식과 태그 하이라이트를 확인할 때는 ft=help를 사용합니다.
표준 파일 구조 예시
*ack.txt* Plugin that integrates ack with Vim
==============================================================================
USAGE INSTRUCTIONS *ack-usage*
:Ack[!] {pattern} *:Ack*
Search recursively for {pattern}. See |:AckAdd|.
Also see http://beyondgrep.com for more information.
vim:tw=78:ts=8:ft=help:norl:
전체 공식 지침은 Vim 내에서 :help help-writing 명령으로 확인할 수 있습니다.
문법 및 구성 요소
마크업 문법 참조
| 문법 | 설명 | 예시 |
|---|---|---|
*tag* |
점프 대상 정의 태그 | *myplugin-intro* |
|tag| |
태그로 이동하는 하이퍼링크 | |:command| |
'option' |
Vim 설정 옵션 | 'textwidth' |
{placeholder} |
필수 또는 선택적 인자 | {Visual}gf |
<key> |
키보드 특수 키 | <PageDown>, <CR> |
`command` |
인라인 명령어 또는 코드 | `set fo=want` |
CTRL-X |
Control 키 조합 | CTRL-] |
HEADING *tag* |
태그가 포함된 대문자 섹션 헤더 | INSTALLATION *my-install* |
Heading~ |
물결표(~)가 붙은 소제목 또는 열 헤더 | Options~ |
===== |
주 섹션 구분선 (78자) | ====================== |
----- |
하위 섹션 구분선 (78자) | ---------------------- |
태그 및 탐색
- 점프 앵커 이름을 별표로 감쌉니다: plugin-tag
- 파이프 문자를 사용하여 태그로 연결합니다: |plugin-tag|
- 파이프 링크 위에서 Ctrl-]를 누르면 해당 태그로 점프하며, Ctrl-T 또는 Ctrl-O로 돌아옵니다.
코드 블록 작성법
이전 단락 끝에 >를 붙이고, 줄 시작 부분에 <를 넣어 코드 블록을 닫습니다:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
문서 헤더
*myplugin.txt* Extended utility toolkit for Vim
문서의 첫 번째 줄에는 항상 파일 이름을 포함하는 기본 태그와 간략한 설명을 작성합니다.
도움말 모드라인 (Modeline)
파일의 맨 마지막 줄에 모드라인을 추가합니다:
vim:tw=78:ts=8:ft=help:norl:
표준 규칙
목차 (CONTENTS)
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
작성자 및 라이선스 정보
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)