Bước tới nội dung

Thành viên:Plantaest/Blog/Quy ước cho bản mẫu

Bách khoa toàn thư mở Wikipedia

Bài viết này nghiên cứu một số vấn đề liên quan đến bản mẫu, nhằm đưa ra hướng thiết kế, sử dụng và quản lý phù hợp về lâu dài.

Có cần thiết phải dịch tham số?

Dịch tham số có lợi và hại gì? Cần so sánh để nhìn ra vấn đề.

Khuyến nghị

  • Tên bản mẫu nên giữ nguyên tiếng Anh nếu đó là những bản mẫu hệ thống như {{Str find}}, và để tiếng Việt nếu đó là những bản mẫu nội dung như infobox, navbox.
  • Khi nhúng trong trang, nên dùng tên bản mẫu chính thức, thay vì những tên đổi hướng. Ví dụ, hãy dùng {{Thông tin khu dân cư}} thay vì {{Infobox settlement}}.
  • Sử dụng tham số tiếng Anh thay vì tiếng Việt, với một số lý do chính:
    • Đa phần các bản mẫu đều được dịch từ enwiki, việc sử dụng tham số gốc sẽ tiện cho quá trình nâng cấp định kỳ, không cần dịch các tham số mới nếu có.
    • Thuận tiện cho việc nhập các bản mẫu mới, đỡ mất công dịch và làm rối tung mã nguồn gốc. Người nhập chỉ cần quan tâm dịch các label, message. Thực tế hiện nay cũng ít người nào siêng dịch hết như xưa, toàn copy paste cho khỏe.
    • Đa phần các bài viết hiện nay là bài dịch, ngay trong nội dung đã thường dùng tên tham số tiếng Anh.
    • Các trình soạn thảo hiện nay đều đã có công cụ TemplateWizard, nó có thể cho phép người dùng chèn bản mẫu thuận tiện, với giao diện hiển thị được danh sách tham số có thể có nhãn ghi chú tiếng Việt nhưng tên gốc vẫn là tiếng Anh, thông qua khai báo tại TemplateData.
    • Tên tham số tiếng Anh dễ dàng hơn trong việc lập trình module Lua. Không phải tự nhiên mà enwiki yêu cầu dùng snake_case cho tham số bản mẫu, nguyên nhân vì trong Lua, snake_case sẽ thuận tiện hơn do tương thích với cú pháp dot notation như args.my_param thay vì bracket notation như args['my_param'].
    • Tuy không chắc chắn, nhưng nhiều công cụ, bot có lẽ chỉ hoạt động tốt với các tham số gốc; rất nhiều lúc gặp lỗi khi bản mẫu dùng tham số tiếng Việt.
    • Lưu ý: Những quan điểm này là tạm thời, và có thể thay đổi khi dự án Fusion đi vào hoạt động.
  • Giới hạn trên áp dụng cho các bản mẫu có nguồn gốc từ enwiki. Đối với các bản mẫu địa phương, vẫn khuyến nghị dùng tham số tiếng Anh trong khả năng, nhất là khi nó là một bản mẫu dẫn xuất, lấy ý tưởng từ các bản mẫu có nguồn gốc từ enwiki.
  • Nên sử dụng những parser function với tên gốc thay vì tên tiếng Việt, ví dụ như khi gọi module, nên dùng #invoke thay vì #gọi. Xét cho cùng, việc thu hẹp các lựa chọn sẽ giúp bảo trì mã tốt hơn về lâu dài, tuân thủ nguyên tắc KISS.
Lấy từ “https://vi.wikipedia.org/w/index.php?title=Thành_viên:Plantaest/Blog/Quy_ước_cho_bản_mẫu&oldid=72040353”