Przewodnik po tworzeniu, formatowaniu i stylowaniu natywnych plików dokumentacji pomocy w Vimie (doc/*.txt).
Pisanie plików pomocy
Tworzenie plików i typy plików
:edit doc/myplugin.txt
:set filetype=help " Podgląd formatowania i podświetlania tagów
:set filetype=text " Wygodny tryb edycji
Użyj ft=help do podglądu stylów oraz ft=text podczas początkowej edycji tekstu.
Przykładowa struktura
*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:
Wpisz :help help-writing w Vimie, aby zapoznać się z pełnymi oficjalnymi wytycznymi.
Składnia i elementy
Składnia znaczników
| Składnia | Opis | Przykład |
|---|---|---|
*tag* |
Definicja docelowego tagu skoku | *myplugin-intro* |
|tag| |
Hiperłącze skaczące do tagu | |:command| |
'option' |
Opcja konfiguracyjna Vima | 'textwidth' |
{placeholder} |
Wymagany lub opcjonalny argument | {Visual}gf |
<key> |
Specjalny klawisz klawiatury | <PageDown>, <CR> |
`command` |
Polecenie lub ciąg kodu w wierszu | `set fo=want` |
CTRL-X |
Kombinacja z klawiszem Control | CTRL-] |
HEADING *tag* |
Nagłówek sekcji pisany wielkimi literami z tagiem | INSTALLATION *my-install* |
Heading~ |
Podnagłówek lub nagłówek kolumny z tyldą | Options~ |
===== |
Główny separator sekcji (78 znaków) | ====================== |
----- |
Separator podsekcji (78 znaków) | ---------------------- |
Tagi i nawigacja
- Otaczaj nazwy kotwic gwiazdkami: plugin-tag
- Twórz odnośniki za pomocą pionowych kresek: |plugin-tag|
- Naciśnij Ctrl-] na łączu, aby przeskoczyć do tagu docelowego; naciśnij Ctrl-T lub Ctrl-O, aby powrócić.
Bloki kodu
Oznaczaj bloki kodu, kończąc poprzedni akapit znakiem >, a sam blok zamykając znakiem < na początku wiersza:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Nagłówek dokumentu
*myplugin.txt* Extended utility toolkit for Vim
W pierwszym wierszu zawsze umieszczaj główny tag z nazwą pliku, a następnie krótki opis.
Modeline pomocy
Dodaj modeline w ostatnim wierszu pliku:
vim:tw=78:ts=8:ft=help:norl:
Konwencje
Spis treści
CONTENTS *myplugin-contents*
1. Introduction .............................. |myplugin-intro|
2. Commands .................................. |myplugin-commands|
3. Configuration Options ..................... |myplugin-options|
Informacje o autorze i licencji
Author: Jack Hackness <[email protected]> *myplugin-author*
License: Same terms as Vim itself (see |license|)