Wikivoyage:Bản mẫu

Những bản mẫu là các trang đặc biệt có thể "nhúng" vào mã nguồn của các bài viết để làm các bài này có thiết kế và văn phong thống nhất. Chúng có tên bắt đầu bởi chữ "Bản mẫu:" (còn gọi là trong không gian tên Bản mẫu). Ví dụ: Bản mẫu:Liên quan Wikivoyage.

Lợi và hại

Các bản mẫu giúp thống nhất văn phong và trình bày giữa các bài viết liên quan. Đặc biệt là đối với bảng thông tin, các trình bày phức tạp mà chúng ta không muốn lặp đi lặp lại từ bài này sang bài khác. Khi cần cập nhật thông tin chung, chỉ cần sửa bản mẫu; các bài dùng chung bản mẫu sẽ tự động được cập nhật theo.

Nhược điểm của việc dùng các bản mẫu là chúng làm tăng gánh nặng cho máy chủ của Wikimedia. Mã nguồn rắc rối khiến chúng khó sửa chữa và khó dùng với những thành viên ít kinh nghiệm.

Nhúng bản mẫu vào bài như thế nào?

Đơn giản, với những bản mẫu không có tham số, khi soạn bài, bạn viết mã {{Tên bản mẫu}} vào mã nguồn của bài (bất cứ chỗ nào bạn muốn nội dung bản mẫu hiện ra trong bài). Ở đây <Tên bản mẫu là phần tên nằm sau chữ "Bản mẫu:" của bản mẫu.

Hãy thử viết mã sau vào Wikivoyage:Chỗ thử để thí nghiệm:

{{Liên quan Wikivoyage}}

Nhiều bản mẫu có tham số. Người nhúng bản mẫu quy định giá trị của tham số khi nhúng. Hiển thị về bản mẫu sẽ hiện ra tùy theo tham số được quy định. Có hai loại tham số:

• Loại không có tên. Cách dùng thường là {{Tên bản mẫu|giá trị 1|giá trị 2|...}}.
• Loại có tên. Cách dùng thường là {{Tên bản mẫu|tên tham 1=giá trị 1|tên tham 2=giá trị 2|...}}.

Xem chi tiết về cách dùng từng bản mẫu cụ thể tại trang thảo luận của bản mẫu hay tại ngay trang mô tả bản mẫu đó.

Trang Wikivoyage:Danh sách bản mẫu liệt kê danh mục một số bản mẫu trong Wikivoyage; mà bạn có thể dùng để thông báo hay cải thiện bài viết. Bạn cũng có thể xem danh sách các bản mẫu tại Thể loại:Bản mẫu.

Nâng cao

Đổ mã nguồn ra bài viết

Khi dùng bản mẫu như hướng dẫn trên, bài viết hiển thị ra như thể chứa mã nguồn của bản mẫu (có vị trí các tham số đã gắn giá trị tương ứng), tuy rằng trong mã nguồn của bài viết chỉ có đoạn {{tên bản mẫu|tham=giá trị}}.

Để đổ mã nguồn của bản mẫu vào mã nguồn của bài viết, chúng ta viết:

{{subst:tên bản mẫu|tham=giá trị}}

Sau khi lưu trang, mã nguồn của bản mẫu (sau khi các tham đã được gắn giá trị tương ứng) sẽ được thay chỗ cho đoạn viết trên. Với cách dùng này, mọi sửa chữa bản mẫu sau này sẽ không ảnh hưởng đến bài viết nữa.

Giá trị đặc biệt

Nếu giá trị định gán cho tham số chứa các ký tự đặc biệt có thể gây ra hiểu nhầm như:

• "}}" (có thể nhầm với việc kết thúc đoạn nhúng bản mẫu),
• "=" (có thể gây nhập nhằng khi dùng với tham số không có tên),
• "|" (có thể nhầm với phân cách giữa các tham số),
• "#", "*", ";", "[[" hay "]]" (có thể gây nhập nhằng khi tương tác với mã nguồn khác trong bài);

chúng ta kẹp ký tự đặc biệt này trong <nowiki> và </nowiki>.

Viết mới hoặc sửa bản mẫu

Viết mới hoặc sửa bản mẫu thường được thực hiện bởi các thành viên có kinh nghiệm; do cần hiểu về các cú pháp bản mẫu.

Một số cú pháp

Tham số

Các bản mẫu có thể có tham số (còn gọi là thông số) hoặc không có tham số. Nếu có tham số, các tham số có thể có tên hoặc không có tên.

Các tham số không có tên được biểu diễn trong mã nguồn bản mẫu bằng cú pháp {{{1}}}, {{{2}}}, ... cho tham số thứ nhất, thứ hai, ... Khi người dùng bản mẫu, mọi giá trị gắn cho tham số thứ nhất sẽ được đưa vào các vị trí chứa {{{1}}} trong mã nguồn và hiệu ứng hiển thị ra trong bài như thể vị trí {{{1}}} được thay bởi giá trị người dùng đã cho. Tương tự cho các tham số thứ hai, ba...

Các tham số có tên, ví dụ tên là X, được biểu diễn trong mã nguồn bản mẫu bằng cú pháp, ví dụ {{{X}}}.

