Wp/apc/ويكيبيديا:قوالب

noborder

هيدي الصفحة هي صفحة إرشادات بويكيبيديا شامي.

الإرشاد هو معيار مقبول بالعموم، و لازم كل المحررين يتبعو بالاعتماد على الحس السليم، مع العلم إنو الإرشادات ما بتندرج تحت بند السياسات.

مساحة القوالب على ويكيبيديا بتستخدم لتخزين القوالب، يلي بتحتوي على تعليمات ويكي مخصصة للإدراج بعدة صفحات، بالعادة عن طريق الإدراج التلقائي. مع إنو مساحة القوالب مخصصة لتخزين أغلب القوالب، بس ممكن كمان إدراج و استبدال القوالب من مساحات تانية، و لهيك شوية صفحات قوالب بتنحط بمساحات تانية، متل مساحة المستخدم.

القوالب بتساعد بالحفاظ على تنسيق متناسق و بتسهل التنقل بين المقالات. بالغالب بتحتوي على عناصر اختيارية أو متغيرة بيتم التحكم فيها عن طريق معايير معينة لتسمح باستخدام مخصص. القوالب كمان بتستخدم للمساعدة بعدد كبير من مهام الصيانة بويكيبيديا. كل قالب بيكون عندو صفحة نقاش قالب: يلي المحررين بيقدرو يناقشو فيها تصميم و تنفيذ القالب المرتبط.

القالب بيندرج بصفحة تانية عن طريق إضافة وسم قالب بمحتوى هديك الصفحة. وسم القالب بيحتوي على اسم صفحة القالب محاطة بأقواس معقوفة مزدوجة، متل {{توضيح}}. إذا اسم صفحة القالب ما بلش بمساحة اسم و نقطتين، بيتفترض إنو موجود بمساحة القوالب.

الروابط الداخلية لصفحات القوالب ممكن تنعمل عن طريق استخدام بادئة قالب:، متل [[قالب:توضيح]]. شوف § الربط بالقوالب لطرق تانية للربط بقالب.

إرشادات

• القوالب ما لازم تنستخدم بالعادة لتخزين نصوص المقالات، لإنو هالشي بصعّب تعديل المحتوى. كمان، ما لازم تنستخدم لإخفاء أو طي المحتوى عن القارئ.
• القوالب يلي بتنحط بالمقالات مصممة لتقديم معلومات بتساعد القارئ، متل أدوات التنقل، التنسيق، أو تحذيرات إنو المحتوى دون المستوى المطلوب. القوالب يلي بتقدم معلومات بتهم المحررين بس، ما لازم تظهر بصفحات المقالات – بهالحالة، لازم تنحط بصفحة نقاش المقال أو بأي مساحة مو مخصصة للمقالات.
• وظيفة القالب لازم تكون واضحة من اسمو، بس ممكن إنشاء تحويلات لتسهيل الاستخدام اليومي للقوالب الشائعة كتير.
• القوالب عالية الخطورة لازم تكون محمية بشكل جزئي، أو محمية للقوالب، أو محمية بشكل كامل حسب الحاجة. هالشي بينطبق كمان على تحويلات القوالب يلي بيتم استخدامها بكثرة.
• القوالب لازم تكون موثقة بوضوح بخصوص كيفية استخدامها و نطاقها.
• ما لازم تنستخدم القوالب لإنشاء ليستات روابط لمقالات تانية إذا كان بإمكان تصنيف، صفحة ليست، أو قسم "شوف كمان" تعمل نفس المهمة.
• القوالب المخصصة لرسائل قصيرة و مؤقتة يلي رح تنشال بسرعة (متل يلي بتنحط بصفحات نقاش المستخدمين)، أو يلي بتحتوي على نص مو متوقع إنو يتغير، لازم يتم إدراجها باستخدام الاستبدال (subst:). أما القوالب يلي مخصصة للاستخدام الطويل الأمد و ممكن تحتاج لتعديلات، لازم يتم إدراجها تلقائياً لتسهيل تحديثها بالمستقبل.
• القوالب يلي بتخالف الإرشادات الموجودة بهالصفحة، أو وظيفتها مو واضحة، أو مكررة، أو صارت مهجورة و بتُستخدم بصفحة وحدة بس، أو بتخالف أي سياسة من سياسات ويكيبيديا، ممكن يتم ترشيحها للمسح بصفحة [ويكيبيديا:نقاش القوالب].

الربط بالقوالب

الروابط الداخلية لصفحات القوالب ممكن تنعمل باستخدام بادئة قالب: أو بديلها TM:، مثلاً:

• [[قالب:توضيح]]
• [[TM:توضيح]]

هالروابط بتاخدك مباشرةً لصفحة القالب الأساسي، بس ممكن كمان الربط مباشرةً بالصفحات الفرعية متل توثيق القالب، مثلاً:

• [[قالب:توضيح/doc]]

