Module:Excerpt - Revision history

Fire at 00:28, 3 June 2025

2025-06-03T00:28:56Z

← Older revision		Revision as of 09:28, 3 June 2025
Line 1:		Line 1:
	-- Module:Excerpt implements the Excerpt template		-- Module:Excerpt implements the Excerpt template
	-- Documentation https://~~www~~.~~mediawiki~~.org/wiki/Module:Excerpt		-- Documentation and master version: https://en.wikipedia.org/wiki/Module:Excerpt
	-- By User:Sophivorus, User:Certes & others		-- Authors: User:Sophivorus, User:Certes, User:Aidan9382 & others
	~~-- Version 1.5~~		-- License: CC-BY-SA-3.0
	-- License CC BY-SA-3.0

	local Transcluder = require( 'Module:Transcluder' )		local Transcluder = require( 'Module:Transcluder' )
Line 16:		Line 15:
	-- Helper function to get arguments		-- Helper function to get arguments
	local args		local args
	function getArg( key, default )		local function getArg( key, default )
	local value = args[ key ]		local value = args[ key ]
	if value and mw.text.trim( value ) ~= '' then		if value and mw.text.trim( value ) ~= '' then
Line 25:		Line 24:

	-- Helper function to handle errors		-- Helper function to handle errors
	function getError( message, value )		local function getError( message, value )
	if type( message ) == 'string' then		if type( message ) == 'string' then
	message = Transcluder.getError( message, value )		message = Transcluder.getError( message, value )
Line 36:		Line 35:

	-- Helper function to get localized messages		-- Helper function to get localized messages
	function getMessage( key )		local function getMessage( key )
	local ok, TNT = pcall( require, 'Module:TNT' )		local ok, TNT = pcall( require, 'Module:TNT' )
	if not ok then return key end		if not ok then return key end
Line 42:		Line 41:
	end		end

			-- Main entry point for templates
	function p.main( frame )		function p.main( frame )
	args = Transcluder.parseArgs( frame )		args = Transcluder.parseArgs( frame )
Line 47:		Line 47:
	-- Make sure the requested page exists		-- Make sure the requested page exists
	local page = getArg( 1 )		local page = getArg( 1 )
	if not page then return getError( 'no-page' ) end		if not page or page == '{{{1}}}' then return getError( 'no-page' ) end
	local title = mw.title.new(page)		local title = mw.title.new(page)
	if not title then return getError( 'no-page' ) end		if not title then return getError( 'invalid-title', page ) end
	if title.isRedirect then title = title.redirectTarget end		if title.isRedirect then title = title.redirectTarget end
	if not title.exists then return getError( 'page-not-found', page ) end		if not title.exists then return getError( 'page-not-found', page ) end
Line 70:		Line 70:
	local noBold = not yesno( getArg( 'bold' ) )		local noBold = not yesno( getArg( 'bold' ) )
	local onlyFreeFiles = yesno( getArg( 'onlyfreefiles', true ) )		local onlyFreeFiles = yesno( getArg( 'onlyfreefiles', true ) )
			local briefDates = yesno( getArg( 'briefdates', false ) )
	local inline = yesno( getArg( 'inline' ) )		local inline = yesno( getArg( 'inline' ) )
	local quote = yesno( getArg( 'quote' ) )		local quote = yesno( getArg( 'quote' ) )
	local more = yesno( getArg( 'more' ) )		local more = yesno( getArg( 'more' ) )
	local class = getArg( 'class' )		local class = getArg( 'class' )
			local displaytitle = getArg( 'displaytitle' ) or page

	-- Build the hatnote		-- Build the hatnote
Line 87:		Line 89:
	end		end
	hat = hat .. ' ' .. getMessage( 'excerpt' ) .. ' '		hat = hat .. ' ' .. getMessage( 'excerpt' ) .. ' '
	if section ~~and not fragment~~ then		if section then
	hat = hat .. '[[:' .. page .. '#' .. mw.uri.anchorEncode( section ) .. '\|' .. ~~page~~		hat = hat .. '[[:' .. page .. '#' .. mw.uri.anchorEncode( section ) .. '\|' .. displaytitle
	.. ' § ' .. mw.ustring.gsub( section, '%[%[([^]\|]+)\|?[^]]*%]%]', '%1' ) .. ']].' -- remove nested links		.. ' § ' .. mw.ustring.gsub( section, '%[%[([^]\|]+)\|?[^]]*%]%]', '%1' ) .. ']].' -- remove nested links
	else		else
	hat = hat .. '[[:' .. page .. '\|' .. ~~page~~ .. ']].'		hat = hat .. '[[:' .. page .. '\|' .. displaytitle .. ']].'
	end		end
	if edit then		if edit then
