Wikipedia:Cẩm nang biên soạn/Hộp thông tin

Hộp thông tin là một vùng hình chữ nhật thường được nằm ở trên cùng bên phải bài viết, bên cạnh phần mở đầu (trong phiên bản dành cho máy tính để bàn) hoặc ở cuối phần mở đầu của bài viết (trong phiên bản di động), tóm tắt các nội dung chính của chủ thể bài viết. Hộp thông tin còn có thể bao gồm một hình ảnh hoặc bản đồ, hoặc cả hai.

Hộp thông tin trong Wikipedia hầu như luôn sử dụng tính năng phần mềm bản mẫu. Mỗi bản mẫu đều có các tham số; để hoạt động bình thường, giá trị của tham số phải được chỉ định khi bản mẫu được chèn vào trang. Điều này cho phép mỗi hộp thông tin hiển thị thông tin liên quan đến chủ thể bài viết, trong khi chỉ yêu cầu một lượng mã tối thiểu trong mỗi bài viết.

Mục đích

Khi xem xét bất kỳ khía cạnh nào của thiết kế hộp thông tin, hãy ghi nhớ mục đích của một hộp thông tin: để tóm tắt (chứ không thay thế) các sự kiện chính xuất hiện trong bài viết (một bài viết vẫn phải giữ hoàn chỉnh ngay cả khi bỏ qua hộp thông tin tóm tắt, trừ các trường hợp ngoại lệ được nêu bên dưới). Nó chứa càng ít thông tin thì nó sẽ càng phục vụ mục đích đó hiệu quả hơn, cho phép người đọc xác định các sự kiện chính trong nháy mắt. Tất nhiên, một số hộp thông tin không chỉ chứa một vài trường; tuy nhiên, nếu có thể, hãy trình bày thông tin ở dạng ngắn gọn và loại trừ mọi nội dung không cần thiết. Tránh các liên kết đến các đề mục trong bài viết; phần mục lục đã đảm nhiệm chức năng đó.

Sẽ có những trường hợp ngoại lệ khi một phần thông tin chuyên ngành chính khó tích hợp vào phần nội dung, nhưng thông tin đó có thể được đặt trong hộp thông tin, chẳng hạn như ISO 639 và các mã tương tự trong {{Thông tin ngôn ngữ}} và hầu hết các tham số trong {{Thông tin hóa chất}}.

Việc áp dụng hộp thông tin cũng làm cho dữ liệu trong đó có sẵn cho trang dùng lại bên thứ ba chẳng hạn như DBpedia ở định dạng chi tiết mà máy có thể đọc được, thường qua vi định dạng.

Nguyên lý thiết kế

Cách tiếp cận tổng thể

Quy trình được khuyến nghị để tạo bản mẫu hộp thông tin chỉ đơn giản là bắt đầu và thu thập càng nhiều điều kiện càng tốt. Trước tiên, hãy kiểm tra định dạng cơ sở cho một bản mẫu mới dưới dạng bảng tĩnh, sau đó khi đạt được sự đồng thuận, hãy di chuyển nó sang định dạng bản mẫu. Bản mẫu nên được xét duyệt trước khi được sử dụng rộng rãi trong các bài viết trong trường hợp bản mẫu hoặc các tham số đã xác định cần sửa đổi để giảm thiểu việc phải thực hiện lại. Nếu các trường và tham số mới được thêm vào, các bài viết phải được cập nhật để phản ánh các điều kiện mới. Nếu các tham số được đổi tên hoặc xóa, nhiều bài viết có khả năng sẽ không bị ảnh hưởng vì các tham số không liên quan sẽ bị bỏ qua.

Phong cách, màu và định dạng

