سانچو:دستاويز/دستاويز

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

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

ھن سانچي کي ڪڏھن ۽ ڪيئن استعمال ڪرڻ بابت تفصيلي ھدايتن لاءِ Wikipedia:Template documentation (شارٽ ڪٽ: WP:TDOC) ڏسو.

ھن سانچي جا ٻہ حصا آھن: وڏو “دستاويزن وارو دٻو” جنھن ۾ دستاويز ۽ ان سان گڏ ھڪ ٽول بار ( [view][edit][history][purge] لنڪس) ھوندا آھن؛ ۽ ننڍو “لنڪ دٻو” جيڪو دستاويزن بابت ميٽا ڊيٽا سان گڏ سينڊباڪس ۽ ٽيسٽ ڪيسز جا لنڪس ڏيکاريندو آھي.

ھن سانچي جو استعمال انھيءَ قابل بڻائيندو آھي تہ سانچا، ضرورت پوڻ تي، محفوظ ڪيا وڃن، ۽ ساڳئي وقت دستاويز ۽ درجا ڪو بہ ايڊيٽر تبديل ڪري سگھي.

عام ترڪيب

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

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

مختلف صفحو ٽرانسڪلوڊ ڪرڻ

جيڪڏھن /doc ذيلي صفحي کانسواءِ ڪو ٻيو صفحو ٽرانسڪلوڊ ڪرڻو ھجي تہ سادو طور |1= ڏيو، مثال:

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

نوٽ: جڏھن دستاويز مقامي /doc ذيلي صفحي کانسواءِ ٻي جاءِ تان لوڊ ٿيندي، تڏھن درجن کي سنڀالڻ ڏکيو ٿي پوندو.

|content= پيرا ميٽر استعمال ڪرڻ

دستاويز سڌو متن طور بہ ڏني وڃي سگھي ٿي، |content= پيرا ميٽر وسيلي:

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

ھن پيرا ميٽر سان ٽول بار نظر نه ايندو. نوٽ: جيڪڏھن /doc ذيلي صفحو موجود آھي تہ لنڪ دٻي ۾ اھو اڃا بہ ڏيکاربو.

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

وڌيڪ ترقي يافته ترڪيب

سرخي کي حسب ضرورت بڻائڻ

دستاويزن واري دٻي جي سرخي نيم اسپيس موجب بدلجي ٿي. ھيٺ ڏنل فھرست ۾ ھر نيم اسپيس لاءِ ڊيفالٽ متن ڏنل آھي:

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

سرخي بدلائڻ لاءِ |heading= ۾ پنھنجو متن ڏيو، مثال طور |heading=انفو باڪس دستاويز.

نوٽ: جيڪڏھن heading پيرا ميٽر خالي ھجي پر ڄاڻايل (مثال |heading=) تہ سرخي ٽول بار سان گڏ نظر نه ايندي.

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

لنڪ دٻي کي حسب ضرورت بڻائڻ

لنڪ دٻي کي بدلائڻ لاءِ |link box= ۾ پنھنجو متن ڏيو، مثال: |link box=مٿي واري دستاويز پاڻمرادو Template:Foo مان تيار ٿئي ٿي.

لنڪ دٻو لڪائڻ لاءِ |link box= کي off رکو.

ٽيسٽ ڪرڻ

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

جڳھ ۽ ٽيگ

مزید معلومات: Wikipedia:Template documentation § Where to place it

ھي ڪوڊ سانچي جي ڪوڊ صفحي جي بلڪل ھيٺان شامل ڪيو وڃي، ۽ <noinclude> کان اڳ ڪا جڳھ نہ ھجي (ڇو تہ اھا اضافي خالي جاءِ اُن صفحن تي نظر ايندي جتي سانچو ٽرانسڪلوڊ ٿئي):

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

ھن متن کي پاڻمرادو داخل ڪرڻ لاءِ اوھان سبسٽيوشن ڪوڊ شارٽ ڪٽ {{subst:doc-code}} بہ استعمال ڪري سگھو ٿا.

درجا ۽ بين الوڪي

دستاويز ڪٿي رکي وئي آھي ان مطابق درجن ۽ بين الوڪي کي سنڀالڻ ڏکيو ٿي سگھي ٿو. ان بابت ڄاڻ لاءِ Wikipedia:Template documentation § Categories and interwiki links ڏسو.

فني تفصيل

پاڻمرادو ڪم ڪندڙ فنڪشنون

جيڪڏھن دستاويز وارو صفحو موجود نہ ھجي تہ ٽول بار جي جاءِ تي [create][purge] لنڪ ڏيکاربو. [create] لنڪ پاڻمرادو پري لوڊ ٿيل متن سان صفحو ٺاھي ٿو جنھن ۾ بنيادي دستاويزي ترڪيب ھوندي. پري لوڊ متن /sandbox ۽ /testcases جي [create] لنڪن لاءِ بہ استعمال ٿيندو آھي.