Line 141:		Line 143:
	if mw.text.trim( excerpt ) == '' and not only then		if mw.text.trim( excerpt ) == '' and not only then
	if section then return getError( 'section-empty', section ) else return getError( 'lead-empty' ) end		if section then return getError( 'section-empty', section ) else return getError( 'lead-empty' ) end
			end

			-- Fix birth and death dates, but only in the first paragraph
			if briefDates then
			local startpos = 1 -- skip initial templates
			local s
			local e = 0
			repeat
			startpos = e + 1
			s, e = mw.ustring.find( excerpt, "%s%b{}%s", startpos )
			until not s or s > startpos
			s, e = mw.ustring.find( excerpt, "%b()", startpos ) -- get (...), which may be (year–year)
			if s and s < startpos + 100 then -- look only near the start
			local year1, conjunction, year2 = mw.ustring.match( mw.ustring.sub( excerpt, s, e ), '(%d%d%d+)(.-)(%d%d%d+)' )
			if year1 and year2 and (mw.ustring.match( conjunction, '[%-–—]' ) or mw.ustring.match( conjunction, '{{%s[sS]nd%s}}' )) then
			local y1 = tonumber(year1)
			local y2 = tonumber(year2)
			if y2 > y1 and y2 < y1 + 125 and y1 <= tonumber( os.date( "%Y" )) then
			excerpt = mw.ustring.sub( excerpt, 1, s ) .. year1 .. "–" .. year2 .. mw.ustring.sub( excerpt, e )
			end
			end
			end
	end		end

Line 153:		Line 177:
	infobox = table.concat( infobox )		infobox = table.concat( infobox )
	local parameters = Transcluder.getParameters( infobox )		local parameters = Transcluder.getParameters( infobox )
	local file, captions, caption		local file, captions, caption, cssclasses, cssclass
	for _, pair in pairs( config.captions ) do		for _, pair in pairs( config.captions ) do
	file = pair[1]		file = pair[1]
Line 163:		Line 187:
	if parameters[ p ] then caption = parameters[ p ] break end		if parameters[ p ] then caption = parameters[ p ] break end
	end		end
	excerpt = '[[File:' .. file .. '\|thumb\|' .. ( caption or '' ) .. ']]' .. excerpt
			-- Check for CSS classes
			-- We opt to use skin-invert-image instead of skin-invert
			-- in all other cases, the CSS provided in the infobox is used
			if pair[3] then
			cssclasses = pair[3]
			for _, p in pairs(cssclasses) do
			if parameters[p] then
			cssclass = ((parameters[p] == 'skin-invert') and 'skin-invert-image' or parameters[p])
			break
			end
			end
			end

			excerpt = '[[File:' .. file ..
			(cssclass and ('\|class=' .. cssclass) or '') ..
			'\|thumb\|' .. (caption or '') .. ']]' .. excerpt
	if ( onlyFreeFiles ) then		if ( onlyFreeFiles ) then
	excerpt = Transcluder.removeNonFreeFiles( excerpt )		excerpt = Transcluder.removeNonFreeFiles( excerpt )

imported>Fire: Created page with "-- Module:Excerpt implements the Excerpt template -- Documentation https://www.mediawiki.org/wiki/Module:Excerpt -- By User:Sophivorus, User:Certes & others -- Version 1.5 -- License CC BY-SA-3.0 local Transcluder = require( 'Module:Transcluder' ) local yesno = require( 'Module:Yesno' ) local ok, config = pcall( require, 'Module:Excerpt/config' ) if not ok then config = {} end local p = {} -- Helper function to get arguments local args function getArg( key, default..."

2022-12-25T03:19:50Z

Created page with "-- Module:Excerpt implements the Excerpt template -- Documentation https://www.mediawiki.org/wiki/Module:Excerpt -- By User:Sophivorus, User:Certes & others -- Version 1.5 -- License CC BY-SA-3.0 local Transcluder = require( 'Module:Transcluder' ) local yesno = require( 'Module:Yesno' ) local ok, config = pcall( require, 'Module:Excerpt/config' ) if not ok then config = {} end local p = {} -- Helper function to get arguments local args function getArg( key, default..."

New page

