Module:Cs1 documentation support - Revision history

Anomie: Sync change from sandbox that has been being used from Template:CS1 language sources/core for months already

2025-05-05T18:30:30Z

Sync change from sandbox that has been being used from Template:CS1 language sources/core for months already

← Previous revision		Revision as of 18:30, 5 May 2025
Line 1,549:		Line 1,549:
	return language_code		return language_code
	else		else
			if override[language_code] == language_name then
⚫	-- Either code doesn't exist or the name doesn't match
			-- Code and name are a valid pair found in override table
⚫	return nil
			return language_code
			else
		⚫	-- Either code doesn't exist or the name doesn't match
		⚫	return nil
			end
	end		end
	end		end

Trappist the monk at 00:17, 1 December 2024

2024-12-01T00:17:20Z

← Previous revision		Revision as of 00:17, 1 December 2024
Line 1,016:		Line 1,016:
	citespeech = {'Template:Cite speech/doc', 'speech'}, -- unique arguments -- no template data		citespeech = {'Template:Cite speech/doc', 'speech'}, -- unique arguments -- no template data
	citessrn = {'Template:Cite SSRN/doc', 'ssrn'}, -- preprint arguments -- no template data		citessrn = {'Template:Cite SSRN/doc', 'ssrn'}, -- preprint arguments -- no template data
	citetechreport = {'Template:Cite ~~techreport~~/doc'},		citetechreport = {'Template:Cite tech report/doc'},
	citethesis = {'Template:Cite thesis/doc', 'thesis'}, -- unique arguments		citethesis = {'Template:Cite thesis/doc', 'thesis'}, -- unique arguments
	citeweb = {'Template:Cite web/doc'},		citeweb = {'Template:Cite web/doc'},

Gonnym: add a code_name_pair_exists function

2024-11-17T17:29:12Z

add a code_name_pair_exists function

@@ Line 1,519: / Line 1,519: @@
 end
 --[[--------------------------< E X P O R T E D   F U N C T I O N S >------------------------------------------
 ]]
@@ Line 1,529: / Line 1,564: @@
 	canonical_name_get = canonical_name_get,
 	cat_lister = cat_lister,
 	error_cat_page_tally = error_cat_page_tally,
 	header_make = header_make,

Trappist the monk: +duplicate alias check;

2024-08-13T22:40:29Z

+duplicate alias check;

← Previous revision		Revision as of 22:40, 13 August 2024
Line 1,152:		Line 1,152:

	local function param_error_msg (param)		local function param_error_msg (param)
	return '<~~code~~ style="~~color~~: ~~inherit; background: inherit; border: none; padding: inherit~~">\|' .. param .. '=</~~code~~> is not a valid parameter';		return '<span style="font-family:"monospace">\|' .. param .. '=</span> is not a valid parameter';
			end


			--[[--------------------------< D U P _ A L I A S _ E R R O R_ M S G >-----------------------------------------


			]]

			local function dup_alias_error_msg (param, alias)
			return '<span style="font-family:"monospace">\|' .. param .. '=</span> has duplicate aliases: <span font-family:"monospace";>\|' .. alias .. '=</span>';
			end


			--[[--------------------------< D U P _ A L I A S E S _ C H E C K >--------------------------------------------

			create an associative array of <param> aliases. if <alias> already present in <aliases_t> add an error message
			to <out>

			]]

			local function dup_aliases_check (param, alias, aliases_t, out_t)
			if not aliases_t[alias] then
			aliases_t[alias] = true;
			else
			table.insert (out_t, dup_alias_error_msg (param, alias));
			end
	end		end

Line 1,245:		Line 1,271:
	param_is_valid = validate_document_param (param_i, template_t[2]);		param_is_valid = validate_document_param (param_i, template_t[2]);
	if param_is_valid then		if param_is_valid then
			local aliases_t = {}; -- used by dup_aliases_check
	if param_t['aliases'] then		if param_t['aliases'] then
	for _, alias in ipairs (param_t['aliases']) do		for _, alias in ipairs (param_t['aliases']) do
			dup_aliases_check (param, alias, aliases_t, out);
	local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character		local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character
	if not validate_document_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?		if not validate_document_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?
