دليل مرجعي لكتابة وتنسيق ملفات وثائق المساعدة الأصلية في محرر 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 للحصول على الإرشادات الرسمية الكاملة.
بناء الجملة والعناصر
مرجع علامات التنسيق (Markup)
| الصيغة | الوصف | مثال |
|---|---|---|
*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:
الأعراف والتقاليد القياسية
جدول المحتويات (TOC)
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|)