Bản mẫu:CompactTOC8/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:CompactTOC8. 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 sử dụng những tính năng phức tạp của cú pháp bản mẫu.
Bạn được khuyến khích làm quen với cấu trúc của bản mẫu này và các hàm cú pháp trước khi sửa đổi bản mẫu. Nếu sửa đổi của bạn gây ra lỗi không mong muốn, hãy sửa chữa hoặc lùi lại nhanh chóng, vì bản mẫu này có thể xuất hiện trên một số lượng lớn trang. |
Purpose[sửa mã nguồn]
This Table of Contents replacement for alphabetical lists provides all the features of Template:CompactTOC7, plus ones from Template:CompactTOC2, etc. that #7 doesn't have (the "Top" "0-9" sections, optionally), and allows you to select what other sections you want. Even the centering is optional, and you can have the "Contents" heading on the top (default) or the side.
Usage[sửa mã nguồn]
Typical:
{{CompactTOC8|symnum=yes}}
For alphabetical only (no number or symbol entries):
{{CompactTOC8}}
For maximum number of features and centered placement (leave off a parameter or change it to blank or "no" to disable a feature)
{{CompactTOC8 |name= |side=yes |center=yes |right= |align=center |nobreak=yes |top=yes |num=yes |sym=yes |symnum= |custom1= |custom2= |custom3= |seealso=yes |notesfirst= |refs=yes |notes=yes |extlinks=yes |a=
...
|z= }}
Parameters[sửa mã nguồn]
name=
— change the heading to an alternative name instead of "Contents", or hide it completely by enteringname=no
side=yes
— put the "Contents" heading on the left side with a colon, instead of the top without onecenter=yes
— center to ToC in the horizontal middle of the page, instead of floated leftright=yes
— align the ToC horizontally to the right of the page (may require<br style="clear:right;" />
after it, depending on page layout), instead of floated left (this parameter is mutually exclusive with the "center" option above, and should be used sparingly and with good reason)align=
— sets the alignment of the links inside the table; default is left; usecenter
,right
orleft
nobreak=yes
— no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; useside=
for that)top=yes
— enable the "Top" link; this is only useful if this copy of the ToC is a secondary ToC not at the top of the page, e.g. in the middle of a long glossary. (Every rendered page has a hidden<a name="top" id="top"></a>
above the sitenotice which makes this link work without having to do anything but enable it in the template.)sym=yes
— enable the "!$@" link for symbolic entries sectionnum=yes
— enable the "0–9" link for numeric entries section (create a heading of==0–9==
for the link to work)symnum=yes
— enable the "!–9" link for combined symbolic and numeric entries section (create a heading of==!–9==
for the link to work)custom1
,custom2
andcustom3
— add up to 3 extra "custom" sections at the end of the list (alternativelySec1, Sec2, Sec3
)seealso=yes
— enable link to the "See also" sectionrefs=yes
— enable link to the "References" section (observe that it is plural)notes=yes
— enable link to the "Notes" section (observe that it is plural)notesfirst=yes
— enable link to the "Notes" section, but placed before "References"; do not use withnotes
(and do observe that it is plural)extlinks=yes
— enable link to the "External links" sectiona=
throughz=
— individually disable particular letters that have no entries. Use with caution and check regularly to make sure that new entries do not require the removal of this parameters. Can also be used to create range links, e.g. "X-Z". (See #Letters below for more detailed documentation of this feature.)
Letters[sửa mã nguồn]
Any letter can be deleted (i.e. because it has no entries in the list) by adding it as a lower case blank parameter
{{CompactTOC8|side=yes|j=|q=}}
Or it can be replaced with an unlinked letter by using that letter (upper case):
{{CompactTOC8|side=yes|j=J|q=Q}}
Note: It is often better to create an empty placeholder span (e.g. <span id="Q" />
where the letter's heading would be in the page if it existed, since in most cases it is quite possible that it will come to exist in the future.
This feature can also be used to create range links:
{{CompactTOC8|side=yes|x=X-Z|y=|z=}}
Shorthand[sửa mã nguồn]
short1
can be used as the very first parameter (beforename=
) for shortening a common usage:
{{CompactTOC8|short1}}
It replaces {{CompactTOC8|side=yes|center=yes|nobreak=yes|refs=yes}}
Examples[sửa mã nguồn]
{{CompactTOC8|top=yes}}
{{CompactTOC8|name=no|center=yes|top=yes|custom1=New section|custom2=Additional section}}
{{CompactTOC8|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|sec1=Other}}
{{CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}