Bản mẫu:Tài liệu

Bách khoa toàn thư mở Wikipedia
Buớc tưới chuyển hướng Bước tới tìm kiếm
Biểu tượng tài liệu Tài liệu bản mẫu [xem] [sửa] [lịch sử] [làm mới]

Đây là {{Tài liệu}}, bản mẫu này tự động hiển thị hộp tài liệu thuyết trình tương tự như bạn đang nhìn thấy bây giờ, với nội dung của nó được chuyển tải sang từ trang khác. Nó có mục đích để dùng cho các trang được chuyển tải vào các trang khác, nghĩa là các bản mẫu, có thể từ tên miền không gian bản mẫu hoặc không. Mẫu này hiển thị hộp tài liệu màu xanh lá cây như 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.

Mẫu này được dùng để ghi lại các mẫu và các trang khác truyền tải lên các trang khác. Nó có thể được sử dụng trong không gian mẫu và hầu hết các không gian tên khác.

Việc sử dụng mẫu này cho phép các mẫu trở thành được bảo vệ khi cần thiết, đồng thời cho phép mọi người chỉnh sửa tài liệu và danh mục.

Sử dụng

Thực tế bản mẫu này không cần tham số nào cả, chỉ cần thế này:

<!--Last line of your template code--><noinclude>
{{Tài liệu}}
<!-- Add categories to the /doc subpage, not here! -->
</noinclude>

Sau đó, bản mẫu này tự động tải nội dung từ trang con /doc của bản mẫu mà nó được sử dụng.

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:

<!--Last line of your template code--><noinclude>
{{Tài liệu|Template:Other page/doc}}
[[Thể loại:Bản mẫu không gian tên Bản mẫu]]
[[Thể loại:Tài liệu bản mẫu]]
[[Thể loại:Bản mẫu dựa trên ngôn ngữ Lua]]
</noinclude>

Lưu ý rằng khi tải tài liệu từ một trang không phải là trang cục bộ đuôi /doc, việc xử lý các trang không phải /doc có thể trở nên khó khăn.

Nội dung cũng có thể được thêm vào trực tiếp dưới dạng văn bản. Như thế này:

<!--Last line of your template code--><noinclude>
{{Tài liệu
 | content =
(some documentation)
}}</noinclude>

Khi tham số |content= đượ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=|content= cũng có thể được kết hợp, như thế này:

<!--Last line of your template code--><noinclude>
{{Tài liệu|1=Template:Any page/doc
| content =
{{Template:Any page/doc |parameters}}
}}</noinclude>

Sau đó, pagename đượ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 chuyển mã thành {{Template:Any page/doc|parameters}}. Trong ví dụ này, một tham số cũng được đưa đến trang /doc đang được tải.

Đoạn mã này nên được thêm vào ở đoạn cuối của mã cho bản mẫu, lưu ý không được có kí tự trống/kí tự xuống dòng dư thừa trước "<noinclude>" (nó có thể gây ra khoảng trống dư thừa trên các trang mà bản mẫu được sử dụng). Tham biến có thể được sử dụng như nói trên để chuyển tải các trang tài liệu thuyết trình bất kỳ.

Bổ sung các thể loại và liên kết kiên wiki vào trang tài liệu thuyết trình, bên trong phạm vi các thẻ includeonly.

Mẹo: Nếu trang tài liệu thuyết trình chứa các thẻ includeonly hoặc noinclude như là một phần của nội dung thuyết trình, thay thế "<" bằng "&lt;".

Chức năng

Nếu trang tài liệu thuyết trình không tồn tại, liên kết "sửa" bao gồm nạp trước tham biến sao cho việc nhấn chuột vào nó sẽ điền trước phom sửa đổi với định dạng trang thuyết trình cơ bản. Tiêu đề phụ thuộc vào không gian tên gọi; ví dụ, nó sẽ hiển thị "Tài liệu bản mẫu" trong không gian tên Bản mẫu. Tải trước văn bản cũng được sử dụng cho /sandbox và /testcases với link (tạo).