Các tham số có thể được gán giá trị mặc định; các giá trị này sẽ được dùng nếu người dùng bản mẫu không chỉ rõ giá trị cho tham tương ứng. Cách viết giá trị mặc định là dùng "|" tiếp theo là giá trị mặc định. Ví dụ {{{1|giá trị mặc định của tham thứ nhất}}}, {{{X|Y}}}.

Phần không hiện ra trong bài

Nếu bạn muốn tạo ra các nội dung chỉ hiển thị tại trang mô tả về bản mẫu mà không hiển thị trong bài dùng bản mẫu này, kẹp nội dung này giữa: <noinclude> và </noinclude>. Các nội dung này có thể là các hướng dẫn về cách dùng bản mẫu; hay phần xếp thể loại trang mô tả bản mẫu vào một thể loại thích hợp; cũng như liên kết đến bản mẫu tương tự ở Wikivoyage ngôn ngữ khác.

Phần chỉ hiện ra trong bài

Nếu bạn muốn tạo ra các nội dung chỉ hiển thị trong bài dùng bản mẫu này mà không hiển thị tại trang mô tả về bản mẫu, kẹp nội dung này giữa: <includeonly> và </includeonly>. Kỹ thuật này thích hợp cho việc giấu các đoạn hiển thị có thể vô nghĩa hoặc gây khó hiểu cho người xem khỏi trang mô tả về bản mẫu, khi các tham số chưa được gắn giá trị.

Bắt đầu với bản mẫu đơn giản

Các bản mẫu đơn giản có thể không cần tham số.

Một cách nhanh và nhiều khả năng thành công đối với các thành viên ít kinh nghiệm khi muốn viết bản mẫu mới là sao chép mã nguồn từ một bản mẫu tương tự có sẵn và thay đổi nhẹ trang trí và nội dung văn bản.

Các bản mẫu phức tạp hơn cũng có thể được sao chép từ Wikivoyage trong ngôn ngữ khác. Lúc đó có thể sẽ cần truyền lên các hình ảnh liên quan, hoặc tạo mới các bản mẫu liên quan, vốn có sẵn trong Wikivoyage ngoại ngữ nhưng chưa có trong Wikivoyage tiếng Việt.

Kỹ năng cần thiết

Khi sửa các bản mẫu nhất thiết phải kiểm tra xem các bài viết có sử dụng chúng hiển thị như mong muốn.

Để biết các bài viết nào sử dụng một bản mẫu, bạn ấn vào liên kết "Các liên kết đến đây" ở cột công cụ trong trang bản mẫu liên quan.

Sau khi sửa một bản mẫu, bạn có thể cần xóa bộ nhớ đệm của trình duyệt và tải lại trang dùng bản mẫu để xem sự thay đổi. Với những trang mà trình duyệt không trực tiếp tải về, bạn có thể phải đợi một thời gian để máy chủ cập nhật thông tin về sự sửa đổi bản mẫu cho các trang dùng bản mẫu này.

Nếu bạn vẫn có khó khăn khi sửa bản mẫu, thử vào Wikivoyage:Bàn giúp đỡ để hỏi các thành viên có kinh nghiệm khác.

Nâng cao

Đổi tên bản mẫu

Có thể đổi tên bản mẫu bằng cách dùng nút di chuyển trên đầu trang mô tả về bản mẫu (nút này dành cho các thành viên đã đăng nhập). Sau khi di chuyển như vậy, các bài viết dùng tên cũ vẫn hiển thị như mong muốn.

Tuy nhiên tránh đổi hướng kép. Các bản mẫu đổi hướng kép sẽ không hoạt động và cần phải được sửa để đổi hướng về bản mẫu chính.

Nhiều tên gọi cho cùng một tham số

Có thể tạo ra hai tên gọi cho cùng một tham số trong bản mẫu bằng cú pháp {{{tên_1|{{{tên_2|mặc_định}}}}}}. Tương tự cho các tham số có thể gọi bằng ba hay nhiều tên gọi hơn.

Kỹ thuật này có thể áp dụng cho việc Việt hóa các bản mẫu sao chép từ Wikivoyage ngôn ngữ khác: có thể đặt tên tiếng Việt cho các tham số và dùng chúng song song với tên gốc trong ngoại ngữ. Ví dụ, nếu bản mẫu có thể được dùng bởi nhiều trang bằng tham số tiếng Anh; và cũng được dùng bởi nhiều trang bằng tham số tiếng Việt thì có thể đưa cả hai tên gọi tham số vào bằng cú pháp {{{tên_tiếng_Việt|{{{tên_tiếng_Anh|mặc_định}}}}}}. Điều này giúp bản mẫu có thể được sao chép thẳng từ Wikivoyage ngoại ngữ mà vẫn hoạt động; đồng thời cũng có thể được dùng bởi các thành viên không thạo ngoại ngữ.

Kết hợp cú pháp tính toán/biến hệ thống

Các bản mẫu có thể dùng các hàm cú pháp trong mã nguồn. Khi đó, nhớ xếp bản mẫu này vào Thể loại:Bản mẫu dùng hàm cú pháp (kẹp trong <noinclude> và </noinclude> để việc xếp loại chỉ dành cho trang mô tả bản mẫu chứ không phải cho bài viết dùng bản mẫu này).

Nhiều bản mẫu tận dụng các biến hệ thống chứa các thông tin về thời gian hay thông tin liên quan đến trang mà bản mẫu sẽ được nhúng vào.

Xem thêm

• Danh sách tất cả các bản mẫu