الگو:میانبر الگو

توضیحات الگو[نمایش] [ویرایش] [تاریخچه] [پاکسازی]

این الگو یک یا چند مورد از تغییرمسیرهای الگو را نمایش می‌دهد (یعنی تغییرمسیرها، که با عنوان «نام‌های مستعار» نیز شناخته می‌شوند؛ مانند آنچه در جعبهٔ سمت راست دیده می‌شود). {{میال}} میانبری است به این الگو، یعنی {{میانبر الگو}}، و می‌تواند مانند آنچه در ویکی‌متن مبدأ این صفحهٔ مستندات دیده می‌شود، به‌جای عنوان اصلی الگو استفاده شود.

استفاده

این الگو را به‌همراه فهرستی از یک یا چند میانبر، که باید با دقت انتخاب شوند، در بالای ویکی‌متن صفحهٔ مستندات (توضیحات) الگو و درست در زیر الگوی {{زیرصفحه توضیحات}} قرار دهید. میانبرهای مذکور در متن ذخیره‌شده و نمایش‌یافته در جعبهٔ میانبرهای این الگو نمایش خواهند یافت و عنوان جعبه بسته به تعداد موارد موجود در فهرست میانبرها، به‌طور خودکار به حالت مفرد یا جمع تبدیل خواهد شد.

انتخاب میانبرها برای نمایش

هرچند که این الگو قابلیت نمایش تا ۱۰ میانبر را دارد، اما توصیه می‌شود که در انتخاب موارد جهت نمایش در جعبهٔ این الگو دقت کنید. حتی در صورت وجود تعداد زیادی تغییرمسیر، حداکثر دو یا سه مورد معمولاً کافی است. با درج کمترین تعداد تغییرمسیرهای ممکن در جعبهٔ میانبرها، به خاطر سپردن آن‌ها آسان‌تر خواهد بود و سازمان‌دهی مستندات الگو نیز بهتر انجام خواهد شد.

فهرست‌کردن سایر میانبرها

سایر میانبرهای الگوها را در بخش «تغییرمسیرها» در توضیحات الگو فهرست کنید. جهت یادآوری، نیازی به فهرست‌کردن تمامی تغییرمسیرها نیست؛ برخی تغییرمسیرها تنها برای حف سوابق نگه‌داشته شده‌اند و برخی دیگر تنها در مواردی نظیر فاصله یا حروف کوچک و بزرگ (در عنوان‌های انگلیسی) با سایر میانبرها تفاوت دارند. نیازی به فهرست‌کردن چنین گونه‌هایی از عنوان میانبرها نیست—تنها نسخه‌های استاندارد و معمول‌ترین‌ها را از میان این گونه‌ها فهرست کنید.

پارامترهای اختیاری

این الگو دارای چندین پارامتر اختیاری است:

• شناور یا float – اگر این پارامتر روی «right» یا «راست» تنظیم شود، جعبهٔ میانبرها، به‌جای قرار گرفتن در سمت چپ (که حالت پیش‌فرض الگو است)، در سمت راست صفحه شناور خواهد شد.
• clear یا پاک‌کن – اگر روی «left» تنظیم شود (و همزمان پارامتر |شناور= نیز روی «چپ» تنظیم شده‌باشد)، جعبه به حاشیهٔ سمت چپ صفحه فشرده خواهد شد و از چسبیدن آن به سمت راست سایر عناصر شناور در چپ جلوگیری خواهد شد. به‌طور مشابه، اگر روی «right» تنظیم شود (و همزمان پارامتر |شناور= نیز روی «راست» تنظیم شده‌باشد)، جعبهٔ میانبرها به سمت راست صفحه فشرده خواهد شد.
• pre یا پیشوند – از این پارامتر می‌توان برای نمایش یک متن پیش از پیوندهای میانبرها و در داخل قلاب‌ها استفاده کرد. از این پارامتر معمولاً برای افزودن عبارت «جا:» استفاده می‌شود. این کار برای نمایش نحو مناسب جهت استفاده از الگو به‌همراه جانشانی انجام می‌شود.
• pre1، pre2 ... یا پیشوند1، پیشوند2، ... – مانند پارامتر قبلی، اما تنها برای افزودن پیشوند مورد نظر به میانبری که شماره‌اش مشخص شده.

نمونه‌های کد ابتدایی

برای نمایش یک میانبر الگو با نام {{خرابکاری-۱}}:

{{میانبر الگو|خرابکاری-۱}}

برای نمایش سه مورد از میانبرهای الگوی {{هبک-خرابکاری/۱}} با نام‌های {{خ-۱}}، {{هبک-خ۱}} و {{خرابکاری-۱}}:

{{میانبر الگو|خ-۱|هبک-خ۱|خرابکاری-۱}}

نمونه به‌همراه پارامتر شناور

استفاده از پارامتر |شناور=راست یا |float=right باعث می‌شود که جعبهٔ تولیدشده توسط این الگو در سمت راست صفحه شناور شود:

{{میانبر الگو|شناور=راست|هبک-خ۱}}

{{میانبر الگو|float=right|هبک-خ۱}}

نمونه به‌همراه متن «جا:» در داخل قلاب‌ها

از این قابلیت الگو معمولاً برای افزودن متنی جهت نمایش چگونگی استفاده از الگو به‌همراه جانشانی استفاده می‌شود.

برای نمایش متن «جا:» پیش از پیوندهای میانبرها، که در داخل قلاب‌ها قرار می‌گیرد، از |پیشوند2=جا: و |پیشوند3=جا: استفاده کنید (ارقام قرار گرفته پس از عبارت «پیشوند» حتماً باید انگلیسی باشند):

{{میانبر الگو|هبک-خ۱|پیشوند2=جا:|خ-۱|پیشوند3=جا:|خرابکاری-۱}}

اگر از پارامتر |پیشوند=جا: استفاده کنید، این پیشوند به تمامی میانبرها افزوده خواهد شد:

{{میانبر الگو|پیشوند=جا:|خ-۱|هبک-خ۱|خرابکاری-۱}}

الگوداده

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

گزارش خطای ماهیانه برای این الگو را ببینید.

الگوداده برای میانبر الگو

جستارهای وابسته

• {{میانبر}} – اعلان استاندارد برای میانبرها.
• {{میانبر سیاست}} – برای میانبرها به بخش‌های صفحه‌های سیاست‌های ویکی‌پدیا.
• {{تغییرمسیر از میانبر الگو}} — الگوی رده تغییرمسیر برای رده‌بندی و برچسب‌زدن تغییرمسیرها
• {{تغییرمسیر الگو}} – به‌طور خودکار تغییرمسیر=بله را تنظیم می‌کند

توضیحات بالا تراگنجانده‌شده از الگو:میانبر الگو/توضیحات است. (ویرایش | تاریخچه)
ویرایشگران می‌توانند در صفحات تمرین (ایجاد | آینه) و آزمایشی (ایجاد) این الگو را آزمایش کنند.
لطفاً رده‌ها را به زیرصفحهٔ /توضیحات بیفزایید. زیرصفحه‌های این الگو.