模組:Furigana

模塊文檔  [查看] [] [歷史] [刷新]

這個文檔嵌入自模塊:Furigana/doc。

本模板可以被替換引用（使用{{subst:振假名|…}}）。

為保持代碼整潔，請勿輕易替換引用。

用於標註一堆振假名。

用法

{{Photrans/button}}
{{LyricsKai
|original=
{{振假名|template=Photrans
|きらり空（そら）に響（ひび）く星（ほし）の聲（こえ）
ああ海（うみ）を照（て）らす　光（ひかり）を辿（たど）れたら
流（なが）れた星（ほし）はどこへ行（ゆ）く？
きっと何（なに）かがそこで待（ま）ってる
旗（はた）を掲（かか）げ進（すす）もう
いつでも月（つき）は歌（うた）い　旅人（たびびと）を導（みちび）いて
「もう迷（まよ）わなくていいから」
}}
|translated= <!-- 略 -->
}}

與下面這段代碼效果相同。

{{Photrans/button}}
{{LyricsKai
|original=
きらり{{Photrans|空|そら}}に{{Photrans|響|ひび}}く{{Photrans|星|ほし}}の{{Photrans|聲|こえ}}
ああ{{Photrans|海|うみ}}を{{Photrans|照|て}}らす　{{Photrans|光|ひかり}}を{{Photrans|辿|たど}}れたら
{{Photrans|流|なが}}れた{{Photrans|星|ほし}}はどこへ{{Photrans|行|ゆ}}く？
きっと{{Photrans|何|なに}}かがそこで{{Photrans|待|ま}}ってる
{{Photrans|旗|はた}}を{{Photrans|掲|かか}}げ{{Photrans|進|すす}}もう
いつでも{{Photrans|月|つき}}は{{Photrans|歌|うた}}い　{{Photrans|旅人|たびびと}}を{{Photrans|導|みちび}}いて
「もう{{Photrans|迷|まよ}}わなくていいから」
|translated= <!-- 略 -->
}}

效果：

[關閉注音]

本段落中所使用的歌詞，其著作權屬於原著作權人，僅以介紹為目的引用。

きらり空（そら）に響（ひび）く星（ほし）の聲（こえ）

亮晶晶 天空中迴響著 星星的聲音

ああ海（うみ）を照（て）らす　光（ひかり）を辿（たど）れたら

啊 追著照亮海面的光束

流（なが）れた星（ほし）はどこへ行（ゆ）く？

流星將去向何處

きっと何（なに）かがそこで待（ま）ってる

在那兒一定有什麼在等著

旗（はた）を掲（かか）げ進（すす）もう

揚起旗幟前進吧

いつでも月（つき）は歌（うた）い　旅人（たびびと）を導（みちび）いて

無論何時 月兒在歌唱 為旅人指著路

「もう迷（まよ）わなくていいから」

所以不會再迷路了

參數

• 匿名參數：需要轉換振假名的內容，可以傳入多個參數。形如漢字[1]（かんじ）的將被轉換為{{template|漢字|かんじ}}，注意是全角括號。
• template：振假名所用模板名，默認值為Ruby。
• compatible：為非空值時啟用兼容模式。僅當不啟用兼容模式會出問題時才應啟用兼容模式。

模板不自帶語言屬性，請確保本模板外部標註了語言，例如，{{LyricsKai}}左欄默認標註了lang="ja"。

連續漢字只標註一部分

用管道符隔開即可：

{{lj|{{振假名|……由崎|星空（ナサ）……}}}}

結果：……由崎星空（ナサ）……

對比不隔開的效果：

{{lj|{{振假名|……由崎星空（ナサ）……}}}}

結果：……由崎星空（ナサ）……

漢字後的括號不是注音

要使漢字後的括號出現在正文中，使用管道符將漢字與括號隔開即可：

{{lj|{{振假名|世紀の覚醒|（2度寢ー3度寢ー）}}}}

結果：世紀の覚醒（2度寢ー3度寢ー）

想要注音的文字不是漢字

本模板內可以正常用其他注音模板：

{{lj|{{振假名|{{ruby|1人|ひとり}}でも大丈夫（だいじょうぶ）だからただ前（まえ）を見（み）て}}}}

結果：1人（ひとり）でも大丈夫（だいじょうぶ）だからただ前（まえ）を見（み）て

從其他注音模板轉換為本模板

一個工具模塊Furigana/utils的transform函數可用於轉換原始碼，使用時請替換引用（即subst:）。它將自動識別所使用的注音模板（限{{Ruby}}、{{Photrans}}、{{Photrans2}}和{{Photransa}}），並選擇出現次數最多的作為template參數^[2]，未被選中的會保留原樣。

{{LyricsKai
|original=
{{subst:#invoke:Furigana/utils|transform|
きらり{{Photrans|空|そら}}に{{Photrans|響|ひび}}く{{Photrans|星|ほし}}の{{Photrans|聲|こえ}}
ああ{{Photrans|海|うみ}}を{{Photrans|照|て}}らす　{{Photrans|光|ひかり}}を{{Photrans|辿|たど}}れたら
{{Photrans|流|なが}}れた{{Photrans|星|ほし}}はどこへ{{ruby|行|ゆ}}く？
きっと{{Photrans|何|なに}}かがそこで{{Photrans|待|ま}}ってる
{{Photrans|旗|はた}}を{{Photrans|掲|かか}}げ{{Photrans|進|すす}}もう
いつでも{{Photrans|月|つき}}は{{Photrans|歌|うた}}い　{{Photrans|旅人|たびびと}}を{{Photrans|導|みちび}}いて
「もう{{Photrans|迷|まよ}}わなくていいから」
}}
|translated= <!-- 略 -->
}}

保存後代碼將變為：

{{LyricsKai
|original=
{{振假名|template=Photrans
|きらり空（そら）に響（ひび）く星（ほし）の聲（こえ）
ああ海（うみ）を照（て）らす　光（ひかり）を辿（たど）れたら
流（なが）れた星（ほし）はどこへ{{ruby|行|ゆ}}く？
きっと何（なに）かがそこで待（ま）ってる
旗（はた）を掲（かか）げ進（すす）もう
いつでも月（つき）は歌（うた）い　旅人（たびびと）を導（みちび）いて
「もう迷（まよ）わなくていいから」
}}
|translated= <!-- 略 -->
}}

該轉換模塊同樣支持通過template手動指定注音模板，不限於上面幾個自動識別的模板。

注意，如果原始代碼中，某個注音模板符合以下情況之一：

• 包含超過2個參數；
• 包含換行；
• 包含等號；
• 參數1不全是漢字^[1]；
• 嵌套了模板。

則該注音模板將保留原樣。例如：

{{subst:#invoke:Furigana/utils|transform|
きらり{{ruby|空|そら}}に{{ruby|響|ひび|ja}}く{{ruby|星|ほ
し}}の{{ruby|聲|{{黑幕|こえ}}}}

{{ruby|1人|ひとり}}
}}

保存後代碼將變為：

{{振假名
|きらり空（そら）に{{ruby|響|ひび|ja}}く{{ruby|星|ほ
し}}の{{ruby|聲|{{黑幕|こえ}}}}

{{ruby|1人|ひとり}}
}}

模塊測試結果（開發者用）

展開結果

【通過】測試1：將「漢字（注音）」（漢字可能是多個字符）解析為{ type = 'rb-rt', rb = '漢字', rt = '注音' }，其餘部分解析為{ type = '...', content = '...' } 【通過】測試2：能夠解析連續「漢字（注音）」 【通過】測試3：某處「漢字（注音）」的括號不成對時，不影響同一行後續的解析 【通過】測試4：每行單獨統計成對的括號。括號內容跨行時，不視為rt，上一行的左括號不會作為下一行括號閉合的依據 【通過】測試5：「非漢字（括號內的內容）」視為普通文本 【通過】測試6：嵌套括號 【通過】測試7：HTML標籤屬性中的括號不會被視為rt 【通過】測試8：存在<ruby>元素時，該元素的內容不會被解析為rb-rt，即使它包含括號 【通過】測試9：換行不會影響對<ruby>元素的判斷 【通過】測試10：傳入多個字符串時，前一個字符串尾部與後一個字符串頭部的漢字不會被當成一個整體

合併   查 · 論 · 編 格式模板 輔助模板 • 格式模板 • 計算模板 • 討論模板 • 圖像模板 • 信息模板 • 頁頂模板 排版 元素浮動 浮動{{Float}} • 清除浮動{{Clear}} • 修改浮動方向{{Clear2}} • 多行{{Stack}}{{Stack begin}}{{Stack end}} • {{Flex}} 分欄 內聯{{Columns-list}} • 多行{{Multicol}}{{Multicol-break}}{{Multicol-end}} 對齊 向下對齊{{Bottom}} • 水平居中{{Center}} 特殊字符 文字連接符{{Wj}}/⁠ • 零寬空格{{Zwsp}}/​ • 不換行空格{{Nbsp}}/  表格 {{Table}} • 單列統一樣式{{Table column style}} 書寫方向 修改書寫方向{{Writing-mode}} • 豎排頁面{{Tategaki}} • 鏡像文本{{鏡像}} 懸停效果 {{Moe-hover}} • {{Hover}} • {{HoverInline}} • {{Hovers}} • {{TextHover}} • {{PicHover}} 顏色 文字顏色 標準{{Color}} • 連結{{Coloredlink}} • 帶顏色的日文{{Cj}} 背景顏色 文字背景色{{Background color}} • 螢光筆效果{{螢光筆}} • {{背景圖片區域}} 文字及背景顏色 行內文字顏色{{Color2}} • 自動化彩幕{{彩幕}} • 高亮文字含上標{{高亮文字}} 交叉顏色 {{交叉顏色}} • {{交叉顏色F}} • {{交叉顏色護眼版}} • {{Rainbow}} 陰影 {{Shadowcolor}} • {{交叉陰影}} 漸變 {{Gradient Text}} • {{Linear-gradient}} • {{Rainbow text}} 顏色塊 {{Color block}} • {{Color block/wl}} • {{CharaBlock}} 顏色操作 顏色計算{{ColorOps}} • 「色相·色度·明度」色彩空間{{Hct}} • 色彩閾值{{亮度閾值}}{{明度閾值}} 格式 字體 Emoji{{Emojifont}} 文字樣式 全功能{{Font}} • 邊框{{Border}} • 代碼格式化{{Pre}} • 強調{{Text-emphasis}} • 上劃線{{上劃線}} • 文字描邊{{文字描邊}} • 文字描邊2{{文字描邊2}} • 文字外發光{{文字外發光}}{{文字外發光/stroke}}{{漸變發光}} • 傾斜文本 {{傾斜文本}} 假樣式 {{假黑幕}} • {{假鏈}} • {{Falselink}} • {{假摺疊}} 格式化 不可見0{{0}} • 交替文本{{Crosstext}} • 空格生成 / 重複文字{{Space}} • 填充空間 / 佔位{{Pad}}{{Padding}} • 小數捨入 / 補零{{Strformat}} 梗 自動化黑幕 {{黑幕}} • 灰色刪除線 {{胡話}} • 模糊文字{{文字模糊}} 注音 Ruby系列 標準{{Ruby}} • 黑幕{{Rubyh}} • 多行{{Ruby-begin}}{{Ruby-item}}{{Ruby-end}} • 單字{{Rubya}} • 簡化版{{RawRuby}} 其它 可開關注音{{Photrans}}{{Photrans2}} • 逐詞可開關注音{{Photransa}} • {{日本人名}} • 國際音標{{IPA}} • 日文句段注音{{振假名}} 其它 定型文 {{配音表}} • {{提問箱}} • {{UnicodeTable}} 連結及分類相關 內鏈分類{{Cate}}{{萌點}} • 名字分類{{Catn}} • ISBN連結{{ISBN}} • 隱藏紅鏈{{Link}} • 無標記外鏈{{Plain link}} • 換色連結{{Coloredlink}} • 連結語言標識{{Languageicon}} 導航框 導航框組件{{Navbox}}{{Navbox subgroup}}{{Navbox with columns}}{{Navbox with collapsible groups}}{{Navbar}} • 大家族簡易模板{{大家族}}{{大家族模板子項}}{{大家族內容行}}{{Linksplit}} • 橫向列表{{Hlist}} 注釋 來源請求{{Citation needed}} • 已故人物{{Dead}}{{已故人物標註}} • 上標{{Supt}} • 分級標誌{{遊戲分級}}{{電影分級}} • 適齡提示標誌{{適齡提示}} • 引言{{Cquote}}{{Quote}}{{Quote frame}}{{文字框}} • 附註{{Ps}} • 註解(註) {{註解}}

注釋

1. ↑ ^{移至： 1.0 1.1} 以及「々」「〆」。
2. 移至 ↑ 由於Ruby是默認值，所以將會省略。

local p = {}
 
-- 轉化為upvalue，提升速度
local type = type
local ipairs = ipairs
local concat = table.concat
local u_gsub = mw.ustring.gsub
local u_sub = mw.ustring.sub
 
local KANJI_LIKE_UNICODE_RANGES = {
	{ 0x2E80,  0x2EFF },  -- CJK部首補充
	{ 0x3005,  0x3007 },  -- "々、〆、〇"
	{ 0x31C0,  0x31EF },  -- CJK筆畫
	{ 0x3400,  0x4DBF },  -- CJK統一表意文字擴展A
	{ 0x4E00,  0x9FFF },  -- CJK統一表意文字
	{ 0xF900,  0xFAFF },  -- CJK兼容表意文字
	{ 0x20000, 0x2A6DF }, -- CJK統一表意文字擴展B
	{ 0x2A700, 0x2EE5F }, -- CJK統一表意文字擴展C-I
	{ 0x2F800, 0x2FA1F }, -- CJK兼容表意文字補充
	{ 0x30000, 0x323AF }, -- CJK統一表意文字擴展G-H
}
local KANJI_LIKE_PATTERN = (function ()
	local char = mw.ustring.char
	local parts = {}
	for i, range in ipairs(KANJI_LIKE_UNICODE_RANGES) do
		parts[i] = type(range) == 'table' and char(range[1])..'-'..char(range[2]) or char(range)
	end
	return '['..concat(parts)..']'
end)()
 
 
--[[
把<tag>、</tag>與其他文本分開。
```lua
divide_tags_and_non_tags('A<span title="（title）">B</span>C')
-->
{
	{ type = 'unknown', content = 'A' },
	{ type = 'tag', content = '<span title="（title）">' },
	{ type = 'unknown', content = 'B' },
	{ type = 'tag', content = '</span>' },
	{ type = 'unknown', content = 'C' },
```
]]
---@param text string
---@return {type: 'tag' | 'unkown', content: string}[]
local function extract_tags(text)
	local result = {}
	local rest = text
		 :gsub(
			 '(.-)(</?[:%a_][:%w_-.]*[^<>]*>)',
			 function (non_tag, tag)
				 if non_tag ~= '' then
					 result[#result+1] = { type = 'unknown', content = non_tag }
				 end
				 result[#result+1] = { type = 'tag', content = tag }
				 return ''
			 end
		 )
	if rest ~= '' then
		result[#result+1] = { type = 'unknown', content = rest }
	end
	return result
end
 
local EXTRACT_RB_RT_PATTERN = '(.-)('..KANJI_LIKE_PATTERN..'+)(%b（）)'
---@param text string
---@param into_tokens ({type: 'ruby-part' | 'tag' | 'text', content: string} | {type: 'rb-rt', rb: string, rt: string})[]
local function extract_rb_rt(text, into_tokens)
	for line_with_lf in text:gmatch('[^\n]*\n*') do
		local rest = u_gsub(
			line_with_lf,
			EXTRACT_RB_RT_PATTERN,
			function (before, rb, rt)
				if before ~= '' then
					into_tokens[#into_tokens+1] = { type = 'text', content = before }
				end
				into_tokens[#into_tokens+1] = {
					type = 'rb-rt',
					rb = rb,
					rt = u_sub(rt, 2, -2),  -- 去除括號
				}
				return ''
			end
		)
		if rest ~= '' then
			into_tokens[#into_tokens+1] = { type = 'text', content = rest }
		end
	end
end
 
---細節見測試 [[Module:Furigana/tests]]。
---@param tokens {type: 'tag' | 'unkown', content: string}[]
---@param into_tokens ({type: 'ruby-part' | 'tag' | 'text', content: string} | {type: 'rb-rt', rb: string, rt: string})[]
local function extract_others(tokens, into_tokens)
	local ruby_start_index = nil
 
	for i, token in ipairs(tokens) do
		if ruby_start_index then  -- 如果處於<ruby>標籤內，則所有token都是ruby-part
			into_tokens[#into_tokens+1] = { type = 'ruby-part', content = token.content }
			if token.type == 'tag' and token.content:match('^</[Rr][Uu][Bb][Yy]') then
				ruby_start_index = nil
			end
		elseif token.type == 'tag' then
			if token.content:match('^<[Rr][Uu][Bb][Yy]') then
				into_tokens[#into_tokens+1] = { type = 'ruby-part', content = token.content }
				ruby_start_index = i
			else
				---@diagnostic disable-next-line: assign-type-mismatch
				into_tokens[#into_tokens+1] = token
			end
		else
			-- assert(token.type == 'unknown')
			extract_rb_rt(token.content, into_tokens)
		end
	end
end
 
---將`texts`解析為tokens，細節見測試[[Module:Furigana/tests]]。
---@param texts string[]
---@return ({type: 'ruby-part' | 'tag' | 'text', content: string} | {type: 'rb-rt', rb: string, rt: string})[]
local function parse(texts)
	local tokens = {}
	for _, text in ipairs(texts) do
		extract_others(extract_tags(text), tokens)
	end
	return tokens
end
p.parse = parse
 
---用`render_ruby`渲染`tokens`中的`rb-rt` token，其餘token不變，最終連接為一個字符串。
---@param tokens ({type: 'ruby-part' | 'tag' | 'text', content: string} | {type: 'rb-rt', rb: string, rt: string})[]
---@param render_ruby fun(rb: string, rt: string): string
---@return string
local function render(tokens, render_ruby)
	local result = {}
	for i, token in ipairs(tokens) do
		result[i] = token.type == 'rb-rt' and render_ruby(token.rb, token.rt) or token.content
	end
	return concat(result)
end
p.render = render
 
---將`texts`中用“漢字（注音）”表示的振假名替換為`render_ruby`的返回值。
---@param texts string | string[]
---@param render_ruby fun(rb: string, rt: string): string
---@return string
function p.process(texts, render_ruby)
	if type(texts) == 'string' then
		texts = { texts }
	end
	local tokens = parse(texts)
	return render(tokens, render_ruby)
end
 
function p.main(frame, args)
	if not args then
		local parent = frame:getParent()
		local templates = { ['Template:振假名'] = true, ['Template:Sandbox'] = true }
		if parent and templates[parent:getTitle()] then
			frame = parent
		end
		args = frame.args
	end
	
	local template = args.template or 'Ruby'
 
	if mw.isSubsting() then
		local prefix = '{{'..template..'|'
		return p.process(args, function (rb, rt)
			return prefix..rb..'|'..rt..'}}'
		end)
	end
 
	local is_compatible_mode = args.compatible and args.compatible ~= ''
	if not is_compatible_mode then
		-- 快速模式，通過字符串替換，避免多次調用frame:expandTemplate
		local placeholder_pattern = '!@$r[bt]$@!'
		local rb_placeholder = '!@$rb$@!'
		local rt_placeholder = '!@$rt$@!'
		local template_string = frame:expandTemplate {
			title = template,
			args = { rb_placeholder, rt_placeholder },
		}
		if template_string:find(placeholder_pattern) then
			return p.process(args, function (rb, rt)
				return template_string:gsub(placeholder_pattern, { [rb_placeholder] = rb, [rt_placeholder] = rt })
			end)
		end
	end
 
	return p.process(args, function (rb, rt)
		return frame:expandTemplate {
			title = template,
			args = { rb, rt },
		}
	end)
end
 
return p