Bản mẫu:Tài liệu tự động kiểm tra xem trang bản mẫu nhúng nó có bị khóa hay không và tự động thêm bản mẫu {{pp-template}} ({{khóa-bản mẫu}}, bản mẫu này thêm biểu tượng ổ khóa vào góc trên bên phải). Vì thế không cần thêm {{khóa-bản mẫu}} tại các bản mẫu có dùng {{Tài liệu}}.

Khi bản mẫu này nằm trên trang mẫu được bảo vệ, giờ đây nó sẽ tự động thêm {{Template sandbox notice}}. Nếu hộp cát đó không phải là một trang con của mẫu trực tiếp, thì tham số |livepage= có thể được sử dụng để liên kết chính xác trở lại bản mẫu đó.

Lời khuyên Thực hành tốt

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 thừa trên các trang sử dụng mẫu).

Các thể loại và liên kết liên kết á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 tag <includeonly>...</includeonly>. Đối với các trường hợp phức tạp hơn, hãy xem Wikipedia:Tài liệu mẫu#Danh mục và liên kết liên mạng.

Nếu trang tài liệu có chứa tag <includeonly> hoặc <noinclude> như một phần của văn bản tài liệu hiển thị, thay nó với code cuối của mã đôi đó.

Đầu

Ghi nhớ rằng nếu trong không gian tên bản mẫu, nó sẽ chỉ đầu:

Test Template Info-Icon - Version (2).svg Tài liệu bản mẫu

Trong không gian tên khác, nó sẽ chỉ đầu:

Tài liệu

Tuy nhiên trong không gian tên Tập tin, nó sẽ chỉ đầu:

Miêu tả

Tham số tiêu đề có thể được sử dụng để đặt tiêu đề thành một cái gì đó khác. Như thế này:

{{Documentation |heading=Infobox documentation}}

Nếu tham số tiêu đề trống nhưng được xác định, 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:

{{Documentation |heading=}}

Tham số heading-style có thể được cho tùy chọn giá trị CSS. 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 = color: red; font-size: 150%;

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 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 xác định tham số |link box=. Ví dụ: |link box=Tài liệu này được tạo tự động bởi [[Template:Country showdata]]

Không gian chính và không gian tên thảo luận

Có các không gian tên: Thể loại, Chính, Tập tin và Mediawiki là không có trang con. Chúng sẽ chuyển tải tài liệu tại các trang thảo luận có tên con là /doc. Thực ra phần mềm mediawiki có trang con, tuy nhiên nó chỉ có thể sửa đổi bởi các bảo quản viên và nó sẽ làm hỏng đến các trang Mediawiki do phần <noinclude></noinclude>. Tuy nhiên, chỉ có các không gian tên là Bản mẫu, Thành viên và các không gian tên thảo luận của nó mới có /sandbox và /testcases.

Cơ sở hợp lý

Bản mẫu này cho phép bất kỳ trang nào sử dụng bất kỳ trang tài liệu thuyết trình nào, và cho phép khóa bản mẫu trong khi vẫn cho phép mọi người sửa đổi nội dung thuyết trình và thể loại của bản mẫu. Nó cũng làm giảm việc sử dụng tài nguyên máy chủ bằng cách đi vòng qua hạn chế kỹ thuật của bản mẫu (xem diễn giải của nhà thiết kế và phát triển).

Chi tiết kỹ thuật

Mẫu này gọi {{Documentation/start box2}} và {{Documentation/end box2}} mà lần lượt gọi {{Documentation/start box}} và {{documentation/end box}}. Hộp / start (và /end box) chứa hầu hết mã, trong khi mẫu này và /start box2 (và /end box2) thực hiện tiền xử lý tham số.

Trang tải trước cho /doc [tạo] liên kết là Template:Documentation/preload. Các trang tải trước cho /sandbox and /testcases [tạo] liên kết là Template:Documentation/preload-sandboxTemplate:Documentation/preload-testcases.

Để biết thêm chi tiết kỹ thuật, xem talk page.

Xem thêm