Line 1,261:		Line 1,289:
	param_is_valid = validate_preprint_param (param_i, template_t[2]);		param_is_valid = validate_preprint_param (param_i, template_t[2]);
	if param_is_valid then		if param_is_valid then
			local aliases_t = {}; -- used by dup_aliases_check
	if param_t['aliases'] then		if param_t['aliases'] then
	for _, alias in ipairs (param_t['aliases']) do		for _, alias in ipairs (param_t['aliases']) do
			dup_aliases_check (param, alias, aliases_t, out);
	local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character		local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character
	if not validate_preprint_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?		if not validate_preprint_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?
Line 1,277:		Line 1,307:
	param_is_valid = validate_unique_param (param_i, template_t[2]);		param_is_valid = validate_unique_param (param_i, template_t[2]);
	if param_is_valid then		if param_is_valid then
			local aliases_t = {}; -- used by dup_aliases_check
	if param_t['aliases'] then		if param_t['aliases'] then
	for _, alias in ipairs (param_t['aliases']) do		for _, alias in ipairs (param_t['aliases']) do
			dup_aliases_check (param, alias, aliases_t, out);
	local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character		local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character
	if not validate_unique_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?		if not validate_unique_param (alias_i, template_t[2]) then -- is 'alias' a known parameter?
Line 1,297:		Line 1,329:
	param_is_valid = validate_basic_param (param_i);		param_is_valid = validate_basic_param (param_i);
	if param_is_valid then		if param_is_valid then
			local aliases_t = {}; -- used by dup_aliases_check
	if param_t['aliases'] then		if param_t['aliases'] then
	for _, alias in ipairs (param_t['aliases']) do		for _, alias in ipairs (param_t['aliases']) do
			dup_aliases_check (param, alias, aliases_t, out)
	local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character		local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character
	if not validate_basic_param (alias_i) and not validate_id_alias (param, alias) then -- for isbn13 (while still supported) must not mask the digits		if not validate_basic_param (alias_i) and not validate_id_alias (param, alias) then -- for isbn13 (while still supported) must not mask the digits

Trappist the monk at 15:06, 9 January 2024

2024-01-09T15:06:07Z

@@ Line 998: / Line 998: @@
 	citeciteseerx = {'Template:Cite CiteSeerX/doc', 'citeseerx'},				-- no template data; preprint uses limited arguments
 	citeconference = {'Template:Cite conference/doc', 'conference'},			-- unique arguments
-	citedocument = {'Template:Cite document/doc'},
+	citedocument = {'Template:Cite document/doc', 'document'},					-- special case; uses whitelist.document_parameters_t
 	citeencyclopedia = {'Template:Cite encyclopedia/doc'},
 	citeepisode = {'Template:Cite episode/doc', 'episode'},						-- unique arguments
@@ Line 1,060: / Line 1,060: @@
 	json = json:match ('<[Tt]emplate[Dd]ata>(.-)</[Tt]emplate[Dd]ata>');		-- remove everything exept the content of the TemplatData tags
 	return json and mw.text.jsonDecode (json);									-- decode the json string and return as a table; nil if not found
 end
@@ Line 1,074: / Line 1,090: @@
 local function validate_basic_param (param)
 	if true == whitelist.common_parameters_t[param] then
 		return true;
 	end
@@ Line 1,226: / Line 1,241: @@
 			local param_is_valid;												-- boolean true when param is valid; nil else
-			if template_t[2] then												-- if template is a preprint or uses unique parameters
+			if template_t[2] then												-- if template is a preprint or uses unique parameters of 'document' parameters
-				if whitelist.preprint_arguments_t[template_t[2]] then			-- if a preprint template
+				if 'document' == template_t[2] then								-- if a {{cite document}} template
 					param_is_valid = validate_preprint_param (param_i, template_t[2]);
 					if param_is_valid then

Trappist the monk at 14:30, 9 January 2024

2024-01-09T14:30:33Z

