المعرفة:توثيق قالب

(تم التحويل من المعرفة:Template documentation)

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

توثيق قالب ما ينبغي أن يغطي:

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

كيفية إنشاء صفحة توثيق

عنوان صفحة التوثيق يكون هو نفسه عنوان صفحة القالب مضافا إليه /شرح في نهايته.

في صفحة القالب، اكتب {{توثيق}} وضعها بين الرمزين: <noinclude>…</noinclude>. ثم في صفحة التوثيق (التي تنتهي برمز /شرح)، أضف أية تفاصيل تود إضافتها مع مراعاة التالي:

  • في أعلى الصفحة، أضف {{صفحة توثيق فرعية}}
  • في أسفل الصفحة، أضف التصنيفات والإنترويكي وضعها بين الرمزين: <includeonly>…</includeonly>.

المخطط التالي يوضح هذا:

{{صفحة توثيق فرعية}}

== الاستخدام ==

== أمثلة ==

== انظر أيضا ==


<includeonly>

<!-- التصنيفات والإنترويكي هنا -->

</includeonly>