Modül:Kısayol

Modül belgelemesi[gör] [değiştir] [geçmiş] [temizle]

Bu modül {{kısayol}} şablonunu yürütür.

Kullanımı

Vikimetin ile

Modülün özellikleri {{kısayol}} şablonu vasıtasıyla kullanılabilir olup şablonun belgelemesinde nasıl yapılacağı açıklanmıştır. Aynı işlevler {{#invoke:Kısayol|main|değişkenler}} çağrısı ile de kullanılabilir.

Lua ile

Modülü Lua ile kullanmak için öncelikle yükleme işlemi yapılmalıdır:

local mShortcut = require('Modül:Kısayol')

Daha sonra aşağıdaki sözdizimiyle kısayol kutuları oluşturulabilir:

mShortcut._main(shortcuts, options, frame, cfg)

• shortcuts kısayol sayfaları listesi. (zorunlu)
• options ayar tablosu olup şu anahtarlar ile özelleştirilebilir:
  • msg kısayol listesinden sonra görüntülenecek bir ileti.
  • category "hayır" değeri ile kullanılan ve sayfanın hata kategorisine eklenmesini engellemeyi sağlayan parametre.
• frame çerçeve nesnesi. İsteğe bağlıdır ve yalnızca dahili olarak kullanılması amaçlanmıştır.
• cfg yapılandırma değerleri tablosu. İsteğe bağlıdır ve yalnızca test amaçlıdır.

Teknik detaylar

Modülün ayar dosyası Modül:Kısayol/yapılandırma sayfasında saklanmaktadır. Modülü farklı dillere çevirmek ya da kategori adları gibi detayları değiştirmek için kullanılabilir.

Yukarıdaki belgeleme içeriği Modül:Kısayol/belge sayfasından yansıtılmaktadır. (değiştir | geçmiş)
Kullanıcılar denemelerini bu şablonun deneme tahtası (oluştur | yansıtma) ve test senaryosu (oluştur) sayfalarında yapabilirler.
Lütfen kategorileri /belge alt sayfasına ekleyin. Bu modül ile ilgili alt sayfalar için buraya tıklayınız.

-- Bu modül {{kısayol}} şablonunu yürütür.

-- Set constants
local CONFIG_MODULE = 'Modül:Kısayol/yapılandırma'

-- Load required modules
local checkType = require('libraryUtil').checkType
local yesno = require('Modül:Evethayır')

local p = {}

local function message(msg, ...)
	return mw.message.newRawMessage(msg, ...):plain()
end

local function makeCategoryLink(cat)
	return string.format('[[%s:%s]]', mw.site.namespaces[14].name, cat)
end

function p._main(shortcuts, options, frame, cfg)
	checkType('_main', 1, shortcuts, 'table')
	checkType('_main', 2, options, 'table', true)
	options = options or {}
	frame = frame or mw.getCurrentFrame()
	cfg = cfg or mw.loadData(CONFIG_MODULE)
	local templateMode = options.template and yesno(options.template)
	local redirectMode = options.redirect and yesno(options.redirect)
	local isCategorized = not options.category or yesno(options.category) ~= false

	-- Validate shortcuts
	for i, shortcut in ipairs(shortcuts) do
		if type(shortcut) ~= 'string' or #shortcut < 1 then
			error(message(cfg['invalid-shortcut-error'], i), 2)
		end
	end

	-- Make the list items. These are the shortcuts plus any extra lines such
	-- as options.msg.
	local listItems = {}
	for i, shortcut in ipairs(shortcuts) do
		local templatePath, prefix
		if templateMode then
			-- Namespace detection
			local titleObj = mw.title.new(shortcut, 10)
			if titleObj.namespace == 10 then
				templatePath = titleObj.fullText
			else
				templatePath = shortcut
			end
			prefix = options['pre' .. i] or options.pre or ''
		end
		if options.target and yesno(options.target) then
			listItems[i] = templateMode
				and string.format("&#123;&#123;%s[[%s|%s]]&#125;&#125;", prefix, templatePath, shortcut)
				or string.format("[[%s]]", shortcut)
		else
			listItems[i] = frame:expandTemplate{
				title = 'Yönlenme',
				args = templateMode and {templatePath, shortcut} or {shortcut, shortcut}
			}
			if templateMode then
				listItems[i] = string.format("&#123;&#123;%s%s&#125;&#125;", prefix, listItems[i])
			end
		end
	end
	table.insert(listItems, options.msg or options.ileti)

	-- Return an error if we have nothing to display
	if #listItems < 1 then
		local msg = cfg['no-content-error']
		msg = string.format('<strong class="error">%s</strong>', msg)
		if isCategorized and cfg['no-content-error-category'] then
			msg = msg .. makeCategoryLink(cfg['no-content-error-category'])
		end
		return msg
	end

	local root = mw.html.create()
	root:wikitext(frame:extensionTag{ name = 'templatestyles', args = { src = 'Modül:Kısayol/biçim.css'} })
	-- Anchors
	local anchorDiv = root
		:tag('div')
			:addClass('module-shortcutanchordiv')
	for i, shortcut in ipairs(shortcuts) do
		local anchor = mw.uri.anchorEncode(shortcut)
		anchorDiv:tag('span'):attr('id', anchor)
	end

	-- Shortcut heading
	local shortcutHeading
	do
		local nShortcuts = #shortcuts
		if nShortcuts > 0 then
			local headingMsg = options['shortcut-heading'] or
				redirectMode and cfg['redirect-heading'] or
				cfg['shortcut-heading']
			shortcutHeading = message(headingMsg, nShortcuts)
			shortcutHeading = frame:preprocess(shortcutHeading)
		end
	end

	-- Shortcut box
	local shortcutList = root
		:tag('div')
			:addClass('module-shortcutboxplain noprint')
			:attr('role', 'note')
	
	local hiza = options.float or options.hiza
	
	if hiza then
		if hiza:lower() == 'left' or hiza:lower() == 'sol' then
			shortcutList:addClass('module-shortcutboxleft')
		end
	end
	
	if options.clear and options.clear ~= '' then
		shortcutList:css('clear', options.clear)
	end
	if shortcutHeading then
		shortcutList
			:tag('div')
				:addClass('module-shortcutlist')
				:wikitext(shortcutHeading)
	end
	
	local ubl = require('Modül:Liste').unbulleted(listItems)
	shortcutList:wikitext(ubl)
	return tostring(root)
end

function p.main(frame)
	local args = require('Modül:Bağımsız değişkenler').getArgs(frame)

	-- Separate shortcuts from options
	local shortcuts, options = {}, {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			shortcuts[k] = v
		else
			options[k] = v
		end
	end

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

	return p._main(shortcuts, options, frame)
end

return p