Модуль:Якорь

Документация

[просмотр | править | история | обновить]

Этот модуль оценён как готовый к использованию. Предполагается, что все баги устранены и он готов для широкого использования. Его можно указывать на справочных страницах и рекомендовать к использованию новым участникам. Для его изменения и тестирования, пожалуйста, используйте песочницу.

Модуль предназначен для создания якорей. На нем работают шаблоны {{якорь}} и {{видимый якорь}}. Также его можно использовать в других модулях.

Использование

Для начала необходимо загрузить модуль:

local anchor = require('Модуль:Якорь').main

Можно использовать неограниченное количество параметров:

anchor(anchor1, anchor2, ...)

Также параметр visible (или v) позволяет выбрать первый якорь в качестве текста, который будет подсвечиваться при переходе, либо отдельно указать этот текст через параметр text:

anchor{visible = true, visible_anchor, anchor2, ...}

или

anchor{visible = true, text = 'какой-то текст', anchor1, anchor2, ...}

local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local compressSparseArray = require('Module:TableTools').compressSparseArray
local p = {}

local function add_anchor(anchor, text, visible)
	local result = mw.html.create('span')
		:attr('id', anchor)
		:wikitext(text)
	if visible then
		result:addClass('highlight-target')
	end
	return tostring(result)
end

local function unpack(...)
	local frame = ...
	local args
	if type(frame.args) == 'table' then
		args = getArgs(frame)
	elseif type(frame) == 'table' then
		args = frame
	else
		args = {...}
	end
	return args
end

function p.main(...)
	local args = unpack(...)
	local anchors = compressSparseArray(args)
	local text
	local visible = yesno(args.visible or args.v)
	if visible then
		text = args.text or args['текст'] or args[1]
	end

	local result = text
	for i, v in ipairs(anchors) do
		result = add_anchor(anchors[i], result, visible)
		--[[
			создание старого ��ида якорей для совместимости,
			см. Обсуждение шаблона:Якорь#Новые html5 ссылки и старые
		]]
		local encoded_anchor = mw.uri.encode(anchors[i], 'WIKI'):gsub('%%', '.')
		if anchors[i] ~= encoded_anchor then
			result = add_anchor(encoded_anchor, result, visible)
		end
	end

	return result
end

return p