Jump to content

Module:Nihongo/sandbox

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Trappist the monk (talk | contribs) at 14:14, 2 October 2022. The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
require('Module:No globals');

local nihongo_err_msg = 'Japanese or romaji text required';
local hanyu_err_msg = 'Chinese or pinyin text required';

local cfg = {
	['nihongo'] = {
		tag = 'ja',
		template = 'nihongo',
		system = 'hepburn',
		system_link = '[[Hepburn romanization|Hepburn]]',
		err_msg = nihongo_err_msg,
		},
	['nihongo3'] = {
		tag = 'ja',
		template = 'nihongo3',
		system = 'hepburn',
		err_msg = nihongo_err_msg,
		},
	['nihongokrt'] = {
		tag = 'ja',
		template = 'nihongo krt',
		system = 'hepburn',
		err_msg = nihongo_err_msg,
		},
	['nihongofoot'] = {
		tag = 'ja',
		template = 'nihongo foot',
		system = 'hepburn',
		system_link = '[[Hepburn romanization|Hepburn]]',
		err_msg = nihongo_err_msg,
		},
	['hanyu'] = {
		tag = 'zh',
		template = 'hanyu',
		system = 'pinyin',
		system_link = '[[Pinyin]]',
		err_msg = hanyu_err_msg,
		},
	['hanyu3'] = {
		tag = 'zh',
		template = 'hanyu3',
		system = 'pinyin',
		err_msg = hanyu_err_msg,
		},
	['hanyukrt'] = {
		tag = 'zh',
		template = 'hanyu krt',
		system = 'pinyin',
		err_msg = hanyu_err_msg,
		},
	['hanyufoot'] = {
		tag = 'zh',
		template = 'hanyu foot',
		system = 'pinyin',
		system_link = '[[Pinyin]]',
		err_msg = hanyu_err_msg,
		},
	}

--[[--------------------------< N I H O N G O _ E R R O R >----------------------------------------------------

Creates an error message for {{nihongo}}, {{nihongo3}}, {{nihongo krt}}, and {{nihongo foot}} when these template are missing <japanese>
or <romaji> inputs; names the offending template, links to template page, and adds article to Category:Nihongo template errors

]]

local function nihongo_hanyu_error (template)
	local msg = {'<span class="error" style="font-size:100%">error: {{'};
	table.insert (msg, cfg[template].template);
	table.insert (msg, '}}: ');
	table.insert (msg, cfg[template].err_msg);
	table.insert (msg, ' ([[Template:');
	table.insert (msg, cfg[template].template);
	table.insert (msg, '|help]])</span>');
	if 0 == mw.title.getCurrentTitle().namespace then
		table.insert (msg, '[[Category:Nihongo template errors]]');
	end

	return table.concat (msg);	
end


--[[--------------------------< R E N D E R E R >--------------------------------------------------------------

Shared support function for nihingo(), nihongo3(), and nihongo_foot().  Calculates an index into formatting{}
from set/unset parameters:
	args[1] (english) has a value of 8 (set) or 0 (unset)
	args[2] (japanese) has a value of 4
	args[3] (romaji) has a value of 2
	args[4] (extra) has a value of 1
index, the sum of these values, gets the appropriate format string from formatting{} table with associated values
from the formatting[index][2] table

]]

local function renderer (args, formatting, extra2)
	local output;
	local index = 0;															-- index into formatting{}
	local param_weight = {8, 4, 2, 1};											-- binary parameter weights: [1] = english (8), [2] = japanese (4), [3] = romaji (2), [4] = extra (1)

	for i=1, 5 do																-- spin through args[1] – args[4]
		index = index + (args[i] and param_weight[i] or 0);						-- calculate an index into formatting{}
	end

	output = (0 ~= index) and string.format (formatting[index][1] and formatting[index][1], formatting[index][2][1], formatting[index][2][2], formatting[index][2][3], formatting[index][2][4]) or nil;

	if extra2 then																-- always just attached to the end (if there is an end) so not part of formatting{}
		output = output and (output .. ' ' .. extra2) or '<5p4n>' .. extra2;	-- <5p4n> and </5p4n>: place holders for font-weight style spans; akin to stripmarkers, to be replaced
	end																			-- (nihongo and nihongo3) or removed (nihongo foot)

	return output and (output .. '</5p4n>') or '';								-- where there is output, add secret tag close
