View source for Template:vi-ruby/documentation

{{documentation subpage}}

This template displays the given ''Hán'' or ''Nôm'' text, with the given ''quốc ngữ'' annotations as [[ruby]] text above it. Use the following syntax:

 <nowiki>{{vi-ruby|畧畑䀡傳西銘/𡄎唭𠄩𡦂人情喓𠻗|trước đèn xem chuyện Tây minh / ngẫm cười hai chữ nhân tình éo le}}</nowiki>

which produces:

:{{vi-ruby|畧畑䀡傳西銘/𡄎唭𠄩𡦂人情喓𠻗|trước đèn xem chuyện Tây minh / ngẫm cười hai chữ nhân tình éo le}}

There should be the same number of Han characters as ''quốc ngữ'' words. If the page title appears in the string of Han characters, each occurrence is highlighted using the HTML5 <code><nowiki><mark></nowiki></code> tag. Alternatively, the character to mark may be specified in the <code>mark</code> parameter:

 <nowiki>{{vi-ruby|畧畑䀡傳西銘/𡄎唭𠄩𡦂人情喓𠻗|mark=𡦂|trước đèn xem chuyện Tây minh / ngẫm cười hai chữ nhân tình éo le}}</nowiki>

:{{vi-ruby|畧畑䀡傳西銘/𡄎唭𠄩𡦂人情喓𠻗|mark=𡦂|trước đèn xem chuyện Tây minh / ngẫm cười hai chữ nhân tình éo le}}

Because very few ''Nôm'' characters have been encoded into the Unicode standard, it is often necessary to give an image or Unicode [[w:Chinese character description languages#Ideographic Description Sequences|ideographic description sequence]] in lieu of the actual character. In the first parameter, place an asterisk where the character would be. Then specify the replacement content in the <code>alts</code> parameter:

 <nowiki>{{vi-ruby|𢚸蹺仍渚𧡊𠊛/𨖲髙氽𣅶*爲𨋣車|alts=⿰竜望|lòng theo nhưng chửa thấy người / lên cao mấy lúc trông vời bánh xe}}</nowiki>

:{{vi-ruby|𢚸蹺仍渚𧡊𠊛/𨖲髙氽𣅶*爲𨋣車|alts=⿰竜望|lòng theo nhưng chửa thấy người / lên cao mấy lúc trông vời bánh xe}}

 <nowiki>{{vi-ruby|餅*|alts=[[File:Nom_Character_V04-5055.svg|20px|alt=⿰米頗]]|bánh phở}}</nowiki>

:{{vi-ruby|餅*|alts=[[File:Nom_Character_V04-5055.svg|20px|alt=⿰米頗]]|bánh phở}}

In the event that multiple replacements are needed, use a single asterisk for each in the first parameter, and specify all the replacements in the <code>alts</code> parameter, separated by spaces. (Use underscores instead of spaces in image names.)

<includeonly>
[[Category:Vietnamese templates]]
[[Category:Script templates]]
</includeonly>