Template:Cite Hong Kong case/HKCFI/doc

This is a documentation subpage for Template:Cite Hong Kong case/HKCFI.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This is a subtemplate of Template:Cite Hong Kong case which generates tooltips on abbreviations in Court of First Instance case citations, to help lay readers understand them. This subtemplate normally should not be called directly from articles, but only from other case citation templates.

Examples

Enter	Result	Comments
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCMP}}`	HCMP
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCA}}`	HCA
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCB}}`	HCB
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCMP}}`	HCMP
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCCL}}`	HCCL
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCCW}}`	HCCW
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCAL}}`	HCAL
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCCT}}`	HCCT
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCPI}}`	HCPI
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCAP}}`	HCAP
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCMA}}`	HCMA
`{{Cite Hong Kong case/HKCFI\|tooltip\|list=HCCC}}`	HCCC
`[http://www.example.com {{Cite Hong Kong case/HKCFI\|tooltip\|list=HCMP}}]`	HCMP	Works inside external links too

Parameters

There are two named parameters:

list: The abbreviation for the law list to which the case belongs, from the case number. Used only in "abbrev" or "tooltip" mode; can be left out otherwise.
text: Used only in "link" mode. The text to be displayed in the link. Defaults to "Court of First Instance".

The first unnamed parameter ("mode") may be one of:

tooltip: Generates an explanation of what the "list" abbreviation means
abbrev: Aids in automatic generation of URLs to judgments on the website of the Hong Kong Legal Information Institute.
link: Generates a link to the Wikipedia article Court of First Instance (Hong Kong).