sexta-feira, 10 de abril de 2009

Escrevendo a documentação de um plugin

É uma boa idéia escrever documentação para o plugin.
Especialmente quando seu comportamento pode ser mudado pelo usuário.

Eis um exemplo de um arquivo de help de plugin 'typecorr.txt':
1     *typecorr.txt*  Plugin for correcting typing mistakes
2
3 If you make typing mistakes, this plugin will have them corrected
4 automatically.
5
6 There are currently only a few corrections. Add your own if you like.
7
8 Mappings:
9 <Leader>a or <Plug>TypecorrAdd
10 Add a correction for the word under the cursor.
11
12 Commands:
13 :Correct {word}
14 Add a correction for {word}.
15
16 *typecorr−settings*
17 This plugin doesn't have any settings.
A primeira linha é a única em que o formato importa. Ela será extraída do
arquivo de help para ser colocada na seção 'LOCAL ADDITIONS:" do help.txt'.
O primeiro '*' deve estar na primeira coluna da primeira linha.
Depois de adicionar seu arquivo de help faça ':help' e verifique que as entradas
alinham adequadamente.

Você pode adicionar mais tags '*...*' dentro de seu arquivo help. Mas seja
cuidadoso de não de usar tags de help existentes. Você irá provavelmente usar
nome do plugin na maioria deles, como 'typecorr-settings' no exemplo.

Usar referencias para outras partes do help em '|...|' é recomendado. Isto torna
fácil para o usuário achar ajuda associada.

0 comentários:

Postar um comentário