Yordam:Andozalar va modullarni hujjatlashtirish

Shablonlar va modullarni MediaWiki juda kuchli xususiyatlari, lekin qiyinchilik yanada murakkab kishilarning aql qilish boʻlishi mumkin, yangi foydalanuvchilar va hatto tajribali foydalanuvchilar uchun bosh karıştırıcı boʻlishi mumkin. Shuning uchun ular mavjudligi oshirish uchun hujjatlar bilan birga boʻlishi kerak. Hujjatlar bir shablonini yoki moduli qilsa va qanday foydalanish tushuntirishi kerak. Boshqa joylarda ularning eʼtiborini koʻp tajribali ishtirokchi oʻz ichiga oladi toʻgʻri foydalanishingiz mumkin, xususan, andozalar uchun, u etarli Andoza sintaksisi nafosatini toʻliq bilmasdan bir foydalanuvchi oddiy bo'lishi kerak. Bu juda keng-ishlatiladigan andozalari holda, ayniqsa, toʻgʻridir.

Oʻz ichiga uchun nima

Hujjatlar qamrab olishi lozim:

• Kategoriyalar va InterVikimediya ishoratlar, qaerda qoʻllaniladigan. Bu bir <includeonly>…</includeonly> konteyner ichida boʻlishi kerak. Modul bir hujjatlar sahifasi orqali tashqari tasniflangan mumkin emas, shuning uchun bu ular uchun, ayniqsa, muhim ahamiyatga ega. Har modul har qanday boshqa hujjatlarni (hali) yozish yoʻq boʻlsa ham, bir turkumga bilan hujjat sahifasiga ega boʻlishi kerak. Koʻp toifalar, mavjud Turkum qarang: ular orqali koʻrib chiqish uchun Turkum:Modullar, Turkum:shablonlar va turkum.

• Andoza yoki moduli asosiy maqsadi: nima u qilsa va u darhol ravshan boʻlmasa, nima uchun u amalga oshirilishi kerak. Boshqa andozalar yoki shunga oʻxshash nomlar yoki maqsadlar bilan modullarni mavjud boʻlsa, u ishlatiladigan notoʻgʻri birining ehtimolini kamaytirish maqsadida, o'sha zikr qilish yaxshi fikr.
• Andoza yoki moduli parametrlarini: ular raqamlangan boʻlsin, deb nomlangan yoki ixtiyoriy va agar shunday boʻlsa, standart qiymatlari qanday va nima sababli ular bor. Agar parametr qiymatlari faqat cheklangan toʻplami olishi mumkin yoki u faqat foydalanishingiz mumkin, agar, masalan, biron-bir tarzda cheklangan boʻlsa: "ha", "yoʻq" yoki raqam, bu aniq tushuntirib berilishi kerak.
• Andozalarini foydalanish misollar: foydalanish kerak aniq vikimatn va u ishlab chiqarish natija belgilang. Vikimatn aniq va oson bu kabi, nusxa ko'chirish qilish uchun, bir <code>…</code> konteyner ichida boʻlishi mumkin. Andoza bilan yoki ixtiyoriy parametr holda bir necha turli xil yoʻllar bilan, foydalanish mumkin boʻlsa, masalan, misollar bir qator beradi. Buning uchun yaxshi bir yoʻli hujjatlar ichiga andozalarini oʻziga uchun bir necha marta (yaʼni, tirik misollar foydalanish) turli parametrlar bilan, har bir vaqt va har bir holatda ishlatiladigan parametrlarni roʻyxatlash.
• Tegishli andozalar yoki modullarni: andoza yoki moduli umumiy maqsadga xizmat qiladi majmui qismi boʻlsa, bu havolani oʻz ichiga oladi - bu oson navigatsiya qiladi, xususan, ketma-ket har bir boshqalarning har bir bogʻlangan ishonch hosil qiling.

/Hujjatlar nomidagi andoza yoki modul oʻzi, bir sahifasiga joylashtiring bayrok. Modul avtomatik ravishda asosiy moduli sahifaga ushbu sahifani transclude. Shablonlar bu qilmasangiz, shuning uchun siz bu, albatta, andoza {{hujjat}} foydalanish kerak boʻladi. Bu tartibga solish uchun hujjat osonlashtirish, hujjatlar dan koʻp murakkab Andoza kodi ajratadi. Bu, shuningdek, ruxsat beruvchi har bir kishi hujjatlarni va kategoriyalari tartibga solish uchun esa andozalar, zarur boʻlgan hollarda himoya qilish imkonini beradi. Andoza sahifada oʻzi Matn bajarish sabablarga koʻra cheklangan andoza, namoyon boʻlsa qayta ishlanishi lozim matn miqdori hisoblab chiqadi. Bir sahifasiga joylashtiring ichida hujjatlarni joylashtirish (MediaWiki chiquvchilar bu Shuning uchun uni tavsiya qilgan), bu bormayapti.

Bir tavsif yaratish qanday

Hujjatlar ostsahifalari mustahkamlik uchun, quyidagi umumiy naqsh yordamida nomidagi va formatlangan boʻlishi kerak.

Andoza:X, yoki sizning moduli Module nomidagi etiladi:: Faraz qilaylik, sizning Andoza Andoza nomidagi etiladi X. Nomi Andoza bilan, bir, pastki sahifani yarating: Modul:X/documentation hujjatlar yoki Modul:X taqdim qilinadigan hujjatlarga. Da tafsilotlarni qarang, {{tavsif berilmagan}} yoki nusxasi-yapıştırın sizning dökümanlarınız uchun, bir start kabi, quyidagi vikimatn:

{{tavsif berilmagan}}

Misol

Ogʻir-oʻrgangan Andoza:uz-ism qarang batafsil Andoza hujjatlarni misol uchun. Muhofaza qilish va hanuz ajratish mumkin: Andoza oʻzi himoyalangan, ammo tavsif, uz-ism/hujjatlar andoza unutmang.

Bir necha andozalar, bir hujjat sahifa

Bir necha andozalar birga ishlash yoki juda oʻxshash boʻlsa, keyin u bilan birga ularni hujjatlar yagona hujjat sahifa saqlab qolish uchun koʻp aniq va oson boʻladi. Buning uchun oddiy usuli, andozalar birida toʻliq hujjatlar sahifasi qilish va undan keyin boshqa andozalar "hujjatlari sahifalari" qayta yoʻnaltirishlar qilishdir. Qarang Andoza:nl-Forscha online-VK va Andoza:nl-Forscha online-chi bu tamoyilning misol uchun.