إذا بدك تربط لقالب باستخدام تنسيق عرض مناسب للقوالب، فيك تستخدم قالب Tl: (اختصار لـ "template link"). مثلاً، للإشارة لقالب "تنظيف"، كتابة:

• {{tl|Cleanup}} رح تظهر بالشكل: {{Cleanup}}

هالطريقة ما بتستدعي القالب، بس العرض بيوضح إنو الكائن المرتبط هو قالب.

كمان فيك تضيف معايير باستخدام قالب Tlp:، مثلاً:

• {{tlp|Convert|1|m}} رح تظهر بالشكل: {{Convert|1|m}}

راجع توثيق القالب Template:Tl لمزيد من الخيارات، متل:

• {{tlb}} (عريض)
• {{tlx}} (كود)
• {{tlxi|param1|param2}} (معايير مائلة)
• {{tnl}} (بدون رابط)
• و خيارات تانية كتيرة.

الممارسات المقترحة

أسماء القوالب

أسماء القوالب لازم تتكون من كلمة أو أكتر، متل {{Train topics}}. أول حرف بالاسم مو حسّاس لحالة الأحرف، يعني {{cleanup}} و {{Cleanup}} نفس القالب. بس باقي الأحرف حساسة للحالة، يعني {{cfd}} و {{cfD}} قالبين مختلفين.

أسماء القوالب بتكون أسهل للحفظ إذا تبعت قواعد الإملاء و المسافات و استخدام الأحرف الكبيرة و الصغيرة بالإنجليزي (شوف كمان إرشادات تسمية المقالات). لازم تتجنب إنشاء قوالب بأسماء مختلفة بس بالحروف الكبيرة أو المسافات أو علامات الترقيم.

إذا كان اسم القالب طويل، ممكن تعمل تحويلات للقالب (يلي بالعادة بتتسمى اختصارات) لتسهيل الكتابة. مثلاً، بدل كتابة {{Template link with subst}}، فيك تستخدم الاختصار {{tls}}.

مساحة تجريب القوالب

إذا حابب تجرب القوالب بدون ما تنمسح تجاربك قبل ما تخلص، فيك تستخدم مساحة تجريب القوالب. كمان فيك تستخدم القوالب التجريبية X1، X2، X3، X4، X5، X6، X7، X8، X9، X10، X11، X12 لهالغاية.

لاستدعاء قالب تجريبي، استخدم الصيغة {{X1}} للقالب X1، {{X2}} للقالب X2، وهكذا.

القوالب الموجودة أصلاً بالغالب بيكون عندها صفحات اختبار و تجريب خاصة فيها (خصوصاً يلي بتستخدم {{Documentation}}). لازم يتم اختبار التعديلات عليها منيح قبل تطبيقها على القالب الرئيسي، لتجنب أي ضرر مو مقصود لعدد كبير من الصفحات.

وضوح و قابلية قراءة الكود

إذا كان القالب فيه عدد كبير من المعايير، من الأفضل تخلي كل معيار بسطر لحاله و توحّد محاذاة علامات الـ "="، لحتى يسهل على المحررين قراءة الكود. مثلاً، لو بدك تعمل صندوق معلومات (Infobox) فيه عدد كبير من المعايير، ممكن يكون كودك بهالشكل:

{{Infobox
 | header1  = نص العنوان 1
 | label2   = نص التسمية 2
 | data2    = نص البيانات 2
 | etc      = إلخ
 }}

القوالب يلي بتستخدم تعابير شرطية كثيرة بتستفيد كمان من ترتيب الأسطر، متل هالكود المستخدم بقالب {{If either}}:

{{#if:{{{1|}}}
  |{{{then|{{{3|}}}}}}
  |{{#if:{{{2|}}}
   |{{{then|{{{3|}}}}}}
   |{{{else|{{{4|}}}}}}
  }}
 }}

الأسطر المتقطعة بهالطريقة بتساعد بفهم العلاقة بين الجمل الشرطية #if و بتسهّل قراءة الكود، رغم إنو هالشي مو ضروري بس بيسهّل التعديل بالمستقبل.

فواصل الأسطر

رغم إنه فواصل الأسطر داخل كود القالب مفيدة لسهولة القراءة، بس الفواصل ببداية أو نهاية كود القالب ممكن تسبب مشاكل بعرض المقالات. لازم تنتبه أثناء كتابة القوالب لتجنب أي مسافات بيضاء غير ضرورية.

مثلاً، كسر سطر واحد داخل Infobox ممكن يتفاعل مع كسر سطر بالمقال و يسبب فاصل فقرة غير مرغوب فيه، أو ممكن يخرب عرض القالب لما يكون مستخدم ضمن سطر. كقاعدة عامة، تجنب وضع فاصلين متتاليين داخل القالب، لأنهم ممكن يضيفوا مسافات بيضاء غير مرغوبة لما ينضاف القالب لصفحة.

لمعلومات أكتر عن تأثير فواصل الأسطر على كود الويكي، شوف [ويكيبيديا:معالجة فواصل الأسطر].