← Previous revision		Revision as of 14:30, 9 January 2024
Line 998:		Line 998:
	citeciteseerx = {'Template:Cite CiteSeerX/doc', 'citeseerx'}, -- no template data; preprint uses limited arguments		citeciteseerx = {'Template:Cite CiteSeerX/doc', 'citeseerx'}, -- no template data; preprint uses limited arguments
	citeconference = {'Template:Cite conference/doc', 'conference'}, -- unique arguments		citeconference = {'Template:Cite conference/doc', 'conference'}, -- unique arguments
			citedocument = {'Template:Cite document/doc'},
	citeencyclopedia = {'Template:Cite encyclopedia/doc'},		citeencyclopedia = {'Template:Cite encyclopedia/doc'},
	citeepisode = {'Template:Cite episode/doc', 'episode'}, -- unique arguments		citeepisode = {'Template:Cite episode/doc', 'episode'}, -- unique arguments

Trappist the monk at 19:46, 26 October 2023

2023-10-26T19:46:06Z

← Previous revision		Revision as of 19:46, 26 October 2023
Line 1,014:		Line 1,014:
	citesign = {'Template:Cite sign/doc'},		citesign = {'Template:Cite sign/doc'},
	citespeech = {'Template:Cite speech/doc', 'speech'}, -- unique arguments -- no template data		citespeech = {'Template:Cite speech/doc', 'speech'}, -- unique arguments -- no template data
	citessrn = {'Template:Cite ~~ssrn~~/doc', 'ssrn'}, -- preprint arguments -- no template data		citessrn = {'Template:Cite SSRN/doc', 'ssrn'}, -- preprint arguments -- no template data
	citetechreport = {'Template:Cite techreport/doc'},		citetechreport = {'Template:Cite techreport/doc'},
	citethesis = {'Template:Cite thesis/doc', 'thesis'}, -- unique arguments		citethesis = {'Template:Cite thesis/doc', 'thesis'}, -- unique arguments

Trappist the monk at 15:44, 25 October 2023

2023-10-25T15:44:48Z

← Previous revision		Revision as of 15:44, 25 October 2023
Line 1,193:		Line 1,193:
	local function template_data_validate (frame)		local function template_data_validate (frame)
	local args_t = getArgs (frame);		local args_t = getArgs (frame);


	if not args_t[1] then		if not args_t[1] then
	return '<span style="color:#d33">Error: cs1\|2 template name required</span>';		return '<span style="color:#d33">Error: cs1\|2 template name required</span>';
Line 1,206:		Line 1,206:

	local cfg_aliases_t = cfg_aliasts_t_make ();		local cfg_aliases_t = cfg_aliasts_t_make ();


	local template_t = templates_t[template_idx];		local template_t = templates_t[template_idx];
Line 1,227:		Line 1,226:
	local param_is_valid; -- boolean true when param is valid; nil else		local param_is_valid; -- boolean true when param is valid; nil else
	if template_t[2] then -- if template is a preprint or uses unique parameters		if template_t[2] then -- if template is a preprint or uses unique parameters
	if whitelist.preprint_arguments_t[template_t[2]] then -- if a preprint template		if whitelist.preprint_arguments_t[template_t[2]] then -- if a preprint template
	param_is_valid = validate_preprint_param (param_i, template_t[2]);		param_is_valid = validate_preprint_param (param_i, template_t[2]);
	if param_is_valid then		if param_is_valid then
Line 1,269:		Line 1,268:
	for _, alias in ipairs (param_t['aliases']) do		for _, alias in ipairs (param_t['aliases']) do
	local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character		local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character
	if not validate_basic_param (alias_i) and not validate_id_alias (param, alias) then -- for isbn13 (while still supported) must not mask the digits		if not validate_basic_param (alias_i) and not validate_id_alias (param, alias) then -- for isbn13 (while still supported) must not mask the digits
	table.insert (out, alias_error_msg (param, alias));		table.insert (out, alias_error_msg (param, alias));
			elseif cfg_aliases_t[param_i:gsub ('#', '')] ~= cfg_aliases_t[alias_i:gsub ('#', '')] then -- is 'alias' known to be an alias of 'param'?
			table.insert (out, alias_error_msg (param, alias));
	end		end
	end		end

Trappist the monk at 22:12, 29 September 2023

2023-09-29T22:12:30Z

