Template:Template doc inline/doc
From Wikipedia, the free encyclopedia
This template is kept temporarily until pages are converted to the merged and improved {{Documentation, template}}.
Note differences in usage mean it cannot be redirected. See Template parameter differences below.
This template displays a "Template documentation" box like you are seeing now.
It is primarily used by {{template doc}} to automatically display the documentation for the template from a /doc subpage, but can also be used to display inline documentation.
It provides a view and an edit link to the documentation page. If that page does not exist yet the edit link preloads Template:Template doc/Preload (backlinks, edit).
[edit] Usage
{{template doc inline|1=inline documentation|2=pagename}}
- Inline documentation is the text to display inside the box.
- Pagename refers to the name of the documentation page, which if specified, creates [view] and [edit] boxes to the right of the heading.
[edit] Template parameter differences
[edit] Parameter for in-line content
- {{Template doc inline}} uses 1=in-line content
- {{Documentation}} uses content=in-line content
- {{Documentation, template}} uses content=in-line content
[edit] Parameter for /doc path
- {{Template doc inline}} uses 2={{FULLPAGENAME}}
- {{Template doc}} uses 1={{PAGENAME}}
- and then transcluded
- {{Template doc inline}} using
- 1={{ {{SUBJECTSPACE}}:{{{1}}} }}
- 2={{SUBJECTSPACE}}:{{{1}}}
- {{Documentation}} uses 1={{FULLPAGENAME}}
- {{Documentation, template}} uses 1={{FULLPAGENAME}}