Cần hướng đến sự nhất quán chung giữa các bài viết sử dụng cùng một hộp thông tin. Không nên thêm định dạng phong cách không liên quan chồng chéo với định dạng trong hộp thông tin mặc định mà không có lý do chính đáng. Hộp thông tin thường có xu hướng viết tắt nhiều hơn so với thông thường trong nội dung bài viết. Các quy tắc chung WP:NBSP (sử dụng khoảng trắng không ngắt dòng), WP:MOSNUM (ngày tháng và số) và WP:MAU (sử dụng màu) là đặc biệt phù hợp trong trường hợp này. Cũng giống như các bản mẫu điều hướng, mục đích của hộp thông tin là tiện ích chứ không phải hình thức; do đó, hộp thông tin không nên trang trí tùy tiện.

Hình ảnh

Xem thêm: Wikipedia:Quy định sử dụng hình ảnh § Kích thước hình hiển thị, và Wikipedia:Cẩm nang biên soạn/Hình ảnh § Hình ảnh trong phần mở đầu

Khi thêm hình ảnh vào hộp thông tin, KHÔNG NÊN sử dụng hình thu nhỏ. Bản mẫu hộp thông tin phải thực thi mô đun InfoboxImage để hỗ trợ cho việc định dạng hình ảnh sao cho nó có thể hoạt động khi chỉ cần cung cấp tên tập tin. Chẳng hạn, để sử dụng Tập tin:Image PlaceHolder.png, bạn chỉ việc dùng |image=Image PlaceHolder.png. Ghi chú về hình ảnh cần được chỉ định bằng tùy chọn |caption=. Mỗi hộp thông tin đều khác nhau và phần tài liệu cho hộp thông tin đang đề cập phải được tham khảo để biết các thông số phù hợp sao cho khớp với hình ảnh và ghi chú. Nếu InfoboxImage chưa được thực thi đầy đủ cho hộp thông tin bạn đang sử dụng, các tùy chọn |alt=, |upright=, |title=, v.v. có thể được gọi qua cú pháp hình ảnh mở rộng đi kèm với |frameless thay vì |thumb. (Bạn có thể thêm một yêu cầu bổ sung các tham số còn thiếu trong trang thảo luận của hộp thông tin.)

Tính nhất quán giữa các hộp thông tin

Để đảm bảo tính nhất quán, các nguyên tắc sau đây được áp dụng:

• Trước khi tạo bản mẫu hộp thông tin mới, hãy kiểm tra xem đã tồn tại một hộp thông tin phù hợp hay chưa.
• Đặt tên bản mẫu là [[Bản mẫu:(Hộp) Thông tin chủ thể]] (chữ "Hộp" không bắt buộc, chủ thể phải ở dạng số ít và được viết hoa phù hợp tương tự như với tên bài viết—ví dụ như "Hộp thông tin Giám mục" hoặc "Thông tin hiệp ước").
• Sử dụng bản mẫu {{Hộp thông tin}} để tạo một hộp thông tin mới.
• Bản mẫu phải có dòng tiêu đề cỡ chữ lớn, in đậm. Có thể sử dụng mô tả bảng hoặc văn bản đầu trang cho việc này. Bản mẫu nên được đặt tên là tên phổ biến của chủ thể bài viết nhưng có thể chứa tên đầy đủ (chính thức); cái này không nhất thiết phải khớp với tiêu đề Wikipedia của bài viết, nhưng quay lại sử dụng cái đó (với {{PAGENAMEBASE}}) thường là ổn. Tiêu đề không nên chứa liên kết.
• Tham số trong bản mẫu phải:
  • Được đặt tên, không được đánh số, để đảm bảo cho việc sử dụng trong tương lai.
  • Sử dụng kiểu viết thường trừ khi chúng là danh từ riêng.
  • Giữ thống nhất giữa các hộp thông tin. Ví dụ, {{Thông tin nhân vật}} cũng như nhiều hộp thông tin tiểu sử khác sử dụng |tên=, nên việc một bản mẫu tiểu sử khác sử dụng tên tham số khác chẳng hạn như |họ và tên= thay vì dùng lại tên tham số có sẵn sẽ gây nhầm lẫn.
  • Sử dụng quy tắc con rắn đối với tên tham số tiếng Anh (ví dụ |birth_date=; không dùng |birthDate= hoặc |BirthDate=).
  • Khoảng trắng giữa các từ trong tên tham số tiếng Anh phải được thể hiện bằng dấu gạch dưới, ví dụ |birth_place=; không dùng |birth-place= hoặc |birth place=.