/doc جي [create] لنڪ لاءِ پري لوڊ صفحو Template:Documentation/preload آھي. /sandbox ۽ /testcases جي [create] لنڪن لاءِ پري لوڊ صفحا Template:Documentation/preload-sandbox ۽ Template:Documentation/preload-testcases آھن. /sandbox جي [mirror] لنڪ لاءِ پري لوڊ صفحو Template:Documentation/mirror آھي.

ھي سانچو محفوظ ٿيل سانچي جي صفحي تي پاڻمرادو {{pp-template}} بہ شامل ڪندو آھي. جڏھن ھي سانچو /sandbox ذيلي صفحي تي ھوندو تہ اھو {{Template sandbox notice}} سانچو بہ شامل ڪندو آھي.

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

نيم اسپيس موجب لنڪ دٻي ۾ گھٽ خاصيتون ٿي سگھن ٿيون يا اھو مڪمل طور لڪل بہ ٿي سگھي ٿو. ھيٺ ڏنل جدول اھو ڏيکاري ٿو:

نيم اسپيس	رويو
Template	مڪمل رويو
Module	مڪمل رويو، ۽ اضافي طور “دستاويز ٺاھيو” لنڪ جڏھن صفحو موجود نہ ھجي
User	مڪمل رويو
ٻيا نيم اسپيس	لڪل، جيستائين |1= نہ ڏنو وڃي (جنھن سان “مٿي واري دستاويز {{{1}}} مان ٽرانسڪلوڊ ٿيل آھي” ڏيکاربو)

ان سان گڏ، جيڪڏھن |1= يا |content= ڏنل ھجي تہ “درجا /doc ذيلي صفحي ۾ شامل ڪريو” وارو متن نظر نہ ايندو.

موضوع نيم اسپيسون بمقابلہ ٽاڪ نيم اسپيسون

ھي سانچو عام طور موضوع نيم اسپيس ۾ رکيو ويندو آھي. پر ڪي صورتون اھڙيون آھن جتي ھن کي ٽاڪ نيم اسپيس ۾ رکڻ ضروري ھوندو آھي:

• MediaWiki نيم اسپيس ۾، ڇو تہ <noinclude> گھڻن سسٽم پيغامن ۾ ڪم نٿو ڪري، ۽ MediaWiki نيم اسپيس کي ڪارڪردگي سبب صاف رکڻ ضروري آھي.

جڏھن ٽاڪ صفحن تي رکيو وڃي، تہ ھي سانچو عام طور صفحي جي مٿان رکيو ويندو آھي ۽ <noinclude>...</noinclude> ٽيگ کان سواءِ.

/doc، /sandbox ۽ /testcases صفحا عام طور موضوع نيم اسپيس ۾ ھجڻ گھرجن، سواءِ انھن نيم اسپيسن جي جن ۾ MediaWiki جي ذيلي صفحي واري خصوصيت فعال ناھي: Main، File، ۽ MediaWiki. (درجن جا ذيلي صفحا ٿي سگھن ٿا، پر دستاويز Category talk نيم اسپيس ۾ ٺھندي آھي جيئن خالي درجا نہ ٺھن. ٻيا بہ ڪيترائي فني سبب آھن جنڪري انھن (۽ رڳو انھن) نيم اسپيسن لاءِ /doc صفحو ٽاڪ صفحي ھيٺ رکڻو پوي ٿو.)

ھي سانچو /doc، /sandbox ۽ /testcases لاءِ پنھنجا [create] لنڪ پاڻمرادو درست نيم اسپيس ڏانھن اشارو ڪندو آھي.

رنگن جو خاڪو

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

	آر جي بي	ايڇ ايس وي	رنگ	عام استعمال	نوٽ
A	#ECFCF4	150°, 6%, 99%		نمونو	موجوده دستاويزن جو پسمنظر
B	#00FF80	Hue=150° (41.7%; 106/255dec) 100%, 100%		بنيادي ھيو	جنھن کي اسين ”رنگ“ چونداسين
1	#A3BFB1	150°, 15%, 75%		فقط ھيڊر بارڊر
2	#CEF2E0	150°, 15%, 95%		مکيه بارڊر؛ ھيڊر پسمنظر
3	#E6FFF2	150°, 10%, 100%		ٻيو ھيڊر، ايڪسينٽ رنگ
4	#F5FFFA	150°, 4%, 100%		مکيه پسمنظر	تنھنڪري A ۾ سچوريشن ٿورو غير ھموار آھي

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

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

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

ذيلي گروپن لاءِ، چائلڊ نيو باڪس ۾:

{{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}} جو ھڪ روپ جيڪو بارن اسٽار سانچن لاءِ استعمال ٿيندو آھي.
• {{Navbox documentation}}، {{Documentation}} جو ھڪ روپ جيڪو نيويگيشن سانچن لاءِ استعمال ٿيندو آھي.
• Wikipedia:Template documentation سانچي جي دستاويزن بابت ھائو ٽُو ھدايتون.
• Wikipedia:Template sandbox and test cases /sandbox ۽ /testcases ذيلي صفحن جي استعمال جي وضاحت ڪندو آھي ۽ سانچي جي ٽيسٽ بابت وڌيڪ ڄاڻ ڏيندو آھي.