Bản mẫu:Tài liệu
Tài liệu bản mẫu | Bản mẫu này được sử dụng ở khoảng 17.000 trang, vì thế những thay đổi đến nó sẽ hiện ra rõ ràng. Vui lòng thử nghiệm các thay đổi ở trang con /sandbox, /testcases của bản mẫu, hoặc ở không gian người dùng của bạn. Cân nhắc 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 sử dụng Lua: |
Đây là bản mẫu {{Tài liệu}} được sử dụng trên hầu hết các trang bản mẫu để chứa thông tin tài liệu hướng dẫn của bản mẫu đó.
Để biết hướng dẫn chi tiết về cách thức và thời điểm sử dụng bản mẫu này, hãy xem Wikipedia:Tài liệu bản mẫu.
Bản mẫu này hiển thị hộp tài liệu màu xanh lá cây bạn đang thấy và tự động tải nội dung từ trang con /doc. Nó cũng có thể tải nội dung từ những nơi khác nếu được hướng dẫn.
Bản mẫu này được dùng để trên các bản mẫu và các trang khác được chuyển tải lên các trang khác. Nó có thể được sử dụng trong không gian tên bản mẫu và hầu hết các không gian tên.
Sử dụng bản mẫu này cho phép các bản mẫu được khóa khi cần thiết vẫn có thể cho phép bất cứ ai sửa đổi tài liệu và thể loại.
Sử dụng
Thông thường bản mẫu này được sử dụng mà không có bất kỳ tham số nào, được đặt ở dưới cùng của bản mẫu hoặc trang, trong phạm vi <noinclude>...</noinclude> chứa:
<syntaxhighlight lang="xml+smarty">
</syntaxhighlight>
Sau đó, bản mẫu này tự động tải nội dung từ trang con /doc của bản mẫu.
Bản mẫu này cũng có thể tải nội dung từ bất kỳ trang nào khác. Như thế này:
<syntaxhighlight lang="xml+smarty">
</syntaxhighlight>
Lưu ý rằng khi tải tài liệu từ một trang không phải là trang cục bộ /doc, việc xử lý các thể loại có thể trở nên khó khăn.
Nội dung cũng có thể được thêm trực tiếp dưới dạng văn bản. Như thế này:
<syntaxhighlight lang="xml+smarty">
</syntaxhighlight>
Khi tham số |content=/|nội dung= được sử dụng, hộp tài liệu thường không hiển thị các liên kết [sửa] [làm mới] ở góc trên cùng bên phải. Lưu ý rằng nếu trang /doc tồn tại, một liên kết đến nó vẫn được hiển thị trong hộp liên kết bên dưới hộp tài liệu.
Tham số |1= và |content=/|nội dung= cũng có thể được kết hợp, như thế này:
<syntaxhighlight lang="xml+smarty">
</syntaxhighlight>
Sau đó, tên trang được cung cấp dưới dạng tham số 1 được sử dụng cho các liên kết [sửa] [làm mới] và cho liên kết /doc trong hộp liên kết bên dưới hộp tài liệu. Nhưng tham số contentđược sử dụng cho nội dung hiển thị trong hộp tài liệu. Đoạn mã trên có nghĩa là nội dung được bao gồm là {{Bản mẫu:Any page/doc|parameters}}. Trong ví dụ này, một tham số cũng được đưa đến trang /doc đang được tải.
Lối tắt
Để tự động chèn noinclude tags, cuộc gọi bản mẫu và nhận xét hướng dẫn, use mã này thay thế:
{{subst:doc-code}}
Mẹo
Mã phải được thêm vào ở dưới cùng của mã bản mẫu, không có khoảng trắng trước < noinclude> (sẽ gây thêm không gian trên các trang sử dụng bản mẫu).
Các thể loại áp dụng cho chính bản mẫu nên được thêm vào cuối trang con /doc, bên trong các thẻ <includeonly>...</includeonly>. Các liên kết liên mạng áp dụng cho bản mẫu nên được liệt kê tại Wikidata (xem thêm Wikipedia:Wikidata). Đối với các trường hợp phức tạp hơn, xem en:Wikipedia:Template documentation#Categories and interwiki links.
Nếu trang tài liệu có chứa tags <includeonly> hoặc <noinclude> như một phần của văn bản tài liệu hiển thị, thay thế "<" với "<" hoặc dùng Bản mẫu:tag.
Đầu đề
Khi trong không gian tên bản mẫu, bản mẫu này hiển thị tiêu đề này:
Tài liệu bản mẫu
Trong hầu hết các không gian tên khác, chẳng hạn như "Wikipedia:", nó hiển thị tiêu đề này:
- Tài liệu
Nhưng khi trên trang Tập tim (hình ảnh), nó hiển thị tiêu đề này:
- Tóm tắt
Tham số heading có thể được sử dụng để đặt tiêu đề cho một cái gì đó khác. Như thế này:
{{Tài liệu |heading=Infobox documentation}}
Nếu tham số heading trống nhưng được xác định, sẽ không có tiêu đề nào được hiển thị và không có liên kết [sửa] [làm mới] nào được hiển thị. Như thế này:
{{Tài liệu |heading=}}
Tham số heading-style parameter có thể được cung cấp các giá trị CSS tùy chọn. Không có dấu ngoặc kép " " nhưng với dấu chấm phẩy kết thúc ;. Ví dụ:
heading-style=font-size:150%;color:red;
Hộp liên kết
Bên dưới hộp tài liệu lớn là một hộp liên kết nhỏ hiển thị một số dữ liệu meta về tài liệu. Hộp liên kết hiển thị những thứ khác nhau tùy thuộc vào tham số nào được cung cấp cho bản mẫu này và trong không gian tên được sử dụng. Trong một số trường hợp, hộp liên kết hoàn toàn không hiển thị.
Để ẩn hộp liên kết, thêm tham số
|link box=off.
Bạn cũng có thể chèn văn bản tùy chỉnh vào hộp liên kết, bằng cách đặt tham số |link box=. Ví dụ:
|link box=Tài liệu này được tạo tự động bởi [[Bản mẫu:Country showdata]]
Chức năng tự động
Nếu trang tài liệu không tồn tại, liên kết [tạo] bao gồm một trang tự động tải để nhấp vào nó sẽ điền trước biểu mẫu chỉnh sửa với định dạng trang tài liệu cơ bản. Tải trước văn bản cũng được sử dụng cho các liên kết [tạo] / sandbox và /testcases.
Khi bản mẫu này nằm trên trang bản mẫu được bảo vệ, giờ đây nó sẽ tự động thêm {{Khóa-bản mẫu}}, trong đó cho thấy ổ khóa màu xám hoặc khác ở góc trên bên phải. Vì vậy, không cần phải thêm thủ công {{Khóa-bản mẫu}} vào bản mẫu sử dụng {{Tài liệu}}.
Khi bản mẫu này nằm trên trang con /sandbox, nó sẽ tự động thêm {{Template sandbox notice}}.
Không gian tên mục tiêu so với không gian tên thảo luận
Thuật ngữ: Không gian tên mục đích trái ngược với không gian tên thảo luận. Ví dụ: "Bản mẫu:" là không gian mục đích của "Thảo luận bản mẫu:".
Mẫu này thường được đặt trong một không gian tên mục đích, trong <noinclude> tags. Nhưng trong một số trường hợp, bản mẫu này cần phải có trên trang thảo luận:
- Trong không gian tên Mediawiki, vì
<noinclude o>...</noinclude o>thường không hoạt động trong các thông báo hệ thống và vì không gian tên Mediawiki cần được giữ sạch vì lý do hiệu suất.
Khi được đặt trên các trang thảo luận, bản mẫu này thường được đặt ở gần đầu trang và không có <noinclude>...</noinclude> tags.
The /doc, /sandbox and /testcases các trang thường phải ở trong không gian tên mục tiêu, ngoại trừ trong các không gian tên không có MediaWiki chức năng trang con được mở: Chính, Tập tin, Mediawiki và Thể loại. (Nhưng hiện tại chúng tôi chỉ hiển thị các liên kết /sandbox và /testcase từ các không gian tên thành viên, thảo luận thành viên, Bản mẫu và Thảo luận bản mẫu.) Ngoài ra còn có một loạt các lý do kỹ thuật khác tại sao trang /doc phải được lưu trữ dưới trang thảo luận cho những người đó (nhưng chỉ những) không gian tên. Bản mẫu này tự động trỏ các liên kết [tạo] của nó cho /doc, /sandbox và /testcase vào không gian tên bên phải.
Thử
Bạn có thể mô phỏng đầu ra cho một trang nhất định bằng cách sử dụng tham số |page=. Ví dụ: nếu bạn sử dụng mã |page=Bản mẫu:Sửa trang khóa, bản mẫu sẽ hoạt động chính xác như thể nó ở trên trang BẢn mẫu:Sửa trang khóa, bao gồm hiển thị các tài liệu từ Bản mẫu:Sửa trang khóa/doc, liên kết đến Bản mẫu:Sửa trang khóa/sandbox, etc. Tham số này hữu ích để thử nghiệm và được sử dụng rộng rãi trên trang thử nghiệm mô-đun.
Thông tin kĩ thuật
Trang tải trước cho liên kết / doc [tạo] là Bản mẫu:Tài liệu/preload. Các trang tải trước cho các liên kết / sandbox và / testcase [tạo] là Bản mẫu:Tài liệu/preload-sandbox và Bản mẫu:Tài liệu/preload-testcases. Trang tải trước cho liên kết / sandbox [sao] là Bản mẫu:Tài liệu/mirror.
Để biết thêm chi tiết, xem trang thảo luận.
Tất cả tham số
{{Tài liệu}}
{{Tài liệu
| content =
}}
{{Tài liệu
| [đường dẫn đến trang tài liệu]
| heading-style =
| heading =
| link box =
}}
Xem thêm
- {{Trang con tài liệu}}, một thông báo được đặt ở đầu trang con /doc giải thích vai trò của nó và bao gồm một liên kết đến trang mà nó ghi lại.
- {{Barnstar documentation}}, một biến thể của {{Documentation}} để sử dụng với bản mẫu barnstar.
- {{Documentation/color scheme}} trình bày bảng màu được sử dụng bởi {{Documentation}}.
- Wikipedia:Tài liệu bản mẫu là một hướng dẫn cách làm tài liệu bản mẫu.
- en:Wikipedia:Template sandbox and test cases explains the use of /sandbox and /testcases subpages and includes more information about template testing.
- en:User:Technical 13/Scripts/editTemplateNoDoc.js, a beta script that enables documentation to be hidden by default when editing templates.