• Hộp thông tin sử dụng tọa độ địa lý nên sử dụng tên tham số |tọa độ= hoặc |coordinates=, với bản mẫu {{Tọa độ}} làm giá trị của tham số.
• Nếu một tham số không áp dụng được hoặc không có thông tin có sẵn, nó nên được để trống và bản mẫu được lập trình lại để ẩn thông tin hoặc cung cấp các giá trị mặc định cho các tham số chưa xác định.

Nguyên nhân gây thiếu nhất quán

Một số yếu tố có thể gây ra sự thiếu nhất quán trong thông tin tóm tắt có sẵn cho một loại bài viết cụ thể:

Thiếu nhất quán trong thiết kế

Hộp thông tin, đặc biệt là các nhánh hộp thông tin cho cùng một thể loại bài viết, nên duy trì hình thức nhất quán với các hộp thông tin liên quan, đặc biệt là liên quan đến bố cục, màu sắc và cấu trúc. Ví dụ, độc giả sẽ mong đợi một mức độ tương đồng khi xem bài viết về Luân Đôn so với thành phố New York.

Bất toàn về mặt lịch sử

Một số thông tin mong muốn có thể đã bị mất đi theo thời gian. Ví dụ, hộp thông tin mô tả một ngân hàng hiện đại có thể cung cấp một số thông tin tài chính nhất định mà ngân hàng thời Trung cổ không có.

Không thống nhất về thứ bậc

Hộp thông tin biểu thị các mối quan hệ thứ bậc có thể có các yêu cầu khác nhau một cách tinh vi tùy thuộc vào vị trí của chủ thể bài viết trong hệ thống thứ bậc. Ví dụ, một hộp thông tin dành cho các tập đoàn sẽ khác nhau, giữa một bài viết mô tả công ty mẹ và chỉ ra các công ty con của nó, với một bài viết mô tả một công ty con và chỉ ra công ty mẹ của nó.

Không thống nhất về tính năng

Các mục trong một tập hợp đơn lẻ có thể có các tính năng tùy chọn mà vốn sẽ thường được liệt kê trong hộp thông tin. Ví dụ, hộp thông tin cho một bài viết về một trường đại học có thể bao gồm tiêu ngữ; nhưng không phải trường đại học nào cũng có.

Thiếu thông tin

Một số mục trong hộp thông tin có thể chưa có sẵn hoặc hoàn toàn không có, chẳng hạn như nhà sản xuất album hoặc phim. Trong những trường hợp này, tốt hơn hết là cung cấp thông tin có sẵn và đồng thời ẩn đi các trường mà thông tin có thể không có sẵn.

Các vấn đề chung cần lưu ý

Tính khả dụng của các trường tùy chọn không có nghĩa là tất cả các trường đều phải là tùy chọn; mặt khác, không nên thêm một số lượng lớn các trường ít dùng mà không quan tâm đến bố cục và tính dễ sử dụng của bản mẫu hộp thông tin. Trong một số trường hợp, mã wiki cho trường vẫn cần được tải xuống ngay cả khi nó không được hiển thị. Việc tạo các bản mẫu quá dài với nhiều trường không liên quan là không được khuyến khích.

Khi bạn thiết kế một bản mẫu hộp thông tin, hãy xem xét các vấn đề sau:

Một trường có giá trị hay không?

Trường đó quan trọng như thế nào đối với các bài viết sẽ sử dụng hộp thông tin? Đó có phải là thông tin tóm tắt, hay là thông tin chi tiết mở rộng hơn vốn có thể được đặt trong phần nội dung của bài viết?

Trường đó có liên quan đến nhiều bài viết sẽ sử dụng hộp thông tin hay không?

