Bản mẫu này được sử dụng ở khoảng 248.000 trang. Để tránh gây lỗi trên quy mô lớn và tải máy chủ không cần thiết, tất cả thay đổi cần được thử nghiệm ở trang con /sandbox, /testcases của bản mẫu, hoặc ở không gian người dùng của bạn. Các thay đổi đã được thử nghiệm có thể thêm vào bản mẫu bằng một sửa đổi duy nhất. Xin hãy thảo luận các thay đổi tại trang thảo luận trước khi áp dụng sửa đổi.
Bản mẫu này không hiển thị trong chế độ xem điện thoại di động của Wikipedia; nó chỉ hiển thị trên máy tính để bàn. Đọc tài liệu để được giải thích thêm.
Bản mẫu này cho phép thiết lập nhanh một bản mẫu điều hướng (hộp điều hướng, navbox) bằng cách cho nó một hoặc nhiều danh sách đến liên kết. Nó được viết sao cho nó mặc định sẽ hoạt động với hầu hết các bản mẫu điều hướng. Thay đổi kiểu mặc định không được khuyến khích, nhưng vẫn có thể. Sử dụng bản mẫu này, hoặc một trong những bản mẫu nằm trong "Bộ navbox" khác được khuyến cáo để chuẩn hóa các bản mẫu điều hướng và để dễ sử dụng.
{{{dưới}}} Xem định dạng thay thế khác tại Trình bày bảng
Hộp điều hướng sử dụng tên số tham số là chữ thường, như tại ô ở trên (phía phải). tên và tiêu đề bắt buộc sẽ tạo ra một hộp 1 dòng nếu các tham số khác bị lược bỏ.
Chú ý rằng "nhóm1" (v.v.) là tùy chọn, cũng như các phần có tên "trên/dưới".
Các tham số cơ bản và phổ biến nhất như sau (xem phía dưới để có danh sách đầy đủ):
tên – tên bản mẫu.
tiêu đề – dòng chữ trong thanh tiêu đề, như: [[Hội đồng Bắc Âu]].
trạng thái – điều trạng thái đóng mở của hộp điều hướng.
groupstyle – kiểu CSS dành cho ô ghi tên nhóm, như: background:#eee;
hình – một tấm hình tùy chọn ở phía bên phải (ghi mã như toàn bộ thẻ hình: [[Hình:XX.jpg|90px]]).
hình trái – một tấm hình tùy chọn ở phía bên trái (ghi mã như tham số "hình").
trên – dòng chữ hiện lên phía trên mục nhóm/dsach (có thể là danh sách các liên kết wiki chung).
nhómn – dòng chữ phía bên trái trước dsach-n (nếu nhóm-n bị bỏ qua, dsach-n bắt đầu ở phía trái hộp).
dsachn – dòng chữ liệt kê các liên kết wiki, thường được định dạng theo kiểu danh sách wiki (liệt kê hoa thị).
dưới – dòng chữ tùy chọn xuất hiện phía dưới mục nhóm/dsach.
Để biết thêm chi tiết, và những những ràng buộc phức tạp hơn, được giải thích ở đề mục phía dưới Miêu tả tham số. Mời xem một số định dạng navbox thay thế dưới: Trình bày bảng.
Miêu tả tham số
Dưới đây là danh sách đầy đủ các tham số của {{Navbox}}. Trong phần lớn trường hợp, những tham số bắt buộc chỉ là tên, tiêu đề, và dsach1, mặc dù các navbox con thậm chí không cần thiết lập chúng.
{{Navbox}} dùng chung nhiều tên tham số như các bản mẫu anh em với nó {{Navbox with columns}} và {{Navbox with collapsible groups}} để thống nhất và dễ sử dụng. Các tham số được đánh dấu bằng một dấu sao (*) là dùng chung cho cả 3 bản mẫu này.
Các tham số thiết lập
name / tên*
Tên của bản mẫu, cần thiết cho các liên kết "X • T • S" ("xem • thảo luận • sửa") hoạt động đúng tại tất cả các trang có sử dụng bản mẫu. Bạn có thể gõ {{subst:PAGENAME}} để tạo nhanh giá trị này. Tham số tên chỉ bắt buộc nếu có tham số tiêu đề, và tham số khung không được thiết lập.
state / trạng thái* [autocollapse, uncollapsed, collapsed, plain, off]
Mặc định là autocollapse. Một navbox với autocollapse sẽ bắt đầu bằng đóng nếu có hai hoặc nhiều bảng trong cùng một trang có sử dụng bảng đóng mở. Nếu không, navbox sẽ được mở. Để có thông tin về kỹ thuật mời xem MediaWiki:Common.js.
Nếu thiết lập là collapsed, navbox sẽ luôn bắt đầu trong trạng thái đóng.
Nếu thiết lập là plain, navbox sẽ luôn luôn mở mà không có liên kết [ẩn] bên phải, và tiêu đề sẽ nằm ở giữa (bằng cách dùng padding để cân bằng với liên kết X • T • S).
Nếu thiết lập là off, navbox sẽ luôn mở mà không có liên kết [ẩn] ở phía phải, nhưng không sử dụng padding để giữ tiêu đề vào giữa. Cách này chỉ dùng cho người nào biết rõ; tùy chọn "plain" là đủ cho đa số ứng dụng trong đó cần giấu đi nút [ẩn]/[hiện].
Nếu thiết lập thứ khác ngoài autocollapse, collapsed, plain, hay off (như "uncollapsed"), navbox sẽ bắt đầu ở trạng thái mở, và có nút "ẩn".
Để hiện hộp khi đứng một mình (không nhúng) nhưng khi đó nội dung tự động ẩn khi trong bài, hãy đặt "uncollapsed" bên trong thẻ <noinclude>:
trạng thái = <noinclude>uncollapsed</noinclude>
Các thiết lập đó sẽ buộc hộp hiển thị khi đứng một mình (thậm chí khi có hộp khác theo sau), hiển thị "[ẩn]" nhưng vẫn tự động đóng khi chèn vào bài.
Thông thường, biên tập viên sẽ muốn một trạng thái khởi đầu mặc định đối với navbox, có thể thay đổi trong bài viết. Đây là mẹo để làm chuyện đó:
Trong bản mẫu trung gian của bạn, tạo một tham số cũng có tên "trạng thái" để vượt qua như sau:
<includeonly>| sẽ khiến bản mẫu mở khi xem chính trang bản mẫu.
navbar / thanh chuyển hướng*
Mặc định là dùng Tnavbar. Nếu thiết lập là plain, các liên kết X • T • S ở phía trái ở thanh tiêu đề sẽ không hiển thị, và padding sẽ tự động được dùng để giữa cho tiêu đề nằm giữa. Dùng off để bỏ liên kết X • T • S, nhưng không áp dụng padding (chỉ dùng khi hiểu rõ; tùy chọn "plain" là đủ cho hầu hết ứng dụng khi không cần một navbar). Chú ý rằng bạn được khuyến cáo không ẩn navbar, để người dùng dễ sửa đổi bản mẫu, và để giữa một kiểu tiêu chuẩn cho tất cả các trang.
border / khung*
Xem mục dưới để sử dụng navbox bên trong một navbox khác với ví dụ và miêu tả đầy đủ hơn. Nếu thiết lập là con hay nhóm con, thì navbox có thể được dùng như một hộp con không có khung bao quanh nằm gọn trong navbox khác. Khung được ẩn và không có padding ở hai bên bảng, do đó nó vừa vào khu vực danh sách của navbox cha. Nếu thiết lập là none, thì khung sẽ ẩn và padding bị bỏ đi, navbox có thể được dùng như con của một navbox chứa khác (đừng sử dụng tùy chọn none bên trong một navbox khác; tương tự như vậy, chỉ dùng tùy chọn con/nhóm con bên trong navbox khác). Nếu thiết lập bất kỳ giá trị nào khác (mặc định), thì một navbox bình thường hiển thị với khung dày 1px. Một cách thay thế để xác định khung là một kiểu cho nhóm như thế này (tức là sử dụng tham số đầu tiên không tên thay vì tham số khung có tên):
{{Hộp điều hướng|con
...
}}
Ô bên trong
title / tiêu đề*
Văn bản hiện ra ở giữa tại hàng đầu tiên của bảng. Nó thường là chủ đề của bản mẫu, tức là một miêu tả cô đọng về nội dung của hộp. Cái này chỉ nên có một dòng, nhưng nếu cần dòng thứ hai, hãy dùng {{Clear}} để đảm bảo canh dòng cho đúng. Tham số này về kỹ thuật là không bắt buộc, nhưng sử dụng {{Navbox}} mà không có tiêu đề thì rất vô ích.
groupn / nhómn
(tức, nhóm1, nhóm2, v.v.) Nếu chỉ định, văn bản hiển thị trong ô tiêu đề đặt ở phía tranh dsachn. Nếu bỏ đi, dsachn sử dụng toàn bộ chiều rộng bảng.
listn / dsachn*
(tức, dsach1, dsach2, v.v.) Thân bản mẫu, thường là danh sách các liên kết. Định dạng là nằm liên tục, mặc dù văn bản có thể được gõ theo từng dòng riêng biệt nếu toàn bộ danh sách được đặt trong <div> </div>. Ít nhất phải có một tham số dsach; mỗi dsach thêm vào được hiển thị trong một hàng tách biệt của bảng. Mỗi dsachn có thể được một tham số nhómn đứng trước, nếu cần (xem ở dưới).
image / hình*
Có thể hiển thị hình trong một ô phía dưới tiêu đề và bên phải nội dung (nhóm/dsach). Để hình hiển thị đúng, tham số dsach1 phải được ghi. Tham số hình chấp nhận mã wiki chuẩn để hiển thị hình, tức là
hình = [[Hình:Example.jpg|100px]]
imageleft / hình trái*
Để hiển thị hình trong một ô phía dưới tiêu đề và phía trái nội dung (dsach). Để hình hiển thị đúng, tham số dsach1 phải được ghi và không có nhóm nào. Tham số hình trái chấp nhận mã wiki chuẩn để hiển thị hình, tức là
hình trái = [[Hình:Example.jpg|100px]]
above / trên*
Một ô dài đầy đủ hiển thị giữa thanh tiêu đề và nhóm/dsach đầu tiên, tức là trên nội dung bản mẫu (nhóm, danh sách và hình). Trong một bản mẫu không có hình, trên hoạt động giống như tham số dsach1 mà không có tham số nhóm1.
below / dưới*
Một ô dài đầy đủ hiển thị dưới nội dung bản mẫu (nhóm, danh sách và hình). Trong một bản mẫu không có hình, dưới hoạt động giống như tham số dsachn cuối cùng của bản mẫu mà không có tham số nhómn.
Tham số tạo kiểu
Tạo kiểu nói chung không khuyến khích để giữ sự thống nhất giữa các bản mẫu và trang tại Wikipedia. Tuy nhiên, vẫn có tùy chọn để điều chỉnh kiểu.
bodystyle / kiểu thân*
Xác định kiểu CSS để áp dụng cho thân bản mẫu. Tùy chọn này nên được dùng cẩn trọng vì nó có thể dẫn tới không thống nhất khi hiển thị. Ví dụ:
style = background:#nnnnnn;
style = width:N [em/%/px or width:auto];
style = float:[left/right/none];
style = clear:[right/left/both/none];
basestyle / kiểu gốc*
Kiểu CSS áp dụng cho các ô tiêu đề, trên, dưới, và nhóm. Kiểu này không áp dụng cho các ô danh sách. Nó thuận tiện để đổi màu cơ bản của navbox mà không phải lặp lại việc chỉ định kiểu cho từng phần khác nhau của navbox. Ví dụ:
basestyle = background:lightskyblue;
titlestyle / kiểu tiêu đề*
Kiểu CSS áp dụng cho tiêu đề, thông dụng nhất là màu nền cho thanh tiêu đề:
titlestyle = background:#nnnnnn;
titlestyle = background:name;
groupstyle / kiểu nhóm
Kiểu CSS áp dụng cho các ô nhómN cells. Tùy chọn này ghi đè bất kỳ kiểu nào áp dụng cho toàn bảng. Ví dụ:
groupstyle = background:#nnnnnn;
groupstyle = text-align:[left/center/right];
groupstyle = vertical-align:[top/middle/bottom];
groupnstyle
Kiểu CSS áp dụng cho một nhóm cụ thể, ngoài bất kỳ kiểu nào xác định bởi tham số groupstyle. Tham số này chỉ nên dùng khi thật cần thiết để bảo đảm chuẩn hóa và đơn giản hóa. Ví dụ:
group3style = background:red;color:white;
groupwidth / chiều rộng nhóm
Một con số đi kèm đơn vị để quy định chiều rộng của nhóm, dùng trong những trường hợp ô nhóm quá rộng vì có chứa văn bản dài. Tuy nhiên tham số này có thể bị tham số group(n)style ghi đè. Ví dụ:
groupwidth = 9em
liststyle / kiểu danh sách*
Danh sách CSS để áp dụng cho tất cả các danh sách. Sẽ bị ghi đè bởi tham số oddstyle và evenstyle (nếu có) ở dưới.
listnstyle*
Kiểu CSS áp dụng cho một nhóm cụ thể, ngoài bất kỳ kiểu nào chỉ định bởi tham số groupstyle. Tham số này chỉ nên dùng khi thật cần thiết để giữ chuẩn hóa và đơn giản hóa. Ví dụ:
list5style = background:#ddddff;
listpadding*
Số và đơn vị dùng để chỉ định padding trong mỗi ô dsach. Các ô dsach đi kèm với một padding mặc định là 0.25em về trái và phải, và 0em ở trên và dưới. Do lý do kỹ thuật phức tạp, nếu chỉ đơn giản ghi "liststyle=padding:0.5em;" (hoặc bất kỳ thiết lập padding nào khác) sẽ không hoạt động. Ví dụ:
listpadding = 0.5em 0em; (thiết lập padding 0.5em cho trái/phải, và 03m cho trên/dưới.)
listpadding = 0em; (bỏ tất cả các padding.)
oddstyle / kiểu lẻ
evenstyle / kiểu chẵn
Áp dụng số danh sách chẵn/lẻ. Kiểu ghi đè được định nghĩa bởi liststyle. Cách hiển thị mặc định là thêm màu xen kẽ (trắng và xám) vào các hàng lẻ/chẵn, để tăng tính dễ đọc. Những tham số này không nên thay đổi trừ khi trong tình huống dị thường.
evenodd / chẵn lẻ[swap, even, odd, off]
Nếu thiết lập là swap, sự xen kẽ hàng chẵn và lẻ tự động đảo ngược. Thông thường, hàng chẵn có nền xám nhẹ; khi tham số này được dùng, hàng lẻ sẽ có màu xám nhẹ thay cho hàng chẵn. Thiết lập là even hay odd sẽ thiết lập tất cả các hàng có màu xen đó. Thiết lập off tắt tự động tô màu hàng. Tham số nâng cao này chỉ nên dùng để sửa các vấn đề khi navbox được dùng làm con của một navbox khác và đường gạch ngang không phù hợp. Các ví dụ và mô tả kỹ hơn có thể tìm thấy ở phần navbox con bên dưới.
abovestyle / kiểu trên*
belowstyle / kiểu dưới*
Kiểu CSS áp dụng vào ô trên cùng (xác định bằng tham số trên) và ô dưới cùng (xác định bằng tham số dưới). Thường được dùng để thiết lập màu nền hoặc canh dòng:
abovestyle = background:#nnnnnn;
abovestyle = text-align:[left/center/right];
imagestyle / kiểu hình*
imageleftstyle / kiểu hình trái*
Kiểu CSS áp dụng cho các ô trong đó có hình/hình trái. Những kiểu này chỉ nên dùng trong các tình huống ngoại lệ, thường để sửa vấn đề về chiều rộng nếu chiều rộng của nhóm được thiết lập và chiều rộng của ô hình trở nên quá lớn. Ví dụ:
imagestyle = width:5em;
Các kiểu mặc định
Các thiết lập kiểu dưới đây là những kiểu mà các biên tập viên dùng navbox thay đổi nhiều nhất. Các kiểu thiết lập phức tạp hơn không có trong danh sách này để giữ cho nó đơn giản. Đa số kiểu được thiết lập trong MediaWiki:Common.css.
Vì liststyle và oddstyle là danh sách lẻ trong suốt có màu với bodystyle, mặc định là #fdfdfd (trắng với một chút xám). Một danh sách có text-align:left; nếu nó có nhóm, nếu không nó sẽ là text-align:center;. Vì chỉ có bodystyle có một dóng thẳng đứng, tất cả cái khác thừa kế vertical-align:middle; của nó.
Tham số nâng cao
bodyclass / lớp thân
aboveclass / lớp trên
groupclass / lớp nhóm
listclass / lớp danh sách
belowclass / lớp dưới
Gán lớp cho thân, trên, nhóm, danh sách, dưới. Cách dùng thường gặp nhất là đặt cho các tham số này giá trị hlist để giúp một danh sách hoa thị hiển thị ngang. Có thể dùng tham số |bodyclass = hlist trong trường hợp cần gán lớp hlist cùng lúc cho hai (hoặc nhiều hơn) trong số các tham số kể trên.
titlegroup / tiêu đề nhóm
Cái này đặt một nhóm vào khu vực tiêu đề, với cùng kiểu mặc định như nhómn. Nó chỉ nên được dùng trong tình huống ngoại lệ (thường là siêu bản mẫu nâng cao) và việc sử dụng nó cần một ít kiến thức về mã bên trong {{Navbox}}; bạn nên sẵn sàng cho việc thiết lập bằng tay kiểu CSS để khiến mọi thức hoạt động đúng nếu bạn muốn dùng nó. Nếu bạn cho rằng bạn có một ứng dụng cho tham số này, có thể cần phải thay đổi suy nghĩ, hoặc hỏi tại trang thảo luận cái đã.
titlegroupstyle / kiểu tiêu đề nhóm
Kiểu dành cho ô nhóm tiêu đề.
innerstyle / kiểu trong
Một tham số cực kỳ nâng cao chỉ dùng cho các siêu bản mẫu nâng cao có dùng navbox. Navbox có cấu trúc thật sự như sau: navbox sử dụng một bảng ngoài để vẽ khung, và một bảng trong dành cho mọi thứ khác (tiêu đề/trên/nhóm/dsach/dưới/hình, v.v.). Tham số style/bodystyle thiết lập kiểu cho bảng ngoài, bảng trong sẽ thừa kế nó, nhưng trong những trường hợp cao cấp (siêu bản mẫu) có thể cần phải thiết lập trực tiếp cho bảng trong. Tham số này cung cấp cách tiếp cận cho bảng trong đó để ứng dụng kiểu. Hãy dùng một cách cẩn trọng.
Trình bày bảng
Bảng tạo ra do {{Navbox}} không có tham số hình, trên và dưới (màu nền xám cho danh sách được thêm vào chỉ để minh họa):
{{Hộp điều hướng
|tên = Hộp điều hướng/doc
|tiêu đề = [[MSC Malaysia]]
|listclass = hlist
|hình = [[Tập tin:Flag of Malaysia.svg|80px]]
|dsach1 =
* [[Tháp đôi Petronas]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Sân bay quốc tế Kuala Lumpur]]
}}
{{Hộp điều hướng
|tên = Hộp điều hướng/doc
|tiêu đề = [[MSC Malaysia]]
|hình = [[Tập tin:Flag of Malaysia.svg|80px]]
|listclass = hlist
|trên = văn bản bên trên ở đây
|nhóm1 = Centre
|dsach1 = [[Cyberjaya]]
|nhóm2 = Area
|dsach2 = [[Klang Valley]]
|nhóm3 = Major landmarks
|dsach3 =
* [[Tháp đôi Petronas]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Sân bay quốc tế Kuala Lumpur]]
|nhóm4 = Infrastructure
|dsach4 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]
|nhóm5 = Prime applications
|dsach5 =
* [[EGovernment]]
* [[MyKad]]
|dưới = Website: [http://www.msc.com.my/ www.msc.com.my]
}}
Có thể đặt nhiều navbox bên trong một khung đơn bằng cách sử dụng tham số khung, hoặc bằng cách thiết lập tham số đầu tiên là "con". Mã cơ bản để làm việc này như sau (thêm một nhóm con vào khu vực nhóm/dsach đầu tiên):
{{Hộp điều hướng
|tên = {{subst:PAGENAME}}
|tiêu đề = tiêu đề
|nhóm1 = [tùy chọn]
|dsach1 = {{Hộp điều hướng|con
...bản mẫu navbox con...
}}
...
}}
Ví dụ nhóm con
Ví dụ này hiển thị cách nhóm con sử dụng. Bạn được khuyến cáo sử dụng {{Navbox|subgroup}}, nhưng cũng có thể cho ra cùng kết quả khi dùng {{Navbox}} với khung = con hoặc tham số không tên đầu tiên thiết lập là con. Chú ý rằng tham số evenodd được dùng để đảo xen kẽ màu trong một số nhóm con để có tất cả các sọc màu hiển thị đúng thứ tự. Nếu bạn muốn bỏ sọc màu, bạn có thể thiết lập liststyle = background:transparent; trong mỗi navbox.
Ví dụ dưới đây được tạo ra sử dụng một navbox thông thường để dùng làm khung chứa chính, sau đó các tham số dsach1, dsach2, và dsach3 của nó chứa các navbox khác, với thiết lập khung = con. Chú ý rằng mỗi navbox con có navbar XTS riêng của nó; những cái này có thể ẩn đi dùng navbar = plain cho mỗi cái, hoặc chỉ cần để trống tham số tên (navbox con không cần tham số tên thiết lập, không giống navbox thường).
This navbox template is specifically designed to work in conjunction two other sister templates: {{Navbox with columns}} and {{Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in the complete parameter list trên). Most importantly, all three of these templates can each be used as children of one another (by using the khung = child parameter, or by specifying the first unnamed parameter to be child (i.e. use {{Hộp điều hướng|child, {{Navbox with columns|child, or {{Navbox with collapsible groups|child).
Technical details
This template uses CSS classes for most of its looks, thus it is fully skinnable.
Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.
The 2px wide khung between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for example bodystyle = background:purple;), then you'll need to make the border-left-color match the background color (i.e. liststyle = border-left-color:purple;). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the liststyle to have width:auto. If you wish to set the group width and use hìnhs, it's up to you to figure out the CSS in the groupstyle, liststyle, hìnhstyle, and hìnhleftstyle parameters to get everything to work correctly. Example of setting group width:
groupstyle = width:10em;
liststyle = width:auto;
Adjacent navboxes have only a 1 pixel khung between them (except in IE6, which doesn't support the necessary CSS). If you set the top or bottom margin of style/bodystyle, then this will not work.
The default margin-left and margin-right of the outer navbox table are set to "auto;". If you wish to use navbox as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option. For example, add the following code to use the navbox as a float:
Wikipedia:Line break handling – The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.
{{Nobold}} – To display text at normal font-weight within a context where the default font-weight is bold, e.g. header cells in tables.
{{•}} và {{•}} – The dot and bullet commonly used to separate items in Navbox lists.
