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

Tủ sách mở Wikibooks
(đổi hướng từ Bản mẫu:Hồ sơ bản mẫu)
Buớc tưới chuyển hướng Bước tới tìm kiếm
Tài liệu bản mẫu[sửa] [lịch sử] [làm mới]

Bản mẫu này tự động hiển thị một hộp tài liệu như bạn đang thấy bây giờ, có nội dung được nhúng từ một trang khác. Nó được dành cho các trang được nhúng trong các trang khác, tức là các bản mẫu, cho dù trong không gian tên bản mẫu hay không.

Usage

Thông thường /doc

<noinclude>{{Documentation}}</noinclude>

Bất kỳ /doc page

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

Nội dung nội dung

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

Nội dung nội tuyến với các liên kết [xem] [sửa]

<noinclude>{{Documentation
|1=Template:any page/doc
|content={{Template:any page/doc|parameters}}
}}</noinclude>

Best practice

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside <includeonly> </includeonly> tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Customizing display

Overrides exist to customize the output in special cases:

  • {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Functions

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Rationale

  • Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
  • Text on the template page itself adds to the amount of text which must be processed when displaying the template, which is limited for performance reasons: there is a pre-expand include size maximum of 2,048,000 bytes. Placing the documentation in a subpage reduces the wikitext for documentation on the template page itself to a template call and noinclude tags. MediaWiki developers have recommended this system for this reason.

See also

Họ {{ Hồ sơ bản mẫu }}