Nếu trường này có liên quan đến rất ít bài viết, thì nó chắc hẳn không nên được đưa vào. Ngược lại, các trường rất phổ biến có thể được đưa vào hộp thông tin – và được đặt làm tùy chọn – ngay cả khi chúng không áp dụng được cho một số bài viết sử dụng hộp thông tin đó.

Khả năng trường đó được để trống là như thế nào?

Bất kỳ trường nào có thể để trống một cách hợp lý thì nên đặt làm tùy chọn. Tuy nhiên, một trường vốn thường được để trống có thể không có gì đặc biệt hữu ích hoặc phù hợp.

Tên trường có thể được sử dụng lại từ nơi khác không?

Chẳng hạn, khi thêm một trường cho ngày chủ thể qua đời vào bản mẫu hộp thông tin tiểu sử, hãy sử dụng |ngày mất= từ {{Thông tin nhân vật}} thay vì một tên tương tự khác như |ngày qua đời= hoặc |chết=.

Nó có phải dành cho người, địa điểm hay tổ chức?

Nếu có, hãy thêm vào vi định dạng hCard.

Nó có phải dành cho một sự kiện với ngày diễn ra xác định?

(Ví dụ như ngày phát hành bản thu âm hoặc lịch thi đấu thể thao) Nếu có, hãy thêm vào vi định dạng hCalendar.

Hộp thông tin địa lý

Hộp thông tin đối với địa danh (như thành phố hoặc quốc gia) thường nên có tiêu đề chính là tên bài viết, mặc dù tên chính thức (ví dụ, Cộng hòa Xã hội chủ nghĩa Việt Nam tại bài Việt Nam) có thể được thay thế. Khi tiêu đề bài viết đã được định hướng, tên gốc có thể đặt làm tiêu đề của hộp thông tin, miễn là chủ thể rõ ràng (ví dụ, São Paulo tại bài São Paulo (bang)). Tên khác hoặc tên bản xứ có thể xuất hiện bên dưới tiêu đề trong trường hợp có lợi cho độc giả. Tên lịch sử trước đây tốt hơn hết nên được đặt trong một hộp thông tin thứ hai, chẳng hạn như trong bài Augsburg.

Bản mẫu động

Về mặt lý thuyết, các trường trong hộp thông tin phải nhất quán trên mọi bài viết sử dụng nó; tuy nhiên trên thực tế, điều này hiếm khi xảy ra vì một số lý do. Các bản mẫu hộp thông tin nên được thiết kế để tự động thích ứng với sự vắng mặt hoặc hiện diện của các trường cụ thể.

Giống như hộp thông tin tĩnh, chúng được thiết kế để trình bày thông tin tóm tắt về chủ thể của một bài viết, sao cho các chủ thể tương tự có giao diện thống nhất và ở một định dạng chung. Tuy nhiên, kỹ thuật bản mẫu cho phép cập nhật phong cách và văn bản thông thường từ một vị trí trung tâm, trang bản mẫu.

Mặc dù có một số lựa chọn thay thế cho hộp thông tin động, chẳng hạn như dùng nhiều bản mẫu (phân nhánh) hoặc để trống các trường, nhưng bạn nên tránh sử dụng chúng vì một số lý do:

Số lượng độc giả lớn hơn rất nhiều so với số biên tập viên

Nhóm quan trọng nhất cần xem xét là những độc giả bình thường của Wikipedia, những người sẽ không bao giờ thực hiện bất kỳ sửa đổi quan trọng nào. Các bản mẫu hộp thông tin chứa nhiều trường trống, dấu chấm hỏi hoặc "Không xác định" sẽ thể hiện vẻ ngoài thiếu chuyên nghiệp.

Số người sửa đổi bài viết lớn hơn rất nhiều so với số người sửa đổi bản mẫu

Một biên tập viên thông thường sẽ chỉ sử dụng bản mẫu mà không thực hiện sửa đổi gì đối với chúng. Để giúp công việc của họ dễ dàng hơn, chúng ta nên đặt mục tiêu giảm thiểu số lượng bản mẫu khác nhau mà họ phải làm quen; do đó, việc tạo nhiều phân nhánh của bản mẫu là điều không mong muốn.

