الگو:میانبر/توضیحات

این مستندات برای {{میانبر}} و الگوهای خواهر آن است. الگوی {{میانبر}} جعبه‌ای را برای اطلاع‌رسانی به ویرایشگران دربارهٔ وجود میانبرهایی برای پیونددهی به یک صفحه یا بخشی از یک صفحه، تولید می‌کنند.

خانوادهٔ الگوهای میانبر در اینجا توصیف شده‌اند، اما هریک از آن‌ها صفحهٔ مستندات اختصاصی خود را دارند؛ بخش جستارهای وابسته را ببینید. الگوی میانبر مشابه الگوی {{لنگر}} است، با این تفاوت که یک جعبهٔ گرافیکی بصری را به صفحهٔ مورد نظر اضافه می‌کند و به‌واسطهٔ آن، یک نام جایگزین را نیز برای صفحه تعریف می‌کند. برای تکمیل سازوکار میانبر زدن به صفحه‌ها، ایجاد یک صفحهٔ تغییرمسیر نیز الزامی است.

برای الگوها، این الگوی میانبر در صفحهٔ توضیحات الگو قرار می‌گیرد.

استفاده

از این الگو نباید در مقاله‌های موجود در فضای نام اصلی استفاده کرد؛ چرا که رابط گرافیکی الگو، باعث ایجاد خودارجاعی می‌شود.

1. الگوی میانبر را در صفحه قرار دهید.
2. یک صفحهٔ تغییرمسیر ایجاد کنید و الگوی {{تغییرمسیر از میانبر}} را به پایین صفحهٔ تغییرمسیر اضافه کنید. عنوان صفحه را برابر با نام میانبر مورد نظر خود انتخاب کنید. نام فضای نام را هم در نام میانبر، و هم در عنوان صفحهٔ تغییرمسیر درج کنید. برای مثال، نام میانبر خود را در قالب عنوان صفحه، و فضای نام مناسب را پیش از نام میانبر جانشین کنید و سپس واژهٔ جادویی #تغییر_مسیر را در نخستین سطر صفحهٔ تغییرمسیر، و الگوی ردهٔ تغییرمسیر را در سطر سوم آن صفحه قرار دهید:

   #تغییر_مسیر [[فضای نام:عنوان صفحه به‌همراه#عنوان اختیاری و احتمالاً بسیار طولانی بخش]]

{{تغییرمسیر از میانبر}}

3. عملکرد تغییرمسیر را بررسی کنید.

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

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

پارامترها

{{میانبر}} پارامترهای زیر را می‌پذیرد:

• <syntaxhighlight lang="text" class="" id="" style="" inline="1">1</syntaxhighlight>، <syntaxhighlight lang="text" class="" id="" style="" inline="1">2</syntaxhighlight>، <syntaxhighlight lang="text" class="" id="" style="" inline="1">3</syntaxhighlight>... – پیوندهای میانبرها.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">شناور</syntaxhighlight> یا <syntaxhighlight lang="text" class="" id="" style="" inline="1">float</syntaxhighlight> – اگر روی <syntaxhighlight lang="text" class="" id="" style="" inline="1">راست</syntaxhighlight> تنظیم شود، جعبهٔ میانبر در سمت راست صفحه شناور خواهد شد (<syntaxhighlight lang="text" class="" id="" style="" inline="1">right</syntaxhighlight> را هم می‌پذیرد).
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">پاک‌کن</syntaxhighlight> یا <syntaxhighlight lang="text" class="" id="" style="" inline="1">clear</syntaxhighlight> – اگر روی <syntaxhighlight lang="text" class="" id="" style="" inline="1">left</syntaxhighlight> (یا <syntaxhighlight lang="text" class="" id="" style="" inline="1">right</syntaxhighlight> در صورت تنظیم |شناور=راست) تنظیم شود، جعبهٔ میانبر به‌جای این که کنار عناصر شناور دیگر در کنار پیش از خود قرار گیرد، در زیر آن‌ها قرار خواهد گرفت (مقدار این پارامتر تنها باید انگلیسی باشد؛ زیرا مقدار وارد شده به آن مستقیماً به‌عنوان مقدار صفت clear در سبک‌های سی‌اس‌اس جعبه استفاده می‌شود).
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">پیام</syntaxhighlight> یا <syntaxhighlight lang="text" class="" id="" style="" inline="1">msg</syntaxhighlight> – یک پیام بدون پیوند که درست در زیر پیوندهای میانبر قرار می‌گیرد.
• <syntaxhighlight lang="text" class="" id="" style="" inline="1">رده</syntaxhighlight> یا <syntaxhighlight lang="text" class="" id="" style="" inline="1">category</syntaxhighlight> – برای فرونشانی رده‌های ردیابی خطا، مقدار این پارامتر را روی مقدارهای منفی نظیر «no»، «خیر»، «false» یا «0» تنظیم کنید.

نمونه‌ها

کد	نتیجه
{{میانبر|وپ:م}}
{{میانبر|وپ:تأیید|وپ:اثبات}}
{{میانبر|وپ:تأیید|وپ:اثبات|پیام=متن پیام}}

لنگرها

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

این موضوع، ایجاد میانبری برای بخشی از یک صفحه را آسان‌تر می‌کند؛ چرا که می‌توانید در زمان ایجاد خود صفحهٔ تغییرمسیر به لنگر ایجادشده توسط الگو پیوند دهید. مانند نمونهٔ زیر:

#تغییر_مسیر [[نام‌صفحه#وپ:م]] {{تغییرمسیر از میانبر}}

محل قرارگیری

این الگو معمولاً در زیر عنوان بخش یا در بالای صفحه‌ها قرار داده می‌شود.

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

• قرار دادن الگوی میانبر در بالای عنوان بخش که در زمان ویرایش صفحه، کمی گیج‌کننده بود
• ایجاد تغییرمسیر به هدف عنوان بخش و نه خود میانبر؛ این کار باعث می‌شد تا در صورت تغییر عنوان بخش، پیوندها بشکنند
• قرار دادن یک {{لنگر}} در عنوان صفحه که میانبر را تکرار کند

اکنون دیگر نیازی به استفاده از این راه حل‌ها نیست، اما استفاده از آن‌ها تأثیری نیز بر پیاده‌سازی کنونی نخواهد داشت.

الگوداده

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

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

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

این الگو برای نمایش یک یا چند میانبر به صفحه به‌کار می‌رود.

⧼templatedata-doc-param-name⧽		⧼templatedata-doc-param-desc⧽	⧼templatedata-doc-param-type⧽	⧼templatedata-doc-param-status⧽
میانبر ۱	1	میانبر ۱ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-required⧽
میانبر ۲	2	میانبر ۲ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۳	3	میانبر ۳ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۴	4	میانبر ۴ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۵	5	میانبر ۵ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۶	6	میانبر ۶ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۷	7	میانبر ۷ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۸	8	میانبر ۸ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
میانبر ۹	9	میانبر ۹ برای صفحه/بخش	⧼templatedata-doc-param-type-wiki-page-name⧽	⧼templatedata-doc-param-status-optional⧽
تغییرمسیر؟	تغییرمسیر redirect	اشاره به «میانبرها» به‌عنوان «تغییرمسیرها». ⧼templatedata-doc-param-default⧽ خیر ⧼templatedata-doc-param-autovalue⧽ بله	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
الگو؟	الگو template	تنظیم برای استفاده در میانبرهای الگوها. همچنین ببینید: {{میانبر الگو}} ⧼templatedata-doc-param-default⧽ خیر ⧼templatedata-doc-param-autovalue⧽ بله	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
مقصد؟	مقصد target	حذف پارامتر redirect=no از نشانی صفحهٔ هدف. ⧼templatedata-doc-param-default⧽ خیر ⧼templatedata-doc-param-autovalue⧽ بله	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
شناورسازی	شناور float	مقدار ویژگی float در زبان سی‌اس‌اس. ⧼templatedata-doc-param-suggestedvalues⧽ right راست left چپ ⧼templatedata-doc-param-default⧽ راست	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-optional⧽
پاک‌کن	پاک‌کن clear	مقدار ویژگی clear در زبان سی‌اس‌اس. ⧼templatedata-doc-param-suggestedvalues⧽ left right both	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-optional⧽
رده‌بندی	رده category	افزودن/نیافزودن صفحه به رده‌های ردیابی خطا در صورت عدم تعیین نام‌های مستعار یا پارامتر پیام. ⧼templatedata-doc-param-default⧽ بله ⧼templatedata-doc-param-autovalue⧽ خیر	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
پیام	پیام msg	یک پیام بدون پیوند که درست زیر پیوندهای میانبرها قرار می‌گیرد.	⧼templatedata-doc-param-type-content⧽	⧼templatedata-doc-param-status-optional⧽

قالب: inline

آزمایش خروجی خام الگوداده:

<templatedata>{"format":"inline","description":"این الگو برای نمایش یک یا چند میانبر به صفحه به‌کار می‌رود.","paramOrder":["الگو","تغییرمسیر","مقصد","شناور","پاک‌کن","رده","پیام","1","2","3","4","5","6","7","8","9"],

"params":{ "1":{"description":"میانبر ۱ برای صفحه/بخش","type":"wiki-page-name","required":true,"label":"میانبر ۱"},

"2":{"type":"wiki-page-name","description":"میانبر ۲ برای صفحه/بخش","label":"میانبر ۲"},

"3":{"type":"wiki-page-name","description":"میانبر ۳ برای صفحه/بخش","label":"میانبر ۳"},

"4":{"type":"wiki-page-name","description":"میانبر ۴ برای صفحه/بخش","label":"میانبر ۴"},

"5":{"type":"wiki-page-name","description":"میانبر ۵ برای صفحه/بخش","label":"میانبر ۵"},

"6":{"type":"wiki-page-name","description":"میانبر ۶ برای صفحه/بخش","label":"میانبر ۶"},

"7":{"type":"wiki-page-name","description":"میانبر ۷ برای صفحه/بخش","label":"میانبر ۷"},

"8":{"type":"wiki-page-name","description":"میانبر ۸ برای صفحه/بخش","label":"میانبر ۸"},

"9":{"type":"wiki-page-name","description":"میانبر ۹ برای صفحه/بخش","label":"میانبر ۹"},

"تغییرمسیر":{"type":"boolean","description":"اشاره به «میانبرها» به‌عنوان «تغییرمسیرها».","label":"تغییرمسیر؟","autovalue":"بله","default":"خیر","aliases":["redirect"]},

"الگو":{"type":"boolean","description":"تنظیم برای استفاده در میانبرهای الگوها. همچنین ببینید: {{میانبر الگو}}","label":"الگو؟","autovalue":"بله","default":"خیر","aliases":["template"]},

"مقصد":{"type":"boolean","description":"حذف پارامتر redirect=no از نشانی صفحهٔ هدف.","label":"مقصد؟","autovalue":"بله","default":"خیر","aliases":["target"]},

"شناور":{"type":"string","description":"مقدار ویژگی float در زبان سی‌اس‌اس.","label":"شناورسازی","autovalue":"","default":"راست","suggestedvalues":["right","راست","left","چپ"],"aliases":["float"]},

"پاک‌کن":{"type":"string","description":"مقدار ویژگی clear در زبان سی‌اس‌اس.","label":"پاک‌کن","suggestedvalues":["left","right","both"],"aliases":["clear"]},

"رده":{"type":"boolean","description":"افزودن/نیافزودن صفحه به رده‌های ردیابی خطا در صورت عدم تعیین نام‌های مستعار یا پارامتر پیام.","label":"رده‌بندی","autovalue":"خیر","default":"بله","aliases":["category"]},

"پیام":{"type":"content","description":"یک پیام بدون پیوند که درست زیر پیوندهای میانبرها قرار می‌گیرد.","label":"پیام","autovalue":"","aliases":["msg"]} }

}</templatedata>

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

• ویکی‌پدیا:میانبر – رهنمود و راهنما پیرامون زمان و و چگونگی ایجاد میانبرها و جعبه‌های میانبر. خواندن این صفحه به هر کاربری که با میانبرها کار می‌کند، توصیه می‌شود.
• {{لنگر}} – راهی جایگزین برای پیوند دادن به بخش‌ها به‌جای استفاده از عنوان خود بخش‌ها که ممکن است تغییر کنند
• {{تغییرمسیر از میانبر}} – برای قرار دادن در صفحهٔ تغییرمسیر و رده‌بندی خود صفحهٔ تغییرمسیر
• {{میانبر الگو}} – برای فهرست‌کردن میانبرها/تغییرمسیرها به یک صفحهٔ الگو کاربرد دارد
• {{جعبه پیوند کوتاه}} – برای پیوندهای اینترنتی کوتاهی که توسط کوتاه‌کنندهٔ پیوند بنیاد ویکی‌مدیا تولید شده‌اند