الگو:میانبر الگو
 | این الگو در تعداد زیادی صفحه صفحه به‌کار رفته است و تغییر دادن آن می‌تواند تأثیرات گسترده‌ای داشته باشد. لطفاً تغییرات را در زیرصفحه‌های /تمرین یا /آزمایشی الگو، یا در زیرصفحهٔ کاربری خودتان بیازمایید. توصیه می‌شود که ابتدا در خصوص تغییرات مورد نظر در صفحهٔ بحث گفتگو کرده و سپس آن‌ها را پیاده‌سازی کنید. |
 | این الگو از لوآ استفاده می‌کند: |
این الگو یک یا چند مورد از تغییرمسیرهای الگو را نمایش می‌دهد (یعنی تغییرمسیرها، که با عنوان «نام‌های مستعار» نیز شناخته می‌شوند؛ مانند آنچه در جعبهٔ سمت راست دیده می‌شود). {{میال}} میانبری است به این الگو، یعنی {{میانبر الگو}}، و می‌تواند مانند آنچه در ویکی‌متن مبدأ این صفحهٔ مستندات دیده می‌شود، به‌جای عنوان اصلی الگو استفاده شود.
استفاده
[ویرایش]این الگو را به‌همراه فهرستی از یک یا چند میانبر، که باید با دقت انتخاب شوند، در بالای ویکی‌متن صفحهٔ مستندات (توضیحات) الگو و درست در زیر الگوی {{زیرصفحه توضیحات}} قرار دهید. میانبرهای مذکور در متن ذخیره‌شده و نمایش‌یافته در جعبهٔ میانبرهای این الگو نمایش خواهند یافت و عنوان جعبه بسته به تعداد موارد موجود در فهرست میانبرها، به‌طور خودکار به حالت مفرد یا جمع تبدیل خواهد شد.
انتخاب میانبرها برای نمایش
[ویرایش]هرچند که این الگو قابلیت نمایش تا ۱۰ میانبر را دارد، اما توصیه می‌شود که در انتخاب موارد جهت نمایش در جعبهٔ این الگو دقت کنید. حتی در صورت وجود تعداد زیادی تغییرمسیر، حداکثر دو یا سه مورد معمولاً کافی است. با درج کمترین تعداد تغییرمسیرهای ممکن در جعبهٔ میانبرها، به خاطر سپردن آن‌ها آسان‌تر خواهد بود و سازمان‌دهی مستندات الگو نیز بهتر انجام خواهد شد.
فهرست‌کردن سایر میانبرها
[ویرایش]سایر میانبرهای الگوها را در بخش «تغییرمسیرها» در توضیحات الگو فهرست کنید. جهت یادآوری، نیازی به فهرست‌کردن تمامی تغییرمسیرها نیست؛ برخی تغییرمسیرها تنها برای حف سوابق نگه‌داشته شده‌اند و برخی دیگر تنها در مواردی نظیر فاصله یا حروف کوچک و بزرگ (در عنوان‌های انگلیسی) با سایر میانبرها تفاوت دارند. نیازی به فهرست‌کردن چنین گونه‌هایی از عنوان میانبرها نیست—تنها نسخه‌های استاندارد و معمول‌ترین‌ها را از میان این گونه‌ها فهرست کنید.
پارامترهای اختیاری
[ویرایش]این الگو دارای چندین پارامتر اختیاری است:
- شناور یا float – اگر این پارامتر روی «right» یا «راست» تنظیم شود، جعبهٔ میانبرها، به‌جای قرار گرفتن در سمت چپ (که حالت پیش‌فرض الگو است)، در سمت راست صفحه شناور خواهد شد.
- clear یا پاک‌کن – اگر روی «left» تنظیم شود (و همزمان پارامتر
|شناور=نیز روی «چپ» تنظیم شده‌باشد)، جعبه به حاشیهٔ سمت چپ صفحه فشرده خواهد شد و از چسبیدن آن به سمت راست سایر عناصر شناور در چپ جلوگیری خواهد شد. به‌طور مشابه، اگر روی «right» تنظیم شود (و همزمان پارامتر|شناور=نیز روی «راست» تنظیم شده‌باشد)، جعبهٔ میانبرها به سمت راست صفحه فشرده خواهد شد. - pre یا پیشوند – از این پارامتر می‌توان برای نمایش یک متن پیش از پیوندهای میانبرها و در داخل قلاب‌ها استفاده کرد. از این پارامتر معمولاً برای افزودن عبارت «جا:» استفاده می‌شود. این کار برای نمایش نحو مناسب جهت استفاده از الگو به‌همراه جانشانی انجام می‌شود.
- pre1، pre2 ... یا پیشوند1، پیشوند2، ... – مانند پارامتر قبلی، اما تنها برای افزودن پیشوند مورد نظر به میانبری که شماره‌اش مشخص شده.
نمونه‌های کد ابتدایی
[ویرایش]برای نمایش یک میانبر الگو با نام {{خرابکاری-۱}}:
{{میانبر الگو|خرابکاری-۱}}
برای نمایش سه مورد از میانبرهای الگوی {{هبک-خرابکاری/۱}} با نام‌های {{خ-۱}}، {{هبک-خ۱}} و {{خرابکاری-۱}}:
{{میانبر الگو|خ-۱|هبک-خ۱|خرابکاری-۱}}
نمونه به‌همراه پارامتر شناور
[ویرایش]استفاده از پارامتر |شناور=راست یا |float=right باعث می‌شود که جعبهٔ تولیدشده توسط این الگو در سمت راست صفحه شناور شود:
{{میانبر الگو|شناور=راست|هبک-خ۱}}
{{میانبر الگو|float=right|هبک-خ۱}}
نمونه به‌همراه متن «جا:» در داخل قلاب‌ها
[ویرایش]از این قابلیت الگو معمولاً برای افزودن متنی جهت نمایش چگونگی استفاده از الگو به‌همراه جانشانی استفاده می‌شود.
برای نمایش متن «جا:» پیش از پیوندهای میانبرها، که در داخل قلاب‌ها قرار می‌گیرد، از |پیشوند2=جا: و |پیشوند3=جا: استفاده کنید (ارقام قرار گرفته پس از عبارت «پیشوند» حتماً باید انگلیسی باشند):
{{میانبر الگو|هبک-خ۱|پیشوند2=جا:|خ-۱|پیشوند3=جا:|خرابکاری-۱}}
اگر از پارامتر |پیشوند=جا: استفاده کنید، این پیشوند به تمامی میانبرها افزوده خواهد شد:
{{میانبر الگو|پیشوند=جا:|خ-۱|هبک-خ۱|خرابکاری-۱}}
الگوداده
[ویرایش]الگوداده میانبر الگو
این الگو برای نمایش یک یا چند مورد از میانبرهای الگوها کاربرد دارد.
| پارامتر | توضیحات | نوع | وضعیت | |
|---|---|---|---|---|
| میانبر ۱ | 1 | میانبر ۱ برای الگو | نام صفحه | ضروری |
| میانبر ۲ | 2 | میانبر ۲ برای الگو | نام صفحه | اختیاری |
| میانبر ۳ | 3 | میانبر ۳ برای الگو | نام صفحه | اختیاری |
| میانبر ۴ | 4 | میانبر ۴ برای الگو | نام صفحه | اختیاری |
| میانبر ۵ | 5 | میانبر ۵ برای الگو | نام صفحه | اختیاری |
| میانبر ۶ | 6 | میانبر ۶ برای الگو | نام صفحه | اختیاری |
| میانبر ۷ | 7 | میانبر ۷ برای الگو | نام صفحه | اختیاری |
| میانبر ۸ | 8 | میانبر ۸ برای الگو | نام صفحه | اختیاری |
| میانبر ۹ | 9 | میانبر ۹ برای الگو | نام صفحه | اختیاری |
| تغییرمسیر؟ | تغییرمسیر redirect | اشاره به «میانبرها» به‌عنوان «تغییرمسیرها».
| بولی | اختیاری |
| مقصد؟ | مقصد target | حذف پارامتر redirect=no از نشانی صفحهٔ هدف.
| بولی | اختیاری |
| شناورسازی | شناور float | مقدار ویژگی float در زبان سی‌اس‌اس.
| رشته | اختیاری |
| پاک‌کن | پاک‌کن clear | مقدار ویژگی clear در زبان سی‌اس‌اس.
| رشته | اختیاری |
| رده‌بندی | رده category | افزودن/نیافزودن صفحه به رده‌های ردیابی خطا در صورت عدم تعیین نام‌های مستعار یا پارامتر «پیام».
| بولی | اختیاری |
| پیام | پیام msg | یک پیام بدون پیوند که درست زیر پیوندهای میانبرها قرار می‌گیرد.
| محتوا | اختیاری |
| پیشوند پیش‌فرض | پیشوند pre | پیشوند پیش‌فرض برای افزودن به قبل از عنوان میانبر
| رشته | اختیاری |
| پیشوند اول | پیشوند1 pre1 | پیشوند برای اولین میانبر الگو
| رشته | اختیاری |
| پیشوند دوم | پیشوند2 pre2 | پیشوند برای دومین میانبر الگو
| رشته | اختیاری |
| پیشوند سوم | پیشوند3 pre3 | پیشوند برای سومین میانبر الگو
| رشته | اختیاری |
| پیشوند چهارم | پیشوند4 pre4 | پیشوند برای چهارمین میانبر الگو
| رشته | اختیاری |
| پیشوند پنجم | پیشوند5 pre5 | پیشوند برای پنجمین میانبر الگو
| رشته | اختیاری |
| پیشوند ششم | پیشوند6 pre6 | پیشوند برای ششمین میانبر الگو
| رشته | اختیاری |
| پیشوند هفتم | پیشوند7 pre7 | پیشوند برای هفتمین میانبر الگو
| رشته | اختیاری |
| پیشوند هشتم | پیشوند8 pre8 | پیشوند برای هشتمین میانبر الگو
| رشته | اختیاری |
| پیشوند نهم | پیشوند9 pre9 | پیشوند برای نهمین میانبر الگو
| رشته | اختیاری |
جستارهای وابسته
[ویرایش]- {{میانبر}} – اعلان استاندارد برای میانبرها.
- {{میانبر سیاست}} – برای میانبرها به بخش‌های صفحه‌های سیاست‌های ویکی‌پدیا.
- {{تغییرمسیر از میانبر الگو}} — الگوی رده تغییرمسیر برای رده‌بندی و برچسب‌زدن تغییرمسیرها
- {{تغییرمسیر الگو}} – به‌طور خودکار
تغییرمسیر=بلهرا تنظیم می‌کند