@@ Line 1,408: / Line 1,408: @@
 local function uncategorized_namespace_lister (frame)
 	local list_t = {};
 	local function compare (a, b)												-- local function to sort namespaces numerically by the identifiers
@@ Line 1,439: / Line 1,436: @@
 --[[--------------------------< E X P O R T E D   F U N C T I O N S >------------------------------------------
 ]]
@@ Line 1,458: / Line 1,472: @@
 	maint_cat_page_tally = maint_cat_page_tally,
 	script_lang_lister = script_lang_lister,
 	template_data_validate = template_data_validate,
 	uncategorized_namespace_lister = uncategorized_namespace_lister,

Trappist the monk at 23:46, 12 August 2023

2023-08-12T23:46:23Z

← Previous revision		Revision as of 23:46, 12 August 2023
Line 187:		Line 187:
	local lang = (frame.args.lang and '' ~= frame.args.lang) and frame.args.lang or mw.getContentLanguage():getCode()		local lang = (frame.args.lang and '' ~= frame.args.lang) and frame.args.lang or mw.getContentLanguage():getCode()
	local source_list = mw.language.fetchLanguageNames(lang, 'all');		local source_list = mw.language.fetchLanguageNames(lang, 'all');
	local override = cfg.~~lang_code_remap~~;		local override = cfg.lang_tag_remap;
	local code_1_list={};		local code_1_list={};
	local code_2_list={};		local code_2_list={};
Line 259:		Line 259:
	local function script_lang_lister (frame)		local function script_lang_lister (frame)
	local lang_code_src = cfg.script_lang_codes ; -- get list of allowed script language codes		local lang_code_src = cfg.script_lang_codes ; -- get list of allowed script language codes
	local override = cfg.~~lang_code_remap~~;		local override = cfg.lang_tag_remap;
	local this_wiki_lang = mw.language.getContentLanguage().code; -- get this wiki's language		local this_wiki_lang = mw.language.getContentLanguage().code; -- get this wiki's language

Line 695:		Line 695:
	local lang_list_t = mw.language.fetchLanguageNames ('en', 'all');		local lang_list_t = mw.language.fetchLanguageNames ('en', 'all');

	local function script_cat_lister (script_lang_codes_t, ~~lang_code_remap_t~~, cats_list_t)		local function script_cat_lister (script_lang_codes_t, lang_tag_remap_t, cats_list_t)
	for _, lang_code in ipairs (script_lang_codes_t) do		for _, lang_code in ipairs (script_lang_codes_t) do
	local lang_name = ~~lang_code_remap_t~~[lang_code] or lang_list_t[lang_code]; -- use remap table to get Bengali instead of Bangla and the like; else use standard MediaWiki names		local lang_name = lang_tag_remap_t[lang_code] or lang_list_t[lang_code]; -- use remap table to get Bengali instead of Bangla and the like; else use standard MediaWiki names
	local cat = 'CS1 uses ' .. lang_name .. '-language script (' .. lang_code .. ')'; -- build a category name		local cat = 'CS1 uses ' .. lang_name .. '-language script (' .. lang_code .. ')'; -- build a category name
	cats_list_t[cat] = 1; -- and save it		cats_list_t[cat] = 1; -- and save it
Line 778:		Line 778:
	end		end

	script_cat_lister (cfg.script_lang_codes, ~~cfg.lang_code_remap or~~ cfg.lang_tag_remap, list_live_cats); -- get live module's foriegn language script cats		script_cat_lister (cfg.script_lang_codes, cfg.lang_tag_remap, list_live_cats); -- get live module's foriegn language script cats

	if sandbox then -- if ~/sandbox module exists and \|sandbox= not set to 'no'		if sandbox then -- if ~/sandbox module exists and \|sandbox= not set to 'no'
Line 786:		Line 786:
	end		end

	script_cat_lister (sb_cfg.script_lang_codes, ~~sb_cfg.lang_code_remap or~~ sb_cfg.lang_tag_remap, list_sbox_cats); -- get sandbox module's foriegn language script cats		script_cat_lister (sb_cfg.script_lang_codes, sb_cfg.lang_tag_remap, list_sbox_cats); -- get sandbox module's foriegn language script cats
	end		end
	else		else