تجنب المسافات البيضاء الزائدة

لتجنب المساحات البيضاء الزائدة، تأكد إنه أي علامة تكون مباشرة بعد كود القالب بدون أسطر إضافية. المثال التالي مأخوذ من قالب {{questions}} و عنده تنسيق جيد لفواصل الأسطر:

{{notice|small=yes|إذا بدك تسأل سؤال، شوف صفحة [[Wikipedia:Questions]] للمساعدة.}}<noinclude>
[[Category:Wikipedia help templates]]
</noinclude>

---

الاستبدال (Substitution)

الصفحة الرئيسية: [ويكيبيديا:الاستبدال]

إذا بدك تستدعي قالب و تخليه ينسخ محتواه للنص المصدر بدل ما يظل متغير مع تحديثات القالب، استخدم الصيغة:

{{subst:اسم القالب (|معايير |...)}}

إضافة subst: بعد الأقواس مباشرةً بتخلي النص الفعلي للقالب ينسخ للصفحة، و بهالحالة القالب ما بيظل مستدعى و أي تعديلات مستقبلية عليه ما رح تأثر على النص.

هالطريقة لازم تستخدمها بالرسائل القصيرة و المؤقتة يلي بتنشال بسرعة، متل يلي بتستخدم بصفحات نقاش المستخدمين. مثال على هيك قالب هو رسالة الترحيب القياسية {{Welcome}}.

كمان، استخدم subst: إذا كنت بحاجة لتعديل الرسالة بعد إضافتها للصفحة. أما إذا ما كنت بحاجة للتعديل، و بدك الرسالة تظل متحدثة تلقائياً مع تغييرات القالب، فلا تستخدم subst:.

---

توثيق القوالب

الصفحة الرئيسية: [ويكيبيديا:توثيق القوالب]

لأن التعامل مع القوالب أصعب شوي للمحررين الجدد، لازم يكون فيه توثيق واضح يشرح طريقة الاستخدام (المعلمات الاختيارية) و نطاق الاستخدام (وين لازم ينحط القالب).

طرق توثيق القالب

1- استخدام قالب {{documentation}}

• طريقة مباشرة لإضافة وصف صغير على نفس صفحة القالب.
• لازم يكون أول بنفس السطر مع آخر حرف من الكود الفعلي للقالب.
• مثال:

'''هالمقال {{{1}}}.'''<noinclude>
{{documentation|content=
 حط هالقالب بأي مقال بيحتاج وصف.  
 بيأخذ معيار واحد، يلي هو صفة بتوصف المقال.  
 مثلاً: {{article-describe|سيء}} رح تطلع  
 '''هالمقال سيء.'''
 }}
</noinclude>

2- إنشاء صفحة توثيق فرعية /doc (الخيار المفضل للقوالب الكبيرة)

• تستخدم للقوالب يلي عندها معايير متعددة أو فيها تفاصيل أكتر.
• قالب {{documentation}} بيضل مستخدم، بس المحتوى المعروض يجي من الصفحة الفرعية /doc بدل ما يكون مكتوب ضمن القالب نفسو.
• مثال:

'''هالمقال {{{1}}}.'''<noinclude>
{{documentation}}
</noinclude>

بهالحالة، كل نص التوثيق بينكتب بصفحة قالب:اسم_القالب/doc، و هيك بيكون القالب نفسو أنظف و أسهل للتعديل بدون تشويش.

الموديولات

أحياناً بيتم استخدام موديولات Lua بدل القوالب لتخزين المواد القابلة لإعادة الاستخدام. الأسباب ورا هالشي بتتضمن استخدام ميزات خاصة بالموديولات متل الحلقات أو القيم المخزنة، و الكود المعقد بالعادة بيكون أسهل للقراءة و الصيانة جوات الموديول. إذا كان الموديول ممكن تنفيذو بسهولة بقالب، فالأفضل إنو يكون قالب، لإنو فيه عدد أكبر من المستخدمين عندون خبرة بتعديل القوالب.

إذا كان الموديول معمول ليتم استخدامه بالمقالات أو بصفحات النقاش، فالأفضل يكون بقالب وسيط لتسهيل الاستخدام بدون الحاجة لاستخدام دالة المحلل #invoke بشكل مباشر. التوثيق بيكون موجود بالغالب بصفحة /doc التابعة للقالب، و توثيق الموديول بيكون بيشير للقالب أو بيشرح تفاصيل تقنية زيادة ما فيه داعي تكون ضمن التوثيق الأساسي للقالب.

القالب الوسيط بيستهلك من حد حجم الإدراج بعد التوسيع أكتر من استدعاء الموديول مباشرة، لهيك ممكن يكون ضروري تجنب استخدامو بالمقالات القريبة من الحد الأقصى.

التدوير عن القوالب

استخدم هالنموذج للبحث ضمن نطاق Template: أو Template_talk:

Template Template_talk