Module:Extract short description - Revision history

WOSlinker: use require('strict') instead of require('Module:No globals')

2022-10-21T21:19:43Z

use require('strict') instead of require('Module:No globals')

← Previous revision		Revision as of 21:19, 21 October 2022
Line 1:		Line 1:
	require('~~Module:No globals~~');		require('strict');

	--[[--------------------------< E X T R A C T _ F R O M _ T E M P L A T E >------------------------------------		--[[--------------------------< E X T R A C T _ F R O M _ T E M P L A T E >------------------------------------

Gonnym: fixed error

2019-06-30T22:46:06Z

fixed error

← Previous revision		Revision as of 22:46, 30 June 2019
Line 33:		Line 33:
	end		end

			local templateName
	for _, template_name in ipairs (template_names_tbl) do -- loop through the name in the table		for _, template_name in ipairs (template_names_tbl) do -- loop through the name in the table
	template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]		template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]
	start = content:find ('{{%s*' .. template_name_pattern); -- find the start of {{template name ...;		start = content:find ('{{%s*' .. template_name_pattern); -- find the start of {{template name ...;
	if start then		if start then
			templateName = template_name
	break; -- found a matching template		break; -- found a matching template
	end		end
Line 45:		Line 47:
	end		end

	local text = string.match (content, '%b{}', start); -- start points to first { of the ~~template_name~~		local text = string.match (content, '%b{}', start); -- start points to first { of the templateName
	if not text then		if not text then
	return '<span style="font-size:100%;" class="error">error: failed to extract template: ' .. ~~template_name~~ .. '</span>';		return '<span style="font-size:100%;" class="error">error: failed to extract template: ' .. templateName .. '</span>';
	end		end

Line 57:		Line 59:
	text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text		text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text
	if not text then		if not text then
	return '<span style="font-size:100%;" class="error">error: no short description text in: ' .. ~~template_name~~ .. ' in '.. article_title .. '</span>';		return '<span style="font-size:100%;" class="error">error: no short description text in: ' .. templateName .. ' in '.. article_title .. '</span>';
	end		end

Trappist the monk at 09:08, 11 October 2018

2018-10-11T09:08:37Z

← Previous revision		Revision as of 09:08, 11 October 2018
Line 143:		Line 143:

	if template_name then		if template_name then
	~~return~~ extract_from_template (frame, article_title, template_name);		local text, _ = extract_from_template (frame, article_title, template_name); -- ignore second return value
			return text;
	else		else
	return extract_from_article (article_title);		return extract_from_article (article_title);

Trappist the monk at 16:56, 10 October 2018

2018-10-10T16:56:16Z

← Previous revision		Revision as of 16:56, 10 October 2018
Line 52:		Line 52:
	text = text:gsub ('<ref[^>]->[^<]-</ref>', ''); -- delete references before preprocessing; they do not belong in shortdesc text		text = text:gsub ('<ref[^>]->[^<]-</ref>', ''); -- delete references before preprocessing; they do not belong in shortdesc text
	text = text:gsub ('<ref[^>]-/ *>', ''); -- also delete self-closed named references		text = text:gsub ('<ref[^>]-/ *>', ''); -- also delete self-closed named references
			text = text:gsub ('{{%s*sfn[^}]-}}', ''); -- delete sfn template which make references using {{#tag:}} parser functions
			text = text:gsub ('{{#tag:ref[^}]-}}', ''); -- and delete these too

	text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text		text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text

Trappist the monk at 09:23, 10 October 2018

2018-10-10T09:23:32Z

← Previous revision		Revision as of 09:23, 10 October 2018
Line 11:		Line 11:
	frame: frame object required to preprocess template_name		frame: frame object required to preprocess template_name
	article_title: the name of the article to inspect - correct spelling and captialization is required		article_title: the name of the article to inspect - correct spelling and captialization is required
	template_names_tbl: table of template names ~~without~~ namespace to be inspected - correct spelling and captialization is required		template_names_tbl: a single template name (a string) or a table of one or more template names all without
			namespace to be inspected - correct spelling and captialization is required

	returns two values:		returns two values:
Line 144:		Line 145:
	return extract_from_article (article_title);		return extract_from_article (article_title);
	end		end
	end



	-----test-----
	-- temporary test function to be deleted
	local function test (frame)
	local tbl = {'Infobox television episode/sandbox', 'short description'};
	local text, good = extract_from_template (frame, 'User:Trappist the monk/sandbox', tbl);
	if good then
	return text;
	else
	return 'extract_from_template() returned this: ' .. text
	end
	end		end

Line 168:		Line 155:
	extract_from_template = extract_from_template,		extract_from_template = extract_from_template,
	extract_from_article = extract_from_article,		extract_from_article = extract_from_article,
	test = test, -- to be deleted
	}		}

Trappist the monk at 09:07, 10 October 2018

2018-10-10T09:07:23Z

← Previous revision		Revision as of 09:07, 10 October 2018
Line 19:		Line 19:
	]]		]]

	--local function extract_from_template (frame, article_title, template_names)
	local function extract_from_template (frame, article_title, template_names_tbl)		local function extract_from_template (frame, article_title, template_names_tbl)
	local content = mw.title.new (article_title):getContent(); -- read the unparsed article source		local content = mw.title.new (article_title):getContent(); -- read the unparsed article source
Line 27:		Line 26:

	local template_name_pattern;		local template_name_pattern;
	local start		local start;

	~~for~~ _, ~~template_name~~ ~~in ipairs~~ (template_names_tbl) do		if 'string' == type (template_names_tbl) then -- when single template name passed in as a string
			template_names_tbl = {template_names_tbl}; -- convert to a table
			end

			for _, template_name in ipairs (template_names_tbl) do -- loop through the name in the table
	template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]		template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]
	start = content:find ('{{%s*' .. template_name_pattern); -- find the start of {{template name ...;		start = content:find ('{{%s*' .. template_name_pattern); -- find the start of {{template name ...;

Trappist the monk at 20:05, 9 October 2018

2018-10-09T20:05:09Z

← Previous revision		Revision as of 20:05, 9 October 2018
Line 11:		Line 11:
	frame: frame object required to preprocess template_name		frame: frame object required to preprocess template_name
	article_title: the name of the article to inspect - correct spelling and captialization is required		article_title: the name of the article to inspect - correct spelling and captialization is required
	~~template~~: ~~the~~ ~~name~~ without namespace of ~~the template to~~ ~~inspect~~ - correct spelling and captialization is required		template_names_tbl: table of template names without namespace to be inspected - correct spelling and captialization is required

			returns two values:
	on success, returns the short description text; ~~error~~ ~~message else~~		on success, returns the short description text and true
			on failure, returns error message and nil

	]]		]]

	local function extract_from_template (frame, article_title, ~~template_name~~)		--local function extract_from_template (frame, article_title, template_names)
			local function extract_from_template (frame, article_title, template_names_tbl)
	local content = mw.title.new (article_title):getContent(); -- read the unparsed article source		local content = mw.title.new (article_title):getContent(); -- read the unparsed article source
	if not content then		if not content then
	return '<span style="font-size:100%;" class="error">error: no article: ' .. article_title .. '</span>';		return '<span style="font-size:100%;" class="error">error: no article: ' .. article_title .. '</span>';
	end		end

			local template_name_pattern;
			local start

	~~local~~ template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]		for _, template_name in ipairs (template_names_tbl) do
			template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]
		⚫	start = content:find ('{{%s*' .. template_name_pattern); -- find the start of {{template name ...;
		⚫	if start then
			break; -- found a matching template
			end
			end

			if not start then -- no templates found: return name of first template in template_names_tbl in error message
⚫	~~local~~ start = ~~string.~~find (~~content,~~ '{{%s*' .. template_name_pattern); -- find the start of {{template name ...;
		⚫	return '<span style="font-size:100%;" class="error">error: no template: ' .. template_names_tbl[1] .. ' in: ' .. article_title .. '</span>';
⚫	if ~~not~~ start then
⚫	return '<span style="font-size:100%;" class="error">error: no template: ' .. ~~template_name~~ .. ' in: ' .. article_title .. '</span>';
	end		end

Line 43:		Line 54:
	end		end

	return ~~text and~~ mw.text.trim (text); -- trim whitespace and done		return mw.text.trim (text), true; -- trim whitespace and done
	-- preprocess the template then apply syntax highlighting		-- preprocess the template then apply syntax highlighting
	-- this will display the preprocessed template; not usable here		-- this will display the preprocessed template; not usable here
Line 130:		Line 141:
	return extract_from_article (article_title);		return extract_from_article (article_title);
	end		end
			end



			-----test-----
			-- temporary test function to be deleted
			local function test (frame)
			local tbl = {'Infobox television episode/sandbox', 'short description'};
			local text, good = extract_from_template (frame, 'User:Trappist the monk/sandbox', tbl);
			if good then
			return text;
			else
			return 'extract_from_template() returned this: ' .. text
			end
	end		end

Line 139:		Line 164:
	extract_short_description = extract_short_description,		extract_short_description = extract_short_description,
	extract_from_template = extract_from_template,		extract_from_template = extract_from_template,
	extract_from_article = extract_from_article		extract_from_article = extract_from_article,
			test = test, -- to be deleted
	}		}

Trappist the monk at 22:14, 8 October 2018

2018-10-08T22:14:29Z

← Previous revision		Revision as of 22:14, 8 October 2018
Line 36:		Line 36:

	text = text:gsub ('<ref[^>]->[^<]-</ref>', ''); -- delete references before preprocessing; they do not belong in shortdesc text		text = text:gsub ('<ref[^>]->[^<]-</ref>', ''); -- delete references before preprocessing; they do not belong in shortdesc text
			text = text:gsub ('<ref[^>]-/ *>', ''); -- also delete self-closed named references

	text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text		text = frame:preprocess (text):match ('<div[^>]-class="shortdescription.->(.-)</div>'); -- preprocess and extract shortdescription text
Line 46:		Line 47:
	-- this will display the preprocessed template; not usable here		-- this will display the preprocessed template; not usable here
	-- for much other than debugging because syntaxhighlight returns a stripmarker		-- for much other than debugging because syntaxhighlight returns a stripmarker
	-- return frame:callParserFunction ('#tag:syntaxhighlight', frame:preprocess (text));		-- return template_name .. frame:callParserFunction ('#tag:syntaxhighlight', frame:preprocess (text));
	end		end

Trappist the monk at 18:58, 4 October 2018

2018-10-04T18:58:40Z

← Previous revision		Revision as of 18:58, 4 October 2018
Line 66:		Line 66:
	local function extract_from_article (article_title)		local function extract_from_article (article_title)
	local content = mw.title.new (article_title):getContent(); -- read the unparsed article source		local content = mw.title.new (article_title):getContent(); -- read the unparsed article source
			if not content then
			return '<span style="font-size:100%;" class="error">error: no article: ' .. article_title .. '</span>';
			end

	local text, start;		local text, start;

Trappist the monk at 18:44, 4 October 2018

2018-10-04T18:44:36Z

← Previous revision		Revision as of 18:44, 4 October 2018
Line 19:		Line 19:
	local function extract_from_template (frame, article_title, template_name)		local function extract_from_template (frame, article_title, template_name)
	local content = mw.title.new (article_title):getContent(); -- read the unparsed article source		local content = mw.title.new (article_title):getContent(); -- read the unparsed article source
			if not content then
⚫	local template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]
			return '<span style="font-size:100%;" class="error">error: no article: ' .. article_title .. '</span>';
			end

		⚫	local template_name_pattern = template_name:gsub ('^%a', string.lower):gsub ('^%a', '%[%1%1%]'):gsub ('%[%a', string.upper); -- make lua pattern for initial letter upper or lower case: A -> [Aa]

	local start = string.find (content, '{{%s*' .. template_name_pattern); -- find the start of {{template name ...;		local start = string.find (content, '{{%s*' .. template_name_pattern); -- find the start of {{template name ...;
	if not start then		if not start then