end


--[[--------------------------< R O M A N I Z E D _ K E R N >--------------------------------------------------

Add kerning when first or last character of romaji/pinyin contacts adjacent opening or closing paranthesis

In this example, without kerning, the romaji characters 'j' and 'V' are italicized so will contact the parentheses
	(<i lang=\"ja-Latn\" title=\"Hepburn transliteration\">jV</i>)

<ret_string> is the formatted template output (except that the magic string '<5p4n>' has not yet been replaced)
<jpnchi> is the return from lang_module._transl() so is not wrapped in parentheses

]]

local function romanized_kern (ret_string, jpnchi)
	if not jpnchi or ('' == jpnchi) then										-- if jpnchi not set
		return ret_string;														-- then we're done
	end

	local jpnchi_text = jpnchi:gsub ('%b<>', ''):gsub ('\'\'+', ''):gsub ('%[%[', ''):gsub ('%]%]', '');	-- strip html tags

	jpnchi = jpnchi:gsub ('([%(%)%.%%%+%-%*%?%[%^%$%]])', '%%%1');				-- escape lua pattern characters

	local jpnchi_has_leading_paren = ret_string:match ('%(' .. jpnchi);			-- has a value if (<jpnchi>; nil else
	local jpnchi_has_trailing_paren = ret_string:match (jpnchi .. '%)');		-- has a value if <jpnchi>); nil else

	local kern_lead_pattern = '^[jpy]';											-- list of characters that when italicized contact unitalicized leading parenthesis
	local kern_tail_pattern = '[dfijkltCEFHIJKMNPR-Z\'"%?!%]]$';				-- list of characters that when italicized contact unitalicized trailing parenthesis

	local kern_right = '<span style="margin-right:.09em">(</span>%1';			-- %1 is <jpnchi> capture
	local kern_left = '%1<span style="margin-left:.09em">)</span>';				-- %1 is <jpnchi> capture

	if jpnchi_has_leading_paren and jpnchi_text:match (kern_lead_pattern) then
		ret_string = ret_string:gsub ('%((' .. jpnchi .. ')', kern_right);		-- replace plain '(' with kerned '('; <jpnchi> included here to ensure that the correct '(' is kerned
	end
	if jpnchi_has_trailing_paren and jpnchi_text:match (kern_tail_pattern) then
		ret_string = ret_string:gsub ('(' .. jpnchi .. ')%)', kern_left);		-- replace plain ')' with kerned ')'; <jpnchi> included here to ensure that the correct ')' is kerned
	end

	return ret_string;															-- done
end


--[[--------------------------< N I H O N G O _ H A N Y U _ C O M M O N >--------------------------------------

Common support for {{nihongo}} and {{hanyu}}

<template> is 'nihongo' or 'hanyu' used to select the appropriate cfg table

]]

local function nihongo_hanyu_common (frame, template)
	local lang_module = require ('Module:Lang' .. (frame:getTitle():match ('/sandbox') or ''));	-- if this module is the sandbox, use Module:lang/sandbox; Module:Lang else

	local args = require ('Module:Arguments').getArgs (frame);
	
	local english, jpnchi, romanized, extra, extra2 = args[1], args[2], args[3], args.extra or args[4], args.extra2 or args[5];	-- meaningful names
	args[4] = extra or args[4];													-- ensure that extra is 'positional' for use by renderer()

	local lead = 'yes' == args.lead;											-- make boolean

	if not (jpnchi or romanized) then											-- not present, return an error message
		return nihongo_hanyu_error (template);
	end
	if jpnchi then
		local template = cfg[template].template;
		jpnchi = lead and lang_module._lang_xx_inherit ({['code']=cfg[template].tag, jpnchi, ['template']=template}) or lang_module._lang ({cfg[template].tag, jpnchi, ['template']=template});	-- add ja script with/without language prefix
	end
	if romanized then
		romanized = (lead and english and (cfg[template].system_link .. ': ') or '') .. lang_module._transl ({'ja', cfg[template].system, romanized}) or nil;
	end

	local formatting = {														-- <5p4n> and </5p4n>: place holders for font-weight style spans; akin to stripmarkers, replaced  before function returns
		{'<5p4n>(%s)', {extra}}, 												-- 1 - (extra)
		{'%s<5p4n>', {romanized}},												-- 2 - romanized
		{'%s<5p4n> (%s)', {romanized, extra}},									-- 3 - romanized (extra)
		{'<5p4n>(%s)', {jpnchi}},												-- 4 - jpnchi
		{'<5p4n>(%s, %s)', {jpnchi, extra}},									-- 5 - (jpnchi, extra)
		{'%s<5p4n> (%s)', {romanized, jpnchi}},									-- 6 - romanized (jpnchi)
		{'%s<5p4n> (%s, %s)', {romanized, jpnchi, extra}},						-- 7 - romanized (jpnchi, extra)
		{'%s<5p4n>', {english}},												-- 8 - english
		{'%s<5p4n> (%s)', {english, extra}},									-- 9 - english (extra)
		{'%s<5p4n> (%s)', {english, romanized}},								-- 10 - english (romanized)
		{'%s<5p4n> (%s, %s)', {english, romanized, extra}},						-- 11 - english (romanized, extra)
		{'%s<5p4n> (%s)', {english, jpnchi}},									-- 12 - english (jpnchi)
		{'%s<5p4n> (%s, %s)', {english, jpnchi, extra}},						-- 13 - english (jpnchi, extra)
		{'%s<5p4n> (%s, %s)', {english, jpnchi, romanized}},					-- 14 - english (jpnchi, romanized)
		{'%s<5p4n> (%s, %s, %s)', {english, jpnchi, romanized, extra}},			-- 15 - english (jpnchi, romanized, extra)
		}

	local ret_string = renderer (args, formatting, extra2)
	ret_string = romanized_kern (ret_string, romanized);						-- kern romanized text when appropriate
	ret_string = ret_string:gsub ('<5p4n>', '<span style="font-weight: normal">'):gsub ('</5p4n>', '</span>');	-- replace 'secret' tags with proper tags

	return ret_string;															-- because gsub returns the number of replacements made as second return value
end


--[[--------------------------< N I H O N G O _ H A N Y U _ 3 _ C O M M O N >----------------------------------

Common support for {{nihongo3}} and {{hanyu3}}

<template> is 'nihongo' or 'hanyu' used to select the appropriate cfg table

]]

local function nihongo_hanyu_3_common (frame, template)
	local lang_module = require ('Module:Lang' .. (frame:getTitle():match ('/sandbox') or ''));	-- if this module is the sandbox, use Module:lang/sandbox; Module:Lang else
	local args = require ('Module:Arguments').getArgs (frame);
	
	local english, jpnchi, romanized, extra, extra2 = args[1], args[2], args[3], args.extra or args[4], args.extra2 or args[5];	-- meaningful names
	args[4] = extra or args[4];													-- ensure that extra is 'positional' for use by renderer()

	if not (jpnchi or romanized) then											-- not present, return an error message
		return nihongo_hanyu_error (template);
	end
	jpnchi = jpnchi and lang_module._lang ({cfg[template].tag, jpnchi}) or nil;
	romanized = romanized and lang_module._transl ({cfg[template].tag, cfg[template].system, romanized}) or nil;
	
	local formatting = {														-- <5p4n> and </5p4n>: place holders for font-weight style spans; akin to stripmarkers, replaced  before function returns
		{'<5p4n>(%s)', {extra}}, 												-- 1 - (extra)
		{'%s<5p4n>', {romanized}},												-- 2 - romanized
		{'%s<5p4n> (%s)', {romanized, extra}},									-- 3 - romanized (extra)
		{'<5p4n>(%s)', {jpnchi}},												-- 4 - jpnchi
		{'<5p4n>(%s, %s)', {jpnchi, extra}},									-- 5 - (jpnchi, extra)
		{'%s<5p4n> (%s)', {romanized, jpnchi}},									-- 6 - romanized (jpnchi)
		{'%s<5p4n> (%s, %s)', {romanized, jpnchi, extra}},						-- 7 - romanized (jpnchi, extra)
		{'%s<5p4n>', {english}},												-- 8 - english
		{'%s<5p4n> (%s)', {english, extra}},									-- 9 - english (extra)
		{'%s<5p4n> (%s)', {romanized, english}},								-- 10 - romanized (english)
		{'%s<5p4n> (%s, %s)', {romanized, english, extra}},						-- 11 - romanized (english, extra)
		{'%s<5p4n> (%s)', {english, jpnchi}},									-- 12 - english (jpnchi)
		{'%s<5p4n> (%s, %s)', {english, jpnchi, extra}},						-- 13 - english (jpnchi, extra)
		{'%s<5p4n> (%s, %s)', {romanized, jpnchi, english}},					-- 14 - romanized (jpnchi, english)
		{'%s<5p4n> (%s, %s, %s)', {romanized, jpnchi, english, extra}},			-- 15 - romanized (jpnchi, english, extra)
		}

	local ret_string = renderer (args, formatting, extra2)
	ret_string = ret_string:gsub ('<5p4n>', '<span style="font-weight: normal">'):gsub ('</5p4n>', '</span>');	-- replace 'secret' tags with proper tags
	return ret_string;															-- because gsub returns the number of replacements made as second return value
end

--[[--------------------------< N I H O N G O _ H A N Y U _ K R T _ C O M M O N >------------------------------

Common support for {{nihongo3}} and {{hanyu3}}

<template> is 'nihongo' or 'hanyu' used to select the appropriate cfg table

]]

local function nihongo_hanyu_krt_common (frame, template)
	local lang_module = require ('Module:Lang' .. (frame:getTitle():match ('/sandbox') or ''));	-- if this module is the sandbox, use Module:lang/sandbox; Module:Lang else
	local args = require ('Module:Arguments').getArgs (frame);
	
	local english, jpnchi, romanized, extra, extra2 = args[1], args[2], args[3], args.extra or args[4], args.extra2 or args[5];	-- meaningful names
	args[4] = extra or args[4];													-- ensure that extra is 'positional' for use by renderer()

	if not (jpnchi or romanized) then											-- not present, return an error message
		return nihongo_hanyu_error (template);
	end
	jpnchi = jpnchi and lang_module._lang ({cfg[template].tag, jpnchi}) or nil;
	romanized = romanized and lang_module._transl ({cfg[template].tag, cfg[template].system, romanized}) or nil;
	
	local formatting = {														-- <5p4n> and </5p4n>: place holders for font-weight style spans; akin to stripmarkers, replaced  before function returns
		{'<5p4n>(%s)', {extra}}, 												-- 1 - (extra)
		{'%s<5p4n>', {romanized}},												-- 2 - romanized
		{'%s<5p4n> (%s)', {romanized, extra}},									-- 3 - romanized (extra)
		{'<5p4n>%s', {jpnchi}},													-- 4 - jpnchi
		{'<5p4n>%s (%s)', {jpnchi, extra}},										-- 5 - jpnchi (extra)
		{'<5p4n>%s (%s)', {jpnchi, romanized}},									-- 6 - jpnchi (romanized)
		{'<5p4n>%s (%s, %s)', {jpnchi, romanized, extra}},						-- 7 - jpnchi (romanized, extra)
		{'%s<5p4n>', {english}},												-- 8 - english
		{'%s<5p4n> (%s)', {english, extra}},									-- 9 - english (extra)
		{'%s<5p4n> (%s)', {romanized, english}},								-- 10 - romanized (english)
		{'%s<5p4n> (%s, %s)', {romanized, english, extra}},						-- 11 - romanized (english, extra)
		{'<5p4n>%s (%s)', {jpnchi, english}},									-- 12 - jpnchi (english)
		{'<5p4n>%s (%s, %s)', {jpnchi, english, extra}},						-- 13 - jpnchi (english, extra)
		{'<5p4n>%s (%s, %s)', {jpnchi, romanized, english}},						-- 14 - jpnchi (romanized, english)
		{'<5p4n>%s (%s, %s, %s)', {jpnchi, romanized, english, extra}},			-- 15 - jpnchi (romanized, english, extra)
		}

	local ret_string = renderer (args, formatting, extra2)
	ret_string = romanized_kern (ret_string, romanized);						-- kern romanized text when appropriate
	ret_string = ret_string:gsub ('<5p4n>', '<span style="font-weight: normal">'):gsub ('</5p4n>', '</span>');	-- replace 'secret' tags with proper tags
	return ret_string;															-- because gsub returns the number of replacements made as second return value
end


--[[--------------------------< N I H O N G O _ H A N Y U _ F O O T _ C O M M O N >----------------------------

Common support for {{nihongo foot}} and {{hanyu foot}}

<template> is 'nihongo' or 'hanyu' used to select the appropriate cfg table

]]

local function nihongo_hanyu_foot_common (frame, template)
	local lang_module = require ('Module:Lang' .. (frame:getTitle():match ('/sandbox') or ''));	-- if this module is the sandbox, use Module:lang/sandbox; Module:Lang else
	local args = require ('Module:Arguments').getArgs (frame);
	
	local english, jpnchi, romanized, extra, extra2 = args[1], args[2], args[3], args.extra or args[4], args.extra2 or args[5];	-- meaningful names
	args[4] = extra or args[4];													-- ensure that extra is 'positional' for use by renderer()
	local post = args[6] or args.post;
	local group = args.group;
	local ref_name = args.ref_name
	local lead = 'yes' == args.lead;											-- make boolean

	if not (jpnchi or romanized) then											-- not present, return an error message
		return nihongo_hanyu_error (template);
	end
	if jpnchi then
		jpnchi = lead and lang_module._lang_xx_inherit ({['code']=cfg[template].tag, jpnchi}) or lang_module._lang ({cfg[template].tag, jpnchi});	-- add ja script with/without language prefix
	end
	if romanized then
		romanized = (lead and (cfg[template].system_link .. ': ') or '') .. lang_module._transl ({'ja', cfg[template].system, romanized}) or nil;
	end
	
	local formatting = {
		{'%s', {extra}}, 														-- 1 - extra
		{'%s', {romanized}},													-- 2 - romanized
		{'%s, %s', {romanized, extra}},											-- 3 - romanized, extra
		{'%s', {jpnchi}},														-- 4 - jpnchi
		{'%s, %s', {jpnchi, extra}},											-- 5 - jpnchi, extra
		{'%s, %s', {jpnchi, romanized}},										-- 6 - jpnchi romanized
		{'%s, %s, %s', {jpnchi, romanized, extra}},								-- 7 - jpnchi romanized, extra
																				-- from here english is used in the mapping but not rendered by renderer so not included in the table
		{'', {''}},																-- 8 - english
		{'%s', {extra}},														-- 9 - extra
		{'%s', {romanized}},													-- 10 - romanized
		{'%s, %s', {romanized, extra}},											-- 11 - romanized, extra
		{'%s', {jpnchi}},														-- 12 - jpnchi
		{'%s, %s', {jpnchi, extra}},											-- 13 - jpnchi, extra
		{'%s, %s', {jpnchi, romanized}},										-- 14 - jpnchi romanized
		{'%s, %s, %s', {jpnchi, romanized, extra}},								-- 15 - jpnchi romanized, extra
		}

	if english and post then													-- rewrite english to include |post=
		english = english .. post;												-- if english has a value append post else just post
	elseif post then
		english = post;															-- english not set, use post
	elseif not english then														-- neither are set
		english = '';															-- make english an empty string for concatenation
	end

	if jpnchi or romanized or extra or extra2 then								-- no ref tag when none of these are set (it would be empty)
		local content = renderer (args, formatting, extra2);
		content = content:gsub ('<5p4n>', ''):gsub ('</5p4n>$', '', 1);			-- strip secret <5p4n> and </5p4n> tags added by renderer(); spans not used by this template

		return english .. frame:extensionTag ({name='ref', args={group=group, name=ref_name}, content=content});	-- english with attached reference tag
	else
		return english;															-- nothing to be inside ref tag so just return english
	end
end


--[=[-------------------------< N I H O N G O >----------------------------------------------------------------

Implement {{nihongo}} using Module:Lang for language and transliteration markup

{{Nihongo|<English>|<japanese>|<romaji>|<extra>|<extra2>|lead=yes}}

<English>, <japanese>, and <romaji> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<japanese>: Japanese language text using Japanese script; TODO: require?
	<romaji>: Hepburn romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Hepburn romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>
|lead=: takes one value 'yes'; renders language name same as {{lang-ja}} but also adds [[Hepburn romanization|Hepburn]]:<space> ahead of the romanization; TODO: in Module:Lang, turnoff tooltip for transl when |lead=yes

]=]

local function nihongo (frame)
	return nihongo_hanyu_common (frame, 'nihongo')
end


--[=[-------------------------< N I H O N G O 3 >--------------------------------------------------------------

Implement {{nihongo3}} using Module:Lang for language and transliteration markup

Similar to {{nihongo}} but changes rendered order and does not support |lead=

{{Nihongo3|<English>|<japanese>|<romaji>|<extra>|<extra2>}}

<English>, <japanese>, and <romaji> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<japanese>: Japanese language text using Japanese script; TODO: require?
	<romaji>: Hepburn romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Hepburn romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>

]=]

local function nihongo3 (frame)
	return nihongo_hanyu_3_common (frame, 'nihongo3')
end


--[=[-------------------------< N I H O N G O K R T >----------------------------------------------------------

Implement {{nihongo krt}} using Module:Lang for language and transliteration markup

Similar to {{nihongo}} but changes rendered order and does not support |lead=

{{Nihongo krt|<English>|<japanese>|<romaji>|<extra>|<extra2>}}

<English>, <japanese>, and <romaji> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<japanese>: Japanese language text using Japanese script; TODO: require?
	<romaji>: Hepburn romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Hepburn romanization'?
	<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>

]=]

local function nihongokrt (frame)
	return nihongo_hanyu_krt_common (frame, 'nihongokrt')
end


--[=[-------------------------< N I H O N G O _ F O O T >------------------------------------------------------

Implement {{nihongo_foot}} using Module:Lang for language and transliteration markup

{{Nihongo foot|<English>|<japanese>|<romaji>|<extra>|<extra2>|<post>|lead=yes|group}}

<English>, <japanese>, and <romaji> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<japanese>: Japanese language text using Japanese script; TODO: require?
	<romaji>: Hepburn romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Hepburn romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>
<post> is positional or named: |post= is a postscript character preceding the <ref>..</ref> tag (after <English>)
|lead=: takes one value 'yes'; renders language name same as {{lang-ja}} but also adds [[Hepburn romanization|Hepburn]]:<space> ahead of the romanization;
	TODO: in Module:Lang, turnoff tooltip for transl when |lead=yes
	in the live template |lead= also adds the Help:Installing Japanese character sets link; this is not supported in this code (nihongo nor nihongo3 have this support)
|group=: the group attribute in <ref group="..."> and in {{reflist}}

]=]

local function nihongo_foot (frame)
	return nihongo_hanyu_foot_common (frame, 'nihongofoot')
end


--[=[-------------------------< H A N Y U >--------------------------------------------------------------------

Implement {{hanyu}} using Module:Lang for language and transliteration markup

{{hanyu|<English>|<chinese>|<pinyin>|<extra>|<extra2>|lead=yes}}

<English>, <chinese>, and <pinyin> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<chinese>: Chinese language text using Chinese script; TODO: require?
	<pinyin>: Pinyin romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Pinyin romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>
|lead=: takes one value 'yes'; renders language name same as {{lang-zh}} but also adds [[Pinyin]]:<space> ahead of the romanization; TODO: in Module:Lang, turnoff tooltip for transl when |lead=yes

]=]

local function hanyu (frame)
	return nihongo_hanyu_common (frame, 'hanyu')
end


--[=[-------------------------< H A N Y U 3 >------------------------------------------------------------------

Implement {{hanyu3}} using Module:Lang for language and transliteration markup

Similar to {{hanyu}} but changes rendered order and does not support |lead=

{{hanyu3|<English>|<chinese>|<pinyin>|<extra>|<extra2>}}

<English>, <chinese>, and <pinyin> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<chinese>: Chinese language text using Chinese script; TODO: require?
	<pinyin>: Pinyin romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Pinyin romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>

]=]

local function hanyu3 (frame)
	return nihongo_hanyu_3_common (frame, 'hanyu3')
end


--[=[-------------------------< H A N Y U K R T >--------------------------------------------------------------------

Implement {{hanyu krt}} using Module:Lang for language and transliteration markup

Similar to {{hanyu}} but changes rendered order and does not support |lead=

{{hanyu krt|<English>|<chinese>|<pinyin>|<extra>|<extra2>}}

<English>, <chinese>, and <pinyin> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<chinese>: Chinese language text using Chinese script; TODO: require?
	<pinyin>: Pinyin romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Pinyin romanization'?
	<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>

]=]

local function hanyukrt (frame)
	return nihongo_hanyu_krt_common (frame, 'hanyukrt')
end


--[=[-------------------------< H A N Y U _ F O O T >----------------------------------------------------------

Implement {{hanyu_foot}} using Module:Lang for language and transliteration markup

{{hanyu foot|<English>|<chinese>|<pinyin>|<extra>|<extra2>|<post>|lead=yes|group}}

<English>, <chinese>, and <pinyin> are positional parameters
	<English>: rendered as presented; purports to be English translation of <kanji/kana>
	<chinese>: Chinese language text using Chinese script; TODO: require?
	<pinyin>: Pinyin romanization (transliteration); TODO: in Module:Lang/data change tooltip text to 'Pinyin romanization'?
<extra> and <extra2> are positional or named: |extra= and |extra2=; mixing can be problematic
	<extra> is rendered as presented preceeded with <comma><space>
	<extra2> is rendered as presented preceeded with <space>
<post> is positional or named: |post= is a postscript character preceding the <ref>..</ref> tag (after <English>)
|lead=: takes one value 'yes'; renders language name same as {{lang-zh}} but also adds [[Pinyin]]:<space> ahead of the romanization;
	TODO: in Module:Lang, turnoff tooltip for transl when |lead=yes
	in the live template |lead= also adds the Help:Installing Chinese character sets link; this is not supported in this code (hanyu nor hanyu3 have this support)
|group=: the group attribute in <ref group="..."> and in {{reflist}}

]=]

local function hanyu_foot (frame)
	return nihongo_hanyu_foot_common (frame, 'hanyufoot')
end


--[[--------------------------< E X P O R T E D   F U N C T I O N S >------------------------------------------
]]

return {
	nihongo = nihongo,
	nihongo3 = nihongo3,
	nihongokrt = nihongokrt,
	nihongo_foot = nihongo_foot,
	
	hanyu = hanyu,
	hanyu3 = hanyu3,
	hanyukrt = hanyukrt,
	hanyu_foot = hanyu_foot,
	}