-- Module:Excerpt implements the Excerpt template
-- Documentation https://www.mediawiki.org/wiki/Module:Excerpt
-- By User:Sophivorus, User:Certes & others
-- Version 1.5
-- License CC BY-SA-3.0

local Transcluder = require( 'Module:Transcluder' )

local yesno = require( 'Module:Yesno' )

local ok, config = pcall( require, 'Module:Excerpt/config' )
if not ok then config = {} end

local p = {}

-- Helper function to get arguments
local args
function getArg( key, default )
local value = args[ key ]
if value and mw.text.trim( value ) ~= '' then
return value
end
return default
end

-- Helper function to handle errors
function getError( message, value )
if type( message ) == 'string' then
message = Transcluder.getError( message, value )
end
if config.categories and config.categories.errors and mw.title.getCurrentTitle().isContentPage then
message:node( '[[Category:' .. config.categories.errors .. ']]' )
end
return message
end

-- Helper function to get localized messages
function getMessage( key )
local ok, TNT = pcall( require, 'Module:TNT' )
if not ok then return key end
return TNT.format( 'I18n/Module:Excerpt.tab', key )
end

function p.main( frame )
args = Transcluder.parseArgs( frame )

-- Make sure the requested page exists
local page = getArg( 1 )
if not page then return getError( 'no-page' ) end
local title = mw.title.new(page)
if not title then return getError( 'no-page' ) end
if title.isRedirect then title = title.redirectTarget end
if not title.exists then return getError( 'page-not-found', page ) end
page = title.prefixedText

-- Set variables from the template parameters
local section = getArg( 2, mw.ustring.match( getArg( 1 ), '[^#]+#(.+)' ) )
local hat = yesno( getArg( 'hat', true ) )
local edit = yesno( getArg( 'edit', true ) )
local this = getArg( 'this' )
local only = getArg( 'only' )
local files = getArg( 'files', getArg( 'file', ( only == 'file' and 1 ) ) )
local lists = getArg( 'lists', getArg( 'list', ( only == 'list' and 1 ) ) )
local tables = getArg( 'tables', getArg( 'table', ( only == 'table' and 1 ) ) )
local templates = getArg( 'templates', getArg( 'template', ( only == 'template' and 1 ) ) )
local paragraphs = getArg( 'paragraphs', getArg( 'paragraph', ( only == 'paragraph' and 1 ) ) )
local references = getArg( 'references' )
local subsections = not yesno( getArg( 'subsections' ) )
local noLinks = not yesno( getArg( 'links', true ) )
local noBold = not yesno( getArg( 'bold' ) )
local onlyFreeFiles = yesno( getArg( 'onlyfreefiles', true ) )
local inline = yesno( getArg( 'inline' ) )
local quote = yesno( getArg( 'quote' ) )
local more = yesno( getArg( 'more' ) )
local class = getArg( 'class' )

-- Build the hatnote
if hat and not inline then
if this then
hat = this
elseif quote then
hat = getMessage( 'this' )
elseif only then
hat = getMessage( only )
else
hat = getMessage( 'section' )
end
hat = hat .. ' ' .. getMessage( 'excerpt' ) .. ' '
if section and not fragment then
hat = hat .. '[[:' .. page .. '#' .. mw.uri.anchorEncode( section ) .. '|' .. page
.. ' § ' .. mw.ustring.gsub( section, '%[%[([^]|]+)|?[^]]*%]%]', '%1' ) .. ']].' -- remove nested links
else
hat = hat .. '[[:' .. page .. '|' .. page .. ']].'
end
if edit then
hat = hat .. '[['
hat = hat .. title:fullUrl( 'action=edit' ) .. ' ' .. mw.message.new( 'editsection' ):plain()
hat = hat .. ']]'
end
if config.hat then
hat = config.hat .. hat .. '}}'
hat = frame:preprocess( hat )
else
hat = mw.html.create( 'div' ):addClass( 'dablink excerpt-hat' ):wikitext( hat )
end
else
hat = nil
end

-- Build the "Read more" link
if more and not inline then
more = "'''[[" .. page .. '#' .. ( section or '' ) .. "|" .. getMessage( 'more' ) .. "]]'''"
more = mw.html.create( 'div' ):addClass( 'noprint excerpt-more' ):wikitext( more )
else
more = nil
end

-- Build the options for Module:Transcluder out of the template parameters and the desired defaults
local options = {
files = files,
lists = lists,
tables = tables,
paragraphs = paragraphs,
sections = subsections,
categories = 0,
references = references,
only = only and mw.text.trim( only, 's' ) .. 's',
noLinks = noLinks,
noBold = noBold,
noSelfLinks = true,
noNonFreeFiles = onlyFreeFiles,
noBehaviorSwitches = true,
fixReferences = true,
linkBold = true,
}

