Bản mẫu:Abbr/doc
Đây là một trang con tài liệu sử dụng bản mẫu dành cho Bản mẫu:Abbr. Nó gồm có các thông tin hướng dẫn sử dụng, thể loại và các nội dung khác không thuộc về phần trang bản mẫu gốc. |
Bản mẫu này được sử dụng ở khoảng 33.000 trang, vì thế những thay đổi đến nó sẽ hiện ra rõ ràng. Vui lòng thử nghiệm các thay đổi ở trang con /sandbox, /testcases của bản mẫu, hoặc ở không gian người dùng của bạn. Cân nhắc thảo luận các thay đổi tại trang thảo luận trước khi áp dụng sửa đổi. |
Cách sử dụng sửa
The template {{abbr}}
and its {{tooltip}}
variant take two unnamed parameters, in order:
|1=
or first unnamed parameter- the term to be explained; shows as text, and may use wikimarkup, such as a link to an article about what it refers to.
|2=
or second unnamed parameter- the expansion or definition or other note about the term; shows as the popup when you hover over the term. No wikimarkup can be used in this parameter.
Use explicitly numbered parameters if a parameter's content contains the equals (=) character:
- Complex example:
[[Sự tương đương khối lượng–năng lượng|{{abbr|{{math|''E'' {{=}} ''mc''<sup>2</sup>}}|2=Energy = mass times the speed of light squared}}]]
- Produces: E = mc2
Named parameters (usually not needed) and the input they take:
|class=
- One or more CSS classes (space-separated if more than one)
|id=
- An HTML
id
(i.e., a#ID name here
link anchor); this must be unique on the entire page. |style=
- Arbitrary inline CSS to apply to the displayed text of the term (has no effect on the tooltip text). For any input that needs to be quotation-marked (e.g. because it contains a space character), use straight single-quotes only, e.g.
|style=font-family: 'Times New Roman', serif;
Examples sửa
Cú pháp | Kết quả |
---|---|
{{abbr|MSLP|Mean Sea Level Pressure}} |
MSLP |
Cú pháp | Kết quả |
---|---|
{{abbr|UK|United Kingdom|class=country-name|id=foobar}} |
UK |
Cú pháp | Kết quả |
---|---|
[[WP:COI|{{tooltip|conflict of interest|in the specific sense employed in Wikipedia policy}}]] |
|
Linking must be done a particular way sửa
To wiki-link the abbreviation being marked up by this template, wrap the template in the link, not vice-versa, or the meaning will not appear in some browsers, including Chrome.
Compatibility | Markup | Renders as |
---|---|---|
Compatible | [[Knockout#Technical knockout|{{abbr|TKO|technical knockout}}]]
|
TKO |
Less compatible | {{abbr|[[Knockout#Technical knockout|TKO]]|technical knockout}}
|
TKO |
Do not link, or use any other wikimarkup or HTML markup, in the meaning (popup) – only plain text.
The mouse-over popup for the meaning text is created by a title=
attribute inside an <abbr>
HTML element's opening tag, so it cannot itself contain any HTML (or markup that resolves to HTML when rendered). This includes simple things like ''italics''
.
Accessibility and HTML validity concerns sửa
{{Abbr}} template is intended only for use with abbreviations (including acronyms and initialisms).
The Web Content Accessibility Guidelines contain guidelines for using the <abbr>
element generated by this template; see section H28: Providing definitions for abbreviations by using the abbr and acronym elements.
Furthermore, the HTML specifications (both those of the W3C and WHATWG) strictly define the <abbr>
element as reserved for markup of abbreviations. Abusing it for mouse-over tooltips breaks our semantic markup and makes our content invalid HTML (technically, "not well-formed"; it will pass an basic automated validator test because such a tool can't tell that the logical application of the data to the structure isn't correct, only that tags are nested properly, etc.).
Redirects sửa
The following template names will redirect to {{Abbr}}:
{{Tooltip}} is a separate template sharing the same documentation.
Template data sửa
Dữ liệu bản mẫu cho Abbr
This template defines an abbreviation or acronym, by creating a tooltip that is displayed on mouse-over.
Tham số | Miêu tả | Kiểu | Trạng thái | |
---|---|---|---|---|
Term | 1 | Shows as text | Chuỗi ngắn | bắt buộc |
Meaning | 2 | Shows as a mouse-over tooltip | Chuỗi dài | bắt buộc |
CSS | style | applies the specified CSS directives to the content of parameter 1 | Chuỗi dài | tùy chọn |
Class | class | Adds a one or more CSS classes | Chuỗi dài | tùy chọn |
ID | id | Adds an HTML id (must be unique in the page) | Chuỗi dài | tùy chọn |