Hoja de trucos de archivos de ayuda de Vim

Guía de referencia para la redacción, estilo y formato de archivos de documentación de ayuda nativos de Vim (doc/*.txt).

Redacción de archivos de ayuda

Creación de archivos y tipos

:edit doc/myplugin.txt
:set filetype=help   " Previsualizar renderizado y resaltado de etiquetas
:set filetype=text   " Modo de edición conveniente

Usa ft=help para previsualizar el estilo y ft=text durante la edición inicial.

Estructura de muestra

*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:

Consulta :help help-writing dentro de Vim para conocer las pautas oficiales completas.

Sintaxis y elementos

Referencia de marcado

Sintaxis	Descripción	Ejemplo
`tag`	Etiqueta definitiva de destino de salto	`myplugin-intro`
`\|tag\|`	Hipervínculo que salta a la etiqueta	`\|:command\|`
`'option'`	Opción de configuración de Vim	`'textwidth'`
`{placeholder}`	Argumento obligatorio u opcional	`{Visual}gf`
`<key>`	Tecla especial del teclado	`<PageDown>`, `<CR>`
`command`	Comando en línea o código	`set fo=want`
`CTRL-X`	Combinación con tecla Control	`CTRL-]`
`HEADING tag`	Encabezado de sección en mayúsculas con etiqueta	`INSTALLATION my-install`
`Heading~`	Subencabezado o cabecera de columna con tilde	`Options~`
`=====`	Separador de sección principal (78 caracteres)	`======================`
`-----`	Separador de subsección (78 caracteres)	`----------------------`

Etiquetas y navegación

Envuelve los nombres de anclaje con asteriscos: plugin-tag
Enlaza a los destinos con barras verticales: |plugin-tag|
Pulsa Ctrl-] sobre un enlace con barras para saltar directamente; pulsa Ctrl-T o Ctrl-O para volver.

Bloques de código

Indica bloques de código terminando el párrafo anterior con > y finalizando el bloque con < al principio de una línea:

Example: >
    let g:loaded_myplugin = 1
    call myplugin#setup()
<

Cabecera del documento

*myplugin.txt*  Extended utility toolkit for Vim

Coloca siempre una etiqueta principal con el nombre del archivo en la primera línea, seguida de una breve descripción.

Modeline de ayuda

Añade una modeline en la última línea del archivo:

vim:tw=78:ts=8:ft=help:norl:

Convenciones

Tabla de contenidos

CONTENTS                                                     *myplugin-contents*

    1. Introduction .............................. |myplugin-intro|
    2. Commands .................................. |myplugin-commands|
    3. Configuration Options ..................... |myplugin-options|

Bloque de autor y licencia

Author:  Jack Hackness <[email protected]>         *myplugin-author*
License: Same terms as Vim itself (see |license|)