-- Get the excerpt itself
local title = page .. '#' .. ( section or '' )
local ok, excerpt = pcall( Transcluder.get, title, options )
if not ok then return getError( excerpt ) end
if mw.text.trim( excerpt ) == '' and not only then
if section then return getError( 'section-empty', section ) else return getError( 'lead-empty' ) end
end

-- If no file was found, try to get one from the infobox
local fileNamespaces = Transcluder.getNamespaces( 'File' )
if ( ( only == 'file' or only == 'files' ) or ( not only and ( files ~= '0' or not files ) ) ) and -- caller asked for files
not Transcluder.matchAny( excerpt, '%[%[', fileNamespaces, ':' ) and -- and there are no files in Transcluder's output
config.captions -- and we have the config option required to try finding files in templates
then
-- We cannot distinguish the infobox from the other templates so we search them all
local infobox = Transcluder.getTemplates( excerpt );
infobox = table.concat( infobox )
local parameters = Transcluder.getParameters( infobox )
local file, captions, caption
for _, pair in pairs( config.captions ) do
file = pair[1]
file = parameters[file]
if file and Transcluder.matchAny( file, '^.*%.', { '[Jj][Pp][Ee]?[Gg]', '[Pp][Nn][Gg]', '[Gg][Ii][Ff]', '[Ss][Vv][Gg]' }, '.*' ) then
file = mw.ustring.match( file, '%[?%[?.-:([^{|]+)%]?%]?' ) or file -- [[File:Example.jpg{{!}}upright=1.5]] to Example.jpg
captions = pair[2]
for _, p in pairs( captions ) do
if parameters[ p ] then caption = parameters[ p ] break end
end
excerpt = '[[File:' .. file .. '|thumb|' .. ( caption or '' ) .. ']]' .. excerpt
if ( onlyFreeFiles ) then
excerpt = Transcluder.removeNonFreeFiles( excerpt )
end
break
end
end
end

-- Unlike other elements, templates are filtered here
-- because we had to search the infoboxes for files
local trash
if only and ( only == 'template' or only == 'templates' ) then
trash, excerpt = Transcluder.getTemplates( excerpt, templates );
else -- Remove blacklisted templates
local blacklist = config.blacklist and table.concat( config.blacklist, ',' ) or ''
if templates then
if string.sub( templates, 1, 1 ) == '-' then --Unwanted templates. Append to blacklist
blacklist = templates .. ',' .. blacklist
else --Wanted templates. Replaces blacklist and acts as whitelist
blacklist = templates
end
else
blacklist = '-' .. blacklist
end
trash, excerpt = Transcluder.getTemplates( excerpt, blacklist );
end

-- Remove extra line breaks but leave one before and after so the parser interprets lists, tables, etc. correctly
excerpt = mw.text.trim( excerpt )
excerpt = string.gsub( excerpt, '\n\n\n+', '\n\n' )
excerpt = '\n' .. excerpt .. '\n'

-- Remove nested categories
excerpt = frame:preprocess( excerpt )
local categories, excerpt = Transcluder.getCategories( excerpt, options.categories )

-- Add tracking categories
if config.categories then
local contentCategory = config.categories.content
if contentCategory and mw.title.getCurrentTitle().isContentPage then
excerpt = excerpt .. '[[Category:' .. contentCategory .. ']]'
end
local namespaceCategory = config.categories[ mw.title.getCurrentTitle().namespace ]
if namespaceCategory then
excerpt = excerpt .. '[[Category:' .. namespaceCategory .. ']]'
end
end

-- Load the styles
local styles
if config.styles then
styles = frame:extensionTag( 'templatestyles', '', { src = config.styles } )
end

-- Combine and return the elements
if inline then
return mw.text.trim( excerpt )
end
local tag = 'div'
if quote then
tag = 'blockquote'
end
excerpt = mw.html.create( 'div' ):addClass( 'excerpt' ):wikitext( excerpt )
local block = mw.html.create( tag ):addClass( 'excerpt-block' ):addClass( class )
return block:node( styles ):node( hat ):node( excerpt ):node( more )
end

-- Entry points for backwards compatibility
function p.lead( frame ) return p.main( frame ) end
function p.excerpt( frame ) return p.main( frame ) end

return p