راهنما:الگو

از ArchWiki پارسی
پرش به: ناوبری، جستجو


یک الگو منبعی از پیش تعریف شده است که میتوان آن را در مقاله ها استفاده کرد. کار اصلی الگوها قالب بندی محتوای یک مطلب است.

استفاده

الگوها با قرار دادن نشانه گذاری هایی مانند زیر در مطالب مورد استفاده قرار میگیرند.

{{نام الگو}}

بیشتر الگوها استدلال های اضافی را شامل میشوند. مانند الگو:Note:

{{Note|این متن یک یادداشت است.}}

که به شکل زیر ظاهر میشود:

توجه: این متن یک یادداشت است.

بعضی از الگوها شامل پارامترهای نامیده شده میباشد. مانند الگو:hc:

{{hc|head=/etc/rc.local|output=exit 0}}

که به شکل زیر ظاهر میشود:

/etc/rc.local
exit 0

شکل کلی یک الگو به شکل زیر است:

{{نام الگو|پارامتر۱|پارامتر۲|...|پارامترN}}

جهت خواندن روش استفاده هر الگو به صفحه مخصوص آن الگو مراجعه کنید.


سبک نگارش

  • الگوها به حروف بزرگ و کوچک حساس هستند و باید به همان شکلی که نامگذاری شدند، استفاده شوند. به طور مثال ‎{{Pkg| ... }}‎ و ‎{{ic| ... }}‎ صحیح است. در حالی که ‎{{pkg| ... }}‎ و ‎{{Ic| ... }}‎ صحیح نیست.
  • اطراف نام الگو نباید فاصله باشد. به طول مثال ‎{{نام الگو| ... }}‎ درست است. در حالی که ‎{{ نام الگو | ... }}‎ درست نیست.
  • الگوها نباید طبقه بندی شوند.

رهایی از کاراکترهای قالب شکن

تعدادی کاراکتر وجود دارد که اگر در الگو استفاده شود باعث خراب شدن خروجی الگو میشود. بیشتر این مشکلات با کاراکترهای "=" (علامت مساوی) و "|" (علامت پایپ) اتفاق می‌افتد. راه حال رفع این مشکل در زیر توضیح داده شده است.


پارامترهای نامیده‌شده

اگر فقط مشکل با "=" باشد، راه‌حل توصیه‌شده این است که پارامترهای الگو رو با اسم یا شماره موضعی معرفی کنید. این روش برای معرفی متغیر یا لینکهای خارجی با رشته پرس و جو در URL‌ها مفید است، اما با دیگر کاراکترهایی مثل "|" کار نمیکند. به عنوان مثال:

{{Tip|1=http://www.archusers.ir/?foo=bar}}

یا با پارامترهای چندگانه:

{{hc|1=$ echo "="|2==}}
{{hc|head=$ echo "="|output==}}
$ echo "="
=

تگ‌های nowiki

اگر شما با کاراکترهایی به غیر از "=" مشکل دارید. مانند: "|"، راه حل پیشنهاد شده این است که تمام پارامتر را با تگ ‎<nowiki>‎ محصور کنید. این روش تمام شکل‌های کاراکترها رو نمایش میدهد، اما موتور ویکی دیگر نمیتواند متن نشانه‌گذاری شده را پردازش کند. مانند لینک‌ها و بقیه الگو‌ها. به عنوان مثال:

{{Tip|<nowiki>= | }} https://www.archusers.ir/ {{ic|foo}}</nowiki>}}
نکته: = | }} https://www.archusers.ir {{ic|foo}}

پیوست قسمتی مشخصی شده(یا حتی یک کاراکتر) در تگ‌های nowiki به طور حتم هنوز هم کار میکند. اما این روش زمانی توصیه میشود که قرار باشد لینک یا الگوی مورد نظر به طور معمول(بدون پردازش موتور ویکی) نمایش داده شود. به طور مثال:

{{Tip|<nowiki>= | }}</nowiki> http://www.archusers.ir {{ic|foo}}}}
نکته: = | }} http://www.archusers.ir ‎foo‎

موجودیت‌های HTML

جایگزینی کاراکترهای متخطی با موجودیت‌های HTML متناظر با آنها همیشه جواب می‌دهد، ولی به خاطر اینکه اینکار سبب کم شدن قابلیت خوانا بودن متن منبع می شود، استفاده از آنها فقط در مواردی که راه حل‌های بالا قابل کاربرد نباشند، توصیه می‌شود. به طور مثال:

{{Tip|&#61; &#124; &#125;&#125;}}
نکته: = | }}

ایجاد

توجه:
  • قبل از ساخت یک الگو ایده را در راهنما بحث:الگو مورد بحث قرار دهید.
  • فقط الگوهای مرتبط و مناسب بسازید. اگر قصد ساخت یک الگوی خیلی ویژه را دارید که احتمالا در تعداد محدودی از صفحات مورد استفاده قرار بگیرد، لطفا خود را به زحمت نیاندازید، و از به هم ریختن فضای نام الگو‌ها بپرهیزید.
  • تنها الگوهای موجز و مختصر ایجاد کنید. همیشه طریق آرچ را به یاد داشته باشید: ‎Keep It Simple, Stupid!‎

الگوی زیر به هنگام ساخت الگوی جدید بایستی استفاده شود تا استفاده و ویرایش آن را راحت‌تر نماید:

<noinclude>
{{الگو}}

توضیح مختصری در مورد الگو

== کاربرد ==

<nowiki>{{نام الگو|param1|param2|...|paramN}}</nowiki>

== نمونه ==

{{نام الگو|param1|param2|...|paramN}}</noinclude><includeonly>کد الگو در اینجا قرار می‌گیرد</includeonly>

برای شروع پروسه ساخت، به سادگی به صفحه الگو:نام الگو مراجعه کنید (‎نام الگو‎ را با نام الگوی دلخواه جایگزین کنید)، و سپس ,ویکی تکست‌های مربوطه را ویرایش یا اضافه کنید.

لیست الگوها

الگوهایی که کاربران می توانند مستقیماً در ویکی آرچ استفاده کنند در زیر لیست شده‌اند. بر روی لینک‌ها کلیک کنید تا توضیحات مفصل مربوط به کاربرد آنها را ببینید. برای دیدن یک لیست که همچنین شامل الگو‌های بومی شده و متا الگو‌ها می‌باشد ویژه:تمام صفحه‌ها/الگو:، ویژه:نمایه پیشوندی/الگو: یا ویژه:الگو با بیشترین پیوند را ببینید.

هشدار: لطفاً با الگو‌های موجود آزمایش نکنید. اگر می‌خواهید یک الگوی محافظت نشده را ویرایش کنید، متن الگو را داخل الگو:جعبه‌ماسه‌بازی کپی کنید، و در آنجا ویرایش و امتحان کنید، و زمانیکه بدرستی کار کرد آن را مجدداً در الگوی مورد نظر کپی کنید. شدیداً توصیه می شود (و برای الگو‌های محافظت شده لازم است) که هرگونه تغییری را ابتدا در صفحات گفتگو پیشنهاد کنید.

آزمایشی

الگوهای وضعیت مقاله

الگوهای مقالات مرتبط

الگوهای قالب بندی کد

الگوهای یادداشت

الگوهای متفرقه

الگوهای بسته های نرم افزاری

الگوهای جدول

همچنین ببینید