Yêu cầu

Hãy đánh giá yêu cầu của hộp thông tin mới trước khi thiết kế. Có một số điểm cần được xem xét khi bắt đầu một hộp thông tin mới:

• Có các tham số riêng biệt đầy đủ và phù hợp
• Không thể giải quyết bằng các hộp thông tin hiện có
• Không thể giải quyết bằng cách tạo một trình bao bọc các hộp thông tin hiện có

Thực thi

Việc dùng Bản mẫu:Hộp thông tin làm cơ sở cho một bản mẫu hộp thông tin mới sẽ cho phép người thiết kế tập trung vào các trường cần đưa vào. Các chức năng như phong cách mặc định và triệt tiêu các dòng trong một bài viết không có giá trị cho một trường cụ thể sẽ được xử lý tự động.

Bản mẫu điều kiện

Bài chi tiết: mw:Help:Extension:ParserFunctions

Hàm phân tích cú pháp có thể được dùng để tùy chọn hiển thị hoặc ẩn nội dung cụ thể (ví dụ như hàng trong bảng) bên trong một hộp thông tin dựa trên giá trị của một hoặc nhiều tham số bản mẫu.

Ví dụ, một tham số có thể được thiết kế để hiển thị chỉ khi một tham số khác tồn tại. Đoạn mã dưới đây hiển thị mô tả của hình ảnh chỉ khi có hình ảnh xuất hiện:

| caption        = {{#if:{{{image|}}}|{{{caption|}}} }}

Bản mẫu có tên dùng tiền tố

Một số bản mẫu con (và bản mẫu độc lập) có tên lấy một tiền tố chung. Chúng được thêm vào một hộp thông tin dựa trên giá trị của một tham số nhất định đóng vai trò là tên hậu tố. Ví dụ, chúng ta tạo ra {{Thông tin animanga/Trò chơi}} và {{Thông tin animanga/Xuất bản}} sau đó sử dụng {{Thông tin animanga/{{{type}}}}}. Sử dụng |type=Trò chơi trong một bài viết sẽ cho ra bản mẫu {{Thông tin animanga/Trò chơi}}.

Bản mẫu nhiều phần

Thay vì có mỗi trường tương ứng với một tham số trong một bản mẫu, hộp thông tin có thể chứa một bản mẫu con cho mỗi trường; chẳng hạn, xem Bản mẫu:Bảng phân loại.

Tương tác giữa nhiều bản mẫu khác nhau

Các bản mẫu có thể được thiết kế theo cách sao cho có thể có nhiều tổ hợp khác nhau được áp dụng. Một tổ hợp thậm chí còn có thể xuất hiện trong trang dưới dạng một hộp thông tin duy nhất.

Ví dụ, nếu Dự án Điện ảnh muốn thiết kế một bản mẫu dựa trên hộp thông tin tĩnh của họ, họ có thể sử dụng Bản mẫu:Thông tin nhân vật và thiết kế một bản mẫu riêng cho dự án với chỉ các thông tin cần thêm vào, và các trang sẽ kết xuất cả hai "đi đôi" cùng nhau.

Sử dụng hộp thông tin trong bài viết

Việc sử dụng hộp thông tin là không bắt buộc cũng như không bị cấm đối với bất cứ bài viết nào. Khi nào nên thêm vào một hộp thông tin, loại hộp thông tin nào cần thêm vào, và phần nào của hộp thông tin cần sử dụng, tất cả đều được xác định qua thảo luận và đồng thuận của các biên tập viên tại mỗi bài viết riêng biệt.

Ý nghĩa gán cho mỗi phần của mỗi hộp thông tin cần phải giống nhau trong toàn thể loại hộp thông tin đó. Ví dụ, đối với một loại hộp thông tin cụ thể, nếu một trong các trường của nó được gọi là "cân nặng", đôi khi sẽ không phù hợp khi sử dụng trường này để biểu thị "cân nặng lúc sinh" và những lúc khác là "cân nặng lúc trưởng thành".

Mỗi loại hộp thông tin phải có tài liệu hướng dẫn về cách sử dụng từng phần/trường.

Giống như bản mẫu điều hướng, hộp thông tin nên tránh sử dụng các biểu tượng lá cờ. Để biết thêm thông tin, xem CNBS:LACO.

Chú thích trong hộp thông tin

Chú thích tham khảo được chấp nhận trong một số trường hợp, nhưng nhìn chung không cần thiết phải có trong hộp thông tin nếu nội dung được lặp lại (và được trích dẫn) ở nơi khác hoặc nếu thông tin rõ ràng. Nếu nội dung cần có chú thích tham khảo và thông tin cũng không xuất hiện trong phần thân của bài viết, thì chú thích đó nên được đưa vào hộp thông tin. Nhưng các biên tập viên trước tiên nên xem xét việc đưa nội dung này vào phần thân của bài viết.

Sắc tộc

Theo đồng thuận của cộng đồng Wikipedia tiếng Anh, tham số |ethnicity= hoặc |sắc tộc= (và tương tự) không được phép đưa vào hộp thông tin tiểu sử.

Quốc tịch và tư cách công dân

Phần lớn các hộp thông tin tiểu sử đều có phần quốc tịch và tư cách công dân. Nói chung, cần tránh sử dụng hai loại thông tin này khi chủ thể đang ở quốc gia vốn có thể được suy ra từ quốc gia nơi sinh ra, như đã được chỉ định trong tham số |nơi sinh=. Khi cần thiết (chẳng hạn do có sự thay đổi quốc tịch sau khi sinh, có hai quốc tịch, hoặc các tình huống bất thường khác), hãy sử dụng |quốc tịch= trừ khi |tư cách công dân= là phù hợp hơn do các vấn đề pháp lý phát sinh. Việc sử dụng quốc tịch và tư cách công dân cùng lúc là rất hiếm khi cần thiết (trường hợp phức tạp nên được giải thích trong phần thân bài viết). Tôn giáo hoặc sắc tộc không nên được đặt ở bất kỳ một trong hai trường nêu trên.

Hộp thông tin và tùy chọn người dùng

Người dùng có thể ẩn đi hộp thông tin trong trình duyệt của mình thông qua CSS cá nhân.

Để ẩn đi tất cả hộp thông tin, hãy thêm dòng sau vào Đặc biệt:Trang tôi/common.css (đối với tất cả giao diện, hoặc Đặc biệt:Trang tôi/skin.css đối với giao diện hiện tại):

div.mw-parser-output .infobox { display: none; }

Ngoài ra, bạn cũng có thể thêm mã dưới đây vào trang common.js hoặc vào trong một kịch bản người dùng trình duyệt được thực thi bởi một tiện ích mở rộng như Greasemonkey:

$('.infobox').hide();

Lưu ý rằng trên thực tế, không phải lúc nào thông tin trong hộp thông tin cũng đều được tìm thấy trong phần thân bài viết, chẳng hạn như đối với hệ thống phân loại đầy đủ trong {{Bảng phân loại}} và các mã cơ sở dữ liệu y khoa trong {{Thông tin bệnh (mới)}}. Hộp thông tin cũng thường là vị trí đặt hình ảnh quan trọng nhất, hoặc thậm chí là hình ảnh duy nhất, trong một bài viết. Tại Wikipedia tiếng Anh có một kịch bản người dùng nhằm ẩn đi hộp thông tin và đồng thời chuyển hình ảnh chứa trong nó sang hình nhỏ riêng.

Xem thêm

• Wikipedia:Danh sách hộp thông tin — trang liệt kê chính
• Tất cả các trang có tiêu đề bắt đầu bằng Bản mẫu:Hộp thông tin hoặc Bản mẫu:Thông tin
• Wikipedia:Mục lục bản mẫu — danh mục tất cả bản mẫu