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

{{زیرصفحه توضیحات}}
<!-- لطفاً رده‌ها را در جای مشخص‌شده در پایین این صفحه، و میان‌ویکی‌ها را در ویکی‌داده قرار دهید ([[ویکی‌هزاره:ویکی‌داده]] را ببینید) -->
{{میانبر|الگو=بله|تغییرمسیر=بله|میان بر|میان‌بر}}
{{پراستفاده|۹۷۴}}
{{لوآ|پودمان:Shortcut|پودمان:Shortcut/config}}
{{الگوسبک|الگو:میانبر/styles.css}}
{{نوار کناری لوآ|پودمان=Shortcut}}
{{انبار|Template:Redirects}}

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

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

برای الگوها، این الگوی میانبر در [[ویکی‌هزاره:مستندسازی الگوها|صفحهٔ توضیحات الگو]] قرار می‌گیرد.

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

# الگوی میانبر را در صفحه قرار دهید. 
# یک صفحهٔ تغییرمسیر ایجاد کنید و الگوی {{الگو|تغییرمسیر از میانبر}} را به پایین صفحهٔ تغییرمسیر اضافه کنید. عنوان صفحه را برابر با نام میانبر مورد نظر خود انتخاب کنید.  نام فضای نام را هم در نام میانبر، و هم در عنوان صفحهٔ تغییرمسیر درج کنید. برای مثال، نام میانبر خود را در قالب عنوان صفحه، و فضای نام مناسب را پیش از نام میانبر جانشین کنید و سپس واژهٔ جادویی <code>#تغییر_مسیر</code> را در نخستین سطر صفحهٔ تغییرمسیر، و الگوی ردهٔ تغییرمسیر را در سطر سوم آن صفحه قرار دهید:
#:<code><nowiki>#تغییر_مسیر [[</nowiki>''فضای نام'':''عنوان صفحه به‌همراه''#''عنوان اختیاری و احتمالاً بسیار طولانی بخش''<nowiki>]]</nowiki><br><br><nowiki>{{تغییرمسیر از میانبر}}</nowiki></code>
# عملکرد تغییرمسیر را بررسی کنید.

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

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

== پارامترها ==
{{الگو|میانبر}} پارامترهای زیر را می‌پذیرد:
* {{code|1}}، {{code|2}}، {{code|3}}... – پیوندهای میانبرها.
* {{code|شناور}} یا {{code|float}} – اگر روی {{code|راست}} تنظیم شود، جعبهٔ میانبر در سمت راست صفحه شناور خواهد شد ({{code|right}} را هم می‌پذیرد).
* {{code|پاک‌کن}} یا {{code|clear}} – اگر روی {{code|left}} (یا {{code|right}} در صورت تنظیم {{پارا|شناور|راست}}) تنظیم شود، جعبهٔ میانبر به‌جای این که کنار عناصر شناور دیگر در کنار پیش از خود قرار گیرد، در زیر آن‌ها قرار خواهد گرفت (مقدار این پارامتر تنها باید انگلیسی باشد؛ زیرا مقدار وارد شده به آن مستقیماً به‌عنوان مقدار صفت clear در سبک‌های سی‌اس‌اس جعبه استفاده می‌شود).
* {{code|پیام}} یا {{code|msg}} – یک پیام بدون پیوند که درست در زیر پیوندهای میانبر قرار می‌گیرد.
* {{code|رده}} یا {{code|category}} – برای فرونشانی رده‌های ردیابی خطا، مقدار این پارامتر را روی مقدارهای منفی نظیر «no»، «خیر»، «false» یا «0» تنظیم کنید.

== نمونه‌ها ==
{|
! کد
! نتیجه
|-
| style="vertical-align:top;" | {{الگوک|{{نام‌صفحه‌مبنا}}|وه:م}}
| {{<!---->{{نام‌صفحه‌مبنا}}|وه:م}}
|-
| style="vertical-align:top;" | {{الگوک|{{نام‌صفحه‌مبنا}}|وه:تأیید|وه:اثبات}}
| {{<!---->{{نام‌صفحه‌مبنا}}|وه:تأیید|وه:اثبات}}
|-
| style="vertical-align:top;" | {{الگوک|{{نام‌صفحه‌مبنا}}|وه:تأیید|وه:اثبات|4=پیام=متن پیام}}
| {{<!---->{{نام‌صفحه‌مبنا}}|وه:تأیید|وه:اثبات|پیام=متن پیام}}
|}

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

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

:<code><nowiki>#تغییر_مسیر [[نام‌صفحه#وه:م]] {{تغییرمسیر از میانبر}}</nowiki></code>

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

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

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

== الگوداده ==
<!-- The <nostrip> comments are necessary to work around bugs in [[Module:Plain text]] -->
{{Format TemplateData|<templatedata>
{
	"description": "این الگو برای نمایش یک یا چند میانبر به صفحه به‌کار می‌رود.",
	"format": "inline",
	"params": {
		"1": {
			"label": "میانبر ۱",
			"description": "میانبر ۱ برای صفحه/بخش",
			"required": true,
			"type": "wiki-page-name"
		},
		"2": {
			"label": "میانبر ۲",
			"description": "میانبر ۲ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"3": {
			"label": "میانبر ۳",
			"description": "میانبر ۳ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"4": {
			"label": "میانبر ۴",
			"description": "میانبر ۴ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"5": {
			"label": "میانبر ۵",
			"description": "میانبر ۵ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"6": {
			"label": "میانبر ۶",
			"description": "میانبر ۶ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"7": {
			"label": "میانبر ۷",
			"description": "میانبر ۷ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"8": {
			"label": "میانبر ۸",
			"description": "میانبر ۸ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"9": {
			"label": "میانبر ۹",
			"description": "میانبر ۹ برای صفحه/بخش",
			"type": "wiki-page-name"
		},
		"تغییرمسیر": {
			"aliases": [
				"redirect"
			],
			"label": "تغییرمسیر؟",
			"description": "اشاره به «میانبرها» به‌عنوان «تغییرمسیرها».",
			"type": "boolean",
			"default": "خیر",
			"autovalue": "بله"
		},
		"الگو": {
			"aliases": [
				"template"
			],
			"label": "الگو؟",
			"description": "تنظیم برای استفاده در میانبرهای الگوها. <p><!--nostrip-->'''همچنین ببینید:''' <code><!--nostrip-->{{[[الگو:میانبر الگو|میانبر الگو]]}}</code></p>",
			"type": "boolean",
			"default": "خیر",
			"autovalue": "بله"
		},
		"مقصد": {
			"aliases": [
				"target"
			],
			"label": "مقصد؟",
			"description": "حذف پارامتر <code><!--nostrip-->redirect=no</code><!--nostrip--> از نشانی صفحهٔ هدف.",
			"type": "boolean",
			"default": "خیر",
			"autovalue": "بله"
		},
		"شناور": {
			"aliases": [
				"float"
			],
			"label": "شناورسازی",
			"description": "مقدار ویژگی <code><!--nostrip-->float</code><!--nostrip--> در زبان سی‌اس‌اس.",
			"type": "string",
			"suggestedvalues": [
				"right",
				"راست",
				"left",
				"چپ"
			],
			"default": "راست",
			"autovalue": ""
		},
		"پاک‌کن": {
			"aliases": [
				"clear"
			],
			"label": "پاک‌کن",
			"description": "مقدار ویژگی <code><!--nostrip-->clear</code><!--nostrip--> در زبان سی‌اس‌اس.",
			"type": "string",
			"suggestedvalues": [
				"left",
				"right",
				"both"
			]
		},
		"رده": {
			"aliases": [
				"category"
			],
			"label": "رده‌بندی",
			"description": "افزودن/نیافزودن صفحه به رده‌های ردیابی خطا در صورت عدم تعیین نام‌های مستعار یا پارامتر <code><!--nostrip-->پیام</code><!--nostrip-->.",
			"type": "boolean",
			"default": "بله",
			"autovalue": "خیر"
		},
		"پیام": {
			"aliases": [
				"msg"
			],
			"label": "پیام",
			"description": "یک پیام بدون پیوند که درست زیر پیوندهای میانبرها قرار می‌گیرد.",
			"type": "content",
			"autovalue": ""
		}
	},
	"paramOrder": [
		"الگو",
		"تغییرمسیر",
		"مقصد",
		"شناور",
		"پاک‌کن",
		"رده",
		"پیام",
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9"
	]
}
</templatedata>}}

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

<includeonly>{{Sandbox other||
<!--لطفاً رده‌ها را زیر این سطر، و میان‌ویکی‌ها را در ویکی‌داده قرار دهید -->
[[رده:الگو:میانبر]]

}}</includeonly>