سانچو:Documentation/doc

سانچو:Documentation subpage سان ڀل نہ کائو.

{{documentation}} سانچو ڪنهن مخصوص سانچي جي دستاويزي ڄاڻ ۽ هدايتن کي رکڻ لاءِ استعمال ٿيندو آهي، عام طور تي ڪنهن /doc ذيلي صفحي مان. هن کي اهڙيءَ طرح به ترتيب ڏئي سگهجي ٿو جو اهو ٻين صفحن مان مواد کڻي، يا سڌو سنئون متن وسيلي ڀريو وڃي.

هن سانچي کي ڪڏهن ۽ ڪيئن استعمال ڪجي، ان بابت تفصيلي هدايتن لاءِ وڪيپيڊيا:سانچي جو دستاويز ڏسو (مختصر صورت: WP:TDOC)۔

هن سانچي جا ٻه حصا آهن: هڪ وڏو "دستاويزي خانو" جنهن جي اندر دستاويز ۽ ان سان گڏ هڪ اوزار-پٽي هوندي آهي (يعني [ڏسو][سنواريو][سوانح][صاف ڪريو] ڳنڍڻيون)، ۽ ٻيو ننڍو "link box" جيڪو دستاويز بابت ميتا ڄاڻ سان گڏ [[وڪيپيڊيا:سانچي جو ريتخانو| ريتخاني ۽ چڪاسڻ واري حالتن جا ڳنڍڻا ڏيکاري ٿو.

هن سانچي جو استعمال سانچن کي محفوظ رکڻ جي سهولت ڏئي ٿو، جتي ضرورت هجي، جڏهن⁠تہ ساڳئي وقت ڪنهن به واپرائيندڙ کي دستاويز ۽ زمرا سنوارڻ جي اجازت ملي ٿي.

عام نحو

عام طور تي، هي سانچو بغير ڪنهن پيرا ميٽر جي استعمال ٿيندو آهي ۽ سانچي واري صفحي جي هيٺان <noinclude>...</noinclude> جي اندر رکيو ويندو آهي (وڌيڪ ڄاڻ لاءِ § Placement and tags ڏسو):

<!-- توهان جي سانچي جي ڪوڊ جي آخري سٽ --><noinclude>
{{Documentation}}
<!-- زمرا /doc ذيلي صفحي ۾ شامل ڪريو -->
</noinclude>

ڪنهن ٻئي صفحي کي ٽرانسڪلوڊ ڪرڻ

جيڪڏهن /doc ذيلي صفحي کان سواءِ ڪنهن ٻئي صفحي کي ٽرانسڪلوڊ ڪرڻو هجي، ته رڳو |1= هن نموني ڏيو:

<!-- توهان جي سانچي جي ڪوڊ جي آخري سٽ --><noinclude>
{{Documentation|سانچو:Other page/doc}}
</noinclude>

ياد رهي ته جڏهن دستاويز مقامي /doc ذيلي صفحي بدران ڪنهن ٻئي صفحي مان کڻو ٿا، تڏهن زمرا سنڀالڻ ڪجهه ڏکيو ٿي پوي ٿو.

|content= پيرا ميٽر جو استعمال

دستاويز کي سڌو سنئون متن جي صورت ۾ به ڏنو وڃي سگهي ٿو، |content= پيرا ميٽر استعمال ڪري:

<!-- توهان جي سانچي جي ڪوڊ جي آخري سٽ --><noinclude>
{{Documentation
 | content =
<!-- سانچي جو دستاويز -->
}}</noinclude>

هن پيرا ميٽر جي استعمال سان اوزار-پٽي ظاهر نه ٿيندي. ياد رهي ته جيڪڏهن /doc ذيلي صفحو موجود هوندو، ته اهو اڃا به link box ۾ ظاهر ٿيندو.

هي به ياد رکو ته جيڪڏهن |1= ۽ |content= ٻئي ڏنا وڃن، ته |content= کي ترجيح ملندي ۽ اهو هميشه دستاويز واري خاني ۾ ڏيکاريو ويندو.

اوسر يافته نحو

سرخي جي موافقت

دستاويزي خاني ۾ سرخي نيم جڳهه موجب بدلجي ويندي آهي. هيٺ هر نيم جڳهه لاءِ اڳواٽ متن ڏنل آهي:

• سانچو نيم جڳهه: سانچي جا دستاويز
• ماڊيول نيم جڳهه: ماڊيول جا دستاويز
• ٻيون نيم جڳهيون: دستاويز

سرخي کي موافق بڻائڻ لاءِ، رڳو |heading= پيرا ميٽر کي پنهنجي پسند موجب مقرر ڪريو، مثال طور |heading=Infobox documentation.

ياد رهي ته جيڪڏهن سرخي heading پيرا ميٽر خالي هجي پر ڏنل هجي (جهڙوڪ |heading=)، ته سرخي ۽ ان سان گڏ اوزار-پٽي ظاهر نه ٿيندي.

|heading-style= پيرا ميٽر ۾ اختياري CSS قيمتون ڏئي سگهجن ٿيون، جيئن |heading-style=font-size:150%;color:red;. ياد رهي ته واڪو نشان " " نه ڏنا وڃن ۽ آخر ۾ سيميڪولن ; ضرور وڌو وڃي.

لنڪ باڪس جي موافقت

لنڪ واري خاني کي موافق بڻائڻ لاءِ، |link box= کي ڪنهن ٻئي متن سان مقرر ڪريو، مثال طور |link box=مٿيون دستاويز پاڻمرادو سانچو:Foo مان تيار ڪيو ويو آهي.

لنڪ وارو خانو لڪائڻ لاءِ، رڳو |link box= کي off تي مقرر ڪريو.

جاچ

|page= پيرا ميٽر استعمال ڪري توهان ڪنهن مخصوص صفحي لاءِ نتيجي جي نقل ڪري سگهو ٿا. مثال طور، جيڪڏهن توهان |page=سانچو:Edit protected ڪوڊ استعمال ڪريو، ته سانچو بلڪل اهڙو ئي ورتاءُ ڪندو ڄڻ اهو صفحي سانچو:Edit protected تي هجي، جنهن ۾ سانچو:Edit protected/doc مان دستاويز ڏيکارڻ، سانچو:Edit protected/sandbox ڏانهن ڳنڍڻ وغيره شامل آهي. هي پيرا ميٽر جاچ لاءِ ڪارآمد آهي ۽ ماڊيول جا ٽيسٽ ڪيس صفحي تي وڏي پيماني تي استعمال ٿيندو آهي.

جاءِ ۽ ٽيگ

هي ڪوڊ سانچي جي ڪوڊ واري صفحي جي بلڪل هيٺان شامل ڪرڻ گهرجي، ۽ <noinclude> کان اڳ ڪا به خالي جاءِ نه هئڻ گهرجي، ڇو ته اهڙيءَ صورت ۾ انهن صفحن تي اضافي خالي جاءِ ظاهر ٿيندي جتي سانچو ٽرانسڪلوڊ ٿئي ٿو:

<!-- توهان جي سانچي جي ڪوڊ جي آخري سٽ --><noinclude>
{{documentation}}
<!-- زمرا /doc ذيلي صفحي ۾ شامل ڪريو -->
</noinclude>

مٿيون متن پاڻمرادو شامل ڪرڻ لاءِ، توهان substitution ڪوڊ وارو شارٽ ڪٽ {{subst:doc-code}} پڻ استعمال ڪري سگهو ٿا.

زمرا ۽ بين الوڪي ڳنڍڻيون

دستاويز ڪٿي رکيل آهي، ان تي دارومدار ڪندي، زمرا ۽ بين الوڪي ڳنڍڻيون سنڀالڻ ڪڏهن ڪڏهن ڏکيو ٿي سگهي ٿو. انهن کي شامل ڪرڻ بابت ڄاڻ لاءِ Wikipedia: سانچو documentation § Categories and interwiki links ڏسو.

فني تفصيل

خودڪار ڪم

جيڪڏهن دستاويزي صفحو موجود نه هجي، ته اوزار-پٽي [create][purge] ڳنڍڻي سان مٽجي ويندي. [create] ڳنڍڻي پاڻمرادو اڳواٽ ڀريل متن سان صفحو ٺاهي ٿي جنهن ۾ بنيادي دستاويزي نحو هوندو آهي. اڳ ڀريل متن /ريتخانو ۽ /آزمائشي حالتن ذريعي ٺاھيل ڳنڍڻين لاءِ به استعمال ٿيندو آهي.

/doc واري [create] ڳنڍڻي لاءِ preload صفحو سانچو:Documentation/preload آهي. /sandbox ۽ /testcases ڳنڍڻين لاءِ preload صفحا سانچو:Documentation/preload-sandbox ۽ سانچو:Documentation/preload-testcases آهن. /sandbox واري [mirror] ڳنڍڻي لاءِ preload صفحو سانچو:Documentation/mirror آهي.

هي سانچو پاڻمرادو ڪنهن محفوظ سانچي واري صفحي تي {{pp-template}} پڻ شامل ڪري ٿو. جڏهن هي سانچو ڪنهن /ريتخانو ذيلي صفحي تي هجي، تڏهن اهو {{سانچو ريتخانو نوٽس}} سانچو پڻ شامل ڪري ٿو.

لنڪ خاني جون خاصيتون

نيم جڳهه موجب، لنڪ خاني ۾ گهٽ خاصيتون ٿي سگهن ٿيون، يا اهو بلڪل ظاهر ئي نه ٿئي. هيٺين جدول ۾ اهو ڏيکاريل آهي:

نيم جڳهه	رويو
سانچو	مڪمل رويو
ماڊيول	مڪمل رويو، ۽ جيڪڏهن صفحو موجود نه هجي ته "create documentation" ڳنڍڻي جو اضافو
واپرائيندڙ	مڪمل رويو
ٻيون نيم جڳهيون	لڪايل، جيستائين |1= ڏنل نه هجي (ان صورت ۾ "مٿيون دستاويز {{{1}}} مان ٽرانسڪلوڊ ٿيل آهي" ڏيکاريو ويندو)

ان کان علاوه، جيڪڏهن |1= يا |content= ڏنل هجي، ته "زمرا /doc ذيلي صفحي ۾ شامل ڪريو" وارو متن ظاهر نه ٿيندو.

موضوعي نيم جڳهيون ۽ بحثي نيم جڳهيون

هي سانچو عام طور تي موضوعي نيم جڳهه ۾ رکيو ويندو آهي. پر ڪجهه حالتن ۾ هن سانچي کي بحثي نيم جڳهه ۾ رکڻ ضروري ٿيندو آهي:

• ميڊياوڪي نيم جڳهه ۾، ڇاڪاڻ⁠تہ <noinclude> گهڻو ڪري نظامي پيغامن ۾ ڪم نٿو ڪري، ۽ ميڊياوڪي نيم جڳهه کي ڪارڪردگي جي سببن جي ڪري صاف رکڻ ضروري هوندو آهي.

جڏهن هي بحث صفحن تي رکيو وڃي، ته عام طور تي اهو صفحي جي مٿئين حصي جي ويجهو ۽ <noinclude>...</noinclude> ٽيگن کان سواءِ رکيو ويندو آهي.

عام طور تي /doc، /ريتخانو ۽ /چڪاسي حالتون صفحا موضوعي نيم جڳهه ۾ هجڻ گهرجن، سواءِ انهن نيم جڳهن جي جتي ميڊياوڪي جي ذيلي صفحي واري خوبي فعال نه هجي: مکيه فائيل، ۽ ميڊياوڪي. (زمرا ذيلي صفحا رکي سگهن ٿا، پر دستاويز زمرو بحث نيم جڳهه ۾ ٺاهيا ويندا آهن ته جيئن خالي زمرا نه ٺهن. ان کان سواءِ به ڪيترا فني سبب آهن جن جي ڪري انهن خاص نيم جڳهن ۾ /doc صفحو ڳالهه واري صفحي هيٺ رکڻو پوي ٿو.)

هي سانچو پاڻمرادو /doc، /ريتخانو ۽ /چڪاسي حالتن لاءِ پنهنجا ڳنڍڻا ٺاھڻ صحيح نيم جڳهه ڏانهن موڙي ٿو.

رنگن جي رٿا

وڪيپيڊيا جا پسمنظر وارا رنگ {{documentation}} لاءِ (Help:Using colors)

	RGB	HSV	رنگ	عام استعمال	نوٽ
A	#ECFCF4	150°, 6%, 99%		نمونو	موجوده دستاويزي پسمنظر
B	#00FF80	Hue=150° (41.7%; 106/255dec) 100%, 100%		بنيادي hue	جنهن کي اسين رنگ چئون ٿا
1	#A3BFB1	150°, 15%, 75%		رڳو سرخيءَ جي ڪنڊ
2	#CEF2E0	150°, 15%, 95%		مکيه ڪنڊ؛ سرخيءَ جو پسمنظر
3	#E6FFF2	150°, 10%, 100%		ٻي سرخي، نمايان رنگ
4	#F5FFFA	150°, 4%, 100%		مکيه پسمنظر	تنهنڪري A ۾ saturation ٿورو مختلف آهي

دستاويزي navbox لاءِ رنگ

هڪ تجويز طور، هتي اهڙا رنگ ڏجن ٿا جيڪي فقط دستاويزي صفحن لاءِ ٺهيل navbox لاءِ مناسب آهن. اهي عام نيري navbox رنگن جي ڇانوَ جي پيروي ڪن ٿا:

| titlestyle = background:#ccffe5;color:inherit;
| basestyle  = background:#ddffee;color:inherit;
<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->

ذيلي گروهن لاءِ، child navboxes ۾:

{{Navbox|child
| groupstyle = background:#e6fff2;color:inherit;
...

مثال:{{Periodic table templates overview}}

مڪمل نحو

{{Documentation}}

يا

{{Documentation
 | [دستاويزي صفحي جو رستو]
}}

{{Documentation
 | content =
}}

يا

{{Documentation
| [دستاويزي صفحي جو رستو]
| heading-style = 
| heading = 
| link box = 
}}

يا 

{{Documentation
| [دستاويزي صفحي جو رستو]
| content = 
| heading-style = 
| heading = 
| link box = 
| page =
}}

پڻ ڏسو

• {{Documentation subpage}}، هڪ نوٽيس جيڪو /doc ذيلي صفحي جي مٿان رکيو ويندو آهي، جيڪو ان جي ڪردار جي وضاحت ڪري ٿو ۽ ان صفحي ڏانهن ڳنڍڻي به ڏئي ٿو جنهن جو اهو دستاويز آهي.
• {{Barnstar documentation}}، {{Documentation}} جو هڪ بدليل روپ، جيڪو barnstar سانچن سان استعمال لاءِ آهي.
• {{Navbox documentation}}، {{Documentation}} جو هڪ بدليل روپ، جيڪو navigation templates سان استعمال لاءِ آهي.
• وڪيپيڊيا:Template documentation سانچي جي دستاويزڪاري بابت هڪ رهنما صفحو آهي.
• وڪيپيڊيا:Template sandbox and test cases /sandbox ۽ /testcases ذيلي صفحن جي استعمال جي وضاحت ڪري ٿو ۽ سانچي جي جاچ بابت وڌيڪ ڄاڻ به ڏئي ٿو.