Jump to content

Template:CJKV

From Elite Dangerous Wiki
Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:CJKV/doc" to edit its documentation if it is available. (How does this work?)


Usage

To use the template, start with {{CJKV}} and add any parameters you like, along with what you want to be displayed. The template will display all and only, the parameters that you give it. The following parameters are supported:

Parameters
Parameter Description Example
|t= traditional Chinese {{CJKV|t=李四}}
traditional Chinese: 李四
|s= simplified Chinese {{CJKV|s=李四}}
simplified Chinese: 李四
|c= Chinese {{CJKV|c=李四}}
Chinese: 李四
|p= Hanyu Pinyin {{CJKV|p=Zhōnghuá Mínguó}}
Hanyu Pinyin: Zhōnghuá Mínguó
|tp= Tongyong Pinyin {{CJKV|tp=Jhonghuá Mínguó}}
Tongyong Pinyin: Jhonghuá Mínguó
|cy= Cantonese Yale {{CJKV|cy=lei5 sei3}}
Cantonese Yale: lei5 sei3
|cj= Cantonese Jyutping {{CJKV|cj=lei5 sei3}}
Cantonese Jyutping: lei5 sei3
|w= Wade–Giles {{CJKV|w=Chung-hua Min-kuo}}
Wade–Giles: Chung-hua Min-kuo
|j= Japanese {{CJKV|j=中華人民共和国}}
Japanese: 中華人民共和国
|r= Rōmaji {{CJKV|r=Chūka jinmin kyōwa-koku}}
Japanese pronunciation: Chūka jinmin kyōwa-koku
|k= Korean {{CJKV|k=중화 인민 공화국}}
Korean: 중화 인민 공화국
|rr= Romaja {{CJKV|rr=Junghwa inmin gonghwaguk}}
Korean pronunciation: Junghwa inmin gonghwaguk
|v= Vietnamese {{CJKV|v=Trung Quốc}}
Vietnamese: Trung Quốc
|l= Literal translation {{CJKV|l=China}}
lit. 'China'

(Note: "Japanese pronunciation" or "Korean pronunciation" will appear, instead of "rōmaji" or "romaja", if their Japanese and Korean parameters are missing respectively. See examples 6 and 7.)

All parameters are optional.

Examples

Traditional Chinese always goes first.

  1. {{CJKV|t=張三|s=张三}}
    traditional Chinese: 張三; simplified Chinese: 张三
  2. {{CJKV|s=张三|t=張三}}
    traditional Chinese: 張三; simplified Chinese: 张三

This template compares traditional Chinese, simplified Chinese and Japanese Kanji automatically.

  1. {{CJKV|t=李四}}
    traditional Chinese: 李四
  2. {{CJKV|s=李四}}
    simplified Chinese: 李四
  3. {{CJKV|t=李四|s=李四}}
    Chinese: 李四
  4. {{CJKV|t=李四|s=李四|j=李四}}
    Chinese and Japanese: 李四
  5. {{CJKV|t=李四|s=李四|j=李四|k=이사}}
    Chinese and Japanese: 李四; Korean: 이사
  6. {{CJKV|t=李四|s=李四|j=李四|k=이사|l=foobar}}
    Chinese and Japanese: 李四; Korean: 이사; lit. 'foobar'

Simplified and traditional Chinese can be combined together.

  1. {{CJKV|t=皇居|s=皇居|j=皇居|k=고쿄}}
    Chinese and Japanese: 皇居; Korean: 고쿄
  2. {{CJKV|c=皇居|j=皇居|k=고쿄}}
    Chinese and Japanese: 皇居; Korean: 고쿄
  3. {{CJKV|c=皇居|j=皇居|k=고쿄|l=Imperial Residence}}
    Chinese and Japanese: 皇居; Korean: 고쿄; lit. 'Imperial Residence'

Note that the combined Chinese parameter will overwrite existing ones.

  1. {{CJKV|t=黃飛鴻|s=黄飞鸿|c=黄飞鸿|j=黄飛鴻|k=황비홍}}
    Chinese: 黄飞鸿; Japanese: 黄飛鴻; Korean: 황비홍
    is equivalent to
  2. {{CJKV|c=黄飞鸿|j=黄飛鴻|k=황비홍}}
    Chinese: 黄飞鸿; Japanese: 黄飛鴻; Korean: 황비홍

More examples:

  1. {{CJKV|t=中國|s=中国|j=中國|k=중국}}
    traditional Chinese and Japanese: 中國; simplified Chinese: 中国; Korean: 중국
  2. {{CJKV|t=中國|s=中国|j=中国|k=중국}}
    traditional Chinese: 中國; simplified Chinese and Japanese: 中国; Korean: 중국
  3. {{CJKV|c=立春|j=立春|k=입춘|v=Lập xuân|l=establishment of spring}}
    Chinese and Japanese: 立春; Korean: 입춘; Vietnamese: Lập xuân; lit. 'establishment of spring'
  4. {{CJKV|t=漢族|s=汉族|p=hànzú|j=漢民族|r=kan minzoku|k=한족}}
    traditional Chinese: 漢族; simplified Chinese: 汉族; pinyin: hànzú; Japanese: 漢民族; rōmaji: kan minzoku; Korean: 한족
  5. {{CJKV|t=中華民國|s=中华民国|p=Zhōnghuá Mínguó|tp=Jhonghuá Mínguó|w=Chung-hua Min-kuo}}
    traditional Chinese: 中華民國; simplified Chinese: 中华民国; pinyin: Zhōnghuá Mínguó; Tongyong Pinyin: Jhonghuá Mínguó; Wade–Giles: Chung-hua Min-kuo
  6. '''Emperor''' ({{CJKV|c=皇帝|p=Huángdì|r=Kōtei|rr=Hwangje|v=Hoàng đế}})
    Emperor (Chinese: 皇帝; pinyin: Huángdì; Japanese pronunciation: Kōtei; Korean pronunciation: Hwangje; Vietnamese: Hoàng đế)
  7. '''History of China''' ({{CJKV|t=中國歷史|s=中国历史|p=Zhōngguó lìshǐ|j=中国の歴史|r=Chūgoku no rekishi|k=중국의 역사|rr=Junggugui Yeoksa|v=Lịch sử Trung Quốc}})
    History of China (traditional Chinese: 中國歷史; simplified Chinese: 中国历史; pinyin: Zhōngguó lìshǐ; Japanese: 中国の歴史; rōmaji: Chūgoku no rekishi; Korean: 중국의 역사; romaja: Junggugui Yeoksa; Vietnamese: Lịch sử Trung Quốc)

See also

  • {{Infobox Chinese}} – infobox template supports traditional, simplified Chinese as well as other common romanizations.

Similar templates

Inline templates for marking up Chinese characters
Template Languages Scripts Transliterations Translation Labels
{{Hani}} Any N/a No
{{CJKV}} Yes Always
{{lang-zh}} Chinese
  • Traditional Chinese
  • Simplified Chinese
Yes Optional
{{yue}} Cantonese
  • Traditional Chinese
  • Simplified Chinese
Jyutping No Optional
{{Nihongo}} Japanese Japanese writing system[lower-alpha 1] Hepburn Yes Optional
{{Nihongo2}} N/a No
{{Korean}} Korean
Yes Optional
{{Hanja}} Korean Hanja N/a No Always
{{Vi-nom}} Vietnamese Chữ Nôm N/a No
{{Lang}} Any Any Any No
{{Langx}} Yes Optional
Template:CJKV invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}
  • Groups: Currently there is no technical limit to the maximum number of groups.
    • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
  • Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
  • Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
    • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
  • Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
  • Bullets: Create unordered lists with lines beginning with *.
  • Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

  • Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
    • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
  • Uncollapsed: Forces the navbox to be displayed.
    • All of the navboxes in this documentation are in the uncollapsed state.
  • Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
    • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Plain: Removes the "show/hide" link.

Sub-groups

  • For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
  • To create sub-groups within {{navbox}}, certain parameters are to be included:
    • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
    • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

  • For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
  • To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
    • The parent navbox is almost always uncollapsed (state=uncollapsed).
    • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
    • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
    • The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

  • The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
  • Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.


TemplateData


Cite error: <ref> tags exist for a group named "lower-alpha", but no corresponding <references group="lower-alpha"/> tag was found