پودمان:Section link

این پودمان پیوندهایی را به صفحه‌ها ایجاد می‌کند که به‌درستی با نماد «§» به‌جای نماد پیش‌فرض «#» قالب‌بندی شده‌اند.

استفاده

از داخل ویکی‌متن

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

از داخل پودمان‌های لوآ

پیش از هر چیز پودمان را بارگیری کنید:

local mSectionLink = require('Module:Section link')

سپس می‌توانید با استفاده از تابع ‎_main پیوند بخش بسازید.

mSectionLink._main(page, sections, options, title)

پارامترها:

page - عنوان صفحه برای پیونددهی. مقدار پیش‌فرض این پارامتر برابر با نام کامل صفحهٔ واردشده به پارامتر title است و در صورت عدم تعریف پارامتر title، مقدار پیش‌فرض آن برابر با عنوان کامل صفحهٔ کنونی است.
sections - آرایه‌ای از نام بخش‌ها برای پیونددهی، یا نام یک بخش در قالب رشته برای پیونددهی.
options - جدولی از گزینه‌ها. فیلدهای زیر را می‌پذیرد:
- nopage - برای اجتناب از نمایش نام صفحهٔ مبنا در پیوندهای تولیدشده، این پارامتر را روی true تنظیم کنید.
title - یک شیء mw.title برای استفاده به‌جای عنوان کنونی. برای کاربردهای آزمایشی تعبیه شده‌است.

استفاده از تمامی پارامترها اختیاری است.

نمونه‌ها

کد لوآ	کد ویکی‌متن	نتیجه
`mSectionLink('پاریس')`	`{{پیوند بخش\|پاریس}}`	پاریس § یادداشت‌ها
`mSectionLink('پاریس', 'معماری')`	`{{پیوند بخش\|پاریس\|معماری}}`	پاریس § معماری
`mSectionLink('پاریس', {'معماری', 'فرهنگ و هنر'})`	`{{پیوند بخش\|پاریس\|معماری\|فرهنگ و هنر}}`	پاریس §§ معماری و فرهنگ و هنر
`mSectionLink('پاریس', {'معماری', 'فرهنگ و هنر', 'ورزش'})`	`{{پیوند بخش\|پاریس\|معماری\|فرهنگ و هنر\|ورزش}}`	پاریس §§ معماری، فرهنگ و هنر، و ورزش
`mSectionLink('پاریس', {'معماری', 'فرهنگ و هنر', 'ورزش'}, {nopage = true})`	`{{پیوند بخش\|پاریس\|معماری\|فرهنگ و هنر\|ورزش\|بدون صفحه=بله}}`	§§ معماری، فرهنگ و هنر، و ورزش

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

نویسهٔ مورد استفاده، الگو:Unichar/main است.

-- This module implements {{section link}}.
require('Module:No globals');

local checkType = require('libraryUtil').checkType

local p = {}

local function makeSectionLink(page, section, display)
	display = display or section
	page = page or ''
	-- MediaWiki doesn't allow these in `page`, so only need to do for `section`
	if type(section) == 'string' then
		section = mw.ustring.gsub(section, "{", "&#x7B;")
		section = mw.ustring.gsub(section, "}", "&#x7D;")
	end
	return mw.ustring.format('[[%s#%s|%s]]', page, section, display)
end

local function normalizeTitle(title)
	title = mw.ustring.gsub(mw.ustring.gsub(title, "'", ""), '"', '')
	title = mw.ustring.gsub(title, "%b<>", "")
	return mw.title.new(title).prefixedText
end

function p._main(page, sections, options, title)
	-- Validate input.
	checkType('_main', 1, page, 'string', true)
	checkType('_main', 3, options, 'table', true)
	if sections == nil then
		sections = {}
	elseif type(sections) == 'string' then
		sections = {sections}
	elseif type(sections) ~= 'table' then
		error(mw.ustring.format(
			"خطای نوع در آرگومان #2 برای '_main' " ..
			"(رشته، جدول یا خالی مورد انتظار بود، در عوض %s دریافت شد)",
			type(sections)
		), 2)
	end
	options = options or {}
	title = title or mw.title.getCurrentTitle()

	-- Deal with blank page names elegantly
	if page and not mw.ustring.find(page, '%S') then
		page = nil
		options.nopage = true
	end

	-- Make the link(s).
	local isShowingPage = not options.nopage
	if #sections <= 1 then
		local linkPage = page or ''
		local section = sections[1] or 'یادداشت‌ها'
		local display = '§&nbsp;' .. section
		if isShowingPage then
			page = page or title.prefixedText
			if options.display or options['نمایش'] and (options.display or options['نمایش']) ~= '' then
				if normalizeTitle(options.display or options['نمایش']) == normalizeTitle(page) then
					display = (options.display or options['نمایش']) .. ' ' .. display
				else
					error(mw.ustring.format(
						'از عنوان ظاهری «%s» صرف نظر شد؛ زیرا ' ..
						"این عنوان با عنوان اصلی صفحه یکسان نیست",
						options.display or options['نمایش']
					), 0)
				end
			else
				display = page .. ' ' .. display
			end
		end
		return makeSectionLink(linkPage, section, display)
	else
		-- Multiple sections. First, make a list of the links to display.
		local ret = {}
		for i, section in ipairs(sections) do
			ret[i] = makeSectionLink(page, section)
		end

		-- Assemble the list of links into a string with mw.text.listToText.
		-- We use the default separator for mw.text.listToText, but a custom
		-- conjunction. There is also a special case conjunction if we only
		-- have two links.
		local conjunction
		if #sections == 2 then
			conjunction = '&#8203; و '
		else
			conjunction = '، و '
		end
		ret = mw.text.listToText(ret, nil, conjunction)

		-- Add the intro text.
		local intro = '§§&nbsp;'
		if isShowingPage then
			intro = (page or title.prefixedText) .. ' ' .. intro
		end
		ret = intro .. ret

		return ret
	end
end

function p.main(frame)
	local yesno = require('Module:Yesno')
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = {'الگو:پیوند بخش', 'الگو:لینک بخش'},
		valueFunc = function (key, value)
			value = mw.ustring.match(value, '^%s*(.-)%s*$') -- Trim whitespace
			-- Allow blank first parameters, as the wikitext template does this.
			if value ~= '' or key == 1 then
				return value
			end
		end
	})

	for k, v in pairs(args) do													-- replace underscores in the positional parameter values
		if 'number' == type(k) then
			if not yesno (args['keep-underscores'] or args['ماندن زیرخط']) then						-- unless |keep-underscores=yes
				args[k] = mw.uri.decode (v, 'WIKI');							-- percent-decode; replace underscores with space characters
			else
				args[k] = mw.uri.decode (v, 'PATH');							-- percent-decode; retain underscores
			end
		end
	end

	-- Sort the arguments.
	local page
	local sections, options = {}, {}
	for k, v in pairs(args) do
		if k == 1 then
			-- Doing this in the loop because of a bug in [[Module:Arguments]]
			-- when using pairs with deleted arguments.
			page = mw.text.decode(v, true)
		elseif type(k) == 'number' then
			sections[k] = v
		else
			options[k] = v
		end
	end
	
	options.nopage = yesno (options.nopage or options['بدون صفحه']);									-- make boolean
	
	-- Extract section from page, if present
	if page then
		local p, s = mw.ustring.match(page, '^(.-)#(.*)$')
		if p then page, sections[1] = p, s end
	end

	-- Compress the sections array.
	local function compressArray(t)
		local nums, ret = {}, {}
		for num in pairs(t) do
			nums[#nums + 1] = num
		end
		table.sort(nums)
		for i, num in ipairs(nums) do
			ret[i] = t[num]
		end
		return ret
	end
	sections = compressArray(sections)

	return p._main(page, sections, options)
end

return p