Οδηγός αναφοράς για τη συγγραφή και μορφοποίηση αρχείων τεκμηρίωσης βοήθειας στο Vim (doc/*.txt).
Συγγραφή αρχείων βοήθειας
Δημιουργία αρχείων & Τύποι αρχείων
:edit doc/myplugin.txt
:set filetype=help " Προεπισκόπηση εμφάνισης και επισήμανση ετικετών
:set filetype=text " Βολική λειτουργία επεξεργασίας
Χρησιμοποιήστε ft=help για προεπισκόπηση και ft=text κατά την αρχική επεξεργασία.
Δομή δείγματος
*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:
Δείτε :help help-writing μέσα στο Vim για τις πλήρεις επίσημες οδηγίες.
Σύνταξη & Στοιχεία
Αναφορά σήμανσης
| Σύνταξη | Περιγραφή | Παράδειγμα |
|---|---|---|
*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
- Συνδεθείτε με τις ετικέτες χρησιμοποιώντας χαρακτήρες pipe: |plugin-tag|
- Πατήστε Ctrl-] πάνω σε σύνδεσμο για άλμα στην ετικέτα; Ctrl-T ή Ctrl-O για επιστροφή.
Μπλοκ κώδικα
Δηλώστε μπλοκ κώδικα ολοκληρώνοντας την προηγούμενη παράγραφο με > και κλείνοντας με < στην αρχή γραμμής:
Example: >
let g:loaded_myplugin = 1
call myplugin#setup()
<
Επικεφαλίδα εγγράφου
*myplugin.txt* Extended utility toolkit for Vim
Τοποθετείτε πάντα μια κύρια ετικέτα με το όνομα αρχείου στην πρώτη γραμμή, ακολουθούμενη από σύντομη περιγραφή.
Γραμμή ρυθμίσεων (Modeline)
Προσθέστε μια γραμμή modeline στην τελευταία γραμμή του αρχείου:
vim:tw=78:ts=8:ft=help:norl:
Συμβάσεις
Πίνακας